home *** CD-ROM | disk | FTP | other *** search
/ ftp.whtech.com / ftp.whtech.com.7z / ftp.whtech.com / emulators / v9t9 / linux / sources / V9t9 / source / OSLib / OSLib.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-10-19  |  9.4 KB  |  438 lines
  1.  
  2. /*
  3.  *    Operating system library.  
  4.  *
  5.  *    This module handles interaction with the operating-system specific
  6.  *    intricacies with file manipulation, memory management, process
  7.  *    spawning, etc.
  8.  *
  9.  */
  10.  
  11. #ifndef __OSLIB_H__
  12. #define __OSLIB_H__
  13.  
  14. #include <conf.h>
  15.  
  16. #include "centry.h"
  17. #include "clstandardtypes.h"
  18. #include "clstandardheaders.h"
  19.  
  20. #include "sysdeps.h"
  21.  
  22. /*    Operating system implementation */
  23.  
  24. /*    Guess the type;
  25.  
  26.     although there are references to compilers,
  27.     these are only based on what I know; these
  28.     xxx_FS defines should not make assumptions
  29.     about the C library                         
  30. */
  31. #if defined(UNDER_MACOS)
  32. #define MAC_FS 1
  33. #endif
  34.  
  35. #if defined(UNDER_QNX)
  36. #define QNX_FS         1
  37. #define POSIX_FS     1
  38. #endif
  39.  
  40. #if defined(UNDER_BEOS)
  41. #define BEWORKS_FS    1
  42. #define POSIX_FS    1
  43. #endif
  44.  
  45. #if defined(UNDER_UNIX)
  46. #define POSIX_FS    1
  47. #endif
  48.  
  49. #if defined(UNDER_WIN32)
  50. #define WIN32_FS    1
  51. #endif
  52.  
  53. #if (defined(WIN32_FS) && defined(POSIX_FS)) || \
  54.     (defined(WIN32_FS) && defined(QNX_FS)) || \
  55.     (defined(MAC_FS) && defined(POSIX_FS)) || \
  56.     (defined(MAC_FS) && defined(WIN32_FS))
  57. #error Conflicting operating systems selected.
  58. #elif !defined(WIN32_FS) && !defined(POSIX_FS) && !defined(MAC_FS)
  59. #error No operating system specified.
  60. #endif
  61.  
  62. #if WIN32_FS
  63. #include "Win32.h"
  64. #elif POSIX_FS
  65. #include "Posix.h"
  66. #elif MAC_FS
  67. #include "MacOS.h"
  68. #endif
  69.  
  70. /*    OS specifier */
  71.  
  72. typedef
  73. struct    OSSpec
  74. {
  75.     OSPathSpec    path;
  76.     OSNameSpec    name;
  77. }    OSSpec;
  78.  
  79.  
  80. /*    get error text for an OSError */
  81. char
  82. *OS_GetErrText(OSError err);                
  83.  
  84. /*********************/
  85.  
  86. /*    Initialize C program context  */
  87. OSError
  88. OS_InitProgram(int *argc, char ***argv);
  89.  
  90. /*    Terminate C program context  */
  91. OSError
  92. OS_TermProgram(void);
  93.  
  94. /*********************/
  95.  
  96. typedef unsigned long    OSSize;
  97. typedef signed long        OSPos;
  98.  
  99. /*    create a new file, overwrite an old one if existing */
  100. OSError    
  101. OS_Create(const OSSpec *spec, OSFileType *type);
  102.  
  103. /*    get status of a file */
  104. OSError
  105. OS_Status(const OSSpec *spec);
  106.  
  107. /*  get type of a file */
  108. OSError
  109. OS_GetFileType(const OSSpec *spec, OSFileType *type);
  110.  
  111. /*  set type for a file */
  112. OSError
  113. OS_SetFileType(const OSSpec *spec, OSFileType *type);
  114.  
  115. /*  get timestamps of a file */
  116. OSError
  117. OS_GetFileTime(const OSSpec *spec, OSTime *crtm, OSTime *chtm);
  118.  
  119. /*  set timestamps of a file; crtm or chtm may be NULL */
  120. OSError
  121. OS_SetFileTime(const OSSpec *spec, OSTime *crtm, OSTime *chtm);
  122.  
  123. /*    modify protection on a file */
  124. OSError
  125. OS_ModifyProtection(const OSSpec *spec, bool protect);
  126.  
  127. /*    get protection on a file */
  128. OSError
  129. OS_CheckProtection(const OSSpec *spec, bool *is_protected);
  130.  
  131. /*    get disk space info */
  132. OSError
  133. OS_GetDiskStats(const OSPathSpec *spec, 
  134.                 OSSize *blocksize, OSSize *total, OSSize *free);
  135.                 
  136.  
  137. /*************************************/
  138.  
  139. typedef enum    
  140. {
  141.     OSReadOnly,                         /* only read */
  142.     OSWrite,                             /* only write */
  143.     OSReadWrite,                         /* read and write */
  144.     OSAppend                             /* only append */
  145. } 
  146. OSOpenMode;
  147.  
  148. typedef enum 
  149. { 
  150.      OSSeekRel,                             /* seek relative to current position */
  151.     OSSeekAbs,                             /* absolute position */
  152.     OSSeekEnd                             /* from end of file */
  153. }
  154. OSSeekMode;
  155.  
  156. /*    open an existing file */
  157. OSError
  158. OS_Open(const OSSpec *spec, OSOpenMode mode, OSRef *ref);
  159.  
  160. /*    write binary data, up to length bytes;
  161.     length==0 can extend file;
  162.     update length;
  163.     error indicates serious failure */
  164. OSError
  165. OS_Write(OSRef ref, void *buffer, OSSize *length);
  166.  
  167. /*    read binary data, up to length bytes;
  168.     update length;
  169.     error indicates serious failure.  */
  170. OSError
  171. OS_Read(OSRef ref, void *buffer, OSSize *length);
  172.  
  173. /*    seek a file;
  174.     illegal seek is revealed by next write or read;
  175.     error indicates serious failure.  */
  176. OSError
  177. OS_Seek(OSRef ref, OSSeekMode how, OSPos offset);
  178.  
  179. /*    tell file position */
  180. OSError
  181. OS_Tell(OSRef ref, OSPos *offs);
  182.  
  183. /*    close a file */
  184. OSError
  185. OS_Close(OSRef ref);
  186.  
  187. /*  get length of a file;
  188.     return error if directory or not found */
  189. OSError
  190. OS_GetSize(OSRef ref, OSSize *length);
  191.  
  192. /*  set length of a file;
  193.     return error if directory or not found */
  194. OSError
  195. OS_SetSize(OSRef ref, OSSize length);
  196.  
  197.  
  198. /*******************************************/
  199.  
  200. /*    delete a file */
  201. OSError
  202. OS_Delete(const OSSpec *spec);
  203.  
  204. /*    rename a file */
  205. OSError
  206. OS_Rename(const OSSpec *oldspec, const OSSpec *newspec);
  207.  
  208. /*    make directory */
  209. OSError
  210. OS_Mkdir(const OSSpec *spec);
  211.  
  212. /*    remove directory */
  213. OSError
  214. OS_Rmdir(const OSPathSpec *spec);
  215.  
  216. /*    change directory */
  217. OSError
  218. OS_Chdir(const OSPathSpec *spec);
  219.  
  220. /*    get current working directory */
  221. OSError
  222. OS_GetCWD(OSPathSpec *spec);
  223.  
  224. /*    spawn a subprocess; 
  225.     pass the full environment block or NULL for the    current one */
  226. OSError
  227. OS_Execute(const OSSpec *spec, char **argv, char **envp, 
  228.             const char *stdoutfile, const char *stderrfile, int *exitcode);
  229.  
  230. /*************************************/
  231.  
  232. /*    tell if a canonical filepath is legal for filesystem */
  233. OSError
  234. OS_IsLegalPath(const char *path);
  235.  
  236. /*    tell if a canonical filepath represents a full path */
  237. int
  238. OS_IsFullPath(const char *path);
  239.  
  240. /*    return ptr to directory in a vol+dir path */
  241. const char *
  242. OS_GetDirPtr(const char *path);
  243.  
  244. /*    compare paths */
  245. int
  246. OS_EqualPath(const char *a, const char *b);
  247.  
  248. /*************************************/
  249.  
  250. /*    make OSSpec from a path;
  251.     path may be relative or absolute, or a filename. */
  252. OSError
  253. OS_MakeSpec(const char *path, OSSpec *spec, bool *isfile);
  254.  
  255. /*    make OSSpec from a path;
  256.     must resolve to a file. */
  257. OSError
  258. OS_MakeFileSpec(const char *path, OSSpec *spec);
  259.  
  260. /*    make OSPathSpec from a volume and directory;
  261.     does not necessarily validate 'vol' as a volume
  262.     or 'dir' as a directory; but only the final path;
  263.     'vol' or 'dir' may each be NULL. */
  264. OSError
  265. OS_MakePathSpec(const char *vol, const char *dir, OSPathSpec *spec);
  266.  
  267. /*    make OSNameSpec from a filename;
  268.     tests name for illegal characters */
  269. OSError
  270. OS_MakeNameSpec(const char *name, OSNameSpec *spec);
  271.  
  272. /*    return FS root spec */
  273. OSError
  274. OS_GetRootSpec(OSPathSpec *spec);
  275.  
  276. /*************************************/
  277.  
  278. /*
  279.     For the OS_xxxToString functions, the string buffer
  280.     and its maximum size are passed.  If the output is too
  281.     big for the buffer, the output is truncated.  If the
  282.     buffer is given as NULL, the buffer is malloc()ed.
  283.     
  284.     A pointer to the buffer is returned, or NULL if memory is out.
  285. */
  286.  
  287. extern char STSbuf[OS_PATHSIZE];
  288.  
  289. /*    make a full pathname from OSSpec */
  290. char *
  291. OS_SpecToString(const OSSpec *spec, char *fullpath, int size);
  292.  
  293. #define OS_SpecToString1(spec) \
  294.     OS_SpecToString(spec, STSbuf, OS_PATHSIZE)
  295. #define OS_SpecToString2(spec,buf) \
  296.     OS_SpecToString(spec, buf, OS_PATHSIZE)
  297.  
  298. /*    make a path from OSPathSpec */
  299. char *
  300. OS_PathSpecToString(const OSPathSpec *spec, char *path, int size);
  301.  
  302. #define OS_PathSpecToString1(spec) \
  303.     OS_PathSpecToString(spec, STSbuf, OS_PATHSIZE)
  304. #define OS_PathSpecToString2(spec,buf) \
  305.     OS_PathSpecToString(spec, buf, OS_PATHSIZE)
  306.  
  307. /*    make a name from OSNameSpec */
  308. char *
  309. OS_NameSpecToString(const OSNameSpec *spec, char *name, int size);
  310.  
  311. #define OS_NameSpecToString1(spec) \
  312.     OS_NameSpecToString(spec, STSbuf, OS_PATHSIZE)
  313. #define OS_NameSpecToString2(spec,buf) \
  314.     OS_NameSpecToString(spec, buf, OS_PATHSIZE)
  315.  
  316. /*    return the size of an OSPathSpec, for duplication purposes */
  317. int
  318. OS_SizeOfPathSpec(const OSPathSpec *spec);
  319.  
  320. /*    return the size of an OSNameSpec, for duplication purposes */
  321. int
  322. OS_SizeOfNameSpec(const OSNameSpec *spec);
  323.  
  324. /*    compare OSSpecs */
  325. int
  326. OS_EqualSpec(const OSSpec *a, const OSSpec *b);
  327.  
  328. /*    compare OSPathSpecs */
  329. int
  330. OS_EqualPathSpec(const OSPathSpec *a, const OSPathSpec *b);
  331.  
  332. /*    compare OSNameSpecs */
  333. int
  334. OS_EqualNameSpec(const OSNameSpec *a, const OSNameSpec *b);
  335.  
  336. /*    tell if OSSpec is a directory */
  337. int
  338. OS_IsDir(const OSSpec *spec);
  339.  
  340. /*    tell if OSSpec is a file */
  341. int
  342. OS_IsFile(const OSSpec *spec);
  343.  
  344. /*    tell if OSSpec is a [soft] link / alias */
  345. int
  346. OS_IsLink(const OSSpec *spec);
  347.  
  348. /*    resolve a [soft] link / alias;  link ptr may be equal to target ptr */
  349. OSError
  350. OS_ResolveLink(const OSSpec *link, OSSpec *target);
  351.  
  352. /*************************************/
  353.  
  354. /*    open a directory for reading */
  355. OSError 
  356. OS_OpenDir(const OSPathSpec *spec, OSDirRef *ref);
  357.  
  358. /*    read an entry from a directory;
  359.     don't return "." or "..";
  360.     return error when end-of-directory reached */
  361. OSError
  362. OS_ReadDir(OSDirRef *ref, OSSpec *entry, char *filename, bool *isfile);
  363.  
  364. /*    close directory */
  365. OSError
  366. OS_CloseDir(OSDirRef *ref);
  367.  
  368.  
  369. /*************************************/
  370.  
  371. /*    return time in milliseconds */
  372. unsigned long
  373. OS_GetMilliseconds(void);
  374.  
  375. /*    return current time */
  376. void
  377. OS_GetTime(OSTime *tm);
  378.  
  379. /*    allocate a memory handle */
  380. OSError
  381. OS_NewHandle(OSSize size, OSHandle *hand);
  382.  
  383. /*    resize handle; handle may not be locked  */
  384. OSError
  385. OS_ResizeHandle(OSHandle *hand, OSSize size);
  386.  
  387. /*    lock handle into memory; always succeeds  */
  388. void *
  389. OS_LockHandle(OSHandle *hand);
  390.  
  391. /*    unlock handle  */
  392. void
  393. OS_UnlockHandle(OSHandle *hand);
  394.  
  395. /*    free handle  */
  396. OSError
  397. OS_FreeHandle(OSHandle *hand);
  398.  
  399. /*    get handle size */
  400. OSError
  401. OS_GetHandleSize(OSHandle *hand, OSSize *size);
  402.  
  403. /*    invalidate handle */
  404. void
  405. OS_InvalidateHandle(OSHandle *hand);
  406.  
  407. /*    tell whether a handle is valid */
  408. bool
  409. OS_ValidHandle(OSHandle *hand);
  410.  
  411. /*************************************/
  412.  
  413. /*    Shared library / DLL routines  */
  414.  
  415. /*    open a shared library  */
  416. OSError
  417. OS_OpenLibrary(const OSSpec *spec, OSLibrary *lib);
  418.  
  419. /*    find a symbol in the library */
  420. OSError
  421. OS_GetLibrarySymbol(OSLibrary lib, char *name, void **sym);
  422.  
  423. /*    close a shared library */
  424. OSError
  425. OS_CloseLibrary(OSLibrary lib);
  426.  
  427. /*************************************/
  428.  
  429. #define __INSIDE_OSLIB_H__
  430. #include "OSLibGeneric.h"
  431. #include "OSLibExtras.h"
  432. #undef __INSIDE_OSLIB_H__
  433.  
  434.  
  435. #include "cexit.h"
  436.  
  437. #endif    //__OSLIB_H__
  438.