Update README
[xonotic/gmqcc.git] / util.c
1 /*
2  * Copyright (C) 2012, 2013
3  *     Dale Weiler
4  *     Wolfgang Bumiller
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
7  * this software and associated documentation files (the "Software"), to deal in
8  * the Software without restriction, including without limitation the rights to
9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10  * of the Software, and to permit persons to whom the Software is furnished to do
11  * so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #define GMQCC_PLATFORM_HEADER
25 #include <string.h>
26 #include <stdlib.h>
27 #include <stdarg.h>
28
29 #include "gmqcc.h"
30 #include "platform.h"
31
32 /*
33  * Initially this was handled with a table in the gmqcc.h header, but
34  * much to my surprise the contents of the table was duplicated for
35  * each translation unit, causing all these strings to be duplicated
36  * for every .c file it was included into. This method culls back on
37  * it. This is a 'utility' function because the executor also depends
38  * on this for disassembled byte-code.
39  */
40 const char *util_instr_str[VINSTR_END] = {
41     "DONE",       "MUL_F",      "MUL_V",      "MUL_FV",
42     "MUL_VF",     "DIV_F",      "ADD_F",      "ADD_V",
43     "SUB_F",      "SUB_V",      "EQ_F",       "EQ_V",
44     "EQ_S",       "EQ_E",       "EQ_FNC",     "NE_F",
45     "NE_V",       "NE_S",       "NE_E",       "NE_FNC",
46     "LE",         "GE",         "LT",         "GT",
47     "LOAD_F",     "LOAD_V",     "LOAD_S",     "LOAD_ENT",
48     "LOAD_FLD",   "LOAD_FNC",   "ADDRESS",    "STORE_F",
49     "STORE_V",    "STORE_S",    "STORE_ENT",  "STORE_FLD",
50     "STORE_FNC",  "STOREP_F",   "STOREP_V",   "STOREP_S",
51     "STOREP_ENT", "STOREP_FLD", "STOREP_FNC", "RETURN",
52     "NOT_F",      "NOT_V",      "NOT_S",      "NOT_ENT",
53     "NOT_FNC",    "IF",         "IFNOT",      "CALL0",
54     "CALL1",      "CALL2",      "CALL3",      "CALL4",
55     "CALL5",      "CALL6",      "CALL7",      "CALL8",
56     "STATE",      "GOTO",       "AND",        "OR",
57     "BITAND",     "BITOR"
58 };
59
60 /*
61  * only required if big endian .. otherwise no need to swap
62  * data.
63  */
64 #if PLATFORM_BYTE_ORDER == GMQCC_BYTE_ORDER_BIG
65     static GMQCC_INLINE void util_swap16(uint16_t *d, size_t l) {
66         while (l--) {
67             d[l] = (d[l] << 8) | (d[l] >> 8);
68         }
69     }
70
71     static GMQCC_INLINE void util_swap32(uint32_t *d, size_t l) {
72         while (l--) {
73             uint32_t v;
74             v = ((d[l] << 8) & 0xFF00FF00) | ((d[l] >> 8) & 0x00FF00FF);
75             d[l] = (v << 16) | (v >> 16);
76         }
77     }
78
79     /* Some strange system doesn't like constants that big, AND doesn't recognize an ULL suffix
80      * so let's go the safe way
81      */
82     static GMQCC_INLINE void util_swap64(uint32_t *d, size_t l) {
83         /*
84         while (l--) {
85             uint64_t v;
86             v = ((d[l] << 8) & 0xFF00FF00FF00FF00) | ((d[l] >> 8) & 0x00FF00FF00FF00FF);
87             v = ((v << 16) & 0xFFFF0000FFFF0000) | ((v >> 16) & 0x0000FFFF0000FFFF);
88             d[l] = (v << 32) | (v >> 32);
89         }
90         */
91         size_t i;
92         for (i = 0; i < l; i += 2) {
93             uint32_t v1 = d[i];
94             d[i] = d[i+1];
95             d[i+1] = v1;
96             util_swap32(d+i, 2);
97         }
98     }
99 #endif
100
101 void util_endianswap(void *_data, size_t length, unsigned int typesize) {
102 #   if PLATFORM_BYTE_ORDER == -1 /* runtime check */
103     if (*((char*)&typesize))
104         return;
105 #else
106     /* prevent unused warnings */
107     (void) _data;
108     (void) length;
109     (void) typesize;
110
111 #   if PLATFORM_BYTE_ORDER == GMQCC_BYTE_ORDER_LITTLE
112         return;
113 #   else
114         switch (typesize) {
115             case 1: return;
116             case 2:
117                 util_swap16((uint16_t*)_data, length>>1);
118                 return;
119             case 4:
120                 util_swap32((uint32_t*)_data, length>>2);
121                 return;
122             case 8:
123                 util_swap64((uint32_t*)_data, length>>3);
124                 return;
125
126             default: exit(EXIT_FAILURE); /* please blow the fuck up! */
127         }
128 #   endif
129 #endif
130 }
131
132 /*
133  * CRC algorithms vary in the width of the polynomial, the value of said polynomial,
134  * the initial value used for the register, weather the bits of each byte are reflected
135  * before being processed, weather the algorithm itself feeds input bytes through the
136  * register or XORs them with a byte from one end and then straight into the table, as
137  * well as (but not limited to the idea of reflected versions) where the final register
138  * value becomes reversed, and finally weather the value itself is used to XOR the final
139  * register value.  AS such you can already imagine how painfully annoying CRCs are,
140  * of course we stand to target Quake, which expects it's certain set of rules for proper
141  * calculation of a CRC.
142  *
143  * In most traditional CRC algorithms on uses a reflected table driven method where a value
144  * or register is reflected if it's bits are swapped around it's center.  For example:
145  * take the bits 0101 is the 4-bit reflection of 1010, and respectfully 0011 would be the
146  * reflection of 1100. Quake however expects a NON-Reflected CRC on the output, but still
147  * requires a final XOR on the values (0xFFFF and 0x0000) this is a standard CCITT CRC-16
148  * which I respectfully as a programmer don't agree with.
149  *
150  * So now you know what we target, and why we target it, despite how unsettling it may seem
151  * but those are what Quake seems to request.
152  */
153
154 static const uint16_t util_crc16_table[] = {
155     0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7, 0x8108,
156     0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF, 0x1231, 0x0210,
157     0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6, 0x9339, 0x8318, 0xB37B,
158     0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE, 0x2462, 0x3443, 0x0420, 0x1401,
159     0x64E6, 0x74C7, 0x44A4, 0x5485, 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE,
160     0xF5CF, 0xC5AC, 0xD58D, 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6,
161     0x5695, 0x46B4, 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D,
162     0xC7BC, 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
163     0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B, 0x5AF5,
164     0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12, 0xDBFD, 0xCBDC,
165     0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A, 0x6CA6, 0x7C87, 0x4CE4,
166     0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41, 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD,
167     0xAD2A, 0xBD0B, 0x8D68, 0x9D49, 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13,
168     0x2E32, 0x1E51, 0x0E70, 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A,
169     0x9F59, 0x8F78, 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E,
170     0xE16F, 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
171     0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E, 0x02B1,
172     0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256, 0xB5EA, 0xA5CB,
173     0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D, 0x34E2, 0x24C3, 0x14A0,
174     0x0481, 0x7466, 0x6447, 0x5424, 0x4405, 0xA7DB, 0xB7FA, 0x8799, 0x97B8,
175     0xE75F, 0xF77E, 0xC71D, 0xD73C, 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657,
176     0x7676, 0x4615, 0x5634, 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9,
177     0xB98A, 0xA9AB, 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882,
178     0x28A3, 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
179     0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92, 0xFD2E,
180     0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9, 0x7C26, 0x6C07,
181     0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1, 0xEF1F, 0xFF3E, 0xCF5D,
182     0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8, 0x6E17, 0x7E36, 0x4E55, 0x5E74,
183     0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
184 };
185
186 /* Non - Reflected */
187 uint16_t util_crc16(uint16_t current, const char *k, size_t len) {
188     register uint16_t h = current;
189     for (; len; --len, ++k)
190         h = util_crc16_table[(h>>8)^((unsigned char)*k)]^(h<<8);
191     return h;
192 }
193 /* Reflective Variation (for reference) */
194 #if 0
195 uint16_t util_crc16(const char *k, int len, const short clamp) {
196     register uint16_t h= (uint16_t)0xFFFFFFFF;
197     for (; len; --len, ++k)
198         h = util_crc16_table[(h^((unsigned char)*k))&0xFF]^(h>>8);
199     return (~h)%clamp;
200 }
201 #endif
202
203 /*
204  * modifier is the match to make and the transposition from it, while add is the upper-value that determines the
205  * transposition from uppercase to lower case.
206  */
207 static GMQCC_INLINE size_t util_strtransform(const char *in, char *out, size_t outsz, const char *mod, int add) {
208     size_t sz = 1;
209     for (; *in && sz < outsz; ++in, ++out, ++sz) {
210         *out = (*in == mod[0])
211                     ? mod[1]
212                     : (util_isalpha(*in) && ((add > 0) ? util_isupper(*in) : !util_isupper(*in)))
213                         ? *in + add
214                         : *in;
215     }
216     *out = 0;
217     return sz-1;
218 }
219
220 size_t util_strtocmd(const char *in, char *out, size_t outsz) {
221     return util_strtransform(in, out, outsz, "-_", 'A'-'a');
222 }
223 size_t util_strtononcmd(const char *in, char *out, size_t outsz) {
224     return util_strtransform(in, out, outsz, "_-", 'a'-'A');
225 }
226 size_t util_optimizationtostr(const char *in, char *out, size_t outsz) {
227     return util_strtransform(in, out, outsz, "_ ", 'a'-'A');
228 }
229
230 int util_snprintf(char *str, size_t size, const char *fmt, ...) {
231     va_list  arg;
232     int      ret;
233
234     va_start(arg, fmt);
235     ret = platform_vsnprintf(str, size, fmt, arg);
236     va_end(arg);
237
238     return ret;
239 }
240
241 int util_asprintf(char **ret, const char *fmt, ...) {
242     va_list  args;
243     int      read;
244
245     va_start(args, fmt);
246     read = platform_vasprintf(ret, fmt, args);
247     va_end  (args);
248
249     return read;
250 }
251
252 int util_sscanf(const char *str, const char *format, ...) {
253     va_list  args;
254     int      read;
255
256     va_start(args, format);
257     read = platform_vsscanf(str, format, args);
258     va_end(args);
259
260     return read;
261 }
262
263 char *util_strncpy(char *dest, const char *src, size_t n) {
264     return platform_strncpy(dest, src, n);
265 }
266 char *util_strncat(char *dest, const char *src, size_t n) {
267     return platform_strncat(dest, src, n);
268 }
269 char *util_strcat(char *dest, const char *src) {
270     return platform_strcat(dest, src);
271 }
272 const char *util_strerror(int err) {
273     return platform_strerror(err);
274 }
275
276 const struct tm *util_localtime(const time_t *timer) {
277     return platform_localtime(timer);
278 }
279 const char *util_ctime(const time_t *timer) {
280     return platform_ctime(timer);
281 }
282
283 bool util_isatty(fs_file_t *file) {
284     if (file == (fs_file_t*)stdout) return !!platform_isatty(STDOUT_FILENO);
285     if (file == (fs_file_t*)stderr) return !!platform_isatty(STDERR_FILENO);
286     return false;
287 }
288
289 void util_seed(uint32_t value) {
290     srand((int)value);
291 }
292 uint32_t util_rand() {
293     return rand();
294 }