ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/cv/mgflib/parser.h
Revision: 1.24
Committed: Thu May 11 20:17:36 1995 UTC (28 years, 11 months ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 1.23: +8 -2 lines
Log Message:
added default handling of undefined entities

File Contents

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