X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/4bb101f2758f169969171dfe6b70f68a406dcc1e..5a10328cd52e3a7a3fa9244dbc367ee439850cab:/perlio.h diff --git a/perlio.h b/perlio.h index 4d88439..d515020 100644 --- a/perlio.h +++ b/perlio.h @@ -1,59 +1,35 @@ /* perlio.h * * Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003, - * by Larry Wall and others + * 2004, 2005, 2006, 2007, by Larry Wall and others * * You may distribute under the terms of either the GNU General Public * License or the Artistic License, as specified in the README file. * */ -#ifndef _PERLIO_H -#define _PERLIO_H +#ifndef PERLIO_H_ +#define PERLIO_H_ /* Interface for perl to IO functions. - There is a hierachy of Configure determined #define controls: - USE_STDIO - forces PerlIO_xxx() to be #define-d onto stdio functions. - This is used for x2p subdirectory and for conservative - builds - "just like perl5.00X used to be". - This dominates over the others. + There is a hierarchy of Configure determined #define controls: + USE_STDIO - No longer available via Configure. Formerly forced + PerlIO_xxx() to be #define-d onto stdio functions. + Now generates compile-time error. USE_PERLIO - The primary Configure variable that enables PerlIO. - If USE_PERLIO is _NOT_ set - then USE_STDIO above will be set to be conservative. - If USE_PERLIO is set - then there are two modes determined by USE_SFIO: - - USE_SFIO - If set causes PerlIO_xxx() to be #define-d onto sfio functions. - A backward compatability mode for some specialist applications. - - If USE_SFIO is not set then PerlIO_xxx() are real functions + PerlIO_xxx() are real functions defined in perlio.c which implement extra functionality required for utf8 support. - One further note - the table-of-functions scheme controlled - by PERL_IMPLICIT_SYS turns on USE_PERLIO so that iperlsys.h can - #define PerlIO_xxx() to go via the function table, without having - to #undef them from (say) stdio forms. - */ -#if defined(PERL_IMPLICIT_SYS) -#ifndef USE_PERLIO -#ifndef NETWARE -/* # define USE_PERLIO */ -#endif -#endif -#endif - #ifndef USE_PERLIO # define USE_STDIO #endif #ifdef USE_STDIO -# ifndef PERLIO_IS_STDIO -# define PERLIO_IS_STDIO -# endif +# error "stdio is no longer supported as the default base layer -- use perlio." #endif /* -------------------- End of Configure controls ---------------------------- */ @@ -64,11 +40,6 @@ */ #include -#ifdef __BEOS__ -int fseeko(FILE *stream, off_t offset, int whence); -off_t ftello(FILE *stream); -#endif - #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64) #define ftell ftello #endif @@ -82,16 +53,6 @@ off_t ftello(FILE *stream); #undef O_BINARY #endif -#ifdef PERLIO_IS_STDIO -/* #define PerlIO_xxxx() as equivalent stdio function */ -#include "perlsdio.h" -#else /* PERLIO_IS_STDIO */ -#ifdef USE_SFIO -/* #define PerlIO_xxxx() as equivalent sfio function */ -#include "perlsfio.h" -#endif /* USE_SFIO */ -#endif /* PERLIO_IS_STDIO */ - #ifndef PerlIO /* ----------- PerlIO implementation ---------- */ /* PerlIO not #define-d to something else - define the implementation */ @@ -102,22 +63,31 @@ typedef PerlIOl *PerlIO; #define PerlIO PerlIO #define PERLIO_LAYERS 1 -extern void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab); -extern PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name, STRLEN len, - int load); -extern PerlIO *PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab, - const char *mode, SV *arg); -extern void PerlIO_pop(pTHX_ PerlIO *f); -extern AV* PerlIO_get_layers(pTHX_ PerlIO *f); -extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param); +/* PERLIO_FUNCS_CONST is now on by default for efficiency, PERLIO_FUNCS_CONST + can be removed 1 day once stable & then PerlIO vtables are permanently RO */ +#ifdef PERLIO_FUNCS_CONST +#define PERLIO_FUNCS_DECL(funcs) const PerlIO_funcs funcs +#define PERLIO_FUNCS_CAST(funcs) (PerlIO_funcs*)(funcs) +#else +#define PERLIO_FUNCS_DECL(funcs) PerlIO_funcs funcs +#define PERLIO_FUNCS_CAST(funcs) (funcs) +#endif + +PERL_CALLCONV void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab); +PERL_CALLCONV PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name, + STRLEN len, + int load); +PERL_CALLCONV PerlIO *PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), + const char *mode, SV *arg); +PERL_CALLCONV void PerlIO_pop(pTHX_ PerlIO *f); +PERL_CALLCONV AV* PerlIO_get_layers(pTHX_ PerlIO *f); +PERL_CALLCONV void PerlIO_clone(pTHX_ PerlInterpreter *proto, + CLONE_PARAMS *param); #endif /* PerlIO */ /* ----------- End of implementation choices ---------- */ -#ifndef PERLIO_IS_STDIO -/* Not using stdio _directly_ as PerlIO */ - /* We now need to determine what happens if source trys to use stdio. * There are three cases based on PERLIO_NOT_STDIO which XS code * can set how it wants. @@ -129,13 +99,13 @@ extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param); This is a known issue with some non UNIX ports which still use "native" stdio features. */ -#ifndef PERLIO_NOT_STDIO -#define PERLIO_NOT_STDIO 1 -#endif +# ifndef PERLIO_NOT_STDIO +# define PERLIO_NOT_STDIO 1 +# endif #else -#ifndef PERLIO_NOT_STDIO -#define PERLIO_NOT_STDIO 0 -#endif +# ifndef PERLIO_NOT_STDIO +# define PERLIO_NOT_STDIO 0 +# endif #endif #ifdef PERLIO_NOT_STDIO @@ -158,9 +128,6 @@ extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param); */ #include "fakesdio.h" #endif /* ifndef PERLIO_NOT_STDIO */ -#endif /* PERLIO_IS_STDIO */ - -#define specialCopIO(sv) ((sv) == Nullsv) /* ----------- fill in things that have not got #define'd ---------- */ @@ -177,6 +144,11 @@ extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param); #define BUFSIZ 1024 #endif +/* The default buffer size for the perlio buffering layer */ +#ifndef PERLIOBUF_DEFAULT_BUFSIZ +#define PERLIOBUF_DEFAULT_BUFSIZ (BUFSIZ > 8192 ? BUFSIZ : 8192) +#endif + #ifndef SEEK_SET #define SEEK_SET 0 #endif @@ -195,187 +167,177 @@ extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param); /* --------------------- Now prototypes for functions --------------- */ START_EXTERN_C -#ifndef NEXT30_NO_ATTRIBUTE -#ifndef HASATTRIBUTE /* disable GNU-cc attribute checking? */ -#ifdef __attribute__ /* Avoid possible redefinition errors */ -#undef __attribute__ -#endif -#define __attribute__(attr) -#endif +#ifndef __attribute__format__ +# ifdef HASATTRIBUTE_FORMAT +# define __attribute__format__(x,y,z) __attribute__((format(x,y,z))) +# else +# define __attribute__format__(x,y,z) +# endif #endif #ifndef PerlIO_init -extern void PerlIO_init(pTHX); +PERL_CALLCONV void PerlIO_init(pTHX); #endif #ifndef PerlIO_stdoutf -extern int PerlIO_stdoutf(const char *, ...) -#ifdef CHECK_FORMAT - __attribute__ ((__format__(__printf__, 1, 2))) -#endif -; +PERL_CALLCONV int PerlIO_stdoutf(const char *, ...) + __attribute__format__(__printf__, 1, 2); #endif #ifndef PerlIO_puts -extern int PerlIO_puts(PerlIO *, const char *); +PERL_CALLCONV int PerlIO_puts(PerlIO *, const char *); #endif #ifndef PerlIO_open -extern PerlIO *PerlIO_open(const char *, const char *); +PERL_CALLCONV PerlIO *PerlIO_open(const char *, const char *); #endif #ifndef PerlIO_openn -extern PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode, - int fd, int imode, int perm, PerlIO *old, - int narg, SV **arg); +PERL_CALLCONV PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode, + int fd, int imode, int perm, PerlIO *old, + int narg, SV **arg); #endif #ifndef PerlIO_eof -extern int PerlIO_eof(PerlIO *); +PERL_CALLCONV int PerlIO_eof(PerlIO *); #endif #ifndef PerlIO_error -extern int PerlIO_error(PerlIO *); +PERL_CALLCONV int PerlIO_error(PerlIO *); #endif #ifndef PerlIO_clearerr -extern void PerlIO_clearerr(PerlIO *); +PERL_CALLCONV void PerlIO_clearerr(PerlIO *); #endif #ifndef PerlIO_getc -extern int PerlIO_getc(PerlIO *); +PERL_CALLCONV int PerlIO_getc(PerlIO *); #endif #ifndef PerlIO_putc -extern int PerlIO_putc(PerlIO *, int); +PERL_CALLCONV int PerlIO_putc(PerlIO *, int); #endif #ifndef PerlIO_ungetc -extern int PerlIO_ungetc(PerlIO *, int); +PERL_CALLCONV int PerlIO_ungetc(PerlIO *, int); #endif #ifndef PerlIO_fdopen -extern PerlIO *PerlIO_fdopen(int, const char *); +PERL_CALLCONV PerlIO *PerlIO_fdopen(int, const char *); #endif #ifndef PerlIO_importFILE -extern PerlIO *PerlIO_importFILE(FILE *, const char *); +PERL_CALLCONV PerlIO *PerlIO_importFILE(FILE *, const char *); #endif #ifndef PerlIO_exportFILE -extern FILE *PerlIO_exportFILE(PerlIO *, const char *); +PERL_CALLCONV FILE *PerlIO_exportFILE(PerlIO *, const char *); #endif #ifndef PerlIO_findFILE -extern FILE *PerlIO_findFILE(PerlIO *); +PERL_CALLCONV FILE *PerlIO_findFILE(PerlIO *); #endif #ifndef PerlIO_releaseFILE -extern void PerlIO_releaseFILE(PerlIO *, FILE *); +PERL_CALLCONV void PerlIO_releaseFILE(PerlIO *, FILE *); #endif #ifndef PerlIO_read -extern SSize_t PerlIO_read(PerlIO *, void *, Size_t); +PERL_CALLCONV SSize_t PerlIO_read(PerlIO *, void *, Size_t); #endif #ifndef PerlIO_unread -extern SSize_t PerlIO_unread(PerlIO *, const void *, Size_t); +PERL_CALLCONV SSize_t PerlIO_unread(PerlIO *, const void *, Size_t); #endif #ifndef PerlIO_write -extern SSize_t PerlIO_write(PerlIO *, const void *, Size_t); +PERL_CALLCONV SSize_t PerlIO_write(PerlIO *, const void *, Size_t); #endif #ifndef PerlIO_setlinebuf -extern void PerlIO_setlinebuf(PerlIO *); +PERL_CALLCONV void PerlIO_setlinebuf(PerlIO *); #endif #ifndef PerlIO_printf -extern int PerlIO_printf(PerlIO *, const char *, ...) -#ifdef CHECK_FORMAT - __attribute__ ((__format__(__printf__, 2, 3))) -#endif -; -#endif -#ifndef PerlIO_sprintf -extern int PerlIO_sprintf(char *, int, const char *, ...) -#ifdef CHECK_FORMAT - __attribute__ ((__format__(__printf__, 3, 4))) -#endif -; +PERL_CALLCONV int PerlIO_printf(PerlIO *, const char *, ...) + __attribute__format__(__printf__, 2, 3); #endif #ifndef PerlIO_vprintf -extern int PerlIO_vprintf(PerlIO *, const char *, va_list); +PERL_CALLCONV int PerlIO_vprintf(PerlIO *, const char *, va_list); #endif #ifndef PerlIO_tell -extern Off_t PerlIO_tell(PerlIO *); +PERL_CALLCONV Off_t PerlIO_tell(PerlIO *); #endif #ifndef PerlIO_seek -extern int PerlIO_seek(PerlIO *, Off_t, int); +PERL_CALLCONV int PerlIO_seek(PerlIO *, Off_t, int); #endif #ifndef PerlIO_rewind -extern void PerlIO_rewind(PerlIO *); +PERL_CALLCONV void PerlIO_rewind(PerlIO *); #endif #ifndef PerlIO_has_base -extern int PerlIO_has_base(PerlIO *); +PERL_CALLCONV int PerlIO_has_base(PerlIO *); #endif #ifndef PerlIO_has_cntptr -extern int PerlIO_has_cntptr(PerlIO *); +PERL_CALLCONV int PerlIO_has_cntptr(PerlIO *); #endif #ifndef PerlIO_fast_gets -extern int PerlIO_fast_gets(PerlIO *); +PERL_CALLCONV int PerlIO_fast_gets(PerlIO *); #endif #ifndef PerlIO_canset_cnt -extern int PerlIO_canset_cnt(PerlIO *); +PERL_CALLCONV int PerlIO_canset_cnt(PerlIO *); #endif #ifndef PerlIO_get_ptr -extern STDCHAR *PerlIO_get_ptr(PerlIO *); +PERL_CALLCONV STDCHAR *PerlIO_get_ptr(PerlIO *); #endif #ifndef PerlIO_get_cnt -extern int PerlIO_get_cnt(PerlIO *); +PERL_CALLCONV SSize_t PerlIO_get_cnt(PerlIO *); #endif #ifndef PerlIO_set_cnt -extern void PerlIO_set_cnt(PerlIO *, int); +PERL_CALLCONV void PerlIO_set_cnt(PerlIO *, SSize_t); #endif #ifndef PerlIO_set_ptrcnt -extern void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, int); +PERL_CALLCONV void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, SSize_t); #endif #ifndef PerlIO_get_base -extern STDCHAR *PerlIO_get_base(PerlIO *); +PERL_CALLCONV STDCHAR *PerlIO_get_base(PerlIO *); #endif #ifndef PerlIO_get_bufsiz -extern int PerlIO_get_bufsiz(PerlIO *); +PERL_CALLCONV SSize_t PerlIO_get_bufsiz(PerlIO *); #endif #ifndef PerlIO_tmpfile -extern PerlIO *PerlIO_tmpfile(void); +PERL_CALLCONV PerlIO *PerlIO_tmpfile(void); #endif #ifndef PerlIO_stdin -extern PerlIO *PerlIO_stdin(void); +PERL_CALLCONV PerlIO *PerlIO_stdin(void); #endif #ifndef PerlIO_stdout -extern PerlIO *PerlIO_stdout(void); +PERL_CALLCONV PerlIO *PerlIO_stdout(void); #endif #ifndef PerlIO_stderr -extern PerlIO *PerlIO_stderr(void); +PERL_CALLCONV PerlIO *PerlIO_stderr(void); #endif #ifndef PerlIO_getpos -extern int PerlIO_getpos(PerlIO *, SV *); +PERL_CALLCONV int PerlIO_getpos(PerlIO *, SV *); #endif #ifndef PerlIO_setpos -extern int PerlIO_setpos(PerlIO *, SV *); +PERL_CALLCONV int PerlIO_setpos(PerlIO *, SV *); #endif #ifndef PerlIO_fdupopen -extern PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int); +PERL_CALLCONV PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int); #endif -#if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO) -extern char *PerlIO_modestr(PerlIO *, char *buf); +#if !defined(PerlIO_modestr) +PERL_CALLCONV char *PerlIO_modestr(PerlIO *, char *buf); #endif #ifndef PerlIO_isutf8 -extern int PerlIO_isutf8(PerlIO *); +PERL_CALLCONV int PerlIO_isutf8(PerlIO *); #endif #ifndef PerlIO_apply_layers -extern int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, - const char *names); +PERL_CALLCONV int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, + const char *names); #endif #ifndef PerlIO_binmode -extern int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode, - const char *names); +PERL_CALLCONV int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode, + const char *names); #endif #ifndef PerlIO_getname -extern char *PerlIO_getname(PerlIO *, char *); +PERL_CALLCONV char *PerlIO_getname(PerlIO *, char *); #endif -extern void PerlIO_destruct(pTHX); +PERL_CALLCONV void PerlIO_destruct(pTHX); -extern int PerlIO_intmode2str(int rawmode, char *mode, int *writing); +PERL_CALLCONV int PerlIO_intmode2str(int rawmode, char *mode, int *writing); #ifdef PERLIO_LAYERS -extern void PerlIO_cleanup(pTHX); +PERL_CALLCONV void PerlIO_cleanup(pTHX); -extern void PerlIO_debug(const char *fmt, ...); +PERL_CALLCONV void PerlIO_debug(const char *fmt, ...) + __attribute__format__(__printf__, 1, 2); typedef struct PerlIO_list_s PerlIO_list_t; - #endif END_EXTERN_C -#endif /* _PERLIO_H */ +#endif /* PERLIO_H_ */ + +/* + * ex: set ts=8 sts=4 sw=4 et: + */