fccf
fccf
fccf é uma ferramenta de linha de comando que pesquisa rapidamente o código-fonte C/C++ em um diretório com base em uma string de pesquisa e imprime trechos de código relevantes que correspondem à consulta.
O vídeo a seguir mostra a pesquisa fccf e a localização de trechos de código em torvalds/linux.
fccf (C++ moderno) O vídeo a seguir mostra fccf pesquisando o código-fonte C++ fccf .
Observe que os resultados da pesquisa aqui incluem:
--flag que corresponda Forneça uma consulta vazia para corresponder a qualquer --flag , por exemplo, qualquer declaração de enum.
... ou qualquer construtor de classe
for Use --for-statement para for declarações. fccf tentará encontrar instruções for (incluindo C++ com intervalo for ) que contenham a string de consulta.
Use a opção --include-expressions para encontrar expressões que correspondam à consulta.
O exemplo a seguir mostra chamadas fccf find para isdigit() .
O exemplo a seguir mostra fccf encontrando referências à variável clang_options .
using declarações Use a opção --using-declaration para encontrar declarações using , diretivas using e declarações de alias de tipo.
namespace Use a opção --namespace-alias para encontrar aliases namespace .
throw Use --throw-expression com uma consulta para procurar expressões throw específicas que contenham a string de consulta.
Conforme apresentado anteriormente, uma consulta vazia aqui tentará corresponder a qualquer expressão throw na base de código:
Construa fccf usando CMake. Para obter mais detalhes, consulte CONSTRUÇÃO.md.
NOTA: fccf requer libclang e LLVM instalados.
# 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 foo@bar:~ $ fccf --help
Usage: fccf [--help] [--version] [--help] [--exact-match] [--json] [--filter VAR] [-j VAR] [--enum] [--struct] [--union] [--member-function] [--function] [--function-template] [-F] [--class] [--class-template] [--class-constructor] [--class-destructor] [-C] [--for-statement] [--namespace-alias] [--parameter-declaration] [--typedef] [--using-declaration] [--variable-declaration] [--verbose] [--include-expressions] [--static-cast] [--dynamic-cast] [--reinterpret-cast] [--const-cast] [-c] [--throw-expression] [--ignore-single-line-results] [--include-dir VAR]... [--language VAR] [--std VAR] [--no-color] query [path]...
Positional arguments:
query
path [nargs: 0 or more]
Optional arguments:
-h, --help shows help message and exits
-v, --version prints version information and exits
-h, --help Shows help message and exits
-E, --exact-match Only consider exact matches
--json Print results in JSON format
-f, --filter Only evaluate files that match filter pattern [nargs=0..1] [default: "*.*"]
-j Number of threads [nargs=0..1] [default: 5]
--enum Search for enum declaration
--struct Search for struct declaration
--union Search for union declaration
--member-function Search for class member function declaration
--function Search for function declaration
--function-template Search for function template declaration
-F Search for any function or function template or class member function
--class Search for class declaration
--class-template Search for class template declaration
--class-constructor Search for class constructor declaration
--class-destructor Search for class destructor declaration
-C Search for any class or class template or struct
--for-statement Search for `for` statement
--namespace-alias Search for namespace alias
--parameter-declaration Search for function or method parameter
--typedef Search for typedef declaration
--using-declaration Search for using declarations, using directives, and type alias declarations
--variable-declaration Search for variable declaration
--verbose Request verbose output
--ie, --include-expressions Search for expressions that refer to some value or member, e.g., function, variable, or enumerator.
--static-cast Search for static_cast
--dynamic-cast Search for dynamic_cast
--reinterpret-cast Search for reinterpret_cast
--const-cast Search for const_cast
-c Search for any static_cast, dynamic_cast, reinterpret_cast, orconst_cast expression
--throw-expression Search for throw expression
--isl, --ignore-single-line-results Ignore forward declarations, member function declarations, etc.
-I, --include-dir Additional include directories [nargs=0..1] [default: {}] [may be repeated]
-l, --language Language option used by clang [nargs=0..1] [default: "c++"]
--std C++ standard to be used by clang [nargs=0..1] [default: "c++17"]
--nc, --no-color Stops fccf from coloring the output fccf faz uma pesquisa recursiva de diretório por uma agulha em um palheiro - como grep ou ripgrep - Ele usa um algoritmo SSE2 strstr SIMD (pesquisa Rabin-Karp SIMD modificada; veja aqui) se possível para encontrar rapidamente, em vários threads, um subconjunto do arquivos de origem no diretório que contém uma agulha.libclang para analisar a unidade de tradução (construir uma árvore de sintaxe abstrata).CXCursor_FunctionDecl para declarações de funções.libclang para o nó) corresponder à consulta de pesquisa, o intervalo de origem do nó AST será identificado - o intervalo de origem é o índice inicial e final do trecho de código em o bufferinclude_directories Para que tudo isso funcione, o fccf primeiro identifica os diretórios candidatos que contêm arquivos de cabeçalho, por exemplo, caminhos que terminam com include/ . Em seguida, ele adiciona esses caminhos às opções clang (antes de analisar a unidade de tradução) como -Ifoo -Ibar/baz etc. Além disso, para cada unidade de tradução, os caminhos pai e avó também são adicionados aos diretórios de inclusão dessa unidade para aumentar a probabilidade de análise bem-sucedida.
Diretórios de inclusão adicionais também podem ser fornecidos ao fccf usando a opção -I ou --include-dir . Usando saída detalhada ( --verbose ), erros na análise da libclang podem ser identificados e correções podem ser tentadas (por exemplo, adicionar os diretórios de inclusão corretos para que libclang fique satisfeita).
Para executar fccf no código-fonte fccf sem erros de libclang, tive que fornecer explicitamente o caminho de inclusão do LLVM-12 da seguinte forma:
foo@bar:~ $ fccf --verbose ' lexer ' . --include-dir /usr/lib/llvm-12/include/
Checking ./source/lexer.cpp
Checking ./source/lexer.hpp
Checking ./source/searcher.cpp
// ./source/lexer.hpp (Line: 14 to 40)
class lexer
{
std::string_view m_input;
fmt::memory_buffer* m_out;
std::size_t m_index {0};
bool m_is_stdout {true};
char previous() const;
char current() const;
char next() const;
void move_forward(std::size_t n = 1);
bool is_line_comment();
bool is_block_comment();
bool is_start_of_identifier();
bool is_start_of_string();
bool is_start_of_number();
void process_line_comment();
void process_block_comment();
bool process_identifier(bool maybe_class_or_struct = false);
void process_string();
std::size_t get_number_of_characters(std::string_view str);
public:
void tokenize_and_pretty_print(std::string_view source,
fmt::memory_buffer* out,
bool is_stdout = true);
} 
