Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amrdeveloper/clangql
ClangQL is a tool that allow you to run SQL-like query on C/C++ Code instead of database files using the GitQL SDK
https://github.com/amrdeveloper/clangql
ast clang cpp database gitql llvm llvm-clang llvm-frontend parser
Last synced: 3 days ago
JSON representation
ClangQL is a tool that allow you to run SQL-like query on C/C++ Code instead of database files using the GitQL SDK
- Host: GitHub
- URL: https://github.com/amrdeveloper/clangql
- Owner: AmrDeveloper
- License: mit
- Created: 2024-04-05T14:12:53.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-11-04T18:19:23.000Z (about 2 months ago)
- Last Synced: 2024-12-14T20:44:33.115Z (8 days ago)
- Topics: ast, clang, cpp, database, gitql, llvm, llvm-clang, llvm-frontend, parser
- Language: Rust
- Homepage: https://crates.io/crates/clangql
- Size: 1.53 MB
- Stars: 497
- Watchers: 10
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
ClangQL - Clang AST Query Language
ClangQL is a tool that allow you to run SQL-like query on C/C++ Code instead of database files using the GitQL SDK.
---
### Samples
Note that all Keywords in ClangQL are case-insensitive, similar to SQL.
```sql
SELECT 1
SELECT 1 + 2
SELECT LEN("Clang Query Language")
SELECT "One" IN ("One", "Two", "Three")
SELECT "Clang Query Language" LIKE "%Query%"
SELECT * FROM functions
SELECT COUNT(name) from functions WHERE return_type = "int"
SELECT DISTINCT name AS function_name FROM functions
SELECT * FROM globals
SELECT COUNT(name) from globals WHERE type = "int"
SELECT * FROM globals WHERE is_volatile
```
### Tables structures
Classes table
| Name | Type | Description |
| ------------- | ------- | ------------------------------- |
| name | Text | Class variable name |
| is_struct | Boolean | True if it a struct declaration |
| bases_count | Integer | Number of bases for this class |
| methods_count | Integer | Number of methods declarations |
| fields_count | Integer | Number of fields declarations |
| size | Integer | The size of class in bits |
| align | Integer | The align of class in bits |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |
---
Enums table
| Name | Type | Description |
| --------------- | ------- | -------------------------------- |
| name | Text | Enumeration name |
| constants_count | Integer | Number of constants in this enum |
| type_literal | Text | Type literal for enum constants |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |
---
Unions table
| Name | Type | Description |
| ------------ | ------- | ----------------------------- |
| name | Text | Union name |
| size | Integer | The size of union in bits |
| fields_count | Integer | Number of fields declarations |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |
---
Functions table
| Name | Type | Description |
| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | Text | Function or Method name |
| signature | Text | Parameters and return type literal |
| args_count | Integer | Number of arguments |
| class_name | Text | Return class name for method |
| return_type | Text | Return type literal |
| is_method | Boolean | True if it's a method |
| is_virtual | Boolean | Return true if a C++ member function or member function template is explicitly declared 'virtual' or if it overrides a virtual method from one of the base classes |
| is_pure_virtual | Boolean | Return ture if a C++ member function or member function template is pure virtual |
| is_static | Boolean | Return ture if a C++ member function is static |
| is_const | Boolean | Return ture if a C++ member function is const |
| has_template | Boolean | True if it's has template |
| access_modifier | Integer | Returns the access control level for method, 1 for public, 2 protected, 3 provide, 0 for invalid |
| is_variadic | Boolean | True if function type is variadic |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |
---
Globals table
| Name | Type | Description |
| ----------- | ------- | --------------------------------- |
| name | Text | Global variable name |
| type | Text | Global variable type literal |
| is_volatile | Boolean | True if variable type is volatile |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |
---
### Download or Install
Note that Building from source or installing from Cargo.io requires LibClang 17 to be installed
- Install from Cargo.io
```
cargo install clangql
```
- Install from Homebrew
```
brew install clangql
```
- Build from source code
```
git clone https://github.com/AmrDeveloper/clangql.git
cd clangql
cargo build
```
### Run ClangQL
```
ClangQL is a SQL like query language to run on local files
Usage: ClangQL [OPTIONS]
Options:
-f, --files Path for local files to run query on
-q, --query ClangQL query to run on selected files
-p, --pagination Enable print result with pagination
-ps, --pagesize Set pagination page size [default: 10]
-o, --output Set output format [render, json, csv]
-a, --analysis Print Query analysis
-h, --help Print ClangQL help
-v, --version Print ClangQL Current Version
```
### License
```
MIT License
Copyright (c) 2024 Amr Hesham
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```