Replace off_t with file_offset_t
[pforth] / csrc / pf_io.h
CommitLineData
8e9db35f
PB
1/* @(#) pf_io.h 98/01/26 1.2 */
2#ifndef _pf_io_h
3#define _pf_io_h
4
5/***************************************************************
6** Include file for PForth IO
7**
8** Author: Phil Burk
9** Copyright 1994 3DO, Phil Burk, Larry Polansky, David Rosenboom
10**
11** The pForth software code is dedicated to the public domain,
12** and any third party may reproduce, distribute and modify
13** the pForth software code or any derivative works thereof
14** without any compensation or license. The pForth software
15** code is provided on an "as is" basis without any warranty
16** of any kind, including, without limitation, the implied
17** warranties of merchantability and fitness for a particular
18** purpose and their equivalents under the laws of any jurisdiction.
19**
20***************************************************************/
21
4d9c915d
PB
22#include "pf_types.h"
23
8e9db35f
PB
24#define PF_CHAR_XON (0x11)
25#define PF_CHAR_XOFF (0x13)
26
27int sdTerminalOut( char c );
28int sdTerminalEcho( char c );
29int sdTerminalFlush( void );
30int sdTerminalIn( void );
31int sdQueryTerminal( void );
32void sdTerminalInit( void );
33void sdTerminalTerm( void );
34
35void ioInit( void );
36void ioTerm( void );
37
8e9db35f
PB
38#ifdef PF_NO_CHARIO
39 void sdEnableInput( void );
40 void sdDisableInput( void );
41
42#else /* PF_NO_CHARIO */
43 #ifdef PF_USER_CHARIO
44/* Get user prototypes or macros from include file.
45** API must match that defined above for the stubs.
46*/
47/* If your sdTerminalIn echos, define PF_KEY_ECHOS. */
48 #include PF_USER_CHARIO
49 #else
50 #define sdEnableInput() /* sdTerminalOut( PF_CHAR_XON ) */
51 #define sdDisableInput() /* sdTerminalOut( PF_CHAR_XOFF ) */
52
53 #endif
54#endif /* PF_NO_CHARIO */
55
56/* Define file access modes. */
57/* User can #undef and re#define using PF_USER_FILEIO if needed. */
58#define PF_FAM_READ_ONLY (0)
59#define PF_FAM_READ_WRITE (1)
60#define PF_FAM_WRITE_ONLY (2)
61#define PF_FAM_BINARY_FLAG (8)
62
63#define PF_FAM_CREATE_WO ("w")
64#define PF_FAM_CREATE_RW ("w+")
65#define PF_FAM_OPEN_RO ("r")
66#define PF_FAM_OPEN_RW ("r+")
67#define PF_FAM_BIN_CREATE_WO ("wb")
68#define PF_FAM_BIN_CREATE_RW ("wb+")
69#define PF_FAM_BIN_OPEN_RO ("rb")
70#define PF_FAM_BIN_OPEN_RW ("rb+")
71
72#ifdef PF_NO_FILEIO
73
74 typedef void FileStream;
75
76 extern FileStream *PF_STDIN;
77 extern FileStream *PF_STDOUT;
78
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82
83 /* Prototypes for stubs. */
84 FileStream *sdOpenFile( const char *FileName, const char *Mode );
85 cell_t sdFlushFile( FileStream * Stream );
86 cell_t sdReadFile( void *ptr, cell_t Size, int32_t nItems, FileStream * Stream );
87 cell_t sdWriteFile( void *ptr, cell_t Size, int32_t nItems, FileStream * Stream );
4d9c915d 88 cell_t sdSeekFile( FileStream * Stream, file_offset_t Position, int32_t Mode );
6f3de396 89 cell_t sdRenameFile( const char *OldName, const char *NewName );
e0701bfb 90 cell_t sdDeleteFile( const char *FileName );
0b1e2489 91 ThrowCode sdResizeFile( FileStream *, uint64_t Size);
4d9c915d 92 file_offset_t sdTellFile( FileStream * Stream );
8e9db35f
PB
93 cell_t sdCloseFile( FileStream * Stream );
94 cell_t sdInputChar( FileStream *stream );
95
96 #ifdef __cplusplus
97 }
98 #endif
99
100 #define PF_SEEK_SET (0)
101 #define PF_SEEK_CUR (1)
102 #define PF_SEEK_END (2)
103 /*
104 ** printf() is only used for debugging purposes.
105 ** It is not required for normal operation.
106 */
107 #define PRT(x) /* No printf(). */
108
109#else
110
111 #ifdef PF_USER_FILEIO
112/* Get user prototypes or macros from include file.
113** API must match that defined above for the stubs.
114*/
115 #include PF_USER_FILEIO
116
117 #else
118 typedef FILE FileStream;
119
120 #define sdOpenFile fopen
e0701bfb 121 #define sdDeleteFile remove
8e9db35f
PB
122 #define sdFlushFile fflush
123 #define sdReadFile fread
124 #define sdWriteFile fwrite
3c17aa8d 125 #if defined(WIN32) || defined(__NT__) || defined(AMIGA)
8e9db35f
PB
126 /* TODO To support 64-bit file offset we probably need fseeki64(). */
127 #define sdSeekFile fseek
128 #define sdTellFile ftell
129 #else
130 #define sdSeekFile fseeko
131 #define sdTellFile ftello
132 #endif
133 #define sdCloseFile fclose
6f3de396 134 #define sdRenameFile rename
8e9db35f
PB
135 #define sdInputChar fgetc
136
137 #define PF_STDIN ((FileStream *) stdin)
138 #define PF_STDOUT ((FileStream *) stdout)
139
1d7147ff
HE
140 #define PF_SEEK_SET (SEEK_SET)
141 #define PF_SEEK_CUR (SEEK_CUR)
142 #define PF_SEEK_END (SEEK_END)
8e9db35f 143
0b1e2489 144 ThrowCode sdResizeFile( FileStream *, uint64_t Size);
e0701bfb 145
8e9db35f
PB
146 /*
147 ** printf() is only used for debugging purposes.
148 ** It is not required for normal operation.
149 */
150 #define PRT(x) { printf x; sdFlushFile(PF_STDOUT); }
151 #endif
152
153#endif /* PF_NO_FILEIO */
154
155
156#ifdef __cplusplus
157extern "C" {
158#endif
159
160cell_t ioAccept( char *Target, cell_t n1 );
161cell_t ioKey( void);
162void ioEmit( char c );
163void ioType( const char *s, cell_t n);
164
165#ifdef __cplusplus
166}
167#endif
168
169#endif /* _pf_io_h */