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 # define USE_PERLIO
  34 #endif
  35 #endif
  36
  37 #ifndef USE_PERLIO
  38 # define USE_STDIO
  39 #endif
  40
  41 #ifdef USE_STDIO
  42 #  ifndef PERLIO_IS_STDIO
  43 #      define PERLIO_IS_STDIO
  44 #  endif
  45 #endif
  46
  47 /* --------------------  End of Configure controls ---------------------------- */
  48
  49 /*
  50  * Although we may not want stdio to be used including <stdio.h> here
  51  * avoids issues where stdio.h has strange side effects
  52  */
  53 #include <stdio.h>
  54
  55 #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
  56 #define ftell ftello
  57 #endif
  58
  59 #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
  60 #define fseek fseeko
  61 #endif
  62
  63 #ifdef PERLIO_IS_STDIO
  64 /* #define PerlIO_xxxx() as equivalent stdio function */
  65 #include "perlsdio.h"
  66 #else  /* PERLIO_IS_STDIO */
  67 #ifdef USE_SFIO
  68 /* #define PerlIO_xxxx() as equivalent sfio function */
  69 #include "perlsfio.h"
  70 #endif /* USE_SFIO */
  71 #endif /* PERLIO_IS_STDIO */
  72
  73 #ifndef PerlIO
  74 /* ----------- PerlIO implementation ---------- */
  75 /* PerlIO not #define-d to something else - define the implementation */
  76
  77 typedef struct _PerlIO PerlIOl;
  78 typedef struct _PerlIO_funcs PerlIO_funcs;
  79 typedef PerlIOl *PerlIO;
  80 #define PerlIO PerlIO
  81 #define PERLIO_LAYERS 1
  82
  83 extern void     PerlIO_define_layer     (PerlIO_funcs *tab);
  84 extern SV *     PerlIO_find_layer       (const char *name, STRLEN len);
  85 extern PerlIO * PerlIO_push             (PerlIO *f,PerlIO_funcs *tab,const char *mode,const char *arg,STRLEN len);
  86 extern void     PerlIO_pop              (PerlIO *f);
  87
  88 #endif /* PerlIO */
  89
  90 /* ----------- End of implementation choices  ---------- */
  91
  92 #ifndef PERLIO_IS_STDIO
  93 /* Not using stdio _directly_ as PerlIO */
  94
  95 /* We now need to determine  what happens if source trys to use stdio.
  96  * There are three cases based on PERLIO_NOT_STDIO which XS code
  97  * can set how it wants.
  98  */
  99
 100 #ifdef PERL_CORE
 101 /* Make a choice for perl core code
 102    - currently this is set to try and catch lingering raw stdio calls.
 103      This is a known issue with some non UNIX ports which still use
 104      "native" stdio features.
 105 */
 106 #ifndef PERLIO_NOT_STDIO
 107 #define PERLIO_NOT_STDIO 1
 108 #endif
 109 #endif
 110
 111 #ifdef PERLIO_NOT_STDIO
 112 #if PERLIO_NOT_STDIO
 113 /*
 114  * PERLIO_NOT_STDIO #define'd as 1
 115  * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
 116  */
 117 #include "nostdio.h"
 118 #else /* if PERLIO_NOT_STDIO */
 119 /*
 120  * PERLIO_NOT_STDIO #define'd as 0
 121  * Case 2: Declares that both PerlIO and stdio can be used
 122  */
 123 #endif /* if PERLIO_NOT_STDIO */
 124 #else  /* ifdef PERLIO_NOT_STDIO */
 125 /*
 126  * PERLIO_NOT_STDIO not defined
 127  * Case 3: Try and fake stdio calls as PerlIO calls
 128  */
 129 #include "fakesdio.h"
 130 #endif /* ifndef PERLIO_NOT_STDIO */
 131 #endif /* PERLIO_IS_STDIO */
 132
 133 #define specialCopIO(sv) ((sv) != Nullsv)
 134
 135 /* ----------- fill in things that have not got #define'd  ---------- */
 136
 137 #ifndef Fpos_t
 138 #define Fpos_t Off_t
 139 #endif
 140
 141 #ifndef EOF
 142 #define EOF (-1)
 143 #endif
 144
 145 /* This is to catch case with no stdio */
 146 #ifndef BUFSIZ
 147 #define BUFSIZ 1024
 148 #endif
 149
 150 #ifndef SEEK_SET
 151 #define SEEK_SET 0
 152 #endif
 153
 154 #ifndef SEEK_CUR
 155 #define SEEK_CUR 1
 156 #endif
 157
 158 #ifndef SEEK_END
 159 #define SEEK_END 2
 160 #endif
 161
 162 /* --------------------- Now prototypes for functions --------------- */
 163
 164 START_EXTERN_C
 165
 166 #ifndef NEXT30_NO_ATTRIBUTE
 167 #ifndef HASATTRIBUTE       /* disable GNU-cc attribute checking? */
 168 #ifdef  __attribute__      /* Avoid possible redefinition errors */
 169 #undef  __attribute__
 170 #endif
 171 #define __attribute__(attr)
 172 #endif
 173 #endif
 174
 175 #ifndef PerlIO_init
 176 extern void     PerlIO_init             (void);
 177 #endif
 178 #ifndef PerlIO_stdoutf
 179 extern int      PerlIO_stdoutf          (const char *,...)
 180                                         __attribute__((__format__ (__printf__, 1, 2)));
 181 #endif
 182 #ifndef PerlIO_puts
 183 extern int      PerlIO_puts             (PerlIO *,const char *);
 184 #endif
 185 #ifndef PerlIO_open
 186 extern PerlIO * PerlIO_open             (const char *,const char *);
 187 #endif
 188 #ifndef PerlIO_close
 189 extern int      PerlIO_close            (PerlIO *);
 190 #endif
 191 #ifndef PerlIO_eof
 192 extern int      PerlIO_eof              (PerlIO *);
 193 #endif
 194 #ifndef PerlIO_error
 195 extern int      PerlIO_error            (PerlIO *);
 196 #endif
 197 #ifndef PerlIO_clearerr
 198 extern void     PerlIO_clearerr         (PerlIO *);
 199 #endif
 200 #ifndef PerlIO_getc
 201 extern int      PerlIO_getc             (PerlIO *);
 202 #endif
 203 #ifndef PerlIO_putc
 204 extern int      PerlIO_putc             (PerlIO *,int);
 205 #endif
 206 #ifndef PerlIO_flush
 207 extern int      PerlIO_flush            (PerlIO *);
 208 #endif
 209 #ifndef PerlIO_ungetc
 210 extern int      PerlIO_ungetc           (PerlIO *,int);
 211 #endif
 212 #ifndef PerlIO_fileno
 213 extern int      PerlIO_fileno           (PerlIO *);
 214 #endif
 215 #ifndef PerlIO_fdopen
 216 extern PerlIO * PerlIO_fdopen           (int, const char *);
 217 #endif
 218 #ifndef PerlIO_importFILE
 219 extern PerlIO * PerlIO_importFILE       (FILE *,int);
 220 #endif
 221 #ifndef PerlIO_exportFILE
 222 extern FILE *   PerlIO_exportFILE       (PerlIO *,int);
 223 #endif
 224 #ifndef PerlIO_findFILE
 225 extern FILE *   PerlIO_findFILE         (PerlIO *);
 226 #endif
 227 #ifndef PerlIO_releaseFILE
 228 extern void     PerlIO_releaseFILE      (PerlIO *,FILE *);
 229 #endif
 230 #ifndef PerlIO_read
 231 extern SSize_t  PerlIO_read             (PerlIO *,void *,Size_t);
 232 #endif
 233 #ifndef PerlIO_write
 234 extern SSize_t  PerlIO_write            (PerlIO *,const void *,Size_t);
 235 #endif
 236 #ifndef PerlIO_setlinebuf
 237 extern void     PerlIO_setlinebuf       (PerlIO *);
 238 #endif
 239 #ifndef PerlIO_printf
 240 extern int      PerlIO_printf           (PerlIO *, const char *,...)
 241                                         __attribute__((__format__ (__printf__, 2, 3)));
 242 #endif
 243 #ifndef PerlIO_sprintf
 244 extern int      PerlIO_sprintf          (char *, int, const char *,...)
 245                                         __attribute__((__format__ (__printf__, 3, 4)));
 246 #endif
 247 #ifndef PerlIO_vprintf
 248 extern int      PerlIO_vprintf          (PerlIO *, const char *, va_list);
 249 #endif
 250 #ifndef PerlIO_tell
 251 extern Off_t    PerlIO_tell             (PerlIO *);
 252 #endif
 253 #ifndef PerlIO_seek
 254 extern int      PerlIO_seek             (PerlIO *, Off_t, int);
 255 #endif
 256 #ifndef PerlIO_rewind
 257 extern void     PerlIO_rewind           (PerlIO *);
 258 #endif
 259 #ifndef PerlIO_has_base
 260 extern int      PerlIO_has_base         (PerlIO *);
 261 #endif
 262 #ifndef PerlIO_has_cntptr
 263 extern int      PerlIO_has_cntptr       (PerlIO *);
 264 #endif
 265 #ifndef PerlIO_fast_gets
 266 extern int      PerlIO_fast_gets        (PerlIO *);
 267 #endif
 268 #ifndef PerlIO_canset_cnt
 269 extern int      PerlIO_canset_cnt       (PerlIO *);
 270 #endif
 271 #ifndef PerlIO_get_ptr
 272 extern STDCHAR * PerlIO_get_ptr         (PerlIO *);
 273 #endif
 274 #ifndef PerlIO_get_cnt
 275 extern int      PerlIO_get_cnt          (PerlIO *);
 276 #endif
 277 #ifndef PerlIO_set_cnt
 278 extern void     PerlIO_set_cnt          (PerlIO *,int);
 279 #endif
 280 #ifndef PerlIO_set_ptrcnt
 281 extern void     PerlIO_set_ptrcnt       (PerlIO *,STDCHAR *,int);
 282 #endif
 283 #ifndef PerlIO_get_base
 284 extern STDCHAR * PerlIO_get_base        (PerlIO *);
 285 #endif
 286 #ifndef PerlIO_get_bufsiz
 287 extern int      PerlIO_get_bufsiz       (PerlIO *);
 288 #endif
 289 #ifndef PerlIO_tmpfile
 290 extern PerlIO * PerlIO_tmpfile          (void);
 291 #endif
 292 #ifndef PerlIO_stdin
 293 extern PerlIO * PerlIO_stdin            (void);
 294 #endif
 295 #ifndef PerlIO_stdout
 296 extern PerlIO * PerlIO_stdout           (void);
 297 #endif
 298 #ifndef PerlIO_stderr
 299 extern PerlIO * PerlIO_stderr           (void);
 300 #endif
 301 #ifndef PerlIO_getpos
 302 extern int      PerlIO_getpos           (PerlIO *,SV *);
 303 #endif
 304 #ifndef PerlIO_setpos
 305 extern int      PerlIO_setpos           (PerlIO *,SV *);
 306 #endif
 307 #ifndef PerlIO_fdupopen
 308 extern PerlIO * PerlIO_fdupopen         (pTHX_ PerlIO *);
 309 #endif
 310 #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
 311 extern char *PerlIO_modestr             (PerlIO *,char *buf);
 312 #endif
 313 #ifndef PerlIO_isutf8
 314 extern int      PerlIO_isutf8           (PerlIO *);
 315 #endif
 316 #ifndef PerlIO_apply_layers
 317 extern int      PerlIO_apply_layers     (pTHX_ PerlIO *f, const char *mode, const char *names);
 318 #endif
 319 #ifndef PerlIO_binmode
 320 extern int      PerlIO_binmode          (pTHX_ PerlIO *f, int iotype, int omode, const char *names);
 321 #endif
 322
 323 #ifndef PERLIO_IS_STDIO
 324
 325 extern void PerlIO_cleanup();
 326
 327 extern void PerlIO_debug(const char *fmt,...);
 328
 329 #endif
 330
 331 END_EXTERN_C
 332
 333 #endif /* _PERLIO_H */