Skip to content

ClangQL is a tool that allow you to run SQL-like query on C/C++ Code instead of database files using the GitQL SDK

License

Notifications You must be signed in to change notification settings

AmrDeveloper/ClangQL

ClangQL - Clang AST Query Language


Crates.io Deps GitHub issues GitHub

ClangQL is a tool that allow you to run SQL-like query on C/C++ Code instead of database files using the GitQL SDK.

animated


Samples

Note that all Keywords in ClangQL are case-insensitive, similar to SQL.

SELECT 1 SELECT 1 + 2 SELECT LEN("Clang Query Language") SELECT "One" IN ("One", "Two", "Three") SELECT "Clang Query Language" LIKE "%Query%" SELECT name, source_loc FROM functions WHERE m_function(ast_function, (m_public() && m_constructor()) || m_default_constructor()); SELECT * FROM functions SELECT COUNT(name) from functions WHERE return_type = "int" SELECT DISTINCT name AS function_name FROM functions SELECT name, source_loc FROM functions WHERE m_function(ast_function, m_constructor()); SELECT name, source_loc FROM functions WHERE m_function(ast_function, m_copy_constructor()); SELECT name, source_loc FROM functions WHERE m_function(ast_function, m_move_constructor()); SELECT name, source_loc FROM functions WHERE m_function(ast_function, m_pure_virtual()); SELECT * FROM globals SELECT COUNT(name) from globals WHERE type = "int" SELECT * FROM globals WHERE is_volatile

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 <paths> Path for local files to run query on -s, --script <file> Script file contains one or more query -q, --query <GQL 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. 

About

ClangQL is a tool that allow you to run SQL-like query on C/C++ Code instead of database files using the GitQL SDK

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Contributors 2

  •  
  •  

Languages