ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/cv/mgflib/parser.h
Revision: 1.36
Committed: Mon Jun 30 14:59:11 2003 UTC (20 years, 10 months ago) by schorsch
Content type: text/plain
Branch: MAIN
Changes since 1.35: +1 -5 lines
Log Message:
Replaced most outdated BSD function calls with their posix equivalents, and cleaned up a few other platform dependencies.

File Contents

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