perlio.h

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