platform.h

   1 /*
   2  * Copyright (C) 2012, 2013
   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
  64 #       ifdef S_ISDIR
  65 #           undef  S_ISDIR
  66 #       endif /*! S_ISDIR */
  67 #       define S_ISDIR(X) ((X)&_S_IFDIR)
  68 #   else
  69 #       include <dirent.h>
  70 #   endif /*!__MINGW32__*/
  71 #else
  72 #   include <sys/types.h>
  73 #   include <sys/stat.h>
  74 #   include <unistd.h>
  75 #   include <dirent.h>
  76 #endif /*!_WIN32*/
  77
  78 /*
  79  * Function: platform_vsnprintf
  80  *  Write formatted output using a pointer to a lis of arguments.
  81  *
  82  * Parameters:
  83  *  buffer - Storage location for output.
  84  *  bytes  - Maximum number of characters to write.
  85  *  format - Format specification.
  86  *  arg    - Variable argument list.
  87  *
  88  * Returns:
  89  *  The number of characters written if the number of characters to write
  90  *  is less than or equal to `bytes`; if the number of characters to write
  91  *  is greater than `bytes`, this function returns -1 indicating that the
  92  *  output has been truncated. The return value does not include the
  93  *  terminating null, if one is written.
  94  *
  95  * Remarks:
  96  *  Function takes pointer to an argument list, then formats the data,
  97  *  and writes up to `bytes` characters to the memory pointed to by
  98  *  `buffer`. If there is room at the end (that is, if the number of
  99  *  character to write is less than `bytes`), the buffer will be null-terminated.
 100  */
 101 int platform_vsnprintf(char *buffer, size_t bytes, const char *format, va_list arg);
 102
 103 /*
 104  * Function: platform_vsscanf
 105  *  Reads formatted data from a string.
 106  *
 107  * Parameters:
 108  *  buffer - Stored data to read.
 109  *  format - Format specification.
 110  *  arg    - Variable argument list.
 111  *
 112  * Returns:
 113  *  The number of fields that are successfully converted and assigned;
 114  *  the return value does not include fields that were read but not
 115  *  assigned. A return vlaue of 0 indicated that no fields were assigned.
 116  *  The return value if EOF for error or if the end of the string is
 117  *  reached before the first conversion.
 118  *
 119  * Remarks:
 120  *  Reads data from `buffer` into the locations that are given by each
 121  *  argument in the `arg` argument list. Every argument in the list must
 122  *  be a pointer to a variable that has a type that corresponds to a
 123  *  type specifier in `format`. The `format` argument controls th
 124  *  interpretation of the input fields and has the same form and function
 125  *  as the `format` argument for the *scanf* function. If copying takes
 126  *  place between strings that overlap, the behaviour is undefined.
 127  */
 128 int platform_vsscanf(const char *buffer, const char *format, va_list arg);
 129
 130 /*
 131  * Function: platform_localtime
 132  *  Convert a time value and correct for the local time zone.
 133  *
 134  * Parameters
 135  *  timer - Pointer to stored time.
 136  *
 137  * Returns:
 138  *  A pointer to a structure result, or NULL if the date passed to
 139  *  the function is before midnight, January 1, 1970.
 140  */
 141 const struct tm *platform_localtime(const time_t *timer);
 142
 143 const char *platform_ctime(const time_t *timer);
 144 char *platform_strncat(char *dest, const char *src, size_t num);
 145 const char *platform_tmpnam(char *str);
 146 const char *platform_getenv(char *var);
 147 int platform_vasprintf(char **dat, const char *fmt, va_list args);
 148 char *platform_strcat(char *dest, const char *src);
 149 char *platform_strncpy(char *dest, const char *src, size_t num);
 150 const char *platform_strerror(int err);
 151 FILE *platform_fopen(const char *filename, const char *mode);
 152 size_t platform_fread(void *ptr, size_t size, size_t count, FILE *stream);
 153 size_t platform_fwrite(const void *ptr, size_t size, size_t count, FILE *stream);
 154 int platform_fflush(FILE *stream);
 155 int platform_vfprintf(FILE *stream, const char *format, va_list arg);
 156 int platform_fclose(FILE *stream);
 157 int platform_ferror(FILE *stream);
 158 int platform_fgetc(FILE *stream);
 159 int platform_fputs(const char *str, FILE *stream);
 160 int platform_fseek(FILE *stream, long offset, int origin);
 161 long platform_ftell(FILE *stream);
 162 int platform_mkdir(const char *path, int mode);
 163 DIR *platform_opendir(const char *path);
 164 int platform_closedir(DIR *dir);
 165 struct dirent *platform_readdir(DIR *dir);
 166 int platform_isatty(int fd);
 167
 168 #endif