src/apc/ir.h

   1 /*!@file
   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
  12   \date    Aug 2016
  13   ----------------------------------------------------------------------------*/
  14
  15
  16 #include <stdint.h>
  17
  18 #define BUF_SIZE 256
  19 #define MAX_SETS 256
  20 #define MAX_ELES 256
  21 #define MAX_QUADS 256
  22 #define MAX_MODELS 256
  23 #define MAX_POSTS 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
  30
  31 /*  Sets: elements. The set is populated at parse time AFTER the
  32     elements are populated, due to the nature of bottom up parsing.          */
  33
  34 struct set {
  35   char name[32];
  36   uint64_t ref_id;
  37   int cdat_idx;
  38 };
  39
  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?                         */
  50
  51 struct cdat {
  52   char name[32];
  53   int idx;
  54   int num_classes;
  55   int num_sets;
  56   struct cdat* class_list[MAX_CLASSES];
  57   struct set set_list[MAX_SETS];
  58 };
  59
  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. */
  66
  67
  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
  76    a random access. */
  77
  78 struct ref {
  79   int type;
  80   struct ref* nextref;
  81   struct ref* lastref;
  82   struct odat* odatp;
  83   uint64_t ref_id; //0xFFFFFF->digit
  84 };
  85
  86
  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
  97    was linked */
  98
  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 */
 101
 102 struct svlink {
 103   uint64_t ref_id;
 104 };
 105
 106 /* A vlink is what it sounds like, a link to a vdat */
 107 struct vlink {
 108   uint64_t ref_id;
 109   char anim_name[32];
 110 };
 111
 112 union link_t {
 113   struct vlink vlink;
 114   struct svlink svlink;
 115 };
 116
 117 /* From: src odat ()To: dest odat (ref_id)*/
 118 struct link {
 119   int type; //1 = olink, 2 = vlink, 3 = svlink
 120   union link_t link_t;
 121   struct cdat* classp;
 122   struct odat* odatp;
 123   int set_idx;
 124   int ele_idx;
 125 };
 126
 127
 128 /* Odats: Odats consist of the object data necessary for
 129    each object. Odats are sometimes referred to as archetypes
 130    at compile-time, in order to distinguish the difference from
 131    a runtime object and a compile-time object.
 132    TODO: Need more info about objects at runtime, to described
 133          the reasoning behind odat structure at compile-time*/
 134
 135 struct root {
 136   int x, y, z;
 137 };
 138
 139 struct odat {
 140   char name[32];
 141   struct vdat* vdatp;
 142   int vdat_id; //
 143   int cdat_idx;
 144   int hitbox;
 145   uint64_t ref_id;
 146   struct root root;
 147   struct ref* refp; /* pointer to it's ref on ref_list */
 148   void* quad_filep;
 149 };
 150
 151 struct odat* curr_set_odatp; //when a set has elements, insert_set() can no longer
 152                             //refer to its odat via curr_odat, so save the set odat.
 153
 154 /* A framesheet is a grouping of animation frames in
 155    a single direction (N,W,S,E) */
 156 struct framesheet {
 157   int width;
 158   int height;
 159   int num_frames;
 160   void* frames[MAX_FRAMES];
 161 };
 162
 163 /* A model is a collection of framesheets for every
 164    direction (N,W,S,E,NW,NE,SW,SE)*/
 165 /* NAMED spritesheet */
 166 struct model {
 167   char name[32];
 168   struct framesheet spritesheet[8]; //one for each
 169 };
 170
 171 /* Vdat: Vdats are the video data of each object. They can not be
 172    created as a stand alone object (because they consist solely
 173    of animation information and not the skeleton on which the
 174    animation manipulates). Vdats have a list of models for every
 175    animation that the vdats odat can do for that vdat*/
 176 struct vdat {
 177   struct odat* creator; //pointer to odat that made this vdat
 178   int num_models;
 179   struct model model_list[MAX_MODELS];
 180 };
 181
 182 /* Called after the cdat open operator has been recognized in grammar. Allocates
 183    the space for a cdat on the cdat_buf, pushes that pointer onto
 184    the cdat_stack */
 185 void
 186 push_cdat(char*);
 187
 188 /* Called after a cdat end operator has been recognized in grammar. Sets
 189    top stack cdat ** to null and decrements stack pointer */
 190 void
 191 pop_cdat(void);
 192
 193 /* Called after an odat has been populated. Allocates memory for
 194    the next odat. */
 195
 196 void
 197 insert_set_label(char*, uint64_t);
 198
 199 /* Populate the sets representation in CURR_CDAT with a ref_id and insert a link
 200    into the link_buf that will resolve the ref_id to an actual odat after parse time. */
 201 void
 202 insert_set_olink(uint64_t);
 203
 204 /* Put the vlink in the link_buf to be processed after parsetime */
 205 void
 206 insert_set_vlink(uint64_t, char*);
 207
 208 /* Put svlink in the link_buf to be processed after parsetime */
 209 void
 210 insert_set_svlink(uint64_t);
 211
 212 /* Called for every set reduction except for sets with olinks. Populates the
 213    set data structures in the CDAT and in the ODAT. Uses the name and ref_id
 214    from insert_set_label. Also inserts a ref into the ref_buf with the CURR_ODAT
 215    pointer so that we can also resolve the odat from its ref_id. */
 216 void
 217 insert_set(void);
 218
 219 /* Insertion of eles is practically equivalent to how sets are inserted because both
 220    share the same data type (ODAT). Like sets, eles have links, labels
 221    and odats. Eles have the added notion of a parent set, and so must be inserted
 222    into said parent set, but this is the only place they truly differ from sets. */
 223
 224 void
 225 insert_set_vdatid(void);
 226
 227 void
 228 insert_ele_label(char*, uint64_t);
 229
 230 /* Insert an ele olink into the CURR_ODAT */
 231 void
 232 insert_ele_olink(uint64_t);
 233
 234 /* Insert a ele vlink  into CURR_ODAT*/
 235 void
 236 insert_ele_vlink(uint64_t, char*);
 237
 238 /* Inserts an ele short vlink into CURR_ODAT*/
 239 void
 240 insert_ele_svlink(uint64_t);
 241
 242 /* inserts ele into CURR_CLASS and CURR_ODAT */
 243 void
 244 insert_ele(void);
 245
 246 void
 247 insert_ele_vdatid(void);
 248
 249 /* Inserts the hitbox into the CURR_ODAT */
 250 void
 251 insert_hitbox(int);
 252
 253 /* Inserts the root into the CURR_ODAT */
 254 void
 255 insert_root(int, int, int);
 256
 257 /* Inserts a quad into the CURR_ODAT */
 258 void
 259 insert_quad(void*);
 260
 261 void
 262 insert_model(void);
 263
 264 void
 265 insert_framesheet(char, char*, uint64_t, int, int, int);
 266
 267 void
 268 insert_frame_pointer(char, void*);
 269
 270 void
 271 alloc_vdat(void);