[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;
    const 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 */
    int err;			/* Saved errno value */
#ifdef VMS
    unsigned os_err;		/* Saved vaxc$errno value */
#elif defined (OS2)
    unsigned long os_err;
#elif defined (WIN32)
    DWORD os_err;		/* Saved GetLastError() value */
#endif
    PerlIOl *head;		/* our ultimate parent pointer */
};

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

/* 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 PERLIO_F_NOTREG         0x01000000   
#define PERLIO_F_CLEARED        0x02000000 /* layer cleared but not freed */

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

/*--------------------------------------------------------------------------------------*/
EXTCONST PerlIO_funcs PerlIO_unix;
EXTCONST PerlIO_funcs PerlIO_perlio;
EXTCONST PerlIO_funcs PerlIO_stdio;
EXTCONST PerlIO_funcs PerlIO_crlf;
EXTCONST PerlIO_funcs PerlIO_utf8;
EXTCONST PerlIO_funcs PerlIO_byte;
EXTCONST PerlIO_funcs PerlIO_raw;
EXTCONST PerlIO_funcs PerlIO_pending;
PERL_CALLCONV PerlIO *PerlIO_allocate(pTHX);
PERL_CALLCONV 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

/*--------------------------------------------------------------------------------------*/
/* 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;

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


PERL_CALLCONV SV *PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param);
PERL_CALLCONV void PerlIO_cleantable(pTHX_ PerlIOl **tablep);
PERL_CALLCONV SV * PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab);
PERL_CALLCONV void PerlIO_default_buffer(pTHX_ PerlIO_list_t *av);
PERL_CALLCONV void PerlIO_stdstreams(pTHX);
PERL_CALLCONV int PerlIO__close(pTHX_ PerlIO *f);
PERL_CALLCONV PerlIO_list_t * PerlIO_resolve_layers(pTHX_ const char *layers, const char *mode, int narg, SV **args);
PERL_CALLCONV PerlIO_funcs * PerlIO_default_layer(pTHX_ I32 n);
PERL_CALLCONV PerlIO_list_t * PerlIO_default_layers(pTHX);
PERL_CALLCONV PerlIO * PerlIO_reopen(const char *path, const char *mode, PerlIO *f);

PERL_CALLCONV PerlIO_list_t *PerlIO_list_alloc(pTHX);
PERL_CALLCONV PerlIO_list_t *PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param);
PERL_CALLCONV void PerlIO_list_free(pTHX_ PerlIO_list_t *list);
PERL_CALLCONV void PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg);
PERL_CALLCONV void PerlIO_list_free(pTHX_ PerlIO_list_t *list);

/* PerlIO_teardown doesn't need exporting, but the EXTERN_C is needed
 * for compiling as C++.  Must also match with what perl.h says. */
EXTERN_C void PerlIO_teardown(void);

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

PERL_CALLCONV IV        PerlIOBase_binmode(pTHX_ PerlIO *f);
PERL_CALLCONV void      PerlIOBase_clearerr(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOBase_close(pTHX_ PerlIO *f);
PERL_CALLCONV PerlIO *  PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
PERL_CALLCONV IV        PerlIOBase_eof(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOBase_error(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOBase_fileno(pTHX_ PerlIO *f);
PERL_CALLCONV void      PerlIOBase_flush_linebuf(pTHX);
PERL_CALLCONV IV        PerlIOBase_noop_fail(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOBase_noop_ok(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOBase_popped(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
PERL_CALLCONV PerlIO *  PerlIOBase_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);
PERL_CALLCONV SSize_t   PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
PERL_CALLCONV void      PerlIOBase_setlinebuf(pTHX_ PerlIO *f);
PERL_CALLCONV SSize_t   PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);

/* Buf */
PERL_CALLCONV Size_t    PerlIOBuf_bufsiz(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOBuf_close(pTHX_ PerlIO *f);
PERL_CALLCONV PerlIO *  PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
PERL_CALLCONV IV        PerlIOBuf_fill(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOBuf_flush(pTHX_ PerlIO *f);
PERL_CALLCONV STDCHAR * PerlIOBuf_get_base(pTHX_ PerlIO *f);
PERL_CALLCONV SSize_t   PerlIOBuf_get_cnt(pTHX_ PerlIO *f);
PERL_CALLCONV STDCHAR * PerlIOBuf_get_ptr(pTHX_ PerlIO *f);
PERL_CALLCONV 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);
PERL_CALLCONV IV        PerlIOBuf_popped(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
PERL_CALLCONV SSize_t   PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
PERL_CALLCONV IV        PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
PERL_CALLCONV void      PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
PERL_CALLCONV Off_t     PerlIOBuf_tell(pTHX_ PerlIO *f);
PERL_CALLCONV SSize_t   PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
PERL_CALLCONV SSize_t   PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);

/* Crlf */
PERL_CALLCONV IV        PerlIOCrlf_binmode(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOCrlf_flush(pTHX_ PerlIO *f);
PERL_CALLCONV SSize_t   PerlIOCrlf_get_cnt(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
PERL_CALLCONV void      PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
PERL_CALLCONV SSize_t   PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
PERL_CALLCONV SSize_t   PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);

/* Pending */
PERL_CALLCONV IV        PerlIOPending_close(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOPending_fill(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOPending_flush(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
PERL_CALLCONV SSize_t   PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
PERL_CALLCONV IV        PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
PERL_CALLCONV void      PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);

/* Pop */
PERL_CALLCONV IV        PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);

/* Raw */
PERL_CALLCONV IV        PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);

/* Stdio */
PERL_CALLCONV void      PerlIOStdio_clearerr(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOStdio_close(pTHX_ PerlIO *f);
PERL_CALLCONV PerlIO *  PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
PERL_CALLCONV IV        PerlIOStdio_eof(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOStdio_error(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOStdio_fileno(pTHX_ PerlIO *f);
#ifdef USE_STDIO_PTR
PERL_CALLCONV STDCHAR * PerlIOStdio_get_ptr(pTHX_ PerlIO *f);
PERL_CALLCONV SSize_t   PerlIOStdio_get_cnt(pTHX_ PerlIO *f);
PERL_CALLCONV void      PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
#endif
PERL_CALLCONV IV        PerlIOStdio_fill(pTHX_ PerlIO *f);
PERL_CALLCONV IV        PerlIOStdio_flush(pTHX_ PerlIO *f);
#ifdef FILE_base
PERL_CALLCONV STDCHAR * PerlIOStdio_get_base(pTHX_ PerlIO *f);
PERL_CALLCONV Size_t    PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f);
#endif
PERL_CALLCONV char *    PerlIOStdio_mode(const char *mode, char *tmode);
PERL_CALLCONV PerlIO *  PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers, IV n, const char *mode, int fd, int imode, int perm, PerlIO *f, int narg, SV **args);
PERL_CALLCONV IV        PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
PERL_CALLCONV SSize_t   PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
PERL_CALLCONV IV        PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
PERL_CALLCONV void      PerlIOStdio_setlinebuf(pTHX_ PerlIO *f);
PERL_CALLCONV Off_t     PerlIOStdio_tell(pTHX_ PerlIO *f);
PERL_CALLCONV SSize_t   PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
PERL_CALLCONV SSize_t   PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);

/* Unix */
PERL_CALLCONV IV        PerlIOUnix_close(pTHX_ PerlIO *f);
PERL_CALLCONV PerlIO *  PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
PERL_CALLCONV IV        PerlIOUnix_fileno(pTHX_ PerlIO *f);
PERL_CALLCONV int       PerlIOUnix_oflags(const char *mode);
PERL_CALLCONV PerlIO *  PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers, IV n, const char *mode, int fd, int imode, int perm, PerlIO *f, int narg, SV **args);
PERL_CALLCONV IV        PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
PERL_CALLCONV SSize_t   PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
PERL_CALLCONV int       PerlIOUnix_refcnt_dec(int fd);
PERL_CALLCONV void      PerlIOUnix_refcnt_inc(int fd);
PERL_CALLCONV int       PerlIOUnix_refcnt(int fd);
PERL_CALLCONV IV        PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
PERL_CALLCONV Off_t     PerlIOUnix_tell(pTHX_ PerlIO *f);
PERL_CALLCONV SSize_t   PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);

/* Utf8 */
PERL_CALLCONV IV        PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);

#endif				/* PERLIOL_H_ */

/*
 * ex: set ts=8 sts=4 sw=4 et:
 */
Commit	Line	Data
6a5bc5ac KW	1	#ifndef PERLIOL_H_
6a5bc5ac KW	2	#define PERLIOL_H_
76ced9ad	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;
e1ec3a88	18	const char *name;
14a5cf38	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	23	PerlIO (Open) (pTHX_ PerlIO_funcs *tab,
1604cfb0 MS	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);
94a175e1	36	IV (Seek) (pTHX_ PerlIO f, Off_t offset, int whence);
f62ce20a NIS	37	Off_t(Tell) (pTHX_ PerlIO f);
f62ce20a NIS	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 */
0ea86a10 FC	70	int err; /* Saved errno value */
	71	#ifdef VMS
	72	unsigned os_err; /* Saved vaxc$errno value */
	73	#elif defined (OS2)
	74	unsigned long os_err;
	75	#elif defined (WIN32)
	76	DWORD os_err; /* Saved GetLastError() value */
	77	#endif
16865ff7	78	PerlIOl head; / our ultimate parent pointer */
76ced9ad NIS	79	};
	80
	81	/--------------------------------------------------------------------------------------/
	82
	83	/* Flag values */
5e2ab84b NIS	84	#define PERLIO_F_EOF 0x00000100
	85	#define PERLIO_F_CANWRITE 0x00000200
	86	#define PERLIO_F_CANREAD 0x00000400
	87	#define PERLIO_F_ERROR 0x00000800
	88	#define PERLIO_F_TRUNCATE 0x00001000
	89	#define PERLIO_F_APPEND 0x00002000
	90	#define PERLIO_F_CRLF 0x00004000
	91	#define PERLIO_F_UTF8 0x00008000
	92	#define PERLIO_F_UNBUF 0x00010000
	93	#define PERLIO_F_WRBUF 0x00020000
	94	#define PERLIO_F_RDBUF 0x00040000
	95	#define PERLIO_F_LINEBUF 0x00080000
	96	#define PERLIO_F_TEMP 0x00100000
	97	#define PERLIO_F_OPEN 0x00200000
	98	#define PERLIO_F_FASTGETS 0x00400000
a9c883f6	99	#define PERLIO_F_TTY 0x00800000
6caa5a9c	100	#define PERLIO_F_NOTREG 0x01000000
abf9167d	101	#define PERLIO_F_CLEARED 0x02000000 /* layer cleared but not freed */
76ced9ad NIS	102
	103	#define PerlIOBase(f) (*(f))
	104	#define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
	105	#define PerlIONext(f) (&(PerlIOBase(f)->next))
04892f78	106	#define PerlIOValid(f) ((f) && *(f))
76ced9ad NIS	107
76ced9ad NIS	108	/--------------------------------------------------------------------------------------/
1d210779 KW	109	EXTCONST PerlIO_funcs PerlIO_unix;
	110	EXTCONST PerlIO_funcs PerlIO_perlio;
	111	EXTCONST PerlIO_funcs PerlIO_stdio;
	112	EXTCONST PerlIO_funcs PerlIO_crlf;
	113	EXTCONST PerlIO_funcs PerlIO_utf8;
	114	EXTCONST PerlIO_funcs PerlIO_byte;
	115	EXTCONST PerlIO_funcs PerlIO_raw;
	116	EXTCONST PerlIO_funcs PerlIO_pending;
fc6bde6f DD	117	PERL_CALLCONV PerlIO *PerlIO_allocate(pTHX);
fc6bde6f DD	118	PERL_CALLCONV SV PerlIO_arg_fetch(PerlIO_list_t av, IV n);
fcf2db38	119	#define PerlIOArg PerlIO_arg_fetch(layers,n)
76ced9ad	120
35990314	121	#ifdef PERLIO_USING_CRLF
f5b9d040 NIS	122	#define PERLIO_STDTEXT "t"
	123	#else
	124	#define PERLIO_STDTEXT ""
	125	#endif
	126
76ced9ad	127	/--------------------------------------------------------------------------------------/
76ced9ad NIS	128	/* perlio buffer layer
	129	As this is reasonably generic its struct and "methods" are declared here
	130	so they can be used to "inherit" from it.
	131	*/
	132
14a5cf38 JH	133	typedef struct {
	134	struct _PerlIO base; /* Base "class" info */
	135	STDCHAR buf; / Start of buffer */
	136	STDCHAR end; / End of valid part of buffer */
	137	STDCHAR ptr; / Current position in buffer */
	138	Off_t posn; /* Offset of buf into the file */
	139	Size_t bufsiz; /* Real size of buffer */
	140	IV oneword; /* Emergency buffer */
76ced9ad NIS	141	} PerlIOBuf;
76ced9ad NIS	142
fc6bde6f	143	PERL_CALLCONV int PerlIO_apply_layera(pTHX_ PerlIO f, const char mode,
1604cfb0	144	PerlIO_list_t *layers, IV n, IV max);
fc6bde6f DD	145	PERL_CALLCONV int PerlIO_parse_layers(pTHX_ PerlIO_list_t av, const char names);
fc6bde6f DD	146	PERL_CALLCONV PerlIO_funcs PerlIO_layer_fetch(pTHX_ PerlIO_list_t av, IV n, PerlIO_funcs *def);
d9dac8cd NIS	147
d9dac8cd NIS	148
fc6bde6f DD	149	PERL_CALLCONV SV PerlIO_sv_dup(pTHX_ SV arg, CLONE_PARAMS *param);
	150	PERL_CALLCONV void PerlIO_cleantable(pTHX_ PerlIOl **tablep);
	151	PERL_CALLCONV SV * PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab);
	152	PERL_CALLCONV void PerlIO_default_buffer(pTHX_ PerlIO_list_t *av);
	153	PERL_CALLCONV void PerlIO_stdstreams(pTHX);
	154	PERL_CALLCONV int PerlIO__close(pTHX_ PerlIO *f);
	155	PERL_CALLCONV PerlIO_list_t * PerlIO_resolve_layers(pTHX_ const char layers, const char mode, int narg, SV **args);
	156	PERL_CALLCONV PerlIO_funcs * PerlIO_default_layer(pTHX_ I32 n);
	157	PERL_CALLCONV PerlIO_list_t * PerlIO_default_layers(pTHX);
	158	PERL_CALLCONV PerlIO * PerlIO_reopen(const char path, const char mode, PerlIO *f);
de009b76	159
fc6bde6f DD	160	PERL_CALLCONV PerlIO_list_t *PerlIO_list_alloc(pTHX);
	161	PERL_CALLCONV PerlIO_list_t PerlIO_clone_list(pTHX_ PerlIO_list_t proto, CLONE_PARAMS *param);
	162	PERL_CALLCONV void PerlIO_list_free(pTHX_ PerlIO_list_t *list);
	163	PERL_CALLCONV void PerlIO_list_push(pTHX_ PerlIO_list_t list, PerlIO_funcs funcs, SV *arg);
	164	PERL_CALLCONV void PerlIO_list_free(pTHX_ PerlIO_list_t *list);
e670910b JH	165
	166	/* PerlIO_teardown doesn't need exporting, but the EXTERN_C is needed
	167	* for compiling as C++. Must also match with what perl.h says. */
0934c9d9	168	EXTERN_C void PerlIO_teardown(void);
0c4128ad	169
76ced9ad	170	/--------------------------------------------------------------------------------------/
de009b76 AL	171	/* Generic, or stub layer functions */
de009b76 AL	172
fc6bde6f DD	173	PERL_CALLCONV IV PerlIOBase_binmode(pTHX_ PerlIO *f);
	174	PERL_CALLCONV void PerlIOBase_clearerr(pTHX_ PerlIO *f);
	175	PERL_CALLCONV IV PerlIOBase_close(pTHX_ PerlIO *f);
	176	PERL_CALLCONV PerlIO * PerlIOBase_dup(pTHX_ PerlIO f, PerlIO o, CLONE_PARAMS *param, int flags);
	177	PERL_CALLCONV IV PerlIOBase_eof(pTHX_ PerlIO *f);
	178	PERL_CALLCONV IV PerlIOBase_error(pTHX_ PerlIO *f);
	179	PERL_CALLCONV IV PerlIOBase_fileno(pTHX_ PerlIO *f);
	180	PERL_CALLCONV void PerlIOBase_flush_linebuf(pTHX);
	181	PERL_CALLCONV IV PerlIOBase_noop_fail(pTHX_ PerlIO *f);
	182	PERL_CALLCONV IV PerlIOBase_noop_ok(pTHX_ PerlIO *f);
	183	PERL_CALLCONV IV PerlIOBase_popped(pTHX_ PerlIO *f);
	184	PERL_CALLCONV IV PerlIOBase_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
	185	PERL_CALLCONV PerlIO * PerlIOBase_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);
	186	PERL_CALLCONV SSize_t PerlIOBase_read(pTHX_ PerlIO f, void vbuf, Size_t count);
	187	PERL_CALLCONV void PerlIOBase_setlinebuf(pTHX_ PerlIO *f);
	188	PERL_CALLCONV SSize_t PerlIOBase_unread(pTHX_ PerlIO f, const void vbuf, Size_t count);
de009b76 AL	189
de009b76 AL	190	/* Buf */
fc6bde6f DD	191	PERL_CALLCONV Size_t PerlIOBuf_bufsiz(pTHX_ PerlIO *f);
	192	PERL_CALLCONV IV PerlIOBuf_close(pTHX_ PerlIO *f);
	193	PERL_CALLCONV PerlIO * PerlIOBuf_dup(pTHX_ PerlIO f, PerlIO o, CLONE_PARAMS *param, int flags);
	194	PERL_CALLCONV IV PerlIOBuf_fill(pTHX_ PerlIO *f);
	195	PERL_CALLCONV IV PerlIOBuf_flush(pTHX_ PerlIO *f);
	196	PERL_CALLCONV STDCHAR * PerlIOBuf_get_base(pTHX_ PerlIO *f);
	197	PERL_CALLCONV SSize_t PerlIOBuf_get_cnt(pTHX_ PerlIO *f);
	198	PERL_CALLCONV STDCHAR * PerlIOBuf_get_ptr(pTHX_ PerlIO *f);
	199	PERL_CALLCONV 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);
	200	PERL_CALLCONV IV PerlIOBuf_popped(pTHX_ PerlIO *f);
	201	PERL_CALLCONV IV PerlIOBuf_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
	202	PERL_CALLCONV SSize_t PerlIOBuf_read(pTHX_ PerlIO f, void vbuf, Size_t count);
	203	PERL_CALLCONV IV PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
	204	PERL_CALLCONV void PerlIOBuf_set_ptrcnt(pTHX_ PerlIO f, STDCHAR ptr, SSize_t cnt);
	205	PERL_CALLCONV Off_t PerlIOBuf_tell(pTHX_ PerlIO *f);
	206	PERL_CALLCONV SSize_t PerlIOBuf_unread(pTHX_ PerlIO f, const void vbuf, Size_t count);
	207	PERL_CALLCONV SSize_t PerlIOBuf_write(pTHX_ PerlIO f, const void vbuf, Size_t count);
de009b76 AL	208
de009b76 AL	209	/* Crlf */
fc6bde6f DD	210	PERL_CALLCONV IV PerlIOCrlf_binmode(pTHX_ PerlIO *f);
	211	PERL_CALLCONV IV PerlIOCrlf_flush(pTHX_ PerlIO *f);
	212	PERL_CALLCONV SSize_t PerlIOCrlf_get_cnt(pTHX_ PerlIO *f);
	213	PERL_CALLCONV IV PerlIOCrlf_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
	214	PERL_CALLCONV void PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO f, STDCHAR ptr, SSize_t cnt);
	215	PERL_CALLCONV SSize_t PerlIOCrlf_unread(pTHX_ PerlIO f, const void vbuf, Size_t count);
	216	PERL_CALLCONV SSize_t PerlIOCrlf_write(pTHX_ PerlIO f, const void vbuf, Size_t count);
de009b76	217
de009b76	218	/* Pending */
fc6bde6f DD	219	PERL_CALLCONV IV PerlIOPending_close(pTHX_ PerlIO *f);
	220	PERL_CALLCONV IV PerlIOPending_fill(pTHX_ PerlIO *f);
	221	PERL_CALLCONV IV PerlIOPending_flush(pTHX_ PerlIO *f);
	222	PERL_CALLCONV IV PerlIOPending_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
	223	PERL_CALLCONV SSize_t PerlIOPending_read(pTHX_ PerlIO f, void vbuf, Size_t count);
	224	PERL_CALLCONV IV PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
	225	PERL_CALLCONV void PerlIOPending_set_ptrcnt(pTHX_ PerlIO f, STDCHAR ptr, SSize_t cnt);
de009b76 AL	226
de009b76 AL	227	/* Pop */
fc6bde6f	228	PERL_CALLCONV IV PerlIOPop_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
de009b76 AL	229
de009b76 AL	230	/* Raw */
fc6bde6f	231	PERL_CALLCONV IV PerlIORaw_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
de009b76 AL	232
de009b76 AL	233	/* Stdio */
fc6bde6f DD	234	PERL_CALLCONV void PerlIOStdio_clearerr(pTHX_ PerlIO *f);
	235	PERL_CALLCONV IV PerlIOStdio_close(pTHX_ PerlIO *f);
	236	PERL_CALLCONV PerlIO * PerlIOStdio_dup(pTHX_ PerlIO f, PerlIO o, CLONE_PARAMS *param, int flags);
	237	PERL_CALLCONV IV PerlIOStdio_eof(pTHX_ PerlIO *f);
	238	PERL_CALLCONV IV PerlIOStdio_error(pTHX_ PerlIO *f);
	239	PERL_CALLCONV IV PerlIOStdio_fileno(pTHX_ PerlIO *f);
15eb3045	240	#ifdef USE_STDIO_PTR
fc6bde6f DD	241	PERL_CALLCONV STDCHAR * PerlIOStdio_get_ptr(pTHX_ PerlIO *f);
	242	PERL_CALLCONV SSize_t PerlIOStdio_get_cnt(pTHX_ PerlIO *f);
	243	PERL_CALLCONV void PerlIOStdio_set_ptrcnt(pTHX_ PerlIO f, STDCHAR ptr, SSize_t cnt);
15eb3045	244	#endif
fc6bde6f DD	245	PERL_CALLCONV IV PerlIOStdio_fill(pTHX_ PerlIO *f);
fc6bde6f DD	246	PERL_CALLCONV IV PerlIOStdio_flush(pTHX_ PerlIO *f);
15eb3045	247	#ifdef FILE_base
fc6bde6f DD	248	PERL_CALLCONV STDCHAR * PerlIOStdio_get_base(pTHX_ PerlIO *f);
fc6bde6f DD	249	PERL_CALLCONV Size_t PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f);
15eb3045	250	#endif
fc6bde6f DD	251	PERL_CALLCONV char * PerlIOStdio_mode(const char mode, char tmode);
	252	PERL_CALLCONV PerlIO * PerlIOStdio_open(pTHX_ PerlIO_funcs self, PerlIO_list_t layers, IV n, const char mode, int fd, int imode, int perm, PerlIO f, int narg, SV **args);
	253	PERL_CALLCONV IV PerlIOStdio_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
	254	PERL_CALLCONV SSize_t PerlIOStdio_read(pTHX_ PerlIO f, void vbuf, Size_t count);
	255	PERL_CALLCONV IV PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
	256	PERL_CALLCONV void PerlIOStdio_setlinebuf(pTHX_ PerlIO *f);
	257	PERL_CALLCONV Off_t PerlIOStdio_tell(pTHX_ PerlIO *f);
	258	PERL_CALLCONV SSize_t PerlIOStdio_unread(pTHX_ PerlIO f, const void vbuf, Size_t count);
	259	PERL_CALLCONV SSize_t PerlIOStdio_write(pTHX_ PerlIO f, const void vbuf, Size_t count);
de009b76 AL	260
de009b76 AL	261	/* Unix */
fc6bde6f DD	262	PERL_CALLCONV IV PerlIOUnix_close(pTHX_ PerlIO *f);
	263	PERL_CALLCONV PerlIO * PerlIOUnix_dup(pTHX_ PerlIO f, PerlIO o, CLONE_PARAMS *param, int flags);
	264	PERL_CALLCONV IV PerlIOUnix_fileno(pTHX_ PerlIO *f);
	265	PERL_CALLCONV int PerlIOUnix_oflags(const char *mode);
	266	PERL_CALLCONV PerlIO * PerlIOUnix_open(pTHX_ PerlIO_funcs self, PerlIO_list_t layers, IV n, const char mode, int fd, int imode, int perm, PerlIO f, int narg, SV **args);
	267	PERL_CALLCONV IV PerlIOUnix_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
	268	PERL_CALLCONV SSize_t PerlIOUnix_read(pTHX_ PerlIO f, void vbuf, Size_t count);
	269	PERL_CALLCONV int PerlIOUnix_refcnt_dec(int fd);
	270	PERL_CALLCONV void PerlIOUnix_refcnt_inc(int fd);
	271	PERL_CALLCONV int PerlIOUnix_refcnt(int fd);
	272	PERL_CALLCONV IV PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
	273	PERL_CALLCONV Off_t PerlIOUnix_tell(pTHX_ PerlIO *f);
	274	PERL_CALLCONV SSize_t PerlIOUnix_write(pTHX_ PerlIO f, const void vbuf, Size_t count);
de009b76 AL	275
de009b76 AL	276	/* Utf8 */
fc6bde6f	277	PERL_CALLCONV IV PerlIOUtf8_pushed(pTHX_ PerlIO f, const char mode, SV arg, PerlIO_funcs tab);
76ced9ad	278
6a5bc5ac	279	#endif /* PERLIOL_H_ */
e9a8c099 MHM	280
e9a8c099 MHM	281	/*
14d04a33	282	* ex: set ts=8 sts=4 sw=4 et:
e9a8c099	283	*/