[thirdparty/glibc.git] / libio / libio.h

/*
Copyright (C) 1991, 1992, 1993, 1994, 1995 Free Software Foundation

This file is part of the GNU IO Library.  This library 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 2, or (at your option)
any later version.

This library 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 this library; see the file COPYING.  If not, write to the Free
Software Foundation, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

As a special exception, if you link this library with files
compiled with a GNU compiler to produce an executable, this does not cause
the resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why
the executable file might be covered by the GNU General Public License. */

/* This is part of the iostream library.  Written by Per Bothner. */

#ifndef _IO_STDIO_H
#define _IO_STDIO_H

#include <_G_config.h>
#define _IO_pos_t _G_fpos_t /* obsolete */
#define _IO_fpos_t _G_fpos_t
#define _IO_size_t _G_size_t
#define _IO_ssize_t _G_ssize_t
#define _IO_off_t _G_off_t
#define _IO_pid_t _G_pid_t
#define _IO_uid_t _G_uid_t
#define _IO_HAVE_SYS_WAIT _G_HAVE_SYS_WAIT
#define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
#define _IO_BUFSIZ _G_BUFSIZ
#define _IO_va_list _G_va_list

#ifdef _G_NEED_STDARG_H
/* This define avoids name pollution if we're using GNU stdarg.h */
#define __need___va_list
#include <stdarg.h>
#ifdef __GNUC_VA_LIST
#undef _IO_va_list
#define _IO_va_list __gnuc_va_list
#endif /* __GNUC_VA_LIST */
#endif

#ifndef __P
#ifdef __STDC__
#define __P(protos) protos
#else
#define __P(protos) ()
#endif
#endif /*!__P*/

/* For backward compatibility */
#ifndef _PARAMS
#define _PARAMS(protos) __P(protos)
#endif /*!_PARAMS*/

#ifndef __STDC__
#define const
#endif
#define _IO_UNIFIED_JUMPTABLES 1

#if 0
#ifdef _IO_NEED_STDARG_H
#include <stdarg.h>
#endif
#endif

#ifndef EOF
#define EOF (-1)
#endif
#ifndef NULL
#if !defined(__cplusplus) || defined(__GNUC__)
#define NULL ((void*)0)
#else
#define NULL (0)
#endif
#endif

#define _IOS_INPUT	1
#define _IOS_OUTPUT	2
#define _IOS_ATEND	4
#define _IOS_APPEND	8
#define _IOS_TRUNC	16
#define _IOS_NOCREATE	32
#define _IOS_NOREPLACE	64
#define _IOS_BIN	128

/* Magic numbers and bits for the _flags field.
   The magic numbers use the high-order bits of _flags;
   the remaining bits are abailable for variable flags.
   Note: The magic numbers must all be negative if stdio
   emulation is desired. */

#define _IO_MAGIC 0xFBAD0000 /* Magic number */
#define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
#define _IO_MAGIC_MASK 0xFFFF0000
#define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
#define _IO_UNBUFFERED 2
#define _IO_NO_READS 4 /* Reading not allowed */
#define _IO_NO_WRITES 8 /* Writing not allowd */
#define _IO_EOF_SEEN 0x10
#define _IO_ERR_SEEN 0x20
#define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
#define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
#define _IO_IN_BACKUP 0x100
#define _IO_LINE_BUF 0x200
#define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
#define _IO_CURRENTLY_PUTTING 0x800
#define _IO_IS_APPENDING 0x1000
#define _IO_IS_FILEBUF 0x2000

/* These are "formatting flags" matching the iostream fmtflags enum values. */
#define _IO_SKIPWS 01
#define _IO_LEFT 02
#define _IO_RIGHT 04
#define _IO_INTERNAL 010
#define _IO_DEC 020
#define _IO_OCT 040
#define _IO_HEX 0100
#define _IO_SHOWBASE 0200
#define _IO_SHOWPOINT 0400
#define _IO_UPPERCASE 01000
#define _IO_SHOWPOS 02000
#define _IO_SCIENTIFIC 04000
#define _IO_FIXED 010000
#define _IO_UNITBUF 020000
#define _IO_STDIO 040000
#define _IO_DONT_CLOSE 0100000


struct _IO_jump_t;  struct _IO_FILE;

/* Define the user-visible type, with user-friendly member names.  */
typedef struct
{
  _IO_ssize_t (*read) __P ((struct _IO_FILE *, void *, _IO_ssize_t));
  _IO_ssize_t (*write) __P ((struct _IO_FILE *, const void *, _IO_ssize_t));
  _IO_fpos_t (*seek) __P ((struct _IO_FILE *, _IO_off_t, int));
  int (*close) __P ((struct _IO_FILE *));
} _IO_cookie_io_functions_t;

/* Handle lock.  */
#ifdef _IO_MTSAFE_IO
#include <pthread.h>
typedef pthread_mutex_t _IO_lock_t;
#else
typedef void _IO_lock_t;
#endif


/* A streammarker remembers a position in a buffer. */

struct _IO_marker {
  struct _IO_marker *_next;
  struct _IO_FILE *_sbuf;
  /* If _pos >= 0
 it points to _buf->Gbase()+_pos. FIXME comment */
  /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
  int _pos;
#if 0
    void set_streampos(streampos sp) { _spos = sp; }
    void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
  public:
    streammarker(streambuf *sb);
    ~streammarker();
    int saving() { return  _spos == -2; }
    int delta(streammarker&);
    int delta();
#endif
};

struct _IO_FILE {
  int _flags;		/* High-order word is _IO_MAGIC; rest is flags. */
#define _IO_file_flags _flags

  /* The following pointers correspond to the C++ streambuf protocol. */
  char* _IO_read_ptr;	/* Current read pointer */
  char* _IO_read_end;	/* End of get area. */
  char* _IO_read_base;	/* Start of putback+get area. */
  char* _IO_write_base;	/* Start of put area. */
  char* _IO_write_ptr;	/* Current put pointer. */
  char* _IO_write_end;	/* End of put area. */
  char* _IO_buf_base;	/* Start of reserve area. */
  char* _IO_buf_end;	/* End of reserve area. */
  /* The following fields are used to support backing up and undo. */
  char *_IO_save_base; /* Pointer to start of non-current get area. */
  char *_IO_backup_base;  /* Pointer to first valid character of backup area */
  char *_IO_save_end; /* Pointer to end of non-current get area. */

  struct _IO_marker *_markers;

  struct _IO_FILE *_chain;

#if  !_IO_UNIFIED_JUMPTABLES
  struct _IO_jump_t *_jumps; /* Jump table */
#endif

  int _fileno;
  int _blksize;
  _IO_off_t _offset;

#define __HAVE_COLUMN /* temporary */
  /* 1+column number of pbase(); 0 is unknown. */
  unsigned short _cur_column;
  char _unused;
  char _shortbuf[1];

  /*  char* _save_gptr;  char* _save_egptr; */

  _IO_lock_t *_lock;
};

#ifndef __cplusplus
typedef struct _IO_FILE _IO_FILE;
#endif

struct _IO_FILE_plus;
extern struct _IO_FILE_plus _IO_stdin_, _IO_stdout_, _IO_stderr_;
#define _IO_stdin ((_IO_FILE*)(&_IO_stdin_))
#define _IO_stdout ((_IO_FILE*)(&_IO_stdout_))
#define _IO_stderr ((_IO_FILE*)(&_IO_stderr_))


/* Special file type for fopencookie function.  */
struct _IO_cookie_file {
  struct _IO_FILE file;
  const void *vtable;
  void *cookie;
  _IO_cookie_io_functions_t io_functions;
};


#ifdef __cplusplus
extern "C" {
#endif

extern int __underflow __P((_IO_FILE*));
extern int __uflow __P((_IO_FILE*));
extern int __overflow __P((_IO_FILE*, int));

#define _IO_getc_unlocked(_fp) \
       ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end ? __uflow(_fp) \
	: *(unsigned char*)(_fp)->_IO_read_ptr++)
#define _IO_peekc_unlocked(_fp) \
       ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end \
	  && __underflow(_fp) == EOF ? EOF \
	: *(unsigned char*)(_fp)->_IO_read_ptr)

#define _IO_putc_unlocked(_ch, _fp) \
   (((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end) \
    ? __overflow(_fp, (unsigned char)(_ch)) \
    : (unsigned char)(*(_fp)->_IO_write_ptr++ = (_ch)))

#define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
#define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)

/* This one is for Emacs. */
#define _IO_PENDING_OUTPUT_COUNT(_fp)	\
	((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)

extern int _IO_getc_locked __P ((_IO_FILE *));
extern int _IO_putc_locked __P ((int, _IO_FILE *));

extern void _IO_flockfile __P ((_IO_FILE *));
extern void _IO_funlockfile __P ((_IO_FILE *));

#ifndef _IO_MTSAFE_IO
# define _IO_flockfile(FILE) /**/
# define _IO_funlockfile(FILE) /**/
#endif /* !_IO_MTSAFE_IO */


extern int _IO_vfscanf __P((_IO_FILE*, const char*, _IO_va_list, int*));
extern int _IO_vfprintf __P((_IO_FILE*, const char*, _IO_va_list));
extern _IO_ssize_t _IO_padn __P((_IO_FILE *, int, _IO_ssize_t));
extern _IO_size_t _IO_sgetn __P((_IO_FILE *, void*, _IO_size_t));

extern void _IO_free_backup_area __P((_IO_FILE*));

#ifdef __cplusplus
}
#endif

#endif /* _IO_STDIO_H */
Commit	Line	Data
96aa2d94 RM	1	/*
	2	Copyright (C) 1991, 1992, 1993, 1994, 1995 Free Software Foundation
	3
	4	This file is part of the GNU IO Library. This library is free
	5	software; you can redistribute it and/or modify it under the
	6	terms of the GNU General Public License as published by the
	7	Free Software Foundation; either version 2, or (at your option)
	8	any later version.
	9
	10	This library is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
	16	along with this library; see the file COPYING. If not, write to the Free
	17	Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	18
	19	As a special exception, if you link this library with files
	20	compiled with a GNU compiler to produce an executable, this does not cause
	21	the resulting executable to be covered by the GNU General Public License.
	22	This exception does not however invalidate any other reasons why
	23	the executable file might be covered by the GNU General Public License. */
	24
	25	/* This is part of the iostream library. Written by Per Bothner. */
	26
	27	#ifndef _IO_STDIO_H
	28	#define _IO_STDIO_H
	29
	30	#include <_G_config.h>
	31	#define _IO_pos_t _G_fpos_t /* obsolete */
	32	#define _IO_fpos_t _G_fpos_t
	33	#define _IO_size_t _G_size_t
	34	#define _IO_ssize_t _G_ssize_t
	35	#define _IO_off_t _G_off_t
	36	#define _IO_pid_t _G_pid_t
	37	#define _IO_uid_t _G_uid_t
	38	#define _IO_HAVE_SYS_WAIT _G_HAVE_SYS_WAIT
	39	#define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
	40	#define _IO_BUFSIZ _G_BUFSIZ
	41	#define _IO_va_list _G_va_list
	42
	43	#ifdef _G_NEED_STDARG_H
	44	/* This define avoids name pollution if we're using GNU stdarg.h */
	45	#define __need___va_list
	46	#include <stdarg.h>
	47	#ifdef __GNUC_VA_LIST
	48	#undef _IO_va_list
	49	#define _IO_va_list __gnuc_va_list
	50	#endif /* __GNUC_VA_LIST */
	51	#endif
	52
	53	#ifndef __P
	54	#ifdef __STDC__
	55	#define __P(protos) protos
	56	#else
	57	#define __P(protos) ()
	58	#endif
	59	#endif /!__P/
	60
	61	/* For backward compatibility */
	62	#ifndef _PARAMS
	63	#define _PARAMS(protos) __P(protos)
	64	#endif /!_PARAMS/
65
66	#ifndef __STDC__
67	#define const
68	#endif
69	#define _IO_UNIFIED_JUMPTABLES 1
70
71	#if 0
72	#ifdef _IO_NEED_STDARG_H
73	#include <stdarg.h>
74	#endif
75	#endif
76
77	#ifndef EOF
78	#define EOF (-1)
79	#endif
80	#ifndef NULL
81	#if !defined(__cplusplus) \|\| defined(__GNUC__)
82	#define NULL ((void*)0)
83	#else
84	#define NULL (0)
85	#endif
86	#endif
87
88	#define _IOS_INPUT 1
89	#define _IOS_OUTPUT 2
90	#define _IOS_ATEND 4
91	#define _IOS_APPEND 8
92	#define _IOS_TRUNC 16
93	#define _IOS_NOCREATE 32
94	#define _IOS_NOREPLACE 64
95	#define _IOS_BIN 128
96
97	/* Magic numbers and bits for the _flags field.
98	The magic numbers use the high-order bits of _flags;
99	the remaining bits are abailable for variable flags.
100	Note: The magic numbers must all be negative if stdio
101	emulation is desired. */
102
103	#define _IO_MAGIC 0xFBAD0000 /* Magic number */
104	#define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
105	#define _IO_MAGIC_MASK 0xFFFF0000
106	#define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
107	#define _IO_UNBUFFERED 2
108	#define _IO_NO_READS 4 /* Reading not allowed */
109	#define _IO_NO_WRITES 8 /* Writing not allowd */
110	#define _IO_EOF_SEEN 0x10
111	#define _IO_ERR_SEEN 0x20
112	#define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
113	#define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
114	#define _IO_IN_BACKUP 0x100
115	#define _IO_LINE_BUF 0x200
116	#define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
117	#define _IO_CURRENTLY_PUTTING 0x800
118	#define _IO_IS_APPENDING 0x1000
119	#define _IO_IS_FILEBUF 0x2000
120
121	/* These are "formatting flags" matching the iostream fmtflags enum values. */
122	#define _IO_SKIPWS 01
123	#define _IO_LEFT 02
124	#define _IO_RIGHT 04
125	#define _IO_INTERNAL 010
126	#define _IO_DEC 020
127	#define _IO_OCT 040
128	#define _IO_HEX 0100
129	#define _IO_SHOWBASE 0200
130	#define _IO_SHOWPOINT 0400
131	#define _IO_UPPERCASE 01000
132	#define _IO_SHOWPOS 02000
133	#define _IO_SCIENTIFIC 04000
134	#define _IO_FIXED 010000
135	#define _IO_UNITBUF 020000
136	#define _IO_STDIO 040000
137	#define _IO_DONT_CLOSE 0100000
138
139
140	struct _IO_jump_t; struct _IO_FILE;
141
142	/* Define the user-visible type, with user-friendly member names. */
143	typedef struct
144	{
145	_IO_ssize_t (read) __P ((struct _IO_FILE , void *, _IO_ssize_t));
146	_IO_ssize_t (write) __P ((struct _IO_FILE , const void *, _IO_ssize_t));
147	_IO_fpos_t (seek) __P ((struct _IO_FILE , _IO_off_t, int));
148	int (close) __P ((struct _IO_FILE ));
149	} _IO_cookie_io_functions_t;
150
7c713e28 RM	151	/* Handle lock. */
7c713e28 RM	152	#ifdef _IO_MTSAFE_IO
edf5b2d7	153	#include <pthread.h>
7c713e28 RM	154	typedef pthread_mutex_t _IO_lock_t;
	155	#else
	156	typedef void _IO_lock_t;
	157	#endif
96aa2d94	158
96aa2d94 RM	159
	160	/* A streammarker remembers a position in a buffer. */
	161
	162	struct _IO_marker {
	163	struct _IO_marker *_next;
	164	struct _IO_FILE *_sbuf;
	165	/* If _pos >= 0
	166	it points to _buf->Gbase()+_pos. FIXME comment */
	167	/* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
	168	int _pos;
	169	#if 0
	170	void set_streampos(streampos sp) { _spos = sp; }
	171	void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
	172	public:
	173	streammarker(streambuf *sb);
	174	~streammarker();
	175	int saving() { return _spos == -2; }
	176	int delta(streammarker&);
	177	int delta();
	178	#endif
	179	};
	180
	181	struct _IO_FILE {
	182	int _flags; /* High-order word is _IO_MAGIC; rest is flags. */
	183	#define _IO_file_flags _flags
	184
	185	/* The following pointers correspond to the C++ streambuf protocol. */
	186	char* _IO_read_ptr; /* Current read pointer */
	187	char* _IO_read_end; /* End of get area. */
	188	char* _IO_read_base; /* Start of putback+get area. */
	189	char* _IO_write_base; /* Start of put area. */
	190	char* _IO_write_ptr; /* Current put pointer. */
	191	char* _IO_write_end; /* End of put area. */
	192	char* _IO_buf_base; /* Start of reserve area. */
	193	char* _IO_buf_end; /* End of reserve area. */
	194	/* The following fields are used to support backing up and undo. */
	195	char _IO_save_base; / Pointer to start of non-current get area. */
	196	char _IO_backup_base; / Pointer to first valid character of backup area */
	197	char _IO_save_end; / Pointer to end of non-current get area. */
	198
	199	struct _IO_marker *_markers;
	200
	201	struct _IO_FILE *_chain;
	202
	203	#if !_IO_UNIFIED_JUMPTABLES
	204	struct _IO_jump_t _jumps; / Jump table */
	205	#endif
	206
	207	int _fileno;
	208	int _blksize;
	209	_IO_off_t _offset;
	210
	211	#define __HAVE_COLUMN /* temporary */
	212	/* 1+column number of pbase(); 0 is unknown. */
	213	unsigned short _cur_column;
	214	char _unused;
	215	char _shortbuf[1];
	216
	217	/* char* _save_gptr; char* _save_egptr; */
	218
7c713e28	219	_IO_lock_t *_lock;
96aa2d94 RM	220	};
	221
	222	#ifndef __cplusplus
	223	typedef struct _IO_FILE _IO_FILE;
	224	#endif
	225
	226	struct _IO_FILE_plus;
	227	extern struct _IO_FILE_plus _IO_stdin_, _IO_stdout_, _IO_stderr_;
	228	#define _IO_stdin ((_IO_FILE*)(&_IO_stdin_))
	229	#define _IO_stdout ((_IO_FILE*)(&_IO_stdout_))
	230	#define _IO_stderr ((_IO_FILE*)(&_IO_stderr_))
	231
fa0bc87c RM	232
	233	/* Special file type for fopencookie function. */
	234	struct _IO_cookie_file {
	235	struct _IO_FILE file;
	236	const void *vtable;
	237	void *cookie;
	238	_IO_cookie_io_functions_t io_functions;
	239	};
	240
	241
96aa2d94 RM	242	#ifdef __cplusplus
	243	extern "C" {
	244	#endif
	245
	246	extern int __underflow __P((_IO_FILE*));
	247	extern int __uflow __P((_IO_FILE*));
	248	extern int __overflow __P((_IO_FILE*, int));
	249
7c713e28	250	#define _IO_getc_unlocked(_fp) \
96aa2d94 RM	251	((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end ? __uflow(_fp) \
96aa2d94 RM	252	: (unsigned char)(_fp)->_IO_read_ptr++)
7c713e28	253	#define _IO_peekc_unlocked(_fp) \
96aa2d94 RM	254	((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end \
	255	&& __underflow(_fp) == EOF ? EOF \
	256	: (unsigned char)(_fp)->_IO_read_ptr)
	257
7c713e28	258	#define _IO_putc_unlocked(_ch, _fp) \
96aa2d94 RM	259	(((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end) \
	260	? __overflow(_fp, (unsigned char)(_ch)) \
	261	: (unsigned char)(*(_fp)->_IO_write_ptr++ = (_ch)))
	262
7c713e28 RM	263	#define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
7c713e28 RM	264	#define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
96aa2d94 RM	265
	266	/* This one is for Emacs. */
	267	#define _IO_PENDING_OUTPUT_COUNT(_fp) \
	268	((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
	269
7c713e28 RM	270	extern int _IO_getc_locked __P ((_IO_FILE *));
	271	extern int _IO_putc_locked __P ((int, _IO_FILE *));
	272
	273	extern void _IO_flockfile __P ((_IO_FILE *));
	274	extern void _IO_funlockfile __P ((_IO_FILE *));
	275
edf5b2d7	276	#ifndef _IO_MTSAFE_IO
7c713e28 RM	277	# define _IO_flockfile(FILE) /**/
7c713e28 RM	278	# define _IO_funlockfile(FILE) /**/
edf5b2d7	279	#endif /* !_IO_MTSAFE_IO */
7c713e28 RM	280
7c713e28 RM	281
96aa2d94 RM	282	extern int _IO_vfscanf __P((_IO_FILE, const char, _IO_va_list, int*));
	283	extern int _IO_vfprintf __P((_IO_FILE, const char, _IO_va_list));
	284	extern _IO_ssize_t _IO_padn __P((_IO_FILE *, int, _IO_ssize_t));
	285	extern _IO_size_t _IO_sgetn __P((_IO_FILE , void, _IO_size_t));
	286
	287	extern void _IO_free_backup_area __P((_IO_FILE*));
	288
	289	#ifdef __cplusplus
	290	}
	291	#endif
	292
	293	#endif /* _IO_STDIO_H */