Make it a function
[xonotic/gmqcc.git] / platform.h
1 /*
2  * Copyright (C) 2012, 2013, 2014
3  *     Dale Weiler
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9  * of the Software, and to permit persons to whom the Software is furnished to do
10  * so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23
24 #ifndef GMQCC_PLATFORM_HDR
25 #define GMQCC_PLATFORM_HDR
26
27 #ifndef GMQCC_PLATFORM_HEADER
28 #   error "This header shouldn't be included!"
29 #endif
30
31 #undef GMQCC_PLATFORM_HEADER
32 #include <stdarg.h>
33 #include <time.h>
34 #include <stdio.h>
35
36 #ifdef _WIN32
37 #   ifndef STDERR_FILENO
38 #       define STDERR_FILENO 2
39 #   endif
40 #   ifndef STDOUT_FILENO
41 #       define STDOUT_FILENO 1
42 #   endif
43 #   ifndef __MINGW32__
44 #       define _WIN32_LEAN_AND_MEAN
45 #       include <windows.h>
46 #       include <io.h>
47 #       include <fcntl.h>
48
49         struct dirent {
50             long               d_ino;
51             unsigned short     d_reclen;
52             unsigned short     d_namlen;
53             char               d_name[FILENAME_MAX];
54         };
55
56         typedef struct {
57             struct _finddata_t dd_dta;
58             struct dirent      dd_dir;
59             long               dd_handle;
60             int                dd_stat;
61             char               dd_name[1];
62         } DIR;
63 #   else
64 #       include <dirent.h>
65 #   endif /*!__MINGW32__*/
66
67 #   ifndef S_ISDIR
68 #       define S_ISDIR(X) ((X)&_S_IFDIR)
69 #   endif
70 #else
71 #   include <sys/types.h>
72 #   include <sys/stat.h>
73 #   include <unistd.h>
74 #   include <dirent.h>
75 #endif /*!_WIN32*/
76
77 /*
78  * Function: platform_vsnprintf
79  *  Write formatted output using a pointer to a lis of arguments.
80  *
81  * Parameters:
82  *  buffer - Storage location for output.
83  *  bytes  - Maximum number of characters to write.
84  *  format - Format specification.
85  *  arg    - Variable argument list.
86  *
87  * Returns:
88  *  The number of characters written if the number of characters to write
89  *  is less than or equal to `bytes`; if the number of characters to write
90  *  is greater than `bytes`, this function returns -1 indicating that the
91  *  output has been truncated. The return value does not include the
92  *  terminating null, if one is written.
93  *
94  * Remarks:
95  *  Function takes pointer to an argument list, then formats the data,
96  *  and writes up to `bytes` characters to the memory pointed to by
97  *  `buffer`. If there is room at the end (that is, if the number of
98  *  character to write is less than `bytes`), the buffer will be null-terminated.
99  */
100 int platform_vsnprintf(char *buffer, size_t bytes, const char *format, va_list arg);
101
102 /*
103  * Function: platform_vsscanf
104  *  Reads formatted data from a string.
105  *
106  * Parameters:
107  *  buffer - Stored data to read.
108  *  format - Format specification.
109  *  arg    - Variable argument list.
110  *
111  * Returns:
112  *  The number of fields that are successfully converted and assigned;
113  *  the return value does not include fields that were read but not
114  *  assigned. A return vlaue of 0 indicated that no fields were assigned.
115  *  The return value if EOF for error or if the end of the string is
116  *  reached before the first conversion.
117  *
118  * Remarks:
119  *  Reads data from `buffer` into the locations that are given by each
120  *  argument in the `arg` argument list. Every argument in the list must
121  *  be a pointer to a variable that has a type that corresponds to a
122  *  type specifier in `format`. The `format` argument controls th
123  *  interpretation of the input fields and has the same form and function
124  *  as the `format` argument for the *scanf* function. If copying takes
125  *  place between strings that overlap, the behaviour is undefined.
126  */
127 int platform_vsscanf(const char *buffer, const char *format, va_list arg);
128
129 /*
130  * Function: platform_localtime
131  *  Convert a time value and correct for the local time zone.
132  *
133  * Parameters
134  *  timer - Pointer to stored time.
135  *
136  * Returns:
137  *  A pointer to a structure result, or NULL if the date passed to
138  *  the function is before midnight, January 1, 1970.
139  */
140 const struct tm *platform_localtime(const time_t *timer);
141
142 /*
143  * Function: platform_ctime
144  *  Convert a time value to a string and adjust for local time zone
145  *  settings.
146  *
147  * Parameters:
148  *  timer - Pointer to stored time.
149  *
150  * Returns:
151  *  Pointer to the character string result. NULL will be returned if time
152  *  represents a date before midnight, January 1, 1970, UTC.
153  *
154  * Remarks:
155  *  Converts a time value stored as a `time_t` value into a chracter string.
156  *  The `timer` value is usually obtained from a call to *time*, which returns
157  *  the number of seconds since midnight, January 1, 1970 UTC. The return
158  *  value of the string contains exactly 26 characters. A 24-hour clock is used.
159  *  All fields have constant width. The newline chracter and the null character
160  *  occupy the last two positions of the string. The converted character string
161  *  is also adjusted according to the local time zone settings.
162  */
163 const char *platform_ctime(const time_t *timer);
164
165 /*
166  * Function: platform_strncat
167  *  Append characters of a string.
168  *
169  * Parameters:
170  *  dest - Null terminated destination string
171  *  src  - Source string
172  *  num  - Number of characters to append
173  *
174  * Returns:
175  *  Pointer to the destination string. No return value is used to indicate
176  *  an error.
177  *
178  * Remarks:
179  *  Function appends, at mode, the first `num` characters of `src` to
180  *  `dest`. The initial character of `src` overwrites the terminating
181  *  null chracter of `dest`. If a null character appears in `src` before
182  *  `num` chracters are appended, `platform_strncat` appends all chracters
183  *  from `src`, up to the null chracter. If `num` is greater than the
184  *  length of `src`, the length of `src` is used in place of `num`.
185  */
186 char *platform_strncat(char *dest, const char *src, size_t num);
187
188 /*
189  * Function: platform_getenv
190  *  Get a value from the current enviroment.
191  *
192  * Parameters:
193  *  var - Enviroment variable name
194  *
195  * Returns:
196  *  A pointer to the enviroment table entry containing `var. It's not
197  *  safe to modify the value of the enviroment variable using the returned
198  *  pointer. The return value is *NULL* if `var` is not found in the
199  *  enviroment table.
200  */
201 const char *platform_getenv(const char *var);
202
203 /*
204  * Function: platform_vasprintf
205  *  Print to allocated string
206  *
207  * Parameters:
208  *  dat  - Pointer to pointer to store allocated data.
209  *  fmt  - Format specification.
210  *  args - Variable argument list.
211  *
212  * Returns:
213  *  Number of character written, -1 is used to indicate an error.
214  *
215  * Remarks:
216  *  Allocate a string large enough to hold the output including
217  *  the terminating null character than write formatted output
218  *  to it using format specification.
219  */
220 int platform_vasprintf(char **dat, const char *fmt, va_list args);
221
222 /*
223  * Function: platform_vfprintf
224  *  Write formatted output using a pointer to a list of arguments.
225  *
226  * Parameters:
227  *  stream - Pointer to stream.
228  *  format - Format specification.
229  *  atrg   - Variable argument list.
230  *
231  * Returns:
232  *  Number of characters written, not including the terminating null
233  *  character, or a negitive value if an output error occurs. -1 is
234  *  also used to indicate an error.
235  *
236  * Remarks:
237  *  Takes a pointer to an argument list, then formats and writes the
238  *  given data to `stream`.
239  */
240 int platform_vfprintf(FILE *stream, const char *format, va_list arg);
241
242 /*
243  * Function: platform_strcat
244  *  Append characters of a string.
245  *
246  * Parameters:
247  *  dest - Null terminated destination string
248  *  src  - Source string
249  *
250  * Returns:
251  *  Pointer to the destination string. No return value is used to indicate
252  *  an error.
253  *
254  * Remarks:
255  *  Appens `src` to `dest` and terminates with resulting null character.
256  *  The initial character of `src` overwrites the terminating null
257  *  character of `dest`. The behaviour of platform_strcat is undefined
258  *  if the source and destination string overlap.
259  */
260 char *platform_strcat(char *dest, const char *src);
261
262 /*
263  * Function: platform_strncpy
264  *  Copys characters of one string to another.
265  *
266  * Parameters:
267  *  dest - Destination string.
268  *  src  - Source string.
269  *  num  - Number of characters to be copied.
270  *
271  * Returns:
272  *  `dest`. No return value is reserved to indicate an error.
273  *
274  * Remarks:
275  *  Copies the initial characters of `src` to `dest` and returns `dest`.
276  *  If `num` is less than or equal to the length of `src1 a null character
277  *  is not appended automatically to the copied string. If `num` is greater
278  *  than the length of `src`, the destination string is padded with null
279  *  characters up to length `num`. The behaviour of this function is undefined
280  *  if the source and destination strings overlap.
281  */
282 char *platform_strncpy(char *dest, const char *src, size_t num);
283
284 /*
285  * Function: platform_strerror
286  *  Get a system error message
287  *
288  * Parameters:
289  *  err - Error number.
290  *
291  * Returns:
292  *  A pointer to the error message
293  */
294 const char *platform_strerror(int err);
295
296 /*
297  * Function: platform_fopen
298  *  Opens a file
299  *
300  * Parameters:
301  *  filename - File name.
302  *  mode     - Kind of access that's enabled.
303  *
304  * Returns:
305  *  A pointer to the open file. A null pointer value indicates an error.
306  */
307 FILE *platform_fopen(const char *filename, const char *mode);
308
309 /*
310  * Function: platform_fread
311  *  Reads data from a stream
312  *
313  * Parameters:
314  *  ptr    - Storage location for data.
315  *  size   - Item size in bytes.
316  *  count  - Maximum number of items to be read.
317  *  stream - Pointer to stream
318  *
319  * Returns:
320  *  The number of full items actually read, which may be less than `count`
321  *  if an error occurs or if the end of the file is encountered before
322  *  reaching `count`. If `size` or `count` is 0, `platform_fread`
323  *  returns 0 and the buffer contents are unchanged.
324  */
325 size_t platform_fread(void *ptr, size_t size, size_t count, FILE *stream);
326
327 /*
328  * Function: platform_fwrite
329  *  Writes data to a stream
330  *
331  * Parameters:
332  *  ptr    - Pointer to data to be written.
333  *  size   - Item size in bytes.
334  *  count  - Maximum number of items to be read.
335  *  stream - Pointer to stream
336  *
337  * Returns:
338  *  The number of full items actually written, which may be less than
339  *  `count` if an error occurs. Also, if an error occurs, the
340  *  file-position indicator cannot be determined.
341  *
342  * Remarks:
343  *  Writes up to `count` items, of `size` length each, from `ptr` to the
344  *  output stream. The file pointer associated with stream (if there is one)
345  *  is incremented by the number of bytes actually written.
346  */
347 size_t platform_fwrite(const void *ptr, size_t size, size_t count, FILE *stream);
348
349 /*
350  * Function: platform_fflush
351  *  Flushes a stream
352  *
353  * Parameters:
354  *  stream - Pointer to stream
355  *
356  * Returns:
357  *  0 value if the buffer was succesffuly flushed. The value 0 is also
358  *  returned in cases in which the specified stream has no buffer or is
359  *  open for reading only. A return value of *EOF* indicates an error.
360  *
361  * Remarks:
362  *  Flushes a stream. If the file associated with stream is open for output,
363  *  platform_fflush writes to that file the contents of the buffer
364  *  associated with the stream. If the stream is open for input,
365  *  platform_fflush clears the contents of the buffer. platform_fflush
366  *  negates the effect of any prior call to ungetc against stream. Also,
367  *  platform_fflush(NULL) flushes all streams opened for output.
368  *  The stream remains open after the call. platform_fflush has no effect
369  *  on an unbuffered stream.
370  */
371 int platform_fflush(FILE *stream);
372
373 /*
374  * Function: platform_fclose
375  *  Closes a stream.
376  *
377  * Parameters:
378  *  stream - Pointer to stream.
379  *
380  * Returns:
381  *  0 value. *EOF* is used to indicate an error.
382  *
383  * Remarks:
384  *  Closes a stream.
385  */
386 int platform_fclose(FILE *stream);
387
388 /*
389  * Function: platform_ferror
390  *  Tests for an error on a stream.
391  *
392  * Parameters:
393  *  stream - Pointer to stream.
394  *
395  * Returns:
396  *  If not error has occured on `stream`, 0 value is returned, otherwise
397  *  it returns a nonzero value.
398  *
399  * Remarks:
400  *  Tests for a reading or writing error on the file associated with `stream`.
401  *  If an error has occured, the error indicator for the stream remains set
402  *  until the stream is closed or rewound.
403  */
404 int platform_ferror(FILE *stream);
405
406 /*
407  * Function: platform_fgetc
408  *  Read a character from a stream.
409  *
410  * Parameters:
411  *  stream - Pointer to a stream.
412  *
413  * Returns:
414  *  The chracter read as an int or EOF to indicate an error or end-of-file.
415  *
416  * Remarks:
417  *  Reads a single chracter from the current position of the file associated
418  *  with `stream`. Than increments that position. If the steam is at the end
419  *  of the file, the end-of-file indicator for the stream is set.
420  */
421 int platform_fgetc(FILE *stream);
422
423 /*
424  * Function: platform_fputs
425  *  Write a string to a stream
426  *
427  * Parameters:
428  *  str    - Output string.
429  *  stream - Pointer to stream.
430  *
431  * Returns:
432  *  Non-negative value if successful. EOF is used to indicate an error.
433  *
434  * Remarks:
435  *  Copies `str` to the output stream at the current position.
436  */
437 int platform_fputs(const char *str, FILE *stream);
438
439 /*
440  * Function: platform_fseek
441  *  Moves the file pointer to a specified location.
442  *
443  * Parameters:
444  *  stream - Pointer to stream.
445  *  offset - Number of bytes from origin to offset.
446  *  origin - Initital position.
447  *
448  * Returns:
449  *  0 value, nonzero values are used to indicate an error.
450  *
451  * Remarks:
452  *  Moves the file pointer (if any) associated with stream to a new
453  *  location that is offset bytes from origin.
454  *  The next operation on the stream takes place at the new location.
455  *  On a stream open for update, the next operation can be either a
456  *  read or a write.
457  */
458 int platform_fseek(FILE *stream, long offset, int origin);
459
460 /*
461  * Function: platform_ftell
462  *  Gets the current position of a file pointer
463  *
464  * Parameters:
465  *  stream - Pointer to stream
466  *
467  * Returns:
468  *  Current file position. May not reflect physical byte offset, e.g
469  *  systems where read-mode does carriage return-linefeed translation.
470  *  -1 value is used to indivate an error.
471  */
472 long platform_ftell(FILE *stream);
473
474 /*
475  * Function: platform_mkdir
476  *  Make a directory
477  *
478  * Parameters:
479  *  path    - Path to create
480  *  mode    - The mode of the directory (implementation defined)
481  *
482  * Returns:
483  *  0 value. -1 value is used to indicate an error. On error no
484  *  directory shall be created.
485  *
486  * Remarks:
487  *  Shall create a new empty directory with with the name path specified
488  *  by argument `path.
489  */
490 int platform_mkdir(const char *path, int mode);
491
492 /*
493  * Function: platform_opendir
494  *  Open a directory
495  *
496  * Parameters:
497  *  path - Path to the directory to open
498  *
499  * Returns:
500  *  Pointer to an object of type *DIR*. A null pointer value indicates
501  *  an error.
502  *
503  * Remarks:
504  *  Shall open a directory stream corresponding to the directory named by
505  *  the `path` argument. The directory stream is positioned at the first entry.
506  */
507 DIR *platform_opendir(const char *path);
508
509 /*
510  * Function: platform_closedir
511  *  Close a directory stream
512  *
513  * Parameters:
514  *  dir - Pointer to directory stream
515  *
516  * Returns:
517  *  0 value. A -1 value indicated an error.
518  *
519  * Remarks:
520  *  Shall close the directory stream referred to by the argument
521  *  `dir`. Upon return, the value of `dir` may no longer point to
522  *  an accessible object of the type *DIR*.
523  */
524 int platform_closedir(DIR *dir);
525
526 /*
527  * Function: platform_readdir
528  *  Read directory
529  *
530  * Parameters:
531  *  dir - Pointer to directory stream
532  *
533  * Returns:
534  *  Pointer to an object of type `struct dirent`. A null pointer value
535  *  indicates an error.
536  *
537  * Remarks:
538  *  When the end of the directory is encountered, a null pointer is
539  *  returned.
540  */
541 struct dirent *platform_readdir(DIR *dir);
542
543 /*
544  * Function: platform_isatty
545  *  Determines whether a file descriptor is associated with a character
546  *  device.
547  *
548  * Returns:
549  *  A nonzero value if the descriptor is associated with a character
550  *  device. Otherwise `platform_isatty` returns 0.
551  */
552 int platform_isatty(int fd);
553
554 #endif