ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/cv/mgflib/parser.h
Revision: 1.20
Committed: Thu Apr 13 12:54:23 1995 UTC (29 years ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 1.19: +23 -19 lines
Log Message:
added index of refraction to materials

File Contents

# Content
1 /* Copyright (c) 1994 Regents of the University of California */
2
3 /* SCCSid "$SunId$ LBL" */
4
5 /*
6 * Header file for MGF interpreter
7 */
8
9 /* must include stdio.h before us */
10
11 /* Entities (order doesn't really matter) */
12 #define MG_E_COMMENT 0
13 #define MG_E_COLOR 1
14 #define MG_E_CCT 2
15 #define MG_E_CONE 3
16 #define MG_E_CMIX 4
17 #define MG_E_CSPEC 5
18 #define MG_E_CXY 6
19 #define MG_E_CYL 7
20 #define MG_E_ED 8
21 #define MG_E_FACE 9
22 #define MG_E_INCLUDE 10
23 #define MG_E_IES 11
24 #define MG_E_IR 12
25 #define MG_E_MATERIAL 13
26 #define MG_E_NORMAL 14
27 #define MG_E_OBJECT 15
28 #define MG_E_POINT 16
29 #define MG_E_PRISM 17
30 #define MG_E_RD 18
31 #define MG_E_RING 19
32 #define MG_E_RS 20
33 #define MG_E_SIDES 21
34 #define MG_E_SPH 22
35 #define MG_E_TD 23
36 #define MG_E_TORUS 24
37 #define MG_E_TS 25
38 #define MG_E_VERTEX 26
39 #define MG_E_XF 27
40
41 #define MG_NENTITIES 28
42
43 #define MG_NAMELIST {"#","c","cct","cone","cmix","cspec","cxy","cyl","ed",\
44 "f","i","ies","ir","m","n","o","p","prism","rd",\
45 "ring","rs","sides","sph","td","torus","ts","v","xf"}
46
47 #define MG_MAXELEN 6
48
49 extern char mg_ename[MG_NENTITIES][MG_MAXELEN];
50
51 /* Handler routines for each entity */
52
53 #ifdef NOPROTO
54 extern int (*mg_ehand[MG_NENTITIES])();
55 #else
56 extern int (*mg_ehand[MG_NENTITIES])(int argc, char **argv);
57 #endif
58
59 /* Error codes */
60 #define MG_OK 0 /* normal return value */
61 #define MG_EUNK 1 /* unknown entity */
62 #define MG_EARGC 2 /* wrong number of arguments */
63 #define MG_ETYPE 3 /* argument type error */
64 #define MG_EILL 4 /* illegal argument value */
65 #define MG_EUNDEF 5 /* undefined reference */
66 #define MG_ENOFILE 6 /* cannot open input file */
67 #define MG_EINCL 7 /* error in included file */
68 #define MG_EMEM 8 /* out of memory */
69 #define MG_ESEEK 9 /* file seek error */
70 #define MG_EBADMAT 10 /* bad material specification */
71
72 #define MG_NERRS 11
73
74 extern char *mg_err[MG_NERRS];
75
76 /*
77 * The general process for running the parser is to fill in the mg_ehand
78 * array with handlers for each entity you know how to handle.
79 * Then, call mg_init to fill in the rest. This function will report
80 * an error and quit if you try to support an inconsistent set of entities.
81 * For each file you want to parse, call mg_load with the file name.
82 * To read from standard input, use NULL as the file name.
83 * For additional control over error reporting and file management,
84 * use mg_open, mg_read, mg_parse and mg_close instead of mg_load.
85 * To pass an entity of your own construction to the parser, use
86 * the mg_handle function rather than the mg_ehand routines directly.
87 * (The first argument to mg_handle is the entity #, or -1.)
88 * To free any data structures and clear the parser, use mg_clear.
89 * If there is an error, mg_load, mg_open, mg_parse, mg_handle and
90 * mg_rewind will return an error from the list above. In addition,
91 * mg_load will report the error to stderr. The mg_read routine
92 * returns 0 when the end of file has been reached.
93 */
94
95 #define MG_MAXLINE 4096 /* maximum input line length */
96 #define MG_MAXARGC (MG_MAXLINE/4) /* maximum argument count */
97
98 typedef struct mg_fctxt {
99 char fname[96]; /* file name */
100 FILE *fp; /* stream pointer */
101 int fid; /* unique file context id */
102 char inpline[MG_MAXLINE]; /* input line */
103 int lineno; /* line number */
104 struct mg_fctxt *prev; /* previous context */
105 } MG_FCTXT;
106
107 typedef struct {
108 int fid; /* file this position is for */
109 int lineno; /* line number in file */
110 long offset; /* offset from beginning */
111 } MG_FPOS;
112
113 extern MG_FCTXT *mg_file; /* current file context */
114
115 #ifdef NOPROTO
116 extern void mg_init(); /* fill in mg_ehand array */
117 extern int mg_load(); /* parse a file */
118 extern int mg_open(); /* open new input file */
119 extern int mg_read(); /* read next line */
120 extern int mg_parse(); /* parse current line */
121 extern void mg_fgetpos(); /* get position on input file */
122 extern int mg_fgoto(); /* go to position on input file */
123 extern void mg_close(); /* close input file */
124 extern void mg_clear(); /* clear parser */
125 extern int mg_handle(); /* handle an entity */
126 #else
127 extern void mg_init(void); /* fill in mg_ehand array */
128 extern int mg_load(char *); /* parse a file */
129 extern int mg_open(MG_FCTXT *, char *); /* open new input file */
130 extern int mg_read(void); /* read next line */
131 extern int mg_parse(void); /* parse current line */
132 extern void mg_fgetpos(MG_FPOS *); /* get position on input file */
133 extern int mg_fgoto(MG_FPOS *); /* go to position on input file */
134 extern void mg_close(void); /* close input file */
135 extern void mg_clear(void); /* clear parser */
136 extern int mg_handle(int, int, char **); /* handle an entity */
137 #endif
138
139 #ifndef MG_NQCD
140 #define MG_NQCD 5 /* default number of divisions */
141 #endif
142
143 extern int mg_nqcdivs; /* divisions per quarter circle */
144
145 /*
146 * The following library routines are included for your convenience:
147 */
148
149 #ifdef NOPROTO
150 extern int mg_entity(); /* get entity number from its name */
151 extern int isint(); /* non-zero if integer format */
152 extern int isflt(); /* non-zero if floating point format */
153 #else
154 extern int mg_entity(char *); /* get entity number from its name */
155 extern int isint(char *); /* non-zero if integer format */
156 extern int isflt(char *); /* non-zero if floating point format */
157 #endif
158
159 /************************************************************************
160 * Definitions for 3-d vector manipulation functions
161 */
162
163 #ifdef SMLFLT
164 #define FLOAT float
165 #define FTINY (1e-3)
166 #else
167 #define FLOAT double
168 #define FTINY (1e-6)
169 #endif
170 #define FHUGE (1e10)
171
172 typedef FLOAT FVECT[3];
173
174 #define VCOPY(v1,v2) ((v1)[0]=(v2)[0],(v1)[1]=(v2)[1],(v1)[2]=(v2)[2])
175 #define DOT(v1,v2) ((v1)[0]*(v2)[0]+(v1)[1]*(v2)[1]+(v1)[2]*(v2)[2])
176 #define VSUM(vr,v1,v2,f) ((vr)[0]=(v1)[0]+(f)*(v2)[0], \
177 (vr)[1]=(v1)[1]+(f)*(v2)[1], \
178 (vr)[2]=(v1)[2]+(f)*(v2)[2])
179
180 #define is0vect(v) (DOT(v,v) <= FTINY*FTINY)
181
182 #define round0(x) if (x <= FTINY && x >= -FTINY) x = 0
183
184 #ifdef NOPROTO
185 extern double normalize(); /* normalize a vector */
186 #else
187 extern double normalize(FVECT); /* normalize a vector */
188 #endif
189
190 /************************************************************************
191 * Definitions for context handling routines
192 * (materials, colors, vectors)
193 */
194
195 #define C_CMINWL 380 /* minimum wavelength */
196 #define C_CMAXWL 780 /* maximum wavelength */
197 #define C_CNSS 41 /* number of spectral samples */
198 #define C_CWLI ((C_CMAXWL-C_CMINWL)/(C_CNSS-1))
199 #define C_CMAXV 10000 /* nominal maximum sample value */
200 #define C_CLPWM (683./C_CMAXV) /* peak lumens/watt multiplier */
201
202 #define C_CSSPEC 01 /* flag if spectrum is set */
203 #define C_CDSPEC 02 /* flag if defined w/ spectrum */
204 #define C_CSXY 04 /* flag if xy is set */
205 #define C_CDXY 010 /* flag if defined w/ xy */
206 #define C_CSEFF 020 /* flag if efficacy set */
207
208 typedef struct {
209 int clock; /* incremented each change */
210 short flags; /* what's been set */
211 short ssamp[C_CNSS]; /* spectral samples, min wl to max */
212 long ssum; /* straight sum of spectral values */
213 float cx, cy; /* xy chromaticity value */
214 float eff; /* efficacy (lumens/watt) */
215 } C_COLOR;
216
217 #define C_DEFCOLOR { 1, C_CDXY|C_CSXY|C_CSSPEC|C_CSEFF,\
218 {C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,\
219 C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,\
220 C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,\
221 C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,\
222 C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,\
223 C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,\
224 C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV,C_CMAXV},\
225 (long)C_CNSS*C_CMAXV, 1./3., 1./3., 178.006 }
226
227 #define c_cval(c,l) ((double)(c)->ssamp[((l)-C_MINWL)/C_CWLI] / (c)->ssum)
228
229 #define C_1SIDEDTHICK 0.005 /* assumed thickness of 1-sided mat. */
230
231 typedef struct {
232 int clock; /* incremented each change -- resettable */
233 int sided; /* 1 if surface is 1-sided, 0 for 2-sided */
234 float nr, ni; /* index of refraction, real and imaginary */
235 float rd; /* diffuse reflectance */
236 C_COLOR rd_c; /* diffuse reflectance color */
237 float td; /* diffuse transmittance */
238 C_COLOR td_c; /* diffuse transmittance color */
239 float ed; /* diffuse emittance */
240 C_COLOR ed_c; /* diffuse emittance color */
241 float rs; /* specular reflectance */
242 C_COLOR rs_c; /* specular reflectance color */
243 float rs_a; /* specular reflectance roughness */
244 float ts; /* specular transmittance */
245 C_COLOR ts_c; /* specular transmittance color */
246 float ts_a; /* specular transmittance roughness */
247 } C_MATERIAL; /* material context */
248
249 typedef struct {
250 int clock; /* incremented each change -- resettable */
251 FVECT p, n; /* point and normal */
252 } C_VERTEX; /* vertex context */
253
254 #define C_DEFMATERIAL {1,0,1.,0.,0.,C_DEFCOLOR,0.,C_DEFCOLOR,0.,C_DEFCOLOR,\
255 0.,C_DEFCOLOR,0.,0.,C_DEFCOLOR,0.}
256 #define C_DEFVERTEX {1,{0.,0.,0.},{0.,0.,0.}}
257
258 extern C_COLOR *c_ccolor; /* the current color */
259 extern char *c_ccname; /* current color name */
260 extern C_MATERIAL *c_cmaterial; /* the current material */
261 extern char *c_cmname; /* current material name */
262 extern C_VERTEX *c_cvertex; /* the current vertex */
263 extern char *c_cvname; /* current vertex name */
264
265 #ifdef NOPROTO
266 extern int c_hcolor(); /* handle color entity */
267 extern int c_hmaterial(); /* handle material entity */
268 extern int c_hvertex(); /* handle vertex entity */
269 extern void c_clearall(); /* clear context tables */
270 extern C_MATERIAL *c_getmaterial(); /* get a named material */
271 extern C_VERTEX *c_getvert(); /* get a named vertex */
272 extern C_COLOR *c_getcolor(); /* get a named color */
273 extern void c_ccvt(); /* fix color representation */
274 extern int c_isgrey(); /* check if color is grey */
275 #else
276 extern int c_hcolor(int, char **); /* handle color entity */
277 extern int c_hmaterial(int, char **); /* handle material entity */
278 extern int c_hvertex(int, char **); /* handle vertex entity */
279 extern void c_clearall(void); /* clear context tables */
280 extern C_MATERIAL *c_getmaterial(char *); /* get a named material */
281 extern C_VERTEX *c_getvert(char *); /* get a named vertex */
282 extern C_COLOR *c_getcolor(char *); /* get a named color */
283 extern void c_ccvt(C_COLOR *, int); /* fix color representation */
284 extern int c_isgrey(C_COLOR *); /* check if color is grey */
285 #endif
286
287 /*************************************************************************
288 * Definitions for hierarchical object name handler
289 */
290
291 extern int obj_nnames; /* depth of name hierarchy */
292 extern char **obj_name; /* names in hierarchy */
293
294 #ifdef NOPROTO
295 extern int obj_handler(); /* handle an object entity */
296 extern void obj_clear(); /* clear object stack */
297 #else
298 extern int obj_handler(int, char **); /* handle an object entity */
299 extern void obj_clear(void); /* clear object stack */
300 #endif
301
302 /**************************************************************************
303 * Definitions for hierarchical transformation handler
304 */
305
306 typedef FLOAT MAT4[4][4];
307
308 #ifdef BSD
309 #define copymat4(m4a,m4b) bcopy((char *)m4b,(char *)m4a,sizeof(MAT4))
310 #else
311 #define copymat4(m4a,m4b) (void)memcpy((char *)m4a,(char *)m4b,sizeof(MAT4))
312 #endif
313
314 #define MAT4IDENT { {1.,0.,0.,0.}, {0.,1.,0.,0.}, \
315 {0.,0.,1.,0.}, {0.,0.,0.,1.} }
316
317 extern MAT4 m4ident;
318
319 #define setident4(m4) copymat4(m4, m4ident)
320
321 /* regular transformation */
322 typedef struct {
323 MAT4 xfm; /* transform matrix */
324 FLOAT sca; /* scalefactor */
325 } XF;
326
327 #define identxf(xp) (void)(setident4((xp)->xfm),(xp)->sca=1.0)
328
329 #define XF_MAXDIM 8 /* maximum array dimensions */
330
331 struct xf_array {
332 MG_FPOS spos; /* starting position on input */
333 int ndim; /* number of array dimensions */
334 struct {
335 short i, n; /* current count and maximum */
336 char arg[8]; /* string argument value */
337 } aarg[XF_MAXDIM];
338 };
339
340 typedef struct xf_spec {
341 long xid; /* unique transform id */
342 short xav0; /* zeroeth argument in xf_argv array */
343 short xac; /* transform argument count */
344 short rev; /* boolean true if vertices reversed */
345 XF xf; /* cumulative transformation */
346 struct xf_array *xarr; /* transformation array pointer */
347 struct xf_spec *prev; /* previous transformation context */
348 } XF_SPEC; /* followed by argument buffer */
349
350 extern int xf_argc; /* total # transform args. */
351 extern char **xf_argv; /* transform arguments */
352 extern XF_SPEC *xf_context; /* current context */
353
354 /*
355 * The transformation handler should do most of the work that needs
356 * doing. Just pass it any xf entities, then use the associated
357 * functions to transform and translate points, transform vectors
358 * (without translation), rotate vectors (without scaling) and scale
359 * values appropriately.
360 *
361 * The routines xf_xfmpoint, xf_xfmvect and xf_rotvect take two
362 * 3-D vectors (which may be identical), transforms the second and
363 * puts the result into the first.
364 */
365
366 #ifdef NOPROTO
367
368 extern int xf_handler(); /* handle xf entity */
369 extern void xf_xfmpoint(); /* transform point */
370 extern void xf_xfmvect(); /* transform vector */
371 extern void xf_rotvect(); /* rotate vector */
372 extern double xf_scale(); /* scale a value */
373 extern void xf_clear(); /* clear xf stack */
374
375 /* The following are support routines you probably won't call directly */
376
377 extern void multmat4(); /* m4a = m4b X m4c */
378 extern void multv3(); /* v3a = v3b X m4 (vectors) */
379 extern void multp3(); /* p3a = p3b X m4 (points) */
380 extern int xf(); /* interpret transform spec. */
381
382 #else
383
384 extern int xf_handler(int, char **); /* handle xf entity */
385 extern void xf_xfmpoint(FVECT, FVECT); /* transform point */
386 extern void xf_xfmvect(FVECT, FVECT); /* transform vector */
387 extern void xf_rotvect(FVECT, FVECT); /* rotate vector */
388 extern double xf_scale(double); /* scale a value */
389 extern void xf_clear(void); /* clear xf stack */
390
391 /* The following are support routines you probably won't call directly */
392
393 extern void multmat4(MAT4, MAT4, MAT4); /* m4a = m4b X m4c */
394 extern void multv3(FVECT, FVECT, MAT4); /* v3a = v3b X m4 (vectors) */
395 extern void multp3(FVECT, FVECT, MAT4); /* p3a = p3b X m4 (points) */
396 extern int xf(XF *, int, char **); /* interpret transform spec. */
397
398 #endif
399
400 /************************************************************************
401 * Miscellaneous definitions
402 */
403
404 #ifdef M_PI
405 #define PI M_PI
406 #else
407 #define PI 3.14159265358979323846
408 #endif
409
410 #ifdef DCL_ATOF
411 extern double atof();
412 #endif
413
414 #ifndef MEM_PTR
415 #define MEM_PTR void *
416 #endif
417
418 extern MEM_PTR malloc();
419 extern MEM_PTR calloc();
420 extern MEM_PTR realloc();
421 extern void free();