ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/cv/mgflib/parser.h
Revision: 1.33
Committed: Fri Feb 28 20:11:29 2003 UTC (21 years, 2 months ago) by greg
Content type: text/plain
Branch: MAIN
CVS Tags: rad3R5
Changes since 1.32: +2 -14 lines
Log Message:
Updates for 3.5 release

File Contents

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