[deliverable/binutils-gdb.git] / gas / input-file.h

/* input_file.h header for input-file.c
   Copyright (C) 1987-2017 Free Software Foundation, Inc.

   This file is part of GAS, the GNU Assembler.

   GAS is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3, or (at your option)
   any later version.

   GAS 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 General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with GAS; see the file COPYING.  If not, write to the Free
   Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
   02110-1301, USA.  */

/*"input_file.c":Operating-system dependent functions to read source files.*/

/*
 * No matter what the operating system, this module must provide the
 * following services to its callers.
 *
 * input_file_begin()			Call once before anything else.
 *
 * input_file_end()			Call once after everything else.
 *
 * input_file_buffer_size()		Call anytime. Returns largest possible
 *					delivery from
 *					input_file_give_next_buffer().
 *
 * input_file_open(name)		Call once for each input file.
 *
 * input_file_give_next_buffer(where)	Call once to get each new buffer.
 *					Return 0: no more chars left in file,
 *					   the file has already been closed.
 *					Otherwise: return a pointer to just
 *					   after the last character we read
 *					   into the buffer.
 *					If we can only read 0 characters, then
 *					end-of-file is faked.
 *
 * input_file_push()			Push state, which can be restored
 *					later.  Does implicit input_file_begin.
 *					Returns char * to saved state.
 *
 * input_file_pop (arg)			Pops previously saved state.
 *
 * input_file_close ()			Closes opened file.
 *
 * All errors are reported so caller doesn't have to think
 * about I/O errors.
 */

char *input_file_give_next_buffer (char *where);
char *input_file_push (void);
size_t input_file_buffer_size (void);
void input_file_begin (void);
void input_file_close (void);
void input_file_end (void);
void input_file_open (const char *filename, int pre);
void input_file_pop (char *arg);
Commit	Line	Data
252b5132	1	/* input_file.h header for input-file.c
2571583a	2	Copyright (C) 1987-2017 Free Software Foundation, Inc.
252b5132 RH	3
	4	This file is part of GAS, the GNU Assembler.
	5
	6	GAS is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
ec2655a6	8	the Free Software Foundation; either version 3, or (at your option)
252b5132 RH	9	any later version.
	10
	11	GAS is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
	15
	16	You should have received a copy of the GNU General Public License
7152f1dc	17	along with GAS; see the file COPYING. If not, write to the Free
4b4da160 NC	18	Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
4b4da160 NC	19	02110-1301, USA. */
252b5132	20
2b0f3761	21	/"input_file.c":Operating-system dependent functions to read source files./
252b5132	22
252b5132 RH	23	/*
	24	* No matter what the operating system, this module must provide the
	25	* following services to its callers.
	26	*
	27	* input_file_begin() Call once before anything else.
	28	*
	29	* input_file_end() Call once after everything else.
	30	*
	31	* input_file_buffer_size() Call anytime. Returns largest possible
	32	* delivery from
	33	* input_file_give_next_buffer().
	34	*
	35	* input_file_open(name) Call once for each input file.
	36	*
	37	* input_file_give_next_buffer(where) Call once to get each new buffer.
	38	* Return 0: no more chars left in file,
	39	* the file has already been closed.
	40	* Otherwise: return a pointer to just
	41	* after the last character we read
	42	* into the buffer.
	43	* If we can only read 0 characters, then
	44	* end-of-file is faked.
	45	*
	46	* input_file_push() Push state, which can be restored
	47	* later. Does implicit input_file_begin.
	48	* Returns char * to saved state.
	49	*
	50	* input_file_pop (arg) Pops previously saved state.
	51	*
	52	* input_file_close () Closes opened file.
	53	*
f79d9c1d AM	54	* All errors are reported so caller doesn't have to think
f79d9c1d AM	55	* about I/O errors.
252b5132 RH	56	*/
252b5132 RH	57
b1f1fa96 KH	58	char input_file_give_next_buffer (char where);
b1f1fa96 KH	59	char *input_file_push (void);
39a45edc	60	size_t input_file_buffer_size (void);
b1f1fa96 KH	61	void input_file_begin (void);
	62	void input_file_close (void);
	63	void input_file_end (void);
3b4dbbbf	64	void input_file_open (const char *filename, int pre);
b1f1fa96	65	void input_file_pop (char *arg);