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
  97 #endif                          /* PerlIO */
  98
  99 /* ----------- End of implementation choices  ---------- */
 100
 101 #ifndef PERLIO_IS_STDIO
 102 /* Not using stdio _directly_ as PerlIO */
 103
 104 /* We now need to determine  what happens if source trys to use stdio.
 105  * There are three cases based on PERLIO_NOT_STDIO which XS code
 106  * can set how it wants.
 107  */
 108
 109 #ifdef PERL_CORE
 110 /* Make a choice for perl core code
 111    - currently this is set to try and catch lingering raw stdio calls.
 112      This is a known issue with some non UNIX ports which still use
 113      "native" stdio features.
 114 */
 115 #ifndef PERLIO_NOT_STDIO
 116 #define PERLIO_NOT_STDIO 1
 117 #endif
 118 #else
 119 #ifndef PERLIO_NOT_STDIO
 120 #define PERLIO_NOT_STDIO 0
 121 #endif
 122 #endif
 123
 124 #ifdef PERLIO_NOT_STDIO
 125 #if PERLIO_NOT_STDIO
 126 /*
 127  * PERLIO_NOT_STDIO #define'd as 1
 128  * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
 129  */
 130 #include "nostdio.h"
 131 #else                           /* if PERLIO_NOT_STDIO */
 132 /*
 133  * PERLIO_NOT_STDIO #define'd as 0
 134  * Case 2: Declares that both PerlIO and stdio can be used
 135  */
 136 #endif                          /* if PERLIO_NOT_STDIO */
 137 #else                           /* ifdef PERLIO_NOT_STDIO */
 138 /*
 139  * PERLIO_NOT_STDIO not defined
 140  * Case 3: Try and fake stdio calls as PerlIO calls
 141  */
 142 #include "fakesdio.h"
 143 #endif                          /* ifndef PERLIO_NOT_STDIO */
 144 #endif                          /* PERLIO_IS_STDIO */
 145
 146 #define specialCopIO(sv) ((sv) != Nullsv)
 147
 148 /* ----------- fill in things that have not got #define'd  ---------- */
 149
 150 #ifndef Fpos_t
 151 #define Fpos_t Off_t
 152 #endif
 153
 154 #ifndef EOF
 155 #define EOF (-1)
 156 #endif
 157
 158 /* This is to catch case with no stdio */
 159 #ifndef BUFSIZ
 160 #define BUFSIZ 1024
 161 #endif
 162
 163 #ifndef SEEK_SET
 164 #define SEEK_SET 0
 165 #endif
 166
 167 #ifndef SEEK_CUR
 168 #define SEEK_CUR 1
 169 #endif
 170
 171 #ifndef SEEK_END
 172 #define SEEK_END 2
 173 #endif
 174
 175 /* --------------------- Now prototypes for functions --------------- */
 176
 177 START_EXTERN_C
 178 #ifndef NEXT30_NO_ATTRIBUTE
 179 #ifndef HASATTRIBUTE            /* disable GNU-cc attribute checking? */
 180 #ifdef  __attribute__           /* Avoid possible redefinition errors */
 181 #undef  __attribute__
 182 #endif
 183 #define __attribute__(attr)
 184 #endif
 185 #endif
 186 #ifndef PerlIO_init
 187 extern void PerlIO_init(void);
 188 #endif
 189 #ifndef PerlIO_stdoutf
 190 extern int PerlIO_stdoutf(const char *, ...)
 191     __attribute__ ((__format__(__printf__, 1, 2)));
 192 #endif
 193 #ifndef PerlIO_puts
 194 extern int PerlIO_puts(PerlIO *, const char *);
 195 #endif
 196 #ifndef PerlIO_open
 197 extern PerlIO *PerlIO_open(const char *, const char *);
 198 #endif
 199 #ifndef PerlIO_openn
 200 extern PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode,
 201                             int fd, int imode, int perm, PerlIO *old,
 202                             int narg, SV **arg);
 203 #endif
 204 #ifndef PerlIO_close
 205 extern int PerlIO_close(PerlIO *);
 206 #endif
 207 #ifndef PerlIO_eof
 208 extern int PerlIO_eof(PerlIO *);
 209 #endif
 210 #ifndef PerlIO_error
 211 extern int PerlIO_error(PerlIO *);
 212 #endif
 213 #ifndef PerlIO_clearerr
 214 extern void PerlIO_clearerr(PerlIO *);
 215 #endif
 216 #ifndef PerlIO_getc
 217 extern int PerlIO_getc(PerlIO *);
 218 #endif
 219 #ifndef PerlIO_putc
 220 extern int PerlIO_putc(PerlIO *, int);
 221 #endif
 222 #ifndef PerlIO_flush
 223 extern int PerlIO_flush(PerlIO *);
 224 #endif
 225 #ifndef PerlIO_ungetc
 226 extern int PerlIO_ungetc(PerlIO *, int);
 227 #endif
 228 #ifndef PerlIO_fileno
 229 extern int PerlIO_fileno(PerlIO *);
 230 #endif
 231 #ifndef PerlIO_fdopen
 232 extern PerlIO *PerlIO_fdopen(int, const char *);
 233 #endif
 234 #ifndef PerlIO_importFILE
 235 extern PerlIO *PerlIO_importFILE(FILE *, int);
 236 #endif
 237 #ifndef PerlIO_exportFILE
 238 extern FILE *PerlIO_exportFILE(PerlIO *, int);
 239 #endif
 240 #ifndef PerlIO_findFILE
 241 extern FILE *PerlIO_findFILE(PerlIO *);
 242 #endif
 243 #ifndef PerlIO_releaseFILE
 244 extern void PerlIO_releaseFILE(PerlIO *, FILE *);
 245 #endif
 246 #ifndef PerlIO_read
 247 extern SSize_t PerlIO_read(PerlIO *, void *, Size_t);
 248 #endif
 249 #ifndef PerlIO_unread
 250 extern SSize_t PerlIO_unread(PerlIO *, const void *, Size_t);
 251 #endif
 252 #ifndef PerlIO_write
 253 extern SSize_t PerlIO_write(PerlIO *, const void *, Size_t);
 254 #endif
 255 #ifndef PerlIO_setlinebuf
 256 extern void PerlIO_setlinebuf(PerlIO *);
 257 #endif
 258 #ifndef PerlIO_printf
 259 extern int PerlIO_printf(PerlIO *, const char *, ...)
 260     __attribute__ ((__format__(__printf__, 2, 3)));
 261 #endif
 262 #ifndef PerlIO_sprintf
 263 extern int PerlIO_sprintf(char *, int, const char *, ...)
 264     __attribute__ ((__format__(__printf__, 3, 4)));
 265 #endif
 266 #ifndef PerlIO_vprintf
 267 extern int PerlIO_vprintf(PerlIO *, const char *, va_list);
 268 #endif
 269 #ifndef PerlIO_tell
 270 extern Off_t PerlIO_tell(PerlIO *);
 271 #endif
 272 #ifndef PerlIO_seek
 273 extern int PerlIO_seek(PerlIO *, Off_t, int);
 274 #endif
 275 #ifndef PerlIO_rewind
 276 extern void PerlIO_rewind(PerlIO *);
 277 #endif
 278 #ifndef PerlIO_has_base
 279 extern int PerlIO_has_base(PerlIO *);
 280 #endif
 281 #ifndef PerlIO_has_cntptr
 282 extern int PerlIO_has_cntptr(PerlIO *);
 283 #endif
 284 #ifndef PerlIO_fast_gets
 285 extern int PerlIO_fast_gets(PerlIO *);
 286 #endif
 287 #ifndef PerlIO_canset_cnt
 288 extern int PerlIO_canset_cnt(PerlIO *);
 289 #endif
 290 #ifndef PerlIO_get_ptr
 291 extern STDCHAR *PerlIO_get_ptr(PerlIO *);
 292 #endif
 293 #ifndef PerlIO_get_cnt
 294 extern int PerlIO_get_cnt(PerlIO *);
 295 #endif
 296 #ifndef PerlIO_set_cnt
 297 extern void PerlIO_set_cnt(PerlIO *, int);
 298 #endif
 299 #ifndef PerlIO_set_ptrcnt
 300 extern void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, int);
 301 #endif
 302 #ifndef PerlIO_get_base
 303 extern STDCHAR *PerlIO_get_base(PerlIO *);
 304 #endif
 305 #ifndef PerlIO_get_bufsiz
 306 extern int PerlIO_get_bufsiz(PerlIO *);
 307 #endif
 308 #ifndef PerlIO_tmpfile
 309 extern PerlIO *PerlIO_tmpfile(void);
 310 #endif
 311 #ifndef PerlIO_stdin
 312 extern PerlIO *PerlIO_stdin(void);
 313 #endif
 314 #ifndef PerlIO_stdout
 315 extern PerlIO *PerlIO_stdout(void);
 316 #endif
 317 #ifndef PerlIO_stderr
 318 extern PerlIO *PerlIO_stderr(void);
 319 #endif
 320 #ifndef PerlIO_getpos
 321 extern int PerlIO_getpos(PerlIO *, SV *);
 322 #endif
 323 #ifndef PerlIO_setpos
 324 extern int PerlIO_setpos(PerlIO *, SV *);
 325 #endif
 326 #ifndef PerlIO_fdupopen
 327 extern PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *);
 328 #endif
 329 #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
 330 extern char *PerlIO_modestr(PerlIO *, char *buf);
 331 #endif
 332 #ifndef PerlIO_isutf8
 333 extern int PerlIO_isutf8(PerlIO *);
 334 #endif
 335 #ifndef PerlIO_apply_layers
 336 extern int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
 337                                const char *names);
 338 #endif
 339 #ifndef PerlIO_binmode
 340 extern int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode,
 341                           const char *names);
 342 #endif
 343 #ifndef PerlIO_getname
 344 extern char *PerlIO_getname(PerlIO *, char *);
 345 #endif
 346
 347 extern void PerlIO_destruct(pTHX);
 348
 349 #ifndef PERLIO_IS_STDIO
 350
 351 extern void PerlIO_cleanup(void);
 352
 353 extern void PerlIO_debug(const char *fmt, ...);
 354
 355 #endif
 356
 357 END_EXTERN_C
 358 #endif                          /* _PERLIO_H */