fccf: 这是一个命令行工具,可根据搜索字符串快速搜索目录中的 C/C++ 源代码,并打印与之匹配的相关代码片段。
fccf is a command-line tool that quickly searches through C/C++ source code in a directory based on a search string and prints relevant code snippets that match the query.
The following video shows fccf searching and finding snippets of code in torvalds/linux.
https://user-images.githubusercontent.com/8450091/165400381-9ba49a62-97fb-4f4a-890a-0dc9b20dfe75.mp4
fccf source tree (Modern C++)The following video shows fccf searching the fccf C++ source code.
Note that search results here include:
https://user-images.githubusercontent.com/8450091/165402206-65d9ed43-b9dd-4528-92bd-0b4ce76b6468.mp4
--flag that matchesProvide an empty query to match any --flag, e.g., any enum declaration.
... or any class constructor
for statementUse --for-statement to search for statements. fccf will try to find for statements (including C++ ranged for) that contain the query string.
Use the --include-expressions option to find expressions that match the query.
The following example shows fccf find calls to isdigit().
The following example shows fccf finding references to the clang_options variable.
using declarationsUse the --using-declaration option to find using declarations, using directives, and type alias declarations.
namespace aliasesUse the --namespace-alias option to find namespace aliases.
throw expressionsUse --throw-expression with a query to search for specific throw expressions that contain the query string.
As presented earlier, an empty query here will attempt to match any throw expression in the code base:
Build fccf using CMake. For more details, see BUILDING.md.
NOTE: fccf requires libclang and LLVM installed.
# Install libclang and LLVM
# sudo apt install libclang-dev llvm
git clone https://github.com/p-ranav/fccf
cd fccf
# Build
cmake -S . -B build -D CMAKE_BUILD_TYPE=Release
cmake --build build
# Install
sudo cmake --install buildfccf Usage…fccf does a recursive directory search for a needle in a haystack - like grep or ripgrep - It uses an SSE2 strstr SIMD algorithm (modified Rabin-Karp SIMD search; see here) if possible to quickly find, in multiple threads, a subset of the source files in the directory that contain a needle.libclang to parse the translation unit (build an abstract syntax tree).CXCursor_FunctionDecl for function declarations.libclang name for the node) matches the search query, then the source range of the AST node is identified - source range is the start and end index of the snippet of code in the bufferinclude_directoriesFor all this to work, fccf first identifies candidate directories that contain header files, e.g., paths that end with include/. It then adds these paths to the clang options (before parsing the translation unit) as -Ifoo -Ibar/baz etc. Additionally, for each translation unit, the parent and grandparent paths are also added to the include directories for that unit in order to increase the likelihood of successful parsing.
Additional include directories can also be provided to fccf using the -I or --include-dir option. Using verbose output (--verbose), errors in the libclang parsing can be identified and fixes can be attempted (e.g., adding the right include directories so that libclang is happy).
To run fccf on the fccf source code without any libclang errors, I had to explicitly provide the include path from LLVM-12 like so:
…暂无开放 Issues,或尚未同步最近议题。