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