add scene lighting constructs; real stdin support
[chaz/rasterize] / common.h
1
2 /*
3 * CS5600 University of Utah
4 * Charles McGarvey
5 * mcgarvey@eng.utah.edu
6 */
7
8 #ifndef _COMMON_H_
9 #define _COMMON_H_
10
11 #include <math.h>
12 #include <stdbool.h>
13 #include <stdint.h>
14 #include <stdio.h>
15 #include <stdlib.h>
16 #include <string.h>
17
18 #include "config.h"
19
20
21 /*
22 * Define a keyword for use while defining small and fast functions.
23 */
24 #if EXTRA_INLINE
25 #define INLINE_MAYBE static inline
26 #else
27 #define INLINE_MAYBE static
28 #endif
29
30
31 /*
32 * Define a type for scalar values, either float or double.
33 */
34 #if DOUBLE_FLOAT
35 typedef double scal_t;
36 #define SCALAR_SIZE 8
37 #define S(K) K
38 #define scal_floor floor
39 #define scal_ceil ceil
40 #define scal_min fmin
41 #define scal_max fmax
42 #define scal_abs fabs
43 #define scal_pow pow
44 #define scal_sqrt sqrt
45 #define scal_sin sin
46 #define scal_cos cos
47 #define scal_tan tan
48 #define scal_asin asin
49 #define scal_acos acos
50 #define scal_atan atan
51 #else
52 typedef float scal_t;
53 #define SCALAR_SIZE 4
54 #define S(K) K##f
55 #define scal_floor floorf
56 #define scal_ceil ceilf
57 #define scal_min fminf
58 #define scal_max fmaxf
59 #define scal_abs fabsf
60 #define scal_pow powf
61 #define scal_sqrt sqrtf
62 #define scal_sin sinf
63 #define scal_cos cosf
64 #define scal_tan tanf
65 #define scal_asin asinf
66 #define scal_acos acosf
67 #define scal_atan atanf
68 #endif
69
70 #define scal_min2(A,B,C) scal_min(scal_min(A,B),C)
71 #define scal_max2(A,B,C) scal_max(scal_max(A,B),C)
72
73 #define SCAL_EPSILON (S(0.000001))
74
75 /*
76 * Check if two scalars are mostly equal, given a margin of error.
77 */
78 INLINE_MAYBE
79 bool scal_isequal2(scal_t a, scal_t b, scal_t e)
80 {
81 return scal_abs(a -b) < e;
82 }
83
84 /*
85 * Check if two scalars are mostly equal.
86 */
87 INLINE_MAYBE
88 bool scal_isequal(scal_t a, scal_t b)
89 {
90 return scal_isequal2(a, b, SCAL_EPSILON);
91 }
92
93 /*
94 * Clamp a scalar between two values.
95 */
96 INLINE_MAYBE
97 scal_t scal_clamp(scal_t s, scal_t min, scal_t max)
98 {
99 if (s < min) {
100 return min;
101 }
102 if (max < s) {
103 return max;
104 }
105 return s;
106 }
107
108
109 /*
110 * Define min and max functions for integers.
111 */
112 INLINE_MAYBE
113 int imin(int a, int b)
114 {
115 return a < b ? a : b;
116 }
117 INLINE_MAYBE
118 int imax(int a, int b)
119 {
120 return a < b ? b : a;
121 }
122
123
124 /*
125 * Define some macros for packing and unpacking bytes to and from larger ints.
126 */
127 #define PACK(W,N,B) (((B) << (8 * (N))) | ((W) & ~(0xff << (8 * (N)))))
128 #define UNPACK(W,N) ((uint8_t)((W) >> (8 * (N))) & 0xff)
129
130
131 /*
132 * Try to execute a statement and print a status message. If the statement
133 * resolves to 0, it is considered to have succeeded; any other evaluation is
134 * an error condition and an abort(3) occurs.
135 * return.
136 */
137 #if VERBOSITY >= 1
138 #define TRY_DO(L, K, ARGS...) \
139 printf("* " L "... ", ##ARGS); \
140 fflush(stdout); \
141 if ((K) == 0) printf("done!\n"); \
142 else abort()
143 #else
144 #define TRY_DO(L, K, ARGS...) \
145 if ((K) != 0) abort()
146 #endif
147
148
149 /*
150 * Declare a type of destructor functions.
151 */
152 typedef void (*dtor_t)(void*);
153 #define DTOR(A) (dtor_t)(A)
154
155
156 /*
157 * Allocate a block of memory of a certain size. This follows the semantics
158 * of malloc(3), except it will never return NULL and will abort(3) if the
159 * memory could not be allocated.
160 */
161 void* mem_alloc(size_t size);
162
163 /*
164 * Change the size of a block of memory. This follows the semantics of
165 * realloc(3), except it will never return NULL and will abort(3) if the
166 * memory could not be allocated.
167 */
168 void* mem_realloc(void* mem, size_t size);
169
170 /*
171 * Deallocate a block of memory previously allocated by mem_alloc or malloc(3)
172 * and friends. This is essentially just a call to free(3).
173 */
174 void mem_free(void* mem);
175
176 /*
177 * Set a function to call if either mem_alloc or mem_realloc fails, or NULL if
178 * no callback should be called. The callback takes the same arguments as
179 * realloc(3) and may try to fulfill the request. The return value of the
180 * callback function will be returned from the allocation function and must be
181 * a valid pointer to an allocated block of memory. The callback function
182 * should not call mem_alloc or mem_realloc and must not return if a block of
183 * memory could not be allocated.
184 */
185 void mem_set_fn(void* (*fn)(void*, size_t));
186
187 /*
188 * Get the number of blocks currently allocated with either mem_alloc or
189 * mem_realloc. This number should be zero at the end of a process running
190 * this program.
191 */
192 int mem_blocks();
193
194
195 /*
196 * Duplicate a string; like the non-standard strdup(3) but uses mem_alloc.
197 * The result needs to be freed with mem_free.
198 */
199 INLINE_MAYBE
200 char* mem_strdup(const char* str)
201 {
202 size_t size = strlen(str) + 1;
203 return (char*)memcpy(mem_alloc(size), str, size);
204 }
205
206 /*
207 * Get an allocated string made up of two strings concatenated together.
208 * The result needs to be freed with mem_free.
209 */
210 INLINE_MAYBE
211 char* mem_strcat(const char* str1, const char* str2)
212 {
213 size_t size1 = strlen(str1);
214 size_t size2 = strlen(str2);
215 char* str = (char*)mem_alloc(size1 + size2 + 1);
216 memcpy(str + size1, str2, size2 + 1);
217 return memcpy(str, str1, size1);
218 }
219
220
221 /*
222 * Cut a string short at the last matching character. The string will be
223 * modified if the character was matched. Either way, str is returned.
224 */
225 INLINE_MAYBE
226 char* strcut(char* str, int c)
227 {
228 char* ptr = strrchr(str, c);
229 if (ptr != NULL) {
230 *ptr = '\0';
231 }
232 return str;
233 }
234
235 /*
236 * Trim white space off of the right side of a string.
237 */
238 void rtrim(char *str);
239
240 /*
241 * Trim white space off of the left side of a string.
242 */
243 void ltrim(char *str);
244
245 /*
246 * Trim white space off of both sides of a string.
247 */
248 INLINE_MAYBE
249 void trim(char *str)
250 {
251 rtrim(str);
252 ltrim(str);
253 }
254
255
256 /*
257 * Initialize the timer.
258 */
259 void timer_start();
260
261 /*
262 * Stop the timer and return how many microseconds passed after
263 * initialization.
264 */
265 long timer_stop();
266
267
268 #endif // _COMMON_H_
269
This page took 0.052986 seconds and 4 git commands to generate.