Pular para o conteúdo principal

extract_c

Página gerada do fonte

Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/analise.py:348.

Extrai funções, protótipos e macros de uma árvore C sem pré-processar alvos.

Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/analise.py.

Assinatura e expansão​

def extract_c(inv: Inventory, source: Source, production: bool) -> None:

Parâmetros formais: inv: Inventory, source: Source, production: bool.

Como funciona​

Extrai funções, protótipos e macros de uma árvore C sem pré-processar alvos.

Implementação completa · 62 linhas
def extract_c(inv: Inventory, source: Source, production: bool) -> None:
"""Extrai funções, protótipos e macros de uma árvore C sem pré-processar alvos."""
assert source.tree is not None
for node in walk(source.tree.root_node):
if node.type in {"function_definition", "declaration"}:
# Fixtures BG não são C puro: sem expandir macros, o parser pode
# interpretar uma chamada como definição. Só o harness unitário é
# inventariado como função C dentro de tests/.
if source.path.startswith("tests/") and source.path != "tests/test_biblioteca.c":
continue
declarator = node.child_by_field_name("declarator")
function = declarator
while function is not None and function.type not in {"function_declarator", "identifier"}:
function = function.child_by_field_name("declarator")
if function is None or function.type != "function_declarator":
continue
name = declarator_name(source, function.child_by_field_name("declarator"))
if not name:
continue
body = node.child_by_field_name("body")
signature = source.data[node.start_byte:body.start_byte].decode("utf-8").strip() if body else segment(source, node)
params = function.child_by_field_name("parameters")
parameters = [segment(source, child) for child in params.named_children
if child.type == "parameter_declaration"] if params else []
storage = [segment(source, child) for child in node.named_children
if child.type == "storage_class_specifier"]
symbol = Symbol(name, "função C", "c", source.path,
node.start_point.row + 1, node.end_point.row + 1,
signature, segment(source, body) if body else "", module_for(source.path),
clean_comment(previous_comment(source, node)), conditions(source, node),
called_names(source, node), parameters,
visibility="interna (static)" if "static" in storage else "pública")
if body is None:
# Chamadas/declarações BG em fixtures não são definições de API.
if source.path.startswith("tests/"):
continue
symbol.prototypes = [{"path": source.path, "line": symbol.line,
"signature": signature, "comment": symbol.comment,
"conditions": symbol.conditions}]
symbol.comment = ""
add_symbol(inv, symbol)
elif node.type in {"preproc_def", "preproc_function_def"}:
name_node = node.child_by_field_name("name")
value = node.child_by_field_name("value")
params = node.child_by_field_name("parameters")
name = segment(source, name_node)
parameters = [segment(source, child) for child in params.named_children
if child.type == "identifier"] if params else []
body = segment(source, value) if value else ""
symbol = Symbol(name, "macro", "c", source.path, node.start_point.row + 1,
node.end_point.row, segment(source, node).rstrip(), body,
module_for(source.path), clean_comment(previous_comment(source, node)),
conditions(source, node),
sorted(set(IDENT.findall(mask_code(body, "c")))), parameters)
add_symbol(inv, symbol)
if production and source.tree.root_node.has_error:
unexpected = [n for n in walk(source.tree.root_node)
if n.type == "ERROR" and 'extern "C"' not in segment(source, n)
and "__attribute__" not in segment(source, n)
and not (segment(source, n).startswith("#") and "BG_FORMATO" in source.text)]
if unexpected:
inv.warnings.append(f"Tree-sitter encontrou sintaxe não reconhecida em {source.path}; revisar extração.")

Nomes internos referenciados: add_symbol, called_names, clean_comment, conditions, declarator_name, mask_code, module_for, previous_comment, segment, walk.

Como este símbolo aparece nos testes​

Sem uso direto localizado

Nenhuma referência direta a este nome foi encontrada nos arquivos de teste. Isso pode ser esperado para guardas de inclusão, configuração ou código exercitado indiretamente; não é uma afirmação de cobertura zero.

Evidência indireta​

Estes símbolos chamam/encaminham para este nome. As referências deles ajudam a rastrear o caminho, mas não substituem um teste específico deste símbolo.

Compiladores, padrão C e sistema operacional​

Nenhum ramo condicional externo foi detectado para este símbolo. A implementação é compartilhada no fonte; isso não certifica compiladores ou sistemas não executados.

  • Script Python: usa a biblioteca padrão e pathlib/subprocess quando aplicável; caminhos não devem depender do separador de um único OS.
Não confunda implementação com certificação

A matriz histórica distingue executado, compilado, avaliado e não testado. Consulte a matriz, os compiladores e os logs atuais dos workflows antes de chamar um alvo de suportado.

Perguntas frequentes​

Perguntas reunidas a partir da definição, do contrato editorial e dos testes de extract_c. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.

Em uma frase, o que extract_c faz?​

Extrai funções, protótipos e macros de uma árvore C sem pré-processar alvos.

Qual é a assinatura e o tipo de retorno de extract_c?​

Assinatura extraída de tools/documentacao/analise.py; visibilidade pública.

def extract_c(inv: Inventory, source: Source, production: bool) -> None:

Como chamar extract_c corretamente?​

Nenhum exemplo editorial nem chamada direta em teste foi localizada. A forma de uso é a assinatura acima; os chamadores aparecem na seção de evidência indireta quando existem.

def extract_c(inv: Inventory, source: Source, production: bool) -> None:

Por que não há teste direto para extract_c?​

A busca estática não encontrou o identificador nos arquivos de teste. Isso é esperado para guardas de inclusão, configuração de build e nomes alcançados apenas por chamadores internos. O JSON de cobertura registra a lacuna em vez de convertê-la em aprovação.

extract_c depende de compilador, padrão C ou sistema operacional?​

extract_c é uma função Python: requer Python 3.10+ e biblioteca padrão, sem compilador C.

O que acontece em caso de falha ou uso inválido?​

Não há ressalva editorial específica para este nome. O comportamento em falha é o do corpo/expansão mostrado acima; não invente validação que o fonte não faz.