Pular para o conteúdo principal

BG_FORMATA_TEXTO · FORMATA_TEXTO

Página gerada do fonte

Gerada por tools/gerar_documentacao.py. Definição: include/basicgol.h:229.

BG_FORMATA_TEXTO: interface macro da biblioteca. Formata em buffer limitado com semântica de snprintf e rejeita truncamento.

Tipo: macro com argumentos · Módulo/categoria: Texto.

Nomes equivalentes: FORMATA_TEXTO. Os testes de qualquer um desses nomes são reunidos nesta página.

Assinatura e expansão​

#define BG_FORMATA_TEXTO(d, t, ...) bg_formata_texto((d), (size_t) (t), __VA_ARGS__)

Parâmetros formais: d, t.

Corpo da macro:

bg_formata_texto((d), (size_t) (t), __VA_ARGS__)

Como funciona​

Valida destino/capacidade/formato, inicia uma va_list e chama vsnprintf. Um retorno negativo ou tamanho maior/igual à capacidade é falha e esvazia o destino. O formato e os argumentos devem ser compatíveis como em printf.

Contrato e armadilhas
  • Formato dinâmico não pode ser integralmente conferido pelo compilador.
  • Não passe texto externo como formato sem argumentos correspondentes.
  • Capacidade zero não escreve no destino.

Exemplo de uso​

TEXTO_FIXO(linha, 64);
FORMATA_TEXTO(linha, TAMANHO_DE(linha), "%s=%d", "idade", 18);

Nomes internos referenciados: bg_formata_texto.

Como este símbolo aparece nos testes​

3 ocorrência(s) em 1 arquivo(s) de teste. Os links apontam para linhas exatas; os trechos mostram o contexto local. Uma menção não prova que todos os ramos foi executado.

tests/casos/09_tipos_expr/t11_texto_seguro/programa.c​

Contexto: t11_texto_seguro. Linhas: 39, 41, 44. Tipo de evidência: código; via FORMATA_TEXTO.

Linhas 37–46 · abrir contexto

// --- formatação verificável (sem inspeção de formato pelo compilador)
ESCREVAL(FORMATA_TEXTO(buf, TAMANHO_VETOR(buf), "%d-%s", 42, "xy"));
ESCREVA_TEXTO(buf); ESCREVA_LINHA();
ESCREVAL(FORMATA_TEXTO(dest, TAMANHO_VETOR(dest), "%s", "longo"));
ESCREVAL(TAMANHO_TEXTO(dest));
TEXTO formato = "<%d>";
ESCREVAL(FORMATA_TEXTO(dest, TAMANHO_VETOR(dest), formato, 7));
ESCREVA_TEXTO(dest); ESCREVA_LINHA();

Ver no GitHub

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​

Condições que envolvem a definição:

  • defined(BASICGOL_H) (fonte)

  • GCC/Clang recebem diagnóstico de formato quando o formato é literal.

  • Há pragma isolado para clang suprimir avisos de formato não literal nesta função variádica; não existe ramo equivalente para GCC/MSVC.

  • Formatação numérica pode depender da locale corrente.

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.

Checklist de integração​

  • Compile com C11: o cabeçalho seleciona formatos e divisões com _Generic, e C99/C89 são recusados com mensagem explícita.
  • A forma curta FORMATA_TEXTO e a forma canônica BG_FORMATA_TEXTO são a mesma macro; escolha uma por arquivo para não misturar estilos.
  • Rode make test (ou make test-biblioteca para a biblioteca) antes de integrar.
make
cc -std=c11 -Wall -Wextra -Wformat=2 -I include programa.c \
build/libbasicgol.a -lm -o programa

Perguntas frequentes​

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

Em uma frase, o que BG_FORMATA_TEXTO faz?​

BG_FORMATA_TEXTO: interface macro da biblioteca. Formata em buffer limitado com semântica de snprintf e rejeita truncamento.

Para que exatamente BG_FORMATA_TEXTO expande?​

O pré-processador substitui BG_FORMATA_TEXTO pelo texto abaixo, sem criar função nem avaliar argumentos por conta própria.

Parâmetros formais: d, t.

bg_formata_texto((d), (size_t) (t), __VA_ARGS__)

Como usar BG_FORMATA_TEXTO em um programa?​

Exemplo editorial mantido em tools/documentacao/contratos.json e conferido contra a assinatura real:

TEXTO_FIXO(linha, 64);
FORMATA_TEXTO(linha, TAMANHO_DE(linha), "%s=%d", "idade", 18);

Onde BG_FORMATA_TEXTO é exercitado nos testes?​

Há 3 ocorrência(s) em 1 arquivo(s): tests/casos/09_tipos_expr/t11_texto_seguro/programa.c. Os links da seção de evidência apontam para a linha exata; uma menção não prova que todos os ramos foram executados.

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

BG_FORMATA_TEXTO exige C11 como o restante da linguagem; largura de tipo, libc e CRT continuam sendo os do alvo.

Ressalvas registradas: GCC/Clang recebem diagnóstico de formato quando o formato é literal. Há pragma isolado para clang suprimir avisos de formato não literal nesta função variádica; não existe ramo equivalente para GCC/MSVC. Formatação numérica pode depender da locale corrente.

Quais armadilhas preciso evitar ao usar BG_FORMATA_TEXTO?​

O contrato editorial registra: “Formato dinâmico não pode ser integralmente conferido pelo compilador.” “Não passe texto externo como formato sem argumentos correspondentes.” “Capacidade zero não escreve no destino.”