perlio.h

   1 #ifndef _PERLIO_H
   2 #define _PERLIO_H
   3 /*
   4   Interface for perl to IO functions.
   5   There is a hierachy of Configure determined #define controls:
   6    USE_STDIO   - forces PerlIO_xxx() to be #define-d onto stdio functions.
   7                  This is used for x2p subdirectory and for conservative
   8                  builds - "just like perl5.00X used to be".
   9                  This dominates over the others.
  10
  11    USE_PERLIO  - The primary Configure variable that enables PerlIO.
  12                  If USE_PERLIO is _NOT_ set
  13                    then USE_STDIO above will be set to be conservative.
  14                  If USE_PERLIO is set
  15                    then there are two modes determined by USE_SFIO:
  16
  17    USE_SFIO    - If set causes PerlIO_xxx() to be #define-d onto sfio functions.
  18                  A backward compatability mode for some specialist applications.
  19
  20                  If USE_SFIO is not set then PerlIO_xxx() are real functions
  21                  defined in perlio.c which implement extra functionality
  22                  required for utf8 support.
  23
  24    One further note - the table-of-functions scheme controlled
  25    by PERL_IMPLICIT_SYS turns on USE_PERLIO so that iperlsys.h can
  26    #define PerlIO_xxx() to go via the function table, without having
  27    to #undef them from (say) stdio forms.
  28
  29 */
  30
  31 #if defined(PERL_IMPLICIT_SYS)
  32 #ifndef USE_PERLIO
  33 #ifndef NETWARE
  34 # define USE_PERLIO
  35 #endif
  36 #endif
  37 #endif
  38
  39 #ifndef USE_PERLIO
  40 # define USE_STDIO
  41 #endif
  42
  43 #ifdef USE_STDIO
  44 #  ifndef PERLIO_IS_STDIO
  45 #      define PERLIO_IS_STDIO
  46 #  endif
  47 #endif
  48
  49 /* --------------------  End of Configure controls ---------------------------- */
  50
  51 /*
  52  * Although we may not want stdio to be used including <stdio.h> here
  53  * avoids issues where stdio.h has strange side effects
  54  */
  55 #include <stdio.h>
  56
  57 #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
  58 #define ftell ftello
  59 #endif
  60
  61 #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
  62 #define fseek fseeko
  63 #endif
  64
  65 /* BS2000 includes are sometimes a bit non standard :-( */
  66 #if defined(POSIX_BC) && defined(O_BINARY) && !defined(O_TEXT)
  67 #undef O_BINARY
  68 #endif
  69
  70 #ifdef PERLIO_IS_STDIO
  71 /* #define PerlIO_xxxx() as equivalent stdio function */
  72 #include "perlsdio.h"
  73 #else                           /* PERLIO_IS_STDIO */
  74 #ifdef USE_SFIO
  75 /* #define PerlIO_xxxx() as equivalent sfio function */
  76 #include "perlsfio.h"
  77 #endif                          /* USE_SFIO */
  78 #endif                          /* PERLIO_IS_STDIO */
  79
  80 #ifndef PerlIO
  81 /* ----------- PerlIO implementation ---------- */
  82 /* PerlIO not #define-d to something else - define the implementation */
  83
  84 typedef struct _PerlIO PerlIOl;
  85 typedef struct _PerlIO_funcs PerlIO_funcs;
  86 typedef PerlIOl *PerlIO;
  87 #define PerlIO PerlIO
  88 #define PERLIO_LAYERS 1
  89
  90 extern void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab);
  91 extern PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name, STRLEN len,
  92                                        int load);
  93 extern PerlIO *PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab,
  94                            const char *mode, SV *arg);
  95 extern void PerlIO_pop(pTHX_ PerlIO *f);
  96 extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param);
  97
  98 #endif                          /* PerlIO */
  99
 100 /* ----------- End of implementation choices  ---------- */
 101
 102 #ifndef PERLIO_IS_STDIO
 103 /* Not using stdio _directly_ as PerlIO */
 104
 105 /* We now need to determine  what happens if source trys to use stdio.
 106  * There are three cases based on PERLIO_NOT_STDIO which XS code
 107  * can set how it wants.
 108  */
 109
 110 #ifdef PERL_CORE
 111 /* Make a choice for perl core code
 112    - currently this is set to try and catch lingering raw stdio calls.
 113      This is a known issue with some non UNIX ports which still use
 114      "native" stdio features.
 115 */
 116 #ifndef PERLIO_NOT_STDIO
 117 #define PERLIO_NOT_STDIO 1
 118 #endif
 119 #else
 120 #ifndef PERLIO_NOT_STDIO
 121 #define PERLIO_NOT_STDIO 0
 122 #endif
 123 #endif
 124
 125 #ifdef PERLIO_NOT_STDIO
 126 #if PERLIO_NOT_STDIO
 127 /*
 128  * PERLIO_NOT_STDIO #define'd as 1
 129  * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
 130  */
 131 #include "nostdio.h"
 132 #else                           /* if PERLIO_NOT_STDIO */
 133 /*
 134  * PERLIO_NOT_STDIO #define'd as 0
 135  * Case 2: Declares that both PerlIO and stdio can be used
 136  */
 137 #endif                          /* if PERLIO_NOT_STDIO */
 138 #else                           /* ifdef PERLIO_NOT_STDIO */
 139 /*
 140  * PERLIO_NOT_STDIO not defined
 141  * Case 3: Try and fake stdio calls as PerlIO calls
 142  */
 143 #include "fakesdio.h"
 144 #endif                          /* ifndef PERLIO_NOT_STDIO */
 145 #endif                          /* PERLIO_IS_STDIO */
 146
 147 #define specialCopIO(sv) ((sv) != Nullsv)
 148
 149 /* ----------- fill in things that have not got #define'd  ---------- */
 150
 151 #ifndef Fpos_t
 152 #define Fpos_t Off_t
 153 #endif
 154
 155 #ifndef EOF
 156 #define EOF (-1)
 157 #endif
 158
 159 /* This is to catch case with no stdio */
 160 #ifndef BUFSIZ
 161 #define BUFSIZ 1024
 162 #endif
 163
 164 #ifndef SEEK_SET
 165 #define SEEK_SET 0
 166 #endif
 167
 168 #ifndef SEEK_CUR
 169 #define SEEK_CUR 1
 170 #endif
 171
 172 #ifndef SEEK_END
 173 #define SEEK_END 2
 174 #endif
 175
 176 /* --------------------- Now prototypes for functions --------------- */
 177
 178 START_EXTERN_C
 179 #ifndef NEXT30_NO_ATTRIBUTE
 180 #ifndef HASATTRIBUTE            /* disable GNU-cc attribute checking? */
 181 #ifdef  __attribute__           /* Avoid possible redefinition errors */
 182 #undef  __attribute__
 183 #endif
 184 #define __attribute__(attr)
 185 #endif
 186 #endif
 187 #ifndef PerlIO_init
 188 extern void PerlIO_init(pTHX);
 189 #endif
 190 #ifndef PerlIO_stdoutf
 191 extern int PerlIO_stdoutf(const char *, ...)
 192     __attribute__ ((__format__(__printf__, 1, 2)));
 193 #endif
 194 #ifndef PerlIO_puts
 195 extern int PerlIO_puts(PerlIO *, const char *);
 196 #endif
 197 #ifndef PerlIO_open
 198 extern PerlIO *PerlIO_open(const char *, const char *);
 199 #endif
 200 #ifndef PerlIO_openn
 201 extern PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode,
 202                             int fd, int imode, int perm, PerlIO *old,
 203                             int narg, SV **arg);
 204 #endif
 205 #ifndef PerlIO_close
 206 extern int PerlIO_close(PerlIO *);
 207 #endif
 208 #ifndef PerlIO_eof
 209 extern int PerlIO_eof(PerlIO *);
 210 #endif
 211 #ifndef PerlIO_error
 212 extern int PerlIO_error(PerlIO *);
 213 #endif
 214 #ifndef PerlIO_clearerr
 215 extern void PerlIO_clearerr(PerlIO *);
 216 #endif
 217 #ifndef PerlIO_getc
 218 extern int PerlIO_getc(PerlIO *);
 219 #endif
 220 #ifndef PerlIO_putc
 221 extern int PerlIO_putc(PerlIO *, int);
 222 #endif
 223 #ifndef PerlIO_flush
 224 extern int PerlIO_flush(PerlIO *);
 225 #endif
 226 #ifndef PerlIO_ungetc
 227 extern int PerlIO_ungetc(PerlIO *, int);
 228 #endif
 229 #ifndef PerlIO_fileno
 230 extern int PerlIO_fileno(PerlIO *);
 231 #endif
 232 #ifndef PerlIO_fdopen
 233 extern PerlIO *PerlIO_fdopen(int, const char *);
 234 #endif
 235 #ifndef PerlIO_importFILE
 236 extern PerlIO *PerlIO_importFILE(FILE *, int);
 237 #endif
 238 #ifndef PerlIO_exportFILE
 239 extern FILE *PerlIO_exportFILE(PerlIO *, int);
 240 #endif
 241 #ifndef PerlIO_findFILE
 242 extern FILE *PerlIO_findFILE(PerlIO *);
 243 #endif
 244 #ifndef PerlIO_releaseFILE
 245 extern void PerlIO_releaseFILE(PerlIO *, FILE *);
 246 #endif
 247 #ifndef PerlIO_read
 248 extern SSize_t PerlIO_read(PerlIO *, void *, Size_t);
 249 #endif
 250 #ifndef PerlIO_unread
 251 extern SSize_t PerlIO_unread(PerlIO *, const void *, Size_t);
 252 #endif
 253 #ifndef PerlIO_write
 254 extern SSize_t PerlIO_write(PerlIO *, const void *, Size_t);
 255 #endif
 256 #ifndef PerlIO_setlinebuf
 257 extern void PerlIO_setlinebuf(PerlIO *);
 258 #endif
 259 #ifndef PerlIO_printf
 260 extern int PerlIO_printf(PerlIO *, const char *, ...)
 261     __attribute__ ((__format__(__printf__, 2, 3)));
 262 #endif
 263 #ifndef PerlIO_sprintf
 264 extern int PerlIO_sprintf(char *, int, const char *, ...)
 265     __attribute__ ((__format__(__printf__, 3, 4)));
 266 #endif
 267 #ifndef PerlIO_vprintf
 268 extern int PerlIO_vprintf(PerlIO *, const char *, va_list);
 269 #endif
 270 #ifndef PerlIO_tell
 271 extern Off_t PerlIO_tell(PerlIO *);
 272 #endif
 273 #ifndef PerlIO_seek
 274 extern int PerlIO_seek(PerlIO *, Off_t, int);
 275 #endif
 276 #ifndef PerlIO_rewind
 277 extern void PerlIO_rewind(PerlIO *);
 278 #endif
 279 #ifndef PerlIO_has_base
 280 extern int PerlIO_has_base(PerlIO *);
 281 #endif
 282 #ifndef PerlIO_has_cntptr
 283 extern int PerlIO_has_cntptr(PerlIO *);
 284 #endif
 285 #ifndef PerlIO_fast_gets
 286 extern int PerlIO_fast_gets(PerlIO *);
 287 #endif
 288 #ifndef PerlIO_canset_cnt
 289 extern int PerlIO_canset_cnt(PerlIO *);
 290 #endif
 291 #ifndef PerlIO_get_ptr
 292 extern STDCHAR *PerlIO_get_ptr(PerlIO *);
 293 #endif
 294 #ifndef PerlIO_get_cnt
 295 extern int PerlIO_get_cnt(PerlIO *);
 296 #endif
 297 #ifndef PerlIO_set_cnt
 298 extern void PerlIO_set_cnt(PerlIO *, int);
 299 #endif
 300 #ifndef PerlIO_set_ptrcnt
 301 extern void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, int);
 302 #endif
 303 #ifndef PerlIO_get_base
 304 extern STDCHAR *PerlIO_get_base(PerlIO *);
 305 #endif
 306 #ifndef PerlIO_get_bufsiz
 307 extern int PerlIO_get_bufsiz(PerlIO *);
 308 #endif
 309 #ifndef PerlIO_tmpfile
 310 extern PerlIO *PerlIO_tmpfile(void);
 311 #endif
 312 #ifndef PerlIO_stdin
 313 extern PerlIO *PerlIO_stdin(void);
 314 #endif
 315 #ifndef PerlIO_stdout
 316 extern PerlIO *PerlIO_stdout(void);
 317 #endif
 318 #ifndef PerlIO_stderr
 319 extern PerlIO *PerlIO_stderr(void);
 320 #endif
 321 #ifndef PerlIO_getpos
 322 extern int PerlIO_getpos(PerlIO *, SV *);
 323 #endif
 324 #ifndef PerlIO_setpos
 325 extern int PerlIO_setpos(PerlIO *, SV *);
 326 #endif
 327 #ifndef PerlIO_fdupopen
 328 extern PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *);
 329 #endif
 330 #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
 331 extern char *PerlIO_modestr(PerlIO *, char *buf);
 332 #endif
 333 #ifndef PerlIO_isutf8
 334 extern int PerlIO_isutf8(PerlIO *);
 335 #endif
 336 #ifndef PerlIO_apply_layers
 337 extern int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
 338                                const char *names);
 339 #endif
 340 #ifndef PerlIO_binmode
 341 extern int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode,
 342                           const char *names);
 343 #endif
 344 #ifndef PerlIO_getname
 345 extern char *PerlIO_getname(PerlIO *, char *);
 346 #endif
 347
 348 extern void PerlIO_destruct(pTHX);
 349
 350 extern int PerlIO_intmode2str(int rawmode, char *mode, int *writing);
 351
 352 #ifdef PERLIO_LAYERS
 353 extern void PerlIO_cleanup(pTHX);
 354
 355 extern void PerlIO_debug(const char *fmt, ...);
 356 typedef struct PerlIO_list_s PerlIO_list_t;
 357
 358
 359 #endif
 360
 361 END_EXTERN_C
 362 #endif                          /* _PERLIO_H */