hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-30 03:05:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

codegen: mention Rust in the README

Browse Source 
Updated README to reflect support for the Rust extractor and added details about Rust generated files.
This commit is contained in:
Paolo Tranquilli
2025-12-16 11:05:39 +01:00
committed by GitHub
parent d709343d38
commit 6fc963177c
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
misc/codegen/README.md
View File

@@ -1,14 +1,17 @@
# Code generation suite
This directory contains the code generation suite used by the Swift extractor and the QL library. This suite will use
the abstract class specification of `schema.py` to generate:
This directory contains the code generation suite used by the Swift and Rust extractors and QL library. This suite will use
the abstract class specification of a `schema` python module to generate:
* the `dbscheme` file (see [`dbschemegen.py`](generators/dbschemegen.py))
* the QL generated code and when appropriate the corresponding stubs (see [`qlgen.py`](generators/qlgen.py))
* C++ tags and trap entries (see [`trapgen.py`](generators/trapgen.py))
* C++ structured classes (see [`cppgen.py`](generators/cppgen.py))
* QL language tests for testing the extractors (see [`qlgen.py`](generators/qlgen.py))
* [Swift] C++ tags and trap entries (see [`trapgen.py`](generators/trapgen.py))
* [Swift] C++ structured classes (see [`cppgen.py`](generators/cppgen.py))
* [Rust] Rust structured classes (see [`rustgen.py`](generators/rustgen.py))
* [Rust] Rust sources for extractor language tests extracted from the documentation snippets (see [`rusttestgen.py`](generators/rusttestgen.py))
An example `schema.py` [can be found in the Swift package](../../swift/schema.py).
Schemas [can be found in the Swift package](../../swift/schema.py) or [in the Rust one](../../rust/schema).
## Usage