Pular para o conteúdo principal

bg_formata_texto

Página gerada do fonte

Gerada por tools/gerar_documentacao.py. Definição: src/biblioteca/texto.c:137.

Formata em buffer limitado com semântica de snprintf e rejeita truncamento.

Tipo: função C · Visibilidade: pública · Arquivo: src/biblioteca/texto.c.

Assinatura e expansão​

bool bg_formata_texto(char *destino, size_t capacidade,
const char *formato, ...)

Parâmetros formais: char *destino, size_t capacidade, const char *formato.

Declarações públicas localizadas:

Formata como snprintf em buffer limitado; false indica formato/saída inválida ou truncamento.

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);

Implementação​

{
va_list argumentos;
int escritos;

if (destino == NULL || capacidade == 0) {
return false;
}
destino[0] = '\0';
if (formato == NULL) {
return false;
}

va_start(argumentos, formato);
escritos = vsnprintf(destino, capacidade, formato, argumentos);
va_end(argumentos);
if (escritos < 0 || (size_t) escritos >= capacidade) {
destino[0] = '\0';
return false;
}
return true;
}

Interface BASICGOL relacionada​

BG_FORMATA_TEXTO

Como este símbolo aparece nos testes​

13 ocorrência(s) em 2 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/portabilidade/fronteira.c​

Contexto: fronteira.c. Linhas: 119, 121, 123, 125, 127, 128, 129. Tipo de evidência: código; via bg_formata_texto.

Linhas 117–131 · abrir contexto
char dst[8];

EXIGE(bg_formata_texto(dst, 4, "%d", 123) == true); /* 3 + NUL */
EXIGE(strcmp(dst, "123") == 0);
EXIGE(bg_formata_texto(dst, 3, "%d", 123) == false); /* truncaria */
EXIGE(dst[0] == '\0');
EXIGE(bg_formata_texto(dst, 8, "%s", "abcdefg") == true);
EXIGE(strcmp(dst, "abcdefg") == 0);
EXIGE(bg_formata_texto(dst, 8, "%s", "abcdefgh") == false);
EXIGE(dst[0] == '\0');
EXIGE(bg_formata_texto(dst, 8, NULL) == false);
EXIGE(bg_formata_texto(NULL, 8, "%d", 1) == false);
EXIGE(bg_formata_texto(dst, 1, "%s", "") == true); /* só o NUL */
EXIGE(dst[0] == '\0');
}

Ver no GitHub

tests/test_biblioteca.c​

Contexto: testa_texto. Linhas: 215, 217, 219, 222, 224, 225. Tipo de evidência: código; via bg_formata_texto.

Linhas 213–227 · abrir contexto
VERIFICA(!bg_texto_vazio(" "));

VERIFICA(bg_formata_texto(formato, sizeof formato, "%s-%d", "id", 42));
VERIFICA(strcmp(formato, "id-42") == 0);
VERIFICA(bg_formata_texto(pequeno, sizeof pequeno, "%d", 123));
VERIFICA(strcmp(pequeno, "123") == 0); /* capacidade exata */
VERIFICA(!bg_formata_texto(pequeno, sizeof pequeno, "%s", "longo"));
VERIFICA(pequeno[0] == '\0');
(void) strcpy(pequeno, "x");
VERIFICA(!bg_formata_texto(pequeno, sizeof pequeno, NULL));
VERIFICA(pequeno[0] == '\0');
VERIFICA(!bg_formata_texto(NULL, sizeof formato, "%d", 1));
VERIFICA(!bg_formata_texto(formato, 0, "%d", 1));

errno = EDOM;

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​

Nenhum ramo condicional externo foi detectado para este símbolo. Diretivas próximas no fonte (podem afetar atributos/diagnósticos ao redor da definição):

  • #if defined(__clang__)
  • # pragma clang diagnostic push
  • # pragma clang diagnostic ignored "-Wmissing-format-attribute"
  • # pragma clang diagnostic ignored "-Wformat-nonliteral"
  • #if defined(__clang__)
  • # pragma clang diagnostic pop

Marcadores de plataforma/representação presentes: __clang__.

  • 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.
  • Tamanhos são bytes. Conversões reais usam a locale C corrente; o projeto não chama setlocale.
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.
  • Declare pelo cabeçalho (include/basicgol/texto.h) e ligue build/libbasicgol.a; não copie o corpo de src/biblioteca/texto.c para o seu arquivo.
  • 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?​

Formata em buffer limitado com semântica de snprintf e rejeita truncamento.

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

Assinatura extraída de src/biblioteca/texto.c; visibilidade pública.

bool bg_formata_texto(char *destino, size_t capacidade,
const char *formato, ...)

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á 13 ocorrência(s) em 2 arquivo(s): tests/portabilidade/fronteira.c, tests/test_biblioteca.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.”