hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Codegen: Create internal folders

Browse Source
This commit is contained in:
Tom Hvitved
2024-09-17 08:49:56 +02:00
parent c7e3682597
commit 1433363523
3 changed files with 31 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
misc/codegen/generators/qlgen.py
View File

@@ -244,7 +244,11 @@ def _get_path(cls: schema.Class) -> pathlib.Path:
def _get_path_impl(cls: schema.Class) -> pathlib.Path:
return pathlib.Path(cls.group or "", cls.name+"Impl").with_suffix(".qll")
return pathlib.Path(cls.group or "", "internal", cls.name+"Impl").with_suffix(".qll")
def _get_path_public(cls: schema.Class) -> pathlib.Path:
return pathlib.Path(cls.group or "", "internal" if "ql_internal" in cls.pragmas else "", cls.name).with_suffix(".qll")
def _get_all_properties(cls: schema.Class, lookup: typing.Dict[str, schema.Class],
@@ -395,9 +399,11 @@ def generate(opts, renderer):
classes_by_dir_and_name = sorted(classes.values(), key=lambda cls: (cls.dir, cls.name))
for c in classes_by_dir_and_name:
path = get_import(stub_out / c.path, opts.root_dir)
path = get_import(stub_out / c.dir / "internal" /
c.name if c.internal else stub_out / c.path, opts.root_dir)
imports[c.name] = path
imports_impl[c.name + "Impl"] = path + "Impl"
path_impl = get_import(stub_out / c.dir / "internal" / c.name, opts.root_dir)
imports_impl[c.name + "Impl"] = path_impl + "Impl"
for c in classes.values():
qll = out / c.path.with_suffix(".qll")
@@ -420,7 +426,8 @@ def generate(opts, renderer):
qldoc = renderer.render_str(stub, template='ql_stub_class_qldoc')
_patch_class_qldoc(c.name, qldoc, stub_file)
class_public = _get_class_public(c)
class_public_file = stub_out / path
path_public = _get_path_public(c)
class_public_file = stub_out / path_public
class_public.imports = [imports[t] for t in classes_used_by[c.name]]
renderer.render(class_public, class_public_file)
@@ -472,7 +479,7 @@ def generate(opts, renderer):
if synth_type.is_final:
final_synth_types.append(synth_type)
if synth_type.has_params:
stub_file = stub_out / cls.group / f"{cls.name}Constructor.qll"
stub_file = stub_out / cls.group / "internal" / f"{cls.name}Constructor.qll"
if not renderer.is_customized_stub(stub_file):
# stub rendering must be postponed as we might not have yet all subtracted synth types in `synth_type`
stubs[stub_file] = ql.Synth.ConstructorStub(synth_type, import_prefix=generated_import_prefix)

4
misc/codegen/templates/ql_class_public.mustache
View File

@@ -1,9 +1,9 @@
// generated by {{generator}}, do not edit
/**
* This module provides the public class `{{name}}`.
* This module provides the {{^internal}}public {{/internal}}class `{{name}}`.
*/
private import {{name}}Impl
private import {{^internal}}internal.{{/internal}}{{name}}Impl
{{#imports}}
import {{.}}
{{/imports}}

30
misc/codegen/test/test_qlgen.py
View File

@@ -36,8 +36,9 @@ def children_file(): return ql_output_path() / "ParentChild.qll"
stub_import = "stub.path"
stub_import_prefix_internal = stub_import + ".internal."
stub_import_prefix = stub_import + "."
root_import = stub_import_prefix + "Element"
root_import = stub_import_prefix_internal + "Element"
gen_import = "other.path"
gen_import_prefix = gen_import + "."
@@ -112,10 +113,13 @@ def _filter_generated_classes(ret, output_test_files=False):
}
base_files -= {pathlib.Path(f"{name}.qll") for name in
("Raw", "Synth", "SynthConstructors", "PureSynthConstructors")}
stub_files = {pathlib.Path(f.parent.parent, f.stem + ".qll") if f.parent.name ==
"internal" and pathlib.Path(f.parent.parent, f.stem + ".qll") in base_files else f for f in stub_files}
assert base_files <= stub_files
return {
str(f): (ret[stub_path() / f],
ret[stub_path() / pathlib.Path(f.parent, f.stem + "Impl.qll")],
str(f): (ret[stub_path() / "internal" / f] if stub_path() / "internal" / f in ret else ret[stub_path() / f],
ret[stub_path() / pathlib.Path(f.parent, "internal" if not f.parent.name ==
"internal" else "", f.stem + "Impl.qll")],
ret[ql_output_path() / f])
for f in base_files
}
@@ -166,7 +170,7 @@ def test_one_empty_internal_class(generate_classes):
]) == {
"A.qll": (a_ql_class_public(name="A", internal=True),
a_ql_stub(name="A"),
a_ql_class(name="A", final=True, internal=True, imports=[stub_import_prefix + "A"])),
a_ql_class(name="A", final=True, internal=True, imports=[stub_import_prefix_internal + "A"])),
}
@@ -178,10 +182,10 @@ def test_hierarchy(generate_classes):
schema.Class("A", derived={"B", "C"}),
]) == {
"A.qll": (a_ql_class_public(name="A"), a_ql_stub(name="A"), a_ql_class(name="A", imports=[stub_import_prefix + "A"])),
"B.qll": (a_ql_class_public(name="B", imports=[stub_import_prefix + "A"]), a_ql_stub(name="B"), a_ql_class(name="B", bases=["A"], bases_impl=["AImpl::A"], imports=[stub_import_prefix + "AImpl::Impl as AImpl"])),
"C.qll": (a_ql_class_public(name="C", imports=[stub_import_prefix + "A"]), a_ql_stub(name="C"), a_ql_class(name="C", bases=["A"], bases_impl=["AImpl::A"], imports=[stub_import_prefix + "AImpl::Impl as AImpl"])),
"B.qll": (a_ql_class_public(name="B", imports=[stub_import_prefix + "A"]), a_ql_stub(name="B"), a_ql_class(name="B", bases=["A"], bases_impl=["AImpl::A"], imports=[stub_import_prefix_internal + "AImpl::Impl as AImpl"])),
"C.qll": (a_ql_class_public(name="C", imports=[stub_import_prefix + "A"]), a_ql_stub(name="C"), a_ql_class(name="C", bases=["A"], bases_impl=["AImpl::A"], imports=[stub_import_prefix_internal + "AImpl::Impl as AImpl"])),
"D.qll": (a_ql_class_public(name="D", imports=[stub_import_prefix + "B", stub_import_prefix + "C"]), a_ql_stub(name="D"), a_ql_class(name="D", final=True, bases=["B", "C"], bases_impl=["BImpl::B", "CImpl::C"],
imports=[stub_import_prefix + cls + "Impl::Impl as " + cls + "Impl" for cls in "BC"])),
imports=[stub_import_prefix_internal + cls + "Impl::Impl as " + cls + "Impl" for cls in "BC"])),
}
@@ -210,15 +214,15 @@ def test_hierarchy_children(generate_children_implementations):
schema.Class("C", bases=["A"], derived={"D"}, pragmas=["ql_internal"]),
schema.Class("D", bases=["B", "C"]),
]) == ql.GetParentImplementation(
classes=[a_ql_class(name="A", internal=True, imports=[stub_import_prefix + "A"]),
classes=[a_ql_class(name="A", internal=True, imports=[stub_import_prefix_internal + "A"]),
a_ql_class(name="B", bases=["A"], bases_impl=["AImpl::A"], imports=[
stub_import_prefix + "AImpl::Impl as AImpl"]),
stub_import_prefix_internal + "AImpl::Impl as AImpl"]),
a_ql_class(name="C", bases=["A"], bases_impl=["AImpl::A"], imports=[
stub_import_prefix + "AImpl::Impl as AImpl"], internal=True),
stub_import_prefix_internal + "AImpl::Impl as AImpl"], internal=True),
a_ql_class(name="D", final=True, bases=["B", "C"], bases_impl=["BImpl::B", "CImpl::C"],
imports=[stub_import_prefix + cls + "Impl::Impl as " + cls + "Impl" for cls in "BC"]),
imports=[stub_import_prefix_internal + cls + "Impl::Impl as " + cls + "Impl" for cls in "BC"]),
],
imports=[stub_import] + [stub_import_prefix + cls for cls in "AC"],
imports=[stub_import] + [stub_import_prefix_internal + cls for cls in "AC"],
)
@@ -471,7 +475,7 @@ def test_class_dir(generate_classes):
"B.qll": (a_ql_class_public(name="B", imports=[stub_import_prefix + "another.rel.path.A"]),
a_ql_stub(name="B"),
a_ql_class(name="B", final=True, bases=["A"], bases_impl=["AImpl::A"],
imports=[stub_import_prefix + "another.rel.path.AImpl::Impl as AImpl"])),
imports=[stub_import_prefix + "another.rel.path.internal.AImpl::Impl as AImpl"])),
}