1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
|
import argparse
import re
import sys
from pathlib import Path
GRAMMAR_DIR = Path("extension/autocomplete/grammar/statements")
TRANSFORMER_DIR = Path("extension/autocomplete/transformer")
FACTORY_REG_FILE = Path("extension/autocomplete/transformer/peg_transformer_factory.cpp")
FACTORY_HPP_FILE = Path("extension/autocomplete/include/transformer/peg_transformer.hpp")
# Matches: RuleName <- ...
GRAMMAR_REGEX = re.compile(r"^(\w+)\s*<-")
# Matches: PEGTransformerFactory::TransformRuleName(
TRANSFORMER_REGEX = re.compile(r"PEGTransformerFactory::Transform(\w+)\s*\(")
# Matches: RegisterEnum<...>("RuleName", ...);
ENUM_RULE_REGEX = re.compile(r'RegisterEnum<[^>]+>\s*\(\s*"(\w+)"\s*,')
# Matches: REGISTER_TRANSFORM(TransformRuleName)
REGISTER_TRANSFORM_REGEX = re.compile(r"REGISTER_TRANSFORM\s*\(\s*Transform(\w+)\s*\)")
EXCLUDED_RULES = {
"FunctionType",
"IfExists",
"Database",
"AbortOrRollback",
"CommitOrEnd",
"StartOrBegin",
"Transaction",
"VariableAssign",
"MacroOrFunction",
"SettingScope",
"ColLabel",
"MacroOrFunction",
"GroupingOrGroupingId",
"DefaultValues",
"RowOrRows",
"Recursive",
"StarSymbol",
"IfNotExists",
"PlainIdentifier",
"QuotedIdentifier",
"CreateTableColumnElement",
"OrReplace",
"ReservedIdentifier",
"CatalogName",
"SchemaName",
"ReservedSchemaName",
"ReservedIdentifier",
"TableName",
"ReservedTableName",
"ColumnName",
"ReservedColumnName",
"FunctionName",
"ReservedFunctionName",
"TableFunctionName",
"TypeName",
"PragmaName",
"SettingName",
"CopyOptionName",
"AtTimeZoneOperator",
"Generated",
"ColumnConstraint",
"AlwaysOrByDefault",
"Lateral",
"ConstraintNameClause",
"ReservedSchemaQualification",
"UsingSample",
"TableSample",
"TypeList",
"NamedParameterAssignment",
"WithOrdinality",
"ByName",
"CollateOperator",
"ExportClause",
"ValueOrValues",
"PivotKeyword",
"UnpivotKeyword",
"Unique",
"DefArg",
"NoneLiteral",
"RowOrStruct",
}
def find_grammar_rules(grammar_path):
"""
Scans the grammar directory for *.gram files and extracts all rule names.
Returns a dictionary mapping:
{ "filename.gram": (Path, ["Rule1", "Rule2"]), ... }
"""
all_rules_by_file = {}
if not grammar_path.is_dir():
print(f"Error: Grammar directory not found: {grammar_path}", file=sys.stderr)
sys.exit(1)
gram_files = sorted(list(grammar_path.glob("*.gram")))
if not gram_files:
print(f"Error: No *.gram files found in {grammar_path}", file=sys.stderr)
sys.exit(1)
for file_path in gram_files:
rules_in_file = []
try:
with file_path.open("r", encoding="utf-8") as f:
for line in f:
match = GRAMMAR_REGEX.match(line)
if match:
rules_in_file.append(match.group(1))
except Exception as e:
print(f"Error reading {file_path}: {e}", file=sys.stderr)
continue
all_rules_by_file[file_path.name] = (file_path, rules_in_file)
return all_rules_by_file
def find_transformer_rules(transformer_path):
"""
Scans the transformer directory for *.cpp files and extracts all
PEGTransformerFactory::Transform...() function implementations.
Returns a set of all found rule names:
{ "AlterStatement", "AlterTableStmt", ... }
"""
transformer_rules = set()
if not transformer_path.is_dir():
print(
f"Error: Transformer directory not found: {transformer_path}",
file=sys.stderr,
)
sys.exit(1)
cpp_files = sorted(list(transformer_path.glob("*.cpp")))
if not cpp_files:
print(f"Error: No *.cpp files found in {transformer_path}", file=sys.stderr)
sys.exit(1)
print(f"Scanning {len(cpp_files)} transformer files in {transformer_path}...")
for file_path in cpp_files:
try:
with file_path.open("r", encoding="utf-8") as f:
content = f.read()
matches = TRANSFORMER_REGEX.finditer(content)
for match in matches:
transformer_rules.add(match.group(1))
except Exception as e:
print(f"Error reading {file_path}: {e}", file=sys.stderr)
continue
return transformer_rules
def find_factory_registrations(factory_file_path):
"""
Scans the factory file for RegisterEnum<...> and REGISTER_TRANSFORM(...)
Returns two sets:
(enum_rules, registered_rules)
"""
enum_rules = set()
registered_rules = set()
if not factory_file_path.is_file():
print(f"Error: Factory file not found: {factory_file_path}", file=sys.stderr)
return enum_rules, registered_rules
print(f"Scanning factory file: {factory_file_path}...")
try:
with factory_file_path.open("r", encoding="utf-8") as f:
content = f.read()
# Find enums
enum_matches = ENUM_RULE_REGEX.finditer(content)
for match in enum_matches:
enum_rules.add(match.group(1))
# Find transformer registrations
reg_matches = REGISTER_TRANSFORM_REGEX.finditer(content)
for match in reg_matches:
registered_rules.add(match.group(1))
except Exception as e:
print(f"Error reading {factory_file_path}: {e}", file=sys.stderr)
return enum_rules, registered_rules
def generate_declaration_stub(rule_name):
"""Generates the C++ method declaration (for the .hpp file)."""
return f"""// TODO: Verify this return type is correct
static unique_ptr<SQLStatement> Transform{rule_name}(PEGTransformer &transformer, optional_ptr<ParseResult> parse_result);
"""
def generate_registration_stub(rule_name):
"""Generates the C++ registration line (for peg_transformer_factory.cpp)."""
return f"REGISTER_TRANSFORM(Transform{rule_name});\n"
def generate_implementation_stub(rule_name):
"""Generates the C++ method implementation (for the transform_...cpp file)."""
return f"""// TODO: Verify this return type is correct
unique_ptr<SQLStatement> PEGTransformerFactory::Transform{rule_name}(PEGTransformer &transformer,
optional_ptr<ParseResult> parse_result) {{
throw NotImplementedException("Transform{rule_name} has not yet been implemented");
}}
"""
def generate_code_for_missing_rules(generation_queue):
"""
Iterates the generation queue and prints stub code, grouped by rule.
"""
if not generation_queue:
print("\nNo missing rules to generate.")
return
print("\n--- Code Generation: Missing Stubs ---")
print("Copy and paste the code below into the correct files.")
rules_to_generate = [] # List of (rule_name, cpp_filename)
for cpp_filename, rules in generation_queue.items():
for rule in rules:
rules_to_generate.append((rule, cpp_filename))
# Sort by rule name
for rule_name, cpp_filename in sorted(rules_to_generate):
cpp_path = TRANSFORMER_DIR / cpp_filename
# Constraint: Do not generate code for non-existent files
if not cpp_path.is_file():
print(f"\n// --- SKIPPING: {rule_name} (File not found: {cpp_filename}) ---")
continue
print(f"--- Generation for rule: {rule_name} ---")
print(f"1. Add DECLARATION to: {FACTORY_HPP_FILE}")
print(generate_declaration_stub(rule_name))
print(f"2. Add REGISTRATION to: {FACTORY_REG_FILE}\nInside the appropriate Register...() function:")
print(generate_registration_stub(rule_name))
print(f"3. Add IMPLEMENTATION to: {cpp_path}")
print(generate_implementation_stub(rule_name))
print(f"--- End of {rule_name} ---\n")
def main():
"""
Main script to find rules, compare them, and print a report.
"""
parser = argparse.ArgumentParser(description="Check transformer coverage and optionally generate stubs.")
parser.add_argument(
"-g",
"--generate",
action="store_true",
help="Generate C++ stubs (declaration, registration, implementation) for missing rules.",
)
parser.add_argument("-s", "--skip-found", action="store_true", help="Skip output of [ FOUND ] rules")
args = parser.parse_args()
grammar_rules_by_file = find_grammar_rules(Path(GRAMMAR_DIR))
transformer_impls = find_transformer_rules(Path(TRANSFORMER_DIR))
enum_rules, registered_rules = find_factory_registrations(Path(FACTORY_REG_FILE))
if not grammar_rules_by_file:
print("Error: Could not find grammar rules. Exiting.", file=sys.stderr)
sys.exit(1)
print("\n--- Rule Coverage Check ---")
total_grammar_rules = 0
total_rules_scanned = 0
total_found_enum = 0
total_found_registered = 0
total_missing_registration = 0
total_missing_implementation = 0
all_grammar_rules_flat = set()
missing_rules_by_file = {}
generation_queue = {}
# Iterate through each file and its rules
for file_name, (file_path, grammar_rules) in sorted(grammar_rules_by_file.items()):
print(f"\n--- File: {file_name} ---")
missing_count_this_file = 0
stem = file_path.stem
cpp_filename = f"transform_{stem}.cpp"
missing_rules_for_gen = []
if not grammar_rules:
print("(No grammar rules found in this file)")
continue
for rule_name in sorted(grammar_rules):
total_rules_scanned += 1
if rule_name in EXCLUDED_RULES:
print(f"{'[ EXCLUDED ]':<14} {rule_name}")
continue
all_grammar_rules_flat.add(rule_name)
total_grammar_rules += 1
is_enum = rule_name in enum_rules
is_transformer = rule_name in transformer_impls
is_registered = rule_name in registered_rules
if is_enum:
status_str = "[ ENUM ]"
total_found_enum += 1
elif is_transformer:
if is_registered:
status_str = "[ FOUND ]"
total_found_registered += 1
else:
status_str = "[ NOT REG'D ]"
total_missing_registration += 1
missing_count_this_file += 1
else:
status_str = "[ MISSING ]"
total_missing_implementation += 1
missing_count_this_file += 1
missing_rules_for_gen.append(rule_name)
if args.skip_found and ("FOUND" in status_str or "ENUM" in status_str):
continue
print(f"{status_str:<14} {rule_name}")
if missing_count_this_file > 0:
missing_rules_by_file[file_name] = missing_count_this_file
if missing_rules_for_gen:
generation_queue[cpp_filename] = missing_rules_for_gen
total_covered = total_found_enum + total_found_registered
total_issues = total_missing_implementation + total_missing_registration
coverage = (total_covered / total_grammar_rules) * 100 if total_grammar_rules > 0 else 0
print("\n--- Summary: Rule Coverage ---")
print(f"{'TOTAL RULES SCANNED':<25} : {total_rules_scanned}")
print(f" {' - Excluded':<23} : {len(EXCLUDED_RULES)}")
print("---------------------------------------")
print(f"{'TOTAL ACTIONABLE RULES':<25} : {total_grammar_rules}")
print(f"{'TOTAL COVERED':<25} : {total_covered} ({coverage:.2f}%)")
print(f" {' - Enum':<23} : {total_found_enum}")
print(f" {' - Registered':<23} : {total_found_registered}")
print(f"{'TOTAL ISSUES':<25} : {total_issues}")
if missing_rules_by_file:
print("\n--- Summary: Issues Per File ---")
for file_name, count in sorted(missing_rules_by_file.items()):
print(f"{file_name:<25} : {count} issues")
print("\n--- Orphan / Mismatch Check ---")
orphan_transformers = transformer_impls - all_grammar_rules_flat - EXCLUDED_RULES
if orphan_transformers:
print("\n[!] Orphan Transformer Functions (No matching grammar rule):")
for rule in sorted(list(orphan_transformers)):
print(f" - Transform{rule}")
orphan_enums = enum_rules - all_grammar_rules_flat - EXCLUDED_RULES
if orphan_enums:
print("\n[!] Orphan Enum Rules (No matching grammar rule):")
for rule in sorted(list(orphan_enums)):
print(f' - RegisterEnum("{rule}")')
orphan_registrations = registered_rules - all_grammar_rules_flat - EXCLUDED_RULES
if orphan_registrations:
print("\n[!] Orphan Registrations (No matching grammar rule):")
for rule in sorted(list(orphan_registrations)):
print(f" - REGISTER_TRANSFORM(Transform{rule})")
missing_impl = registered_rules - transformer_impls
if missing_impl:
print("\n [!] Registered but NOT Implemented (Will cause C++ error):")
for rule in sorted(list(missing_impl)):
print(f" - REGISTER_TRANSFORM(Transform{rule})")
unnecessary_reg = registered_rules.intersection(enum_rules)
if unnecessary_reg:
print("\n[!] Rule registered as BOTH Enum and Transformer (Ambiguous):")
for rule in sorted(list(unnecessary_reg)):
print(f" - {rule}")
if args.generate:
generate_code_for_missing_rules(generation_queue)
if __name__ == "__main__":
main()
|