summaryrefslogtreecommitdiff
path: root/hw/dmx/config/dmxparse.h
blob: de81d23b73e7e25771b41fe2916a46453a3a16d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
/*
 * Copyright 2002 Red Hat Inc., Durham, North Carolina.
 *
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation on the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NON-INFRINGEMENT.  IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/*
 * Authors:
 *   Rickard E. (Rik) Faith <faith@redhat.com>
 *
 */

/** \file
 * Interface to DMX configuration file parser.  \see dmxparse.c */

#ifndef _DMXPARSE_H_
#define _DMXPARSE_H_

#include <stdio.h>              /* For FILE */

/** Stores tokens not stored in other structures (e.g., keywords and ;) */
typedef struct _DMXConfigToken {
    int                      token;
    int                      line;
    const char               *comment;
} DMXConfigToken, *DMXConfigTokenPtr;

/** Stores parsed strings. */
typedef struct _DMXConfigString {
    int                      token;
    int                      line;
    const char               *comment;
    const char               *string;
    struct _DMXConfigString  *next;
} DMXConfigString, *DMXConfigStringPtr;

/** Stores parsed numbers. */
typedef struct _DMXConfigNumber {
    int                      token;
    int                      line;
    const char               *comment;
    int                      number;
} DMXConfigNumber, *DMXConfigNumberPtr;

/** Stores parsed pairs (e.g., x y) */
typedef struct _DMXConfigPair {
    int                      token;
    int                      line;
    const char               *comment;
    int                      x;
    int                      y;
    int                      xsign;
    int                      ysign;
} DMXConfigPair, *DMXConfigPairPtr;

/** Stores parsed comments not stored with a token. */
typedef struct _DMXConfigComment {
    int                      token;
    int                      line;
    const char               *comment;
} DMXConfigComment, *DMXConfigCommentPtr;

typedef enum {
    dmxConfigComment,
    dmxConfigVirtual,
    dmxConfigDisplay,
    dmxConfigWall,
    dmxConfigOption,
    dmxConfigParam
} DMXConfigType;

/** Stores a geometry specification. */
typedef struct _DMXConfigPartDim {
    DMXConfigPairPtr         dim;
    DMXConfigPairPtr         offset;
} DMXConfigPartDim, *DMXConfigPartDimPtr;

/** Stores a pair of geometry specifications. */
typedef struct _DMXConfigFullDim {
    DMXConfigPartDimPtr      scrn;
    DMXConfigPartDimPtr      root;
} DMXConfigFullDim, *DMXConfigFullDimPtr;

/** Stores parsed display information. */
typedef struct _DMXConfigDisplay {
                                /* Summary information */
    const char               *name;
                                /* Screen Window Geometry */
    int                      scrnWidth, scrnHeight;
    int                      scrnX, scrnY;
    int                      scrnXSign, scrnYSign;
                                /* Root Window Geometry */
    int                      rootWidth, rootHeight;
    int                      rootX, rootY;
    int                      rootXSign, rootYSign;
                                /* Origin in global space */
    int                      rootXOrigin, rootYOrigin;
    
                                /* Raw configuration information */
    DMXConfigTokenPtr        start;
    DMXConfigStringPtr       dname;
    DMXConfigFullDimPtr      dim;
    DMXConfigPairPtr         origin;
    DMXConfigTokenPtr        end;
} DMXConfigDisplay, *DMXConfigDisplayPtr;

/** Stores parsed wall information. */
typedef struct _DMXConfigWall {
                                /* Summary information */
    int                      width, height; /* dimensions of displays */
    int                      xwall, ywall; /* dimensions of wall, in tiles */

    
                                /* Raw configuration informaiton */
    DMXConfigTokenPtr        start;
    DMXConfigPairPtr         wallDim;
    DMXConfigPairPtr         displayDim;
    DMXConfigStringPtr       nameList;
    DMXConfigTokenPtr        end;
} DMXConfigWall, *DMXConfigWallPtr;

/** Stores parsed option information. */
typedef struct _DMXConfigOption {
                                /* Summary information */
    char                     *string;
    
                                /* Raw configuration informaiton */
    DMXConfigTokenPtr        start;
    DMXConfigStringPtr       option;
    DMXConfigTokenPtr        end;
} DMXConfigOption, *DMXConfigOptionPtr;

/** Stores parsed param information. */
typedef struct _DMXConfigParam {
    int                      argc;
    const char               **argv;
    
    DMXConfigTokenPtr        start;
    DMXConfigTokenPtr        open;
    DMXConfigStringPtr       param;
    DMXConfigTokenPtr        close;
    DMXConfigTokenPtr        end; /* Either open/close OR end */
    struct _DMXConfigParam   *next;
} DMXConfigParam, *DMXConfigParamPtr;

/** Stores options under an entry (subentry). */
typedef struct _DMXConfigSub {
    DMXConfigType             type;
    DMXConfigCommentPtr       comment;
    DMXConfigDisplayPtr       display;
    DMXConfigWallPtr          wall;
    DMXConfigOptionPtr        option;
    DMXConfigParamPtr         param;
    struct _DMXConfigSub      *next;
} DMXConfigSub, *DMXConfigSubPtr;

/** Stores parsed virtual information. */
typedef struct _DMXConfigVirtual {
                                /* Summary information */
    const char                *name;
    int                       width, height;

                                /* Raw configuration information */
    DMXConfigTokenPtr         start;
    DMXConfigStringPtr        vname;
    DMXConfigPairPtr          dim;
    DMXConfigTokenPtr         open;
    DMXConfigSubPtr           subentry;
    DMXConfigTokenPtr         close;
} DMXConfigVirtual, *DMXConfigVirtualPtr;

/** Heads entry storage. */
typedef struct _DMXConfigEntry {
    DMXConfigType            type;
    DMXConfigCommentPtr      comment;
    DMXConfigVirtualPtr      virtual;
    struct _DMXConfigEntry   *next;
} DMXConfigEntry, *DMXConfigEntryPtr;

extern DMXConfigEntryPtr   dmxConfigEntry;

extern int                 yylex(void);
extern int                 yydebug;
extern void                yyerror(const char *message);

extern void                dmxConfigLog(const char *format, ...);
extern void                *dmxConfigAlloc(unsigned long bytes);
extern void                *dmxConfigRealloc(void *orig,
                                             unsigned long orig_bytes,
                                             unsigned long bytes);
extern const char          *dmxConfigCopyString(const char *string,
                                                int length);
extern void                dmxConfigFree(void *area);
extern DMXConfigTokenPtr   dmxConfigCreateToken(int token, int line,
                                                const char *comment);
extern void                dmxConfigFreeToken(DMXConfigTokenPtr p);
extern DMXConfigStringPtr  dmxConfigCreateString(int token, int line,
                                                 const char *comment,
                                                 const char *string);
extern void                dmxConfigFreeString(DMXConfigStringPtr p);
extern DMXConfigNumberPtr  dmxConfigCreateNumber(int token, int line,
                                                 const char *comment,
                                                 int number);
extern void                dmxConfigFreeNumber(DMXConfigNumberPtr p);
extern DMXConfigPairPtr    dmxConfigCreatePair(int token, int line,
                                               const char *comment,
                                               int x, int y,
                                               int xsign, int ysign);
extern void                dmxConfigFreePair(DMXConfigPairPtr p);
extern DMXConfigCommentPtr dmxConfigCreateComment(int token, int line,
                                                  const char *comment);
extern void                dmxConfigFreeComment(DMXConfigCommentPtr p);
extern DMXConfigPartDimPtr dmxConfigCreatePartDim(DMXConfigPairPtr pDim,
                                                  DMXConfigPairPtr pOffset);
extern void                dmxConfigFreePartDim(DMXConfigPartDimPtr p);
extern DMXConfigFullDimPtr dmxConfigCreateFullDim(DMXConfigPartDimPtr pScrn,
                                                  DMXConfigPartDimPtr pRoot);
extern void                dmxConfigFreeFullDim(DMXConfigFullDimPtr p);
extern DMXConfigDisplayPtr dmxConfigCreateDisplay(DMXConfigTokenPtr pStart,
                                                  DMXConfigStringPtr pName,
                                                  DMXConfigFullDimPtr pDim,
                                                  DMXConfigPairPtr pOrigin,
                                                  DMXConfigTokenPtr pEnd);
extern void                dmxConfigFreeDisplay(DMXConfigDisplayPtr p);
extern DMXConfigWallPtr    dmxConfigCreateWall(DMXConfigTokenPtr pStart,
                                               DMXConfigPairPtr pWallDim,
                                               DMXConfigPairPtr pDisplayDim,
                                               DMXConfigStringPtr pNameList,
                                               DMXConfigTokenPtr pEnd);
extern void                dmxConfigFreeWall(DMXConfigWallPtr p);
extern DMXConfigOptionPtr  dmxConfigCreateOption(DMXConfigTokenPtr pStart,
                                                 DMXConfigStringPtr pOption,
                                                 DMXConfigTokenPtr pEnd);
extern void                dmxConfigFreeOption(DMXConfigOptionPtr p);
extern DMXConfigParamPtr   dmxConfigCreateParam(DMXConfigTokenPtr pStart,
                                                DMXConfigTokenPtr pOpen,
                                                DMXConfigStringPtr pParam,
                                                DMXConfigTokenPtr pClose,
                                                DMXConfigTokenPtr pEnd);
extern void                dmxConfigFreeParam(DMXConfigParamPtr p);
extern const char          **dmxConfigLookupParam(DMXConfigParamPtr p,
                                                  const char *key,
                                                  int *argc);
extern DMXConfigSubPtr     dmxConfigCreateSub(DMXConfigType type,
                                              DMXConfigCommentPtr comment,
                                              DMXConfigDisplayPtr display,
                                              DMXConfigWallPtr wall,
                                              DMXConfigOptionPtr option,
                                              DMXConfigParamPtr param);
extern void                dmxConfigFreeSub(DMXConfigSubPtr sub);
extern DMXConfigSubPtr     dmxConfigSubComment(DMXConfigCommentPtr comment);
extern DMXConfigSubPtr     dmxConfigSubDisplay(DMXConfigDisplayPtr display);
extern DMXConfigSubPtr     dmxConfigSubWall(DMXConfigWallPtr wall);
extern DMXConfigSubPtr     dmxConfigSubOption(DMXConfigOptionPtr option);
extern DMXConfigSubPtr     dmxConfigSubParam(DMXConfigParamPtr param);
extern DMXConfigSubPtr     dmxConfigAddSub(DMXConfigSubPtr head,
                                           DMXConfigSubPtr sub);
extern DMXConfigVirtualPtr dmxConfigCreateVirtual(DMXConfigTokenPtr pStart,
                                                  DMXConfigStringPtr pName,
                                                  DMXConfigPairPtr pDim,
                                                  DMXConfigTokenPtr pOpen,
                                                  DMXConfigSubPtr pSubentry,
                                                  DMXConfigTokenPtr pClose);
extern void                dmxConfigFreeVirtual(DMXConfigVirtualPtr virtual);
extern DMXConfigEntryPtr   dmxConfigCreateEntry(DMXConfigType type,
                                                DMXConfigCommentPtr comment,
                                                DMXConfigVirtualPtr virtual);
extern void                dmxConfigFreeEntry(DMXConfigEntryPtr entry);
extern DMXConfigEntryPtr   dmxConfigAddEntry(DMXConfigEntryPtr head,
                                             DMXConfigType type,
                                             DMXConfigCommentPtr comment,
                                             DMXConfigVirtualPtr virtual);
extern DMXConfigEntryPtr   dmxConfigEntryComment(DMXConfigCommentPtr comment);
extern DMXConfigEntryPtr   dmxConfigEntryVirtual(DMXConfigVirtualPtr virtual);

#endif