2 \brief Intermediate Representation (IR) between Directory Structure and Engine Grammar
3 \details The IR serves as a storage structure that is populated during the
4 parsing of the input directory structure. After parsing is complete,
5 the IR will be condensed (removed of excess allocated space) and then
6 output as the Engine Grammar. In this file we describe the semantic actions
7 that are called at each step, and the memory buffers that they populate.
8 See parser.y for the description on how the input grammar is constructed,
9 and where/when semantic actions are called.
10 TODO: or just write it here.
11 \author Jordan Lavatai
13 ----------------------------------------------------------------------------*/
22 #define MAX_MODELS 256
24 #define MAX_CLASS_DEPTH 256
25 #define MAX_CLASSES 256
26 #define MAX_FRAMES 256
27 #define PTRS_IN_PAGE 1024
28 #define MAX_CHUNKS 256
29 #define PAGES_PER_CHUNK 16
31 /* Sets: elements. The set is populated at parse time AFTER the
32 elements are populated, due to the nature of bottom up parsing. */
40 /* Cdats: A cdat is a class data structure. Cdats serve as the central */
41 /* data types of the IR. For each cdat, sets and element */
42 /* ref_ids must be dereferenced to determine the odat information. Cdats */
43 /* contain pointers to their subclasses so that the relationship between */
44 /* classes can be determined, but the subclasses are not represented inside */
45 /* of the cdat itself but rather in subsequent cdats in cdat_buf. We */
46 /* can determine the number of subclasses (the last index into cdat_buf */
47 /* that represents a subclass of some arbitrary cdat) each cdat has by */
48 /* incrementing num_classes during parse time. */
49 /* TODO: Should classes point to their parent class? */
56 struct cdat
* class_list
[MAX_CLASSES
];
57 struct set set_list
[MAX_SETS
];
60 /* The cdat_stack is a stack pointers to cdat pointers, the top of which is
61 the cdat that is currently being parsed. Whenever a new cdat is recognized
62 by the grammar (CLOPEN), a cdat is pushed onto the cdat_stack, and we refer
63 to this cdat through the macro CURR_CDAT. By keeping a cdat_stack, we have
64 access to the current cdat so that the elements and sets can populate themselves
65 in the cdat accordingly. */
68 /* Refs: Each set/ele has a reference to its object data (odat) through a ref_id.
69 Ref_ids are unsigned 64 byte integers that map to the hex values RGBA. During
70 the construction of the directory structure, users can choose a RGBA value for
71 each object that any other object can refer to via links (see link). If a user
72 does not choose an RGBA value, then the object is given one from the system space.
73 We maintain a doubly linked list of refs in the ref_buf at parse time so that
74 links can be resolved after the parsing of the directory structure is complete.
75 For every 16th ref, we create a post so that we can reduce on the search time for
83 uint64_t ref_id
; //0xFFFFFF->digit
87 /* Links: At parse time, a set/ele can include a link in their
88 grammar representation instead of the actual data and this signifies
89 to the APC that that set/ele wishes to use the data of another
90 set/ele, either its video data (vdat) or object data (odat). The link
91 itself contains the type of link it is, the ref_id OR name, and
92 which set/ele created the link. During parse time, links can be made
93 to o/vdats that have yet to be parsed. In order to accomodate for this,
94 we resolve all links AFTER parse time by iterating through the link_buf,
95 finding the ref_id that was stored for some object (if the ref_id exists),
96 and creating a relative pointer from the original object to the data that
99 /* Svlinks stand for short vlink, which is a link to a vdat. svlinks
100 differ from vlinks because they do not have a name */
106 /* A vlink is what it sounds like, a link to a vdat */
112 /* Olinks are links to odats */
120 struct svlink svlink
;
123 /* From: Some odat ()To: Another odat (ref_id)*/
125 int type
; //1 = olink, 2 = vlink, 3 = svlink
133 /* Odats: Odats consist of the object data necessary for
134 each object. Odats are sometimes referred to as archetypes
135 at compile-time, in order to distinguish the difference from
136 a runtime object and a compile-time object.
137 TODO: Need more info about objects at runtime, to described
138 the reasoning behind odat structure at compile-time*/
152 struct ref
* refp
; /* pointer to it's ref on ref_list */
156 struct odat
* curr_set_odatp
; //when a set has elements, insert_set() can no longer
157 //refer to its odat via curr_odat, so save the set odat.
159 /* A framesheet is a grouping of animation frames in
160 a single direction (N,W,S,E) */
165 void* frames
[MAX_FRAMES
];
168 /* A model is a collection of framesheets for every
169 direction (N,W,S,E,NW,NE,SW,SE)*/
170 /* NAMED spritesheet */
173 struct framesheet spritesheet
[8]; //one for each
176 /* Vdat: Vdats are the video data of each object. They can not be
177 created as a stand alone object (because they consist solely
178 of animation information and not the skeleton on which the
179 animation manipulates). Vdats have a list of models for every
180 animation that the vdats odat can do for that vdat*/
182 struct odat
* creator
; //pointer to odat that made this vdat
184 struct model model_list
[MAX_MODELS
];
187 /* Called after the cdat open operator has been recognized in grammar. Allocates
188 the space for a cdat on the cdat_buf, pushes that pointer onto
193 /* Called after a cdat end operator has been recognized in grammar. Sets
194 top stack cdat ** to null and decrements stack pointer */
198 /* Called after an odat has been populated. Allocates memory for
202 insert_set_label(char*, uint64_t);
204 /* Populate the sets representation in CURR_CDAT with a ref_id and insert a link
205 into the link_buf that will resolve the ref_id to an actual odat after parse time. */
207 insert_set_olink(uint64_t);
209 /* Put the vlink in the link_buf to be processed after parsetime */
211 insert_set_vlink(uint64_t, char*);
213 /* Put svlink in the link_buf to be processed after parsetime */
215 insert_set_svlink(uint64_t);
217 /* Called for every set reduction except for sets with olinks. Populates the
218 set data structures in the CDAT and in the ODAT. Uses the name and ref_id
219 from insert_set_label. Also inserts a ref into the ref_buf with the CURR_ODAT
220 pointer so that we can also resolve the odat from its ref_id. */
224 /* Insertion of eles is practically equivalent to how sets are inserted because both
225 share the same data type (ODAT). Like sets, eles have links, labels
226 and odats. Eles have the added notion of a parent set, and so must be inserted
227 into said parent set, but this is the only place they truly differ from sets. */
230 insert_set_vdatid(void);
233 insert_ele_label(char*, uint64_t);
235 /* Insert an ele olink into the CURR_ODAT */
237 insert_ele_olink(uint64_t);
239 /* Insert a ele vlink into CURR_ODAT*/
241 insert_ele_vlink(uint64_t, char*);
243 /* Inserts an ele short vlink into CURR_ODAT*/
245 insert_ele_svlink(uint64_t);
247 /* inserts ele into CURR_CLASS and CURR_ODAT */
252 insert_ele_vdatid(void);
254 /* Inserts the hitbox into the CURR_ODAT */
258 /* Inserts the root into the CURR_ODAT */
260 insert_root(int, int, int);
262 /* Inserts a quad into the CURR_ODAT */
270 insert_framesheet(char, char*, uint64_t, int, int, int);
273 insert_frame_pointer(char, void*);