This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #61392] Method call documentation in perlobj.pod
[perl5.git] / win32 / win32iop.h
1 #ifndef WIN32IOP_H
2 #define WIN32IOP_H
3
4 #ifndef START_EXTERN_C
5 #ifdef __cplusplus
6 #  define START_EXTERN_C extern "C" {
7 #  define END_EXTERN_C }
8 #  define EXTERN_C extern "C"
9 #else
10 #  define START_EXTERN_C
11 #  define END_EXTERN_C
12 #  define EXTERN_C
13 #endif
14 #endif
15
16 #if defined(_MSC_VER) || defined(__MINGW32__)
17 #  include <sys/utime.h>
18 #else
19 #  include <utime.h>
20 #endif
21
22 /*
23  * defines for flock emulation
24  */
25 #define LOCK_SH 1
26 #define LOCK_EX 2
27 #define LOCK_NB 4
28 #define LOCK_UN 8
29
30 /*
31  * Make this as close to original stdio as possible.
32  */
33
34 /*
35  * function prototypes for our own win32io layer
36  */
37 START_EXTERN_C
38
39 DllExport  int *        win32_errno(void);
40 DllExport  char ***     win32_environ(void);
41 DllExport  FILE*        win32_stdin(void);
42 DllExport  FILE*        win32_stdout(void);
43 DllExport  FILE*        win32_stderr(void);
44 DllExport  int          win32_ferror(FILE *fp);
45 DllExport  int          win32_feof(FILE *fp);
46 DllExport  char*        win32_strerror(int e);
47
48 DllExport  int          win32_fprintf(FILE *pf, const char *format, ...);
49 DllExport  int          win32_printf(const char *format, ...);
50 DllExport  int          win32_vfprintf(FILE *pf, const char *format, va_list arg);
51 DllExport  int          win32_vprintf(const char *format, va_list arg);
52 DllExport  size_t       win32_fread(void *buf, size_t size, size_t count, FILE *pf);
53 DllExport  size_t       win32_fwrite(const void *buf, size_t size, size_t count, FILE *pf);
54 DllExport  FILE*        win32_fopen(const char *path, const char *mode);
55 DllExport  FILE*        win32_fdopen(int fh, const char *mode);
56 DllExport  FILE*        win32_freopen(const char *path, const char *mode, FILE *pf);
57 DllExport  int          win32_fclose(FILE *pf);
58 DllExport  int          win32_fputs(const char *s,FILE *pf);
59 DllExport  int          win32_fputc(int c,FILE *pf);
60 DllExport  int          win32_ungetc(int c,FILE *pf);
61 DllExport  int          win32_getc(FILE *pf);
62 DllExport  int          win32_fileno(FILE *pf);
63 DllExport  void         win32_clearerr(FILE *pf);
64 DllExport  int          win32_fflush(FILE *pf);
65 DllExport  Off_t        win32_ftell(FILE *pf);
66 DllExport  int          win32_fseek(FILE *pf,Off_t offset,int origin);
67 DllExport  int          win32_fgetpos(FILE *pf,fpos_t *p);
68 DllExport  int          win32_fsetpos(FILE *pf,const fpos_t *p);
69 DllExport  void         win32_rewind(FILE *pf);
70 DllExport  int          win32_tmpfd(void);
71 DllExport  FILE*        win32_tmpfile(void);
72 DllExport  void         win32_abort(void);
73 DllExport  int          win32_fstat(int fd,Stat_t *sbufptr);
74 DllExport  int          win32_stat(const char *name,Stat_t *sbufptr);
75 DllExport  int          win32_pipe( int *phandles, unsigned int psize, int textmode );
76 DllExport  PerlIO*      win32_popen( const char *command, const char *mode );
77 DllExport  PerlIO*      win32_popenlist(const char *mode, IV narg, SV **args);
78 DllExport  int          win32_pclose( PerlIO *pf);
79 DllExport  int          win32_rename( const char *oname, const char *newname);
80 DllExport  int          win32_setmode( int fd, int mode);
81 DllExport  int          win32_chsize(int fd, Off_t size);
82 DllExport  Off_t        win32_lseek( int fd, Off_t offset, int origin);
83 DllExport  Off_t        win32_tell( int fd);
84 DllExport  int          win32_dup( int fd);
85 DllExport  int          win32_dup2(int h1, int h2);
86 DllExport  int          win32_open(const char *path, int oflag,...);
87 DllExport  int          win32_close(int fd);
88 DllExport  int          win32_eof(int fd);
89 DllExport  int          win32_read(int fd, void *buf, unsigned int cnt);
90 DllExport  int          win32_write(int fd, const void *buf, unsigned int cnt);
91 DllExport  int          win32_spawnvp(int mode, const char *cmdname,
92                               const char *const *argv);
93 DllExport  int          win32_mkdir(const char *dir, int mode);
94 DllExport  int          win32_rmdir(const char *dir);
95 DllExport  int          win32_chdir(const char *dir);
96 DllExport  int          win32_flock(int fd, int oper);
97 DllExport  int          win32_execv(const char *cmdname, const char *const *argv);
98 DllExport  int          win32_execvp(const char *cmdname, const char *const *argv);
99 DllExport  void         win32_perror(const char *str);
100 DllExport  void         win32_setbuf(FILE *pf, char *buf);
101 DllExport  int          win32_setvbuf(FILE *pf, char *buf, int type, size_t size);
102 DllExport  int          win32_flushall(void);
103 DllExport  int          win32_fcloseall(void);
104 DllExport  char*        win32_fgets(char *s, int n, FILE *pf);
105 DllExport  char*        win32_gets(char *s);
106 DllExport  int          win32_fgetc(FILE *pf);
107 DllExport  int          win32_putc(int c, FILE *pf);
108 DllExport  int          win32_puts(const char *s);
109 DllExport  int          win32_getchar(void);
110 DllExport  int          win32_putchar(int c);
111 DllExport  void*        win32_malloc(size_t size);
112 DllExport  void*        win32_calloc(size_t numitems, size_t size);
113 DllExport  void*        win32_realloc(void *block, size_t size);
114 DllExport  void         win32_free(void *block);
115
116 DllExport  int          win32_open_osfhandle(intptr_t handle, int flags);
117 DllExport  intptr_t     win32_get_osfhandle(int fd);
118 DllExport  FILE*        win32_fdupopen(FILE *pf);
119
120 DllExport  DIR*         win32_opendir(const char *filename);
121 DllExport  struct direct*       win32_readdir(DIR *dirp);
122 DllExport  long         win32_telldir(DIR *dirp);
123 DllExport  void         win32_seekdir(DIR *dirp, long loc);
124 DllExport  void         win32_rewinddir(DIR *dirp);
125 DllExport  int          win32_closedir(DIR *dirp);
126
127 DllExport  char*        win32_getenv(const char *name);
128 DllExport  int          win32_putenv(const char *name);
129
130 DllExport  unsigned     win32_sleep(unsigned int);
131 DllExport  int          win32_times(struct tms *timebuf);
132 DllExport  unsigned     win32_alarm(unsigned int sec);
133 DllExport  int          win32_stat(const char *path, Stat_t *buf);
134 DllExport  char*        win32_longpath(char *path);
135 DllExport  char*        win32_ansipath(const WCHAR *path);
136 DllExport  int          win32_ioctl(int i, unsigned int u, char *data);
137 DllExport  int          win32_link(const char *oldname, const char *newname);
138 DllExport  int          win32_unlink(const char *f);
139 DllExport  int          win32_utime(const char *f, struct utimbuf *t);
140 DllExport  int          win32_gettimeofday(struct timeval *tp, void *not_used);
141 DllExport  int          win32_uname(struct utsname *n);
142 DllExport  int          win32_wait(int *status);
143 DllExport  int          win32_waitpid(int pid, int *status, int flags);
144 DllExport  int          win32_kill(int pid, int sig);
145 DllExport  unsigned long        win32_os_id(void);
146 DllExport  void*        win32_dynaload(const char*filename);
147 DllExport  int          win32_access(const char *path, int mode);
148 DllExport  int          win32_chmod(const char *path, int mode);
149 DllExport  int          win32_getpid(void);
150
151 DllExport char *        win32_crypt(const char *txt, const char *salt);
152
153 DllExport void *        win32_get_childenv(void);
154 DllExport void          win32_free_childenv(void* d);
155 DllExport void          win32_clearenv(void);
156 DllExport char *        win32_get_childdir(void);
157 DllExport void          win32_free_childdir(char* d);
158 DllExport Sighandler_t  win32_signal(int sig, Sighandler_t subcode);
159
160
161 END_EXTERN_C
162
163 #undef alarm
164 #define alarm                   win32_alarm
165
166 /*
167  * the following six(6) is #define in stdio.h
168  */
169 #ifndef WIN32IO_IS_STDIO
170 #undef errno
171 #undef environ
172 #undef stderr
173 #undef stdin
174 #undef stdout
175 #undef ferror
176 #undef feof
177 #undef fclose
178 #undef pipe
179 #undef pause
180 #undef sleep
181 #undef times
182 #undef ioctl
183 #undef unlink
184 #undef utime
185 #undef gettimeofday
186 #undef uname
187 #undef wait
188
189 #ifdef __BORLANDC__
190 #undef ungetc
191 #undef getc
192 #undef putc
193 #undef getchar
194 #undef putchar
195 #endif
196
197 #if defined(__MINGW32__) || defined(__BORLANDC__)
198 #undef fileno
199 #endif
200
201 #define stderr                          win32_stderr()
202 #define stdout                          win32_stdout()
203 #define stdin                           win32_stdin()
204 #define feof(f)                         win32_feof(f)
205 #define ferror(f)                       win32_ferror(f)
206 #define errno                           (*win32_errno())
207 #define environ                         (*win32_environ())
208 #define strerror                        win32_strerror
209
210 /*
211  * redirect to our own version
212  */
213 #undef fprintf
214 #define fprintf                 win32_fprintf
215 #define vfprintf                win32_vfprintf
216 #define printf                  win32_printf
217 #define vprintf                 win32_vprintf
218 #define fread(buf,size,count,f) win32_fread(buf,size,count,f)
219 #define fwrite(buf,size,count,f)        win32_fwrite(buf,size,count,f)
220 #define fopen                   win32_fopen
221 #undef fdopen
222 #define fdopen                  win32_fdopen
223 #define freopen                 win32_freopen
224 #define fclose(f)               win32_fclose(f)
225 #define fputs(s,f)              win32_fputs(s,f)
226 #define fputc(c,f)              win32_fputc(c,f)
227 #define ungetc(c,f)             win32_ungetc(c,f)
228 #undef getc
229 #define getc(f)                 win32_getc(f)
230 #define fileno(f)               win32_fileno(f)
231 #define clearerr(f)             win32_clearerr(f)
232 #define fflush(f)               win32_fflush(f)
233 #define ftell(f)                win32_ftell(f)
234 #define fseek(f,o,w)            win32_fseek(f,o,w)
235 #define fgetpos(f,p)            win32_fgetpos(f,p)
236 #define fsetpos(f,p)            win32_fsetpos(f,p)
237 #define rewind(f)               win32_rewind(f)
238 #define tmpfile()               win32_tmpfile()
239 #define abort()                 win32_abort()
240 #define fstat(fd,bufptr)        win32_fstat(fd,bufptr)
241 #define stat(pth,bufptr)        win32_stat(pth,bufptr)
242 #define longpath(pth)           win32_longpath(pth)
243 #define ansipath(pth)           win32_ansipath(pth)
244 #define rename(old,new)         win32_rename(old,new)
245 #define setmode(fd,mode)        win32_setmode(fd,mode)
246 #define chsize(fd,sz)           win32_chsize(fd,sz)
247 #define lseek(fd,offset,orig)   win32_lseek(fd,offset,orig)
248 #define tell(fd)                win32_tell(fd)
249 #define dup(fd)                 win32_dup(fd)
250 #define dup2(fd1,fd2)           win32_dup2(fd1,fd2)
251 #define open                    win32_open
252 #define close(fd)               win32_close(fd)
253 #define eof(fd)                 win32_eof(fd)
254 #define read(fd,b,s)            win32_read(fd,b,s)
255 #define write(fd,b,s)           win32_write(fd,b,s)
256 #define _open_osfhandle         win32_open_osfhandle
257 #define _get_osfhandle          win32_get_osfhandle
258 #define spawnvp                 win32_spawnvp
259 #define mkdir                   win32_mkdir
260 #define rmdir                   win32_rmdir
261 #define chdir                   win32_chdir
262 #define flock(fd,o)             win32_flock(fd,o)
263 #define execv                   win32_execv
264 #define execvp                  win32_execvp
265 #define perror                  win32_perror
266 #define setbuf                  win32_setbuf
267 #define setvbuf                 win32_setvbuf
268 #undef flushall
269 #define flushall                win32_flushall
270 #undef fcloseall
271 #define fcloseall               win32_fcloseall
272 #define fgets                   win32_fgets
273 #define gets                    win32_gets
274 #define fgetc                   win32_fgetc
275 #undef putc
276 #define putc                    win32_putc
277 #define puts                    win32_puts
278 #undef getchar
279 #define getchar                 win32_getchar
280 #undef putchar
281 #define putchar                 win32_putchar
282 #define access(p,m)             win32_access(p,m)
283 #define chmod(p,m)              win32_chmod(p,m)
284
285
286 #if !defined(MYMALLOC) || !defined(PERL_CORE)
287 #undef malloc
288 #undef calloc
289 #undef realloc
290 #undef free
291 #define malloc                  win32_malloc
292 #define calloc                  win32_calloc
293 #define realloc                 win32_realloc
294 #define free                    win32_free
295 #endif
296
297 #define pipe(fd)                win32_pipe((fd), 512, O_BINARY)
298 #define pause()                 win32_sleep((32767L << 16) + 32767)
299 #define sleep                   win32_sleep
300 #define times                   win32_times
301 #define ioctl                   win32_ioctl
302 #define link                    win32_link
303 #define unlink                  win32_unlink
304 #define utime                   win32_utime
305 #define gettimeofday            win32_gettimeofday
306 #define uname                   win32_uname
307 #define wait                    win32_wait
308 #define waitpid                 win32_waitpid
309 #define kill                    win32_kill
310
311 #define opendir                 win32_opendir
312 #define readdir                 win32_readdir
313 #define telldir                 win32_telldir
314 #define seekdir                 win32_seekdir
315 #define rewinddir               win32_rewinddir
316 #define closedir                win32_closedir
317 #define os_id                   win32_os_id
318 #define getpid                  win32_getpid
319
320 #undef crypt
321 #define crypt(t,s)              win32_crypt(t,s)
322
323 #undef get_childenv
324 #undef free_childenv
325 #undef clearenv
326 #undef get_childdir
327 #undef free_childdir
328 #define get_childenv()          win32_get_childenv()
329 #define free_childenv(d)        win32_free_childenv(d)
330 #define clearenv()              win32_clearenv()
331 #define get_childdir()          win32_get_childdir()
332 #define free_childdir(d)        win32_free_childdir(d)
333
334 #undef getenv
335 #define getenv win32_getenv
336 #undef putenv
337 #define putenv win32_putenv
338
339 #endif /* WIN32IO_IS_STDIO */
340 #endif /* WIN32IOP_H */