Branch
Hash :
7b089321
Author :
Date :
2025-01-01T09:24:36
maint: run 'make update-copyright'
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
/* A string or file based input stream, that keeps track of a line number.
Copyright (C) 2024-2025 Free Software Foundation, Inc.
This file is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This file is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>. */
/* Written by Bruno Haible <bruno@clisp.org>, 2024. */
#ifndef _SFL_ISTREAM_H
#define _SFL_ISTREAM_H
#include "sf-istream.h"
/* An input stream type that can read from a file or from a string
and that keeps track of a line number. */
typedef struct sfl_istream sfl_istream_t;
struct sfl_istream
{
sf_istream_t istream;
size_t line_number;
};
#ifdef __cplusplus
extern "C" {
#endif
/* Initializes STREAM to read from FP.
FP must be a FILE stream open for reading. */
extern void sfl_istream_init_from_file (sfl_istream_t *stream, FILE *fp);
/* Initializes STREAM to read from a NUL-terminated string INPUT.
The contents of INPUT must stay available and unchanged as long as STREAM
is in use. */
extern void sfl_istream_init_from_string (sfl_istream_t *stream,
const char *input);
/* Initializes STREAM to read from a string INPUT.
The contents of INPUT must stay available and unchanged as long as STREAM
is in use. Operations on STREAM will not modify the contents of INPUT. */
extern void sfl_istream_init_from_string_desc (sfl_istream_t *stream,
string_desc_t input);
/* Sets the current line number of STREAM. */
extern void sfl_set_line_number (sfl_istream_t *stream, size_t line_number);
/* Returns the current line number of STREAM. */
extern size_t sfl_get_line_number (sfl_istream_t *stream);
/* Reads a single 'char' from STREAM, and returns it as an 'unsigned char'.
Returns EOF when the end of stream was already reached. */
extern int sfl_getc (sfl_istream_t *stream);
/* Tests whether STREAM has encountered an error.
You may want to call this function after sf_getc (stream) has
returned EOF; in other situations it is guaranteed to return 0. */
extern int sfl_ferror (sfl_istream_t *stream);
/* Assuming that C was the last value returned by sf_getc (stream),
this call pushes back C onto the stream.
Only 1 character of pushback is guaranteed. */
extern void sfl_ungetc (sfl_istream_t *stream, int c);
/* Frees all memory held by STREAM.
This call has no effect on the arguments provided to sfl_istream_init_*. */
extern void sfl_free (sfl_istream_t *stream);
#ifdef __cplusplus
}
#endif
#endif /* _SFL_ISTREAM_H */