Pular para o conteúdo principal

bg_leia_texto

Página gerada do fonte

Gerada por tools/gerar_documentacao.py. Definição: src/biblioteca/consola.c:80.

Wrapper de stdin compatível com LEIA_TEXTO, descartando um newline deixado por leitura formatada anterior.

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

Assinatura e expansão​

bool bg_leia_texto(char *destino, size_t capacidade)

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

Declarações públicas localizadas:

Lê uma linha de stdin. Compatibilidade com LEIA_TEXTO: descarta um LF ou CRLF pendente deixado por uma leitura formatada anterior. Use bg_leia_linha(stdin, ...) quando uma linha vazia precisar ser preservada.

Como funciona​

Inspeciona o próximo byte de stdin. Se for LF ou CRLF pendente, consome esse terminador antes de chamar bg_leia_linha. Caso contrário devolve o byte com ungetc e lê a linha atual.

Contrato e armadilhas
  • Uma linha vazia intencional pode ser confundida com o newline pendente; prefira bg_leia_linha(stdin, ...) quando isso importar.
  • Não mistura leitura de texto com scanf depois de começar a usar bg_leia_linha sem entender o estado do fluxo.

Exemplo de uso​

TEXTO_FIXO(nome, 80);
SE LEIA_TEXTO(nome, TAMANHO_DE(nome)) ENTAO
ESCREVAL(nome);
FIM_SE

Implementação​

{
int c;

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

/* O formato scanf deixa normalmente o fim da linha por consumir. */
c = getchar();
if (c == '\n') {
return bg_leia_linha(stdin, destino, capacidade);
}
if (c == '\r') {
int seguinte = getchar();

if (seguinte != '\n' && seguinte != EOF
&& ungetc(seguinte, stdin) == EOF) {
return false;
}
if (seguinte == EOF && ferror(stdin)) {
return false;
}
return bg_leia_linha(stdin, destino, capacidade);
}
if (c == EOF) {
return false;
}
if (ungetc(c, stdin) == EOF) {
return false;
}
return bg_leia_linha(stdin, destino, capacidade);
}

Interface BASICGOL relacionada​

BG_LEIA_TEXTO

Nomes internos referenciados: bg_leia_linha.

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/test_biblioteca.c​

Contexto: testa_stdin_compativel, testa_stdin_texto_longo. Linhas: 423, 453, 455. Tipo de evidência: código; via bg_leia_texto.

Linhas 421–425 · abrir contexto

if (scanf("%d", &inteiro) != 1 || inteiro != 42
|| !bg_leia_texto(linha, sizeof linha)
|| strcmp(linha, "linha de texto") != 0
|| !bg_leia_inteiro(&inteiro) || inteiro != -7

Ver no GitHub

Linhas 451–457 · abrir contexto
char seguinte[8];

if (bg_leia_texto(pequeno, sizeof pequeno)
|| pequeno[0] != '\0'
|| !bg_leia_texto(seguinte, sizeof seguinte)
|| strcmp(seguinte, "ok") != 0) {
(void) fprintf(stderr, "falha no descarte de linha longa\n");

Ver no GitHub

Modos de integração/falha fatal​

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.

  • O tratamento explícito de CR/LF cobre a diferença de fim de linha entre Windows e Unix.
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/consola.h) e ligue build/libbasicgol.a; não copie o corpo de src/biblioteca/consola.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_leia_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_leia_texto faz?​

Wrapper de stdin compatível com LEIA_TEXTO, descartando um newline deixado por leitura formatada anterior.

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

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

bool bg_leia_texto(char *destino, size_t capacidade)

Como usar bg_leia_texto em um programa?​

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

TEXTO_FIXO(nome, 80);
SE LEIA_TEXTO(nome, TAMANHO_DE(nome)) ENTAO
ESCREVAL(nome);
FIM_SE

Onde bg_leia_texto é exercitado nos testes?​

Há 3 ocorrência(s) em 1 arquivo(s): 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_leia_texto depende de compilador, padrão C ou sistema operacional?​

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

Ressalvas registradas: O tratamento explícito de CR/LF cobre a diferença de fim de linha entre Windows e Unix.

Quais armadilhas preciso evitar ao usar bg_leia_texto?​

O contrato editorial registra: “Uma linha vazia intencional pode ser confundida com o newline pendente; prefira bg_leia_linha(stdin, ...) quando isso importar.” “Não mistura leitura de texto com scanf depois de começar a usar bg_leia_linha sem entender o estado do fluxo.”