lib/os_base.h

   1 /* File: "os_base.h" */
   2
   3 /* Copyright (c) 1994-2012 by Marc Feeley, All Rights Reserved. */
   4
   5 #ifndef ___OS_BASE_H
   6 #define ___OS_BASE_H
   7
   8 #include "os.h"
   9
  10
  11 /*---------------------------------------------------------------------------*/
  12
  13 /* Standard I/O emulation. */
  14
  15
  16 #include <stdio.h>
  17
  18 typedef FILE ___FILE;
  19
  20 #define ___stdin  stdin
  21 #define ___stdout stdout
  22 #define ___stderr stderr
  23
  24 extern ___FILE *___fopen
  25    ___P((const char *path,
  26          const char *mode),
  27         ());
  28
  29 extern int ___fclose
  30    ___P((___FILE *stream),
  31         ());
  32
  33 extern size_t ___fread
  34    ___P((void *ptr,
  35          size_t size,
  36          size_t nmemb,
  37          ___FILE *stream),
  38         ());
  39
  40 extern size_t ___fwrite
  41    ___P((const void *ptr,
  42          size_t size,
  43          size_t nmemb,
  44          ___FILE *stream),
  45         ());
  46
  47 extern int ___fflush
  48    ___P((___FILE *stream),
  49         ());
  50
  51 #ifdef ___DEBUG
  52
  53 extern int ___printf
  54    ___P((const char *format,
  55          ...),
  56         ());
  57
  58 #endif
  59
  60
  61 /*---------------------------------------------------------------------------*/
  62
  63
  64 typedef struct ___base_module_struct
  65   {
  66     int refcount;
  67
  68 #ifdef ___DEBUG
  69
  70     ___FILE *debug;
  71
  72     long alloc_mem_calls;
  73     long free_mem_calls;
  74
  75 #endif
  76
  77 #ifdef USE_CLASSIC_MACOS
  78
  79     /* Which features are available. */
  80
  81     ___BOOL has_GetUTCDateTime;
  82     ___BOOL has_GetDateTime;
  83     ___BOOL has_ReadLocation;
  84     ___BOOL has_Delay;
  85     ___BOOL has_IdleUpdate;
  86     ___BOOL has_WaitNextEvent;
  87     ___BOOL has_OSDispatch;
  88     ___BOOL has_FindFolder;
  89     ___BOOL has_AliasMgr;
  90     ___BOOL has_AppleEvents;
  91
  92 #define ___BASE_MODULE_INIT , 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
  93
  94 #endif
  95   } ___base_module;
  96
  97
  98 extern ___base_module ___base_mod;
  99
 100
 101 /*---------------------------------------------------------------------------*/
 102
 103 /* Memory allocation. */
 104
 105
 106 /*
 107  * Does "___alloc_mem" allocate upwards (___ALLOC_MEM_UP) or downwards
 108  * (___ALLOC_MEM_DOWN).  This setting only affects performance.
 109  */
 110
 111 #define ___ALLOC_MEM_UP
 112
 113
 114 extern void *___alloc_mem
 115    ___P((unsigned long bytes),
 116         ());
 117
 118 extern void ___free_mem
 119    ___P((void *ptr),
 120         ());
 121
 122
 123 #ifdef ___DEBUG
 124 #ifdef ___DEBUG_ALLOC_MEM_TRACE
 125
 126 extern void * ___alloc_mem_debug
 127    ___P((unsigned long bytes,
 128          int lineno,
 129          char *file),
 130         ());
 131
 132 #endif
 133 #endif
 134
 135
 136 extern void *___alloc_mem_code
 137    ___P((unsigned long bytes),
 138         ());
 139
 140 extern void ___free_mem_code
 141    ___P((void *ptr),
 142         ());
 143
 144
 145 /*---------------------------------------------------------------------------*/
 146
 147 /* Program startup. */
 148
 149
 150 extern ___program_startup_info_struct ___program_startup_info;
 151
 152
 153 extern int ___main
 154    ___P((___mod_or_lnk (*linker)(___global_state_struct*)),
 155         ());
 156
 157
 158 /*---------------------------------------------------------------------------*/
 159
 160 /* Process termination. */
 161
 162
 163 extern void ___exit_process
 164    ___P((int status),
 165         ());
 166
 167
 168 /* Process exit codes (see sysexits.h on many UNIX systems). */
 169
 170 #define ___EXIT_CODE_OK          0
 171 #define ___EXIT_CODE_USAGE       64
 172 #define ___EXIT_CODE_DATAERR     65
 173 #define ___EXIT_CODE_NOINPUT     66
 174 #define ___EXIT_CODE_NOUSER      67
 175 #define ___EXIT_CODE_NOHOST      68
 176 #define ___EXIT_CODE_UNAVAILABLE 69
 177 #define ___EXIT_CODE_SOFTWARE    70
 178 #define ___EXIT_CODE_OSERR       71
 179 #define ___EXIT_CODE_OSFILE      72
 180 #define ___EXIT_CODE_CANTCREAT   73
 181 #define ___EXIT_CODE_IOERR       74
 182 #define ___EXIT_CODE_TEMPFAIL    75
 183 #define ___EXIT_CODE_PROTOCOL    76
 184 #define ___EXIT_CODE_NOPERM      77
 185 #define ___EXIT_CODE_CONFIG      78
 186
 187
 188 /*---------------------------------------------------------------------------*/
 189
 190 /* Error handling. */
 191
 192
 193 /* Max length of an error message, not including null. */
 194
 195 #define ___ERR_MAX_LENGTH 1024
 196
 197
 198 /*
 199  * The procedure "___fatal_error" is called by the runtime system when
 200  * an unrecoverable error has occured.
 201  */
 202
 203 extern void ___fatal_error
 204    ___P((char **msgs),
 205         ());
 206
 207
 208 /*
 209  * The procedure "___display_error" is called by the runtime system to
 210  * send an error message to the user.
 211  */
 212
 213 extern void ___display_error
 214    ___P((char **msgs),
 215         ());
 216
 217
 218 /* Conversion of OS error codes to Scheme error codes. */
 219
 220
 221 /**********************************/
 222 #define err_code_from_errno() ___err_code_from_errno()
 223 #define err_code_from_h_errno() ___err_code_from_h_errno()
 224 #define err_code_from_gai_code(code) ___err_code_from_gai_code(code)
 225 #define err_code_from_GetLastError() ___err_code_from_GetLastError()
 226 #define err_code_from_WSAGetLastError() ___err_code_from_WSAGetLastError()
 227 #define fnf_or_err_code_from_errno() ___fnf_or_err_code_from_errno()
 228 #define fnf_or_err_code_from_GetLastError() ___fnf_or_err_code_from_GetLastError()
 229
 230
 231 #ifdef USE_errno
 232
 233 #ifdef ___DEBUG
 234
 235 extern ___SCMOBJ ___err_code_from_errno_debug
 236    ___P((int lineno,
 237          char *file),
 238         ());
 239
 240 #define ___err_code_from_errno() \
 241 ___err_code_from_errno_debug(__LINE__,__FILE__)
 242
 243 #else
 244
 245 extern ___SCMOBJ ___err_code_from_errno ___PVOID;
 246
 247 #endif
 248
 249 #define ___fnf_or_err_code_from_errno() \
 250 ___err_code_from_errno()
 251
 252 #define ___ERR_CODE_EAGAIN ___FIX(___ERRNO_ERR(EAGAIN))
 253 #define ___ERR_CODE_ENOENT ___FIX(___ERRNO_ERR(ENOENT))
 254
 255 #endif
 256
 257
 258 #ifdef USE_h_errno
 259
 260 #ifdef ___DEBUG
 261
 262 extern ___SCMOBJ ___err_code_from_h_errno_debug
 263    ___P((int lineno,
 264          char *file),
 265         ());
 266
 267 #define ___err_code_from_h_errno() \
 268 ___err_code_from_h_errno_debug(__LINE__,__FILE__)
 269
 270 #else
 271
 272 extern ___SCMOBJ ___err_code_from_h_errno ___PVOID;
 273
 274 #endif
 275
 276 #endif
 277
 278
 279 #ifdef USE_getaddrinfo
 280
 281 #ifdef ___DEBUG
 282
 283 extern ___SCMOBJ ___err_code_from_gai_code_debug
 284    ___P((int code,
 285          int lineno,
 286          char *file),
 287         ());
 288
 289 #define ___err_code_from_gai_code(code) \
 290 ___err_code_from_gai_code_debug(code,__LINE__,__FILE__)
 291
 292 #else
 293
 294 extern ___SCMOBJ ___err_code_from_gai_code
 295    ___P((int code),
 296         ());
 297
 298 #endif
 299
 300 #endif
 301
 302
 303 #ifdef USE_GetLastError
 304
 305 #ifdef ___DEBUG
 306
 307 extern ___SCMOBJ ___err_code_from_GetLastError_debug
 308    ___P((int lineno,
 309          char *file),
 310         ());
 311
 312 #define ___err_code_from_GetLastError() \
 313 ___err_code_from_GetLastError_debug(__LINE__,__FILE__)
 314
 315 #else
 316
 317 extern ___SCMOBJ ___err_code_from_GetLastError ___PVOID;
 318
 319 #endif
 320
 321 #define ___fnf_or_err_code_from_GetLastError() \
 322 ___err_code_from_GetLastError()
 323
 324 #define ___ERR_CODE_ERROR_FILE_NOT_FOUND \
 325 ___FIX(___WIN32_ERR(ERROR_FILE_NOT_FOUND))
 326
 327 #endif
 328
 329
 330 #ifdef USE_WSAGetLastError
 331 #ifdef ___DEBUG
 332
 333 extern ___SCMOBJ ___err_code_from_WSAGetLastError_debug
 334    ___P((int lineno,
 335          char *file),
 336         ());
 337
 338 #define ___err_code_from_WSAGetLastError() \
 339 ___err_code_from_WSAGetLastError_debug(__LINE__,__FILE__)
 340
 341 #else
 342
 343 extern ___SCMOBJ ___err_code_from_WSAGetLastError ___PVOID;
 344
 345 #endif
 346 #endif
 347
 348
 349 #ifdef USE_OSErr
 350 #ifdef ___DEBUG
 351
 352 extern ___SCMOBJ ___err_code_from_OSErr_debug
 353    ___P((OSErr e,
 354          int lineno,
 355          char *file),
 356         ());
 357
 358 #define ___err_code_from_OSErr(e) \
 359 ___err_code_from_OSErr_debug(e,__LINE__,__FILE__)
 360
 361 #else
 362
 363 extern ___SCMOBJ ___err_code_from_OSErr
 364    ___P((OSErr e),
 365         ());
 366
 367 #endif
 368 #endif
 369
 370
 371 /* Conversion of Scheme error codes to error messages. */
 372
 373 extern ___SCMOBJ ___os_err_code_to_string
 374    ___P((___SCMOBJ err),
 375         ());
 376
 377
 378 /*---------------------------------------------------------------------------*/
 379
 380 /* Interrupt handling. */
 381
 382
 383 extern void ___set_signal_handler
 384    ___P((int sig,
 385          void (*handler) ___P((int sig),())),
 386         ());
 387
 388
 389 /*---------------------------------------------------------------------------*/
 390
 391 /* Basic OS services module initialization/finalization. */
 392
 393
 394 extern ___SCMOBJ ___setup_base_module ___PVOID;
 395
 396 extern void ___cleanup_base_module ___PVOID;
 397
 398
 399 /*---------------------------------------------------------------------------*/
 400
 401
 402 #endif