[perl5.git] / perliol.h

#ifndef _PERLIOL_H
#define _PERLIOL_H

typedef struct {
    PerlIO_funcs *funcs;
    SV *arg;
} PerlIO_pair_t;

struct PerlIO_list_s {
    IV refcnt;
    IV cur;
    IV len;
    PerlIO_pair_t *array;
};

struct _PerlIO_funcs {
    Size_t fsize;
    char *name;
    Size_t size;
    U32 kind;
    IV (*Pushed) (pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
    IV (*Popped) (pTHX_ PerlIO *f);
    PerlIO *(*Open) (pTHX_ PerlIO_funcs *tab,
		     PerlIO_list_t *layers, IV n,
		     const char *mode,
		     int fd, int imode, int perm,
		     PerlIO *old, int narg, SV **args);
    IV (*Binmode)(pTHX_ PerlIO *f);
    SV *(*Getarg) (pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags);
    IV (*Fileno) (pTHX_ PerlIO *f);
    PerlIO *(*Dup) (pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
    /* Unix-like functions - cf sfio line disciplines */
     SSize_t(*Read) (pTHX_ PerlIO *f, void *vbuf, Size_t count);
     SSize_t(*Unread) (pTHX_ PerlIO *f, const void *vbuf, Size_t count);
     SSize_t(*Write) (pTHX_ PerlIO *f, const void *vbuf, Size_t count);
    IV (*Seek) (pTHX_ PerlIO *f, Off_t offset, int whence);
     Off_t(*Tell) (pTHX_ PerlIO *f);
    IV (*Close) (pTHX_ PerlIO *f);
    /* Stdio-like buffered IO functions */
    IV (*Flush) (pTHX_ PerlIO *f);
    IV (*Fill) (pTHX_ PerlIO *f);
    IV (*Eof) (pTHX_ PerlIO *f);
    IV (*Error) (pTHX_ PerlIO *f);
    void (*Clearerr) (pTHX_ PerlIO *f);
    void (*Setlinebuf) (pTHX_ PerlIO *f);
    /* Perl's snooping functions */
    STDCHAR *(*Get_base) (pTHX_ PerlIO *f);
     Size_t(*Get_bufsiz) (pTHX_ PerlIO *f);
    STDCHAR *(*Get_ptr) (pTHX_ PerlIO *f);
     SSize_t(*Get_cnt) (pTHX_ PerlIO *f);
    void (*Set_ptrcnt) (pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
};

/*--------------------------------------------------------------------------------------*/
/* Kind values */
#define PERLIO_K_RAW		0x00000001
#define PERLIO_K_BUFFERED	0x00000002
#define PERLIO_K_CANCRLF	0x00000004
#define PERLIO_K_FASTGETS	0x00000008
#define PERLIO_K_DUMMY		0x00000010
#define PERLIO_K_UTF8		0x00008000
#define PERLIO_K_DESTRUCT	0x00010000
#define PERLIO_K_MULTIARG	0x00020000

/*--------------------------------------------------------------------------------------*/
struct _PerlIO {
    PerlIOl *next;		/* Lower layer */
    PerlIO_funcs *tab;		/* Functions for this layer */
    U32 flags;			/* Various flags for state */
};

/*--------------------------------------------------------------------------------------*/

/* Flag values */
#define PERLIO_F_EOF		0x00000100
#define PERLIO_F_CANWRITE	0x00000200
#define PERLIO_F_CANREAD	0x00000400
#define PERLIO_F_ERROR		0x00000800
#define PERLIO_F_TRUNCATE	0x00001000
#define PERLIO_F_APPEND		0x00002000
#define PERLIO_F_CRLF		0x00004000
#define PERLIO_F_UTF8		0x00008000
#define PERLIO_F_UNBUF		0x00010000
#define PERLIO_F_WRBUF		0x00020000
#define PERLIO_F_RDBUF		0x00040000
#define PERLIO_F_LINEBUF	0x00080000
#define PERLIO_F_TEMP		0x00100000
#define PERLIO_F_OPEN		0x00200000
#define PERLIO_F_FASTGETS	0x00400000
#define PERLIO_F_TTY		0x00800000

#define PerlIOBase(f)      (*(f))
#define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
#define PerlIONext(f)      (&(PerlIOBase(f)->next))
#define PerlIOValid(f)     ((f) && *(f))

/*--------------------------------------------------------------------------------------*/
/* Data exports - EXT rather than extern is needed for Cygwin */
EXT PerlIO_funcs PerlIO_unix;
EXT PerlIO_funcs PerlIO_perlio;
EXT PerlIO_funcs PerlIO_stdio;
EXT PerlIO_funcs PerlIO_crlf;
EXT PerlIO_funcs PerlIO_utf8;
EXT PerlIO_funcs PerlIO_byte;
EXT PerlIO_funcs PerlIO_raw;
EXT PerlIO_funcs PerlIO_pending;
#ifdef HAS_MMAP
EXT PerlIO_funcs PerlIO_mmap;
#endif
#ifdef WIN32
EXT PerlIO_funcs PerlIO_win32;
#endif
extern PerlIO *PerlIO_allocate(pTHX);
extern SV *PerlIO_arg_fetch(PerlIO_list_t *av, IV n);
#define PerlIOArg PerlIO_arg_fetch(layers,n)

#ifdef PERLIO_USING_CRLF
#define PERLIO_STDTEXT "t"
#else
#define PERLIO_STDTEXT ""
#endif

/*--------------------------------------------------------------------------------------*/
/* Generic, or stub layer functions */

extern IV PerlIOBase_fileno(pTHX_ PerlIO *f);
extern PerlIO *PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
extern IV PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
extern IV PerlIOBase_popped(pTHX_ PerlIO *f);
extern IV PerlIOBase_binmode(pTHX_ PerlIO *f);
extern SSize_t PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
extern SSize_t PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf,
				 Size_t count);
extern IV PerlIOBase_eof(pTHX_ PerlIO *f);
extern IV PerlIOBase_error(pTHX_ PerlIO *f);
extern void PerlIOBase_clearerr(pTHX_ PerlIO *f);
extern IV PerlIOBase_close(pTHX_ PerlIO *f);
extern void PerlIOBase_setlinebuf(pTHX_ PerlIO *f);
extern void PerlIOBase_flush_linebuf(pTHX);

extern IV PerlIOBase_noop_ok(pTHX_ PerlIO *f);
extern IV PerlIOBase_noop_fail(pTHX_ PerlIO *f);

/*--------------------------------------------------------------------------------------*/
/* perlio buffer layer
   As this is reasonably generic its struct and "methods" are declared here
   so they can be used to "inherit" from it.
*/

typedef struct {
    struct _PerlIO base;	/* Base "class" info */
    STDCHAR *buf;		/* Start of buffer */
    STDCHAR *end;		/* End of valid part of buffer */
    STDCHAR *ptr;		/* Current position in buffer */
    Off_t posn;			/* Offset of buf into the file */
    Size_t bufsiz;		/* Real size of buffer */
    IV oneword;			/* Emergency buffer */
} PerlIOBuf;

extern int PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
		    PerlIO_list_t *layers, IV n, IV max);
extern int PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names);
extern void PerlIO_list_free(pTHX_ PerlIO_list_t *list);
extern PerlIO_funcs *PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def);


extern SV *PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param);
extern PerlIO *PerlIOBuf_open(pTHX_ PerlIO_funcs *self,
			      PerlIO_list_t *layers, IV n,
			      const char *mode, int fd, int imode,
			      int perm, PerlIO *old, int narg, SV **args);
extern IV PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
extern IV PerlIOBuf_popped(pTHX_ PerlIO *f);
extern PerlIO *PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
extern SSize_t PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
extern SSize_t PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
extern SSize_t PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
extern IV PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
extern Off_t PerlIOBuf_tell(pTHX_ PerlIO *f);
extern IV PerlIOBuf_close(pTHX_ PerlIO *f);
extern IV PerlIOBuf_flush(pTHX_ PerlIO *f);
extern IV PerlIOBuf_fill(pTHX_ PerlIO *f);
extern STDCHAR *PerlIOBuf_get_base(pTHX_ PerlIO *f);
extern Size_t PerlIOBuf_bufsiz(pTHX_ PerlIO *f);
extern STDCHAR *PerlIOBuf_get_ptr(pTHX_ PerlIO *f);
extern SSize_t PerlIOBuf_get_cnt(pTHX_ PerlIO *f);
extern void PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);

extern int PerlIOUnix_oflags(const char *mode);

/*--------------------------------------------------------------------------------------*/

#endif				/* _PERLIOL_H */
Commit	Line	Data
76ced9ad NIS	1	#ifndef _PERLIOL_H
	2	#define _PERLIOL_H
	3
14a5cf38 JH	4	typedef struct {
	5	PerlIO_funcs *funcs;
	6	SV *arg;
fcf2db38 NIS	7	} PerlIO_pair_t;
fcf2db38 NIS	8
3a1ee7e8	9	struct PerlIO_list_s {
14a5cf38 JH	10	IV refcnt;
	11	IV cur;
	12	IV len;
	13	PerlIO_pair_t *array;
3a1ee7e8	14	};
fcf2db38	15
14a5cf38	16	struct _PerlIO_funcs {
2dc2558e	17	Size_t fsize;
14a5cf38 JH	18	char *name;
14a5cf38 JH	19	Size_t size;
c9e984e3	20	U32 kind;
2dc2558e	21	IV (Pushed) (pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs *tab);
f62ce20a	22	IV (Popped) (pTHX_ PerlIO f);
14a5cf38 JH	23	PerlIO (Open) (pTHX_ PerlIO_funcs *tab,
	24	PerlIO_list_t *layers, IV n,
	25	const char *mode,
	26	int fd, int imode, int perm,
	27	PerlIO old, int narg, SV *args);
86e05cf2	28	IV (Binmode)(pTHX_ PerlIO f);
ecdeb87c	29	SV (Getarg) (pTHX_ PerlIO f, CLONE_PARAMS param, int flags);
f62ce20a	30	IV (Fileno) (pTHX_ PerlIO f);
ecdeb87c	31	PerlIO (Dup) (pTHX_ PerlIO f, PerlIO o, CLONE_PARAMS *param, int flags);
14a5cf38	32	/* Unix-like functions - cf sfio line disciplines */
f62ce20a NIS	33	SSize_t(Read) (pTHX_ PerlIO f, void *vbuf, Size_t count);
	34	SSize_t(Unread) (pTHX_ PerlIO f, const void *vbuf, Size_t count);
	35	SSize_t(Write) (pTHX_ PerlIO f, const void *vbuf, Size_t count);
	36	IV (Seek) (pTHX_ PerlIO f, Off_t offset, int whence);
	37	Off_t(Tell) (pTHX_ PerlIO f);
	38	IV (Close) (pTHX_ PerlIO f);
14a5cf38	39	/* Stdio-like buffered IO functions */
f62ce20a NIS	40	IV (Flush) (pTHX_ PerlIO f);
	41	IV (Fill) (pTHX_ PerlIO f);
	42	IV (Eof) (pTHX_ PerlIO f);
	43	IV (Error) (pTHX_ PerlIO f);
	44	void (Clearerr) (pTHX_ PerlIO f);
	45	void (Setlinebuf) (pTHX_ PerlIO f);
14a5cf38	46	/* Perl's snooping functions */
f62ce20a NIS	47	STDCHAR (Get_base) (pTHX_ PerlIO *f);
	48	Size_t(Get_bufsiz) (pTHX_ PerlIO f);
	49	STDCHAR (Get_ptr) (pTHX_ PerlIO *f);
	50	SSize_t(Get_cnt) (pTHX_ PerlIO f);
	51	void (Set_ptrcnt) (pTHX_ PerlIO f, STDCHAR * ptr, SSize_t cnt);
76ced9ad NIS	52	};
76ced9ad NIS	53
f5b9d040 NIS	54	/--------------------------------------------------------------------------------------/
f5b9d040 NIS	55	/* Kind values */
5e2ab84b NIS	56	#define PERLIO_K_RAW 0x00000001
5e2ab84b NIS	57	#define PERLIO_K_BUFFERED 0x00000002
f5b9d040	58	#define PERLIO_K_CANCRLF 0x00000004
5e2ab84b	59	#define PERLIO_K_FASTGETS 0x00000008
dfebf958	60	#define PERLIO_K_DUMMY 0x00000010
26fb694e	61	#define PERLIO_K_UTF8 0x00008000
13621cfb	62	#define PERLIO_K_DESTRUCT 0x00010000
7cf31beb	63	#define PERLIO_K_MULTIARG 0x00020000
f5b9d040 NIS	64
f5b9d040 NIS	65	/--------------------------------------------------------------------------------------/
14a5cf38 JH	66	struct _PerlIO {
	67	PerlIOl next; / Lower layer */
	68	PerlIO_funcs tab; / Functions for this layer */
4b069b44	69	U32 flags; /* Various flags for state */
76ced9ad NIS	70	};
	71
	72	/--------------------------------------------------------------------------------------/
	73
	74	/* Flag values */
5e2ab84b NIS	75	#define PERLIO_F_EOF 0x00000100
	76	#define PERLIO_F_CANWRITE 0x00000200
	77	#define PERLIO_F_CANREAD 0x00000400
	78	#define PERLIO_F_ERROR 0x00000800
	79	#define PERLIO_F_TRUNCATE 0x00001000
	80	#define PERLIO_F_APPEND 0x00002000
	81	#define PERLIO_F_CRLF 0x00004000
	82	#define PERLIO_F_UTF8 0x00008000
	83	#define PERLIO_F_UNBUF 0x00010000
	84	#define PERLIO_F_WRBUF 0x00020000
	85	#define PERLIO_F_RDBUF 0x00040000
	86	#define PERLIO_F_LINEBUF 0x00080000
	87	#define PERLIO_F_TEMP 0x00100000
	88	#define PERLIO_F_OPEN 0x00200000
	89	#define PERLIO_F_FASTGETS 0x00400000
a9c883f6	90	#define PERLIO_F_TTY 0x00800000
76ced9ad NIS	91
	92	#define PerlIOBase(f) (*(f))
	93	#define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
	94	#define PerlIONext(f) (&(PerlIOBase(f)->next))
04892f78	95	#define PerlIOValid(f) ((f) && *(f))
76ced9ad NIS	96
76ced9ad NIS	97	/--------------------------------------------------------------------------------------/
26fb694e NIS	98	/* Data exports - EXT rather than extern is needed for Cygwin */
	99	EXT PerlIO_funcs PerlIO_unix;
	100	EXT PerlIO_funcs PerlIO_perlio;
	101	EXT PerlIO_funcs PerlIO_stdio;
	102	EXT PerlIO_funcs PerlIO_crlf;
	103	EXT PerlIO_funcs PerlIO_utf8;
	104	EXT PerlIO_funcs PerlIO_byte;
	105	EXT PerlIO_funcs PerlIO_raw;
7ea3cd40	106	EXT PerlIO_funcs PerlIO_pending;
76ced9ad	107	#ifdef HAS_MMAP
26fb694e	108	EXT PerlIO_funcs PerlIO_mmap;
76ced9ad	109	#endif
0c4128ad NIS	110	#ifdef WIN32
	111	EXT PerlIO_funcs PerlIO_win32;
	112	#endif
5f1a76d0	113	extern PerlIO *PerlIO_allocate(pTHX);
14a5cf38	114	extern SV PerlIO_arg_fetch(PerlIO_list_t av, IV n);
fcf2db38	115	#define PerlIOArg PerlIO_arg_fetch(layers,n)
76ced9ad	116
35990314	117	#ifdef PERLIO_USING_CRLF
f5b9d040 NIS	118	#define PERLIO_STDTEXT "t"
	119	#else
	120	#define PERLIO_STDTEXT ""
	121	#endif
	122
76ced9ad NIS	123	/--------------------------------------------------------------------------------------/
	124	/* Generic, or stub layer functions */
	125
f62ce20a	126	extern IV PerlIOBase_fileno(pTHX_ PerlIO *f);
ecdeb87c	127	extern PerlIO PerlIOBase_dup(pTHX_ PerlIO f, PerlIO o, CLONE_PARAMS param, int flags);
2dc2558e	128	extern IV PerlIOBase_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
f62ce20a	129	extern IV PerlIOBase_popped(pTHX_ PerlIO *f);
86e05cf2	130	extern IV PerlIOBase_binmode(pTHX_ PerlIO *f);
f62ce20a NIS	131	extern SSize_t PerlIOBase_read(pTHX_ PerlIO f, void vbuf, Size_t count);
f62ce20a NIS	132	extern SSize_t PerlIOBase_unread(pTHX_ PerlIO f, const void vbuf,
14a5cf38	133	Size_t count);
f62ce20a NIS	134	extern IV PerlIOBase_eof(pTHX_ PerlIO *f);
	135	extern IV PerlIOBase_error(pTHX_ PerlIO *f);
	136	extern void PerlIOBase_clearerr(pTHX_ PerlIO *f);
	137	extern IV PerlIOBase_close(pTHX_ PerlIO *f);
	138	extern void PerlIOBase_setlinebuf(pTHX_ PerlIO *f);
	139	extern void PerlIOBase_flush_linebuf(pTHX);
14a5cf38	140
f62ce20a NIS	141	extern IV PerlIOBase_noop_ok(pTHX_ PerlIO *f);
f62ce20a NIS	142	extern IV PerlIOBase_noop_fail(pTHX_ PerlIO *f);
76ced9ad NIS	143
	144	/--------------------------------------------------------------------------------------/
	145	/* perlio buffer layer
	146	As this is reasonably generic its struct and "methods" are declared here
	147	so they can be used to "inherit" from it.
	148	*/
	149
14a5cf38 JH	150	typedef struct {
	151	struct _PerlIO base; /* Base "class" info */
	152	STDCHAR buf; / Start of buffer */
	153	STDCHAR end; / End of valid part of buffer */
	154	STDCHAR ptr; / Current position in buffer */
	155	Off_t posn; /* Offset of buf into the file */
	156	Size_t bufsiz; /* Real size of buffer */
	157	IV oneword; /* Emergency buffer */
76ced9ad NIS	158	} PerlIOBuf;
76ced9ad NIS	159
d9dac8cd NIS	160	extern int PerlIO_apply_layera(pTHX_ PerlIO f, const char mode,
	161	PerlIO_list_t *layers, IV n, IV max);
	162	extern int PerlIO_parse_layers(pTHX_ PerlIO_list_t av, const char names);
	163	extern void PerlIO_list_free(pTHX_ PerlIO_list_t *list);
	164	extern PerlIO_funcs PerlIO_layer_fetch(pTHX_ PerlIO_list_t av, IV n, PerlIO_funcs *def);
	165
	166
8cf8f3d1	167	extern SV PerlIO_sv_dup(pTHX_ SV arg, CLONE_PARAMS *param);
14a5cf38 JH	168	extern PerlIO PerlIOBuf_open(pTHX_ PerlIO_funcs self,
	169	PerlIO_list_t *layers, IV n,
	170	const char *mode, int fd, int imode,
	171	int perm, PerlIO old, int narg, SV *args);
2dc2558e	172	extern IV PerlIOBuf_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
44798d05	173	extern IV PerlIOBuf_popped(pTHX_ PerlIO *f);
ecdeb87c	174	extern PerlIO PerlIOBuf_dup(pTHX_ PerlIO f, PerlIO o, CLONE_PARAMS param, int flags);
f62ce20a NIS	175	extern SSize_t PerlIOBuf_read(pTHX_ PerlIO f, void vbuf, Size_t count);
	176	extern SSize_t PerlIOBuf_unread(pTHX_ PerlIO f, const void vbuf, Size_t count);
	177	extern SSize_t PerlIOBuf_write(pTHX_ PerlIO f, const void vbuf, Size_t count);
	178	extern IV PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
	179	extern Off_t PerlIOBuf_tell(pTHX_ PerlIO *f);
	180	extern IV PerlIOBuf_close(pTHX_ PerlIO *f);
	181	extern IV PerlIOBuf_flush(pTHX_ PerlIO *f);
	182	extern IV PerlIOBuf_fill(pTHX_ PerlIO *f);
	183	extern STDCHAR PerlIOBuf_get_base(pTHX_ PerlIO f);
	184	extern Size_t PerlIOBuf_bufsiz(pTHX_ PerlIO *f);
	185	extern STDCHAR PerlIOBuf_get_ptr(pTHX_ PerlIO f);
	186	extern SSize_t PerlIOBuf_get_cnt(pTHX_ PerlIO *f);
	187	extern void PerlIOBuf_set_ptrcnt(pTHX_ PerlIO f, STDCHAR ptr, SSize_t cnt);
14a5cf38 JH	188
14a5cf38 JH	189	extern int PerlIOUnix_oflags(const char *mode);
0c4128ad	190
76ced9ad NIS	191	/--------------------------------------------------------------------------------------/
76ced9ad NIS	192
14a5cf38	193	#endif /* _PERLIOL_H */