updated lexer_lex and ir
[henge/webcc.git] / src / apc / ir.h
index 0424f6f..53b1d65 100644 (file)
 #define MAX_CLASSES 256
 #define MAX_FRAMES 256
 #define PTRS_IN_PAGE 1024
+#define MAX_CHUNKS 256
+#define PAGES_PER_CHUNK 16
+
+/*  Sets: elements. The set is populated at parse time AFTER the
+    elements are populated, due to the nature of bottom up parsing.          */
+
+struct set {
+  char name[32];
+  uint64_t ref_id;
+  int cdat_idx;
+};
+
+/*  Cdats: A cdat is a class data structure. Cdats serve as the central       */
+/*  data types of the IR. For each cdat, sets and element                     */
+/*  ref_ids must be dereferenced to determine the odat information. Cdats     */
+/*  contain pointers to their subclasses so that the relationship between     */
+/*  classes can be determined, but the subclasses are not represented inside  */
+/*  of the cdat itself but rather in subsequent cdats in cdat_buf. We     */
+/*  can determine the number of subclasses (the last index into cdat_buf      */
+/*  that represents a subclass of some arbitrary cdat) each cdat has by       */
+/*  incrementing num_classes during parse time.                               */
+/*  TODO: Should classes point to their parent class?                         */
+
+struct cdat {
+  char name[32];
+  int idx;
+  int num_classes;
+  int num_sets;
+  struct cdat* class_list[MAX_CLASSES];
+  struct set set_list[MAX_SETS];
+};
+
+/* The cdat_stack is a stack pointers to cdat pointers, the top of which is
+   the cdat that is currently being parsed. Whenever a new cdat is recognized
+   by the grammar (CLOPEN), a cdat is pushed onto the cdat_stack, and we refer
+   to this cdat through the macro CURR_CDAT. By keeping a cdat_stack, we have
+   access to the current cdat so that the elements and sets can populate themselves
+   in the cdat accordingly. */
+
+
+/* Refs: Each set/ele has a reference to its object data (odat) through a ref_id.
+   Ref_ids are unsigned 64 byte integers that map to the hex values RGBA. During
+   the construction of the directory structure, users can choose a RGBA value for
+   each object that any other object can refer to via links (see link). If a user
+   does not choose an RGBA value, then the object is given one from the system space.
+   We maintain a doubly linked list of refs in the ref_buf at parse time so that
+   links can be resolved after the parsing of the directory structure is complete.
+   For every 16th ref, we create a post so that we can reduce on the search time for
+   a random access. */
+
+struct ref {
+  int type;
+  struct ref* nextref;
+  struct ref* lastref;
+  struct odat* odatp;
+  uint64_t ref_id; //0xFFFFFF->digit
+};
+
+
+/* Links: At parse time, a set/ele can include a link in their
+   grammar representation instead of the actual data and this signifies
+   to the APC that that set/ele wishes to use the data of another
+   set/ele, either its video data (vdat) or object data (odat). The link
+   itself contains the type of link it is, the ref_id OR name, and
+   which set/ele created the link. During parse time, links can be made
+   to o/vdats that have yet to be parsed. In order to accomodate for this,
+   we resolve all links AFTER parse time by iterating through the link_buf,
+   finding the ref_id that was stored for some object (if the ref_id exists),
+   and creating a relative pointer from the original object to the data that
+   was linked */
+
+/* Svlinks stand for short vlink, which is a link to a vdat. svlinks
+   differ from vlinks because they do not have a name */
+
+struct svlink {
+  uint64_t ref_id;
+};
+
+/* A vlink is what it sounds like, a link to a vdat */
+struct vlink {
+  uint64_t ref_id;
+  char anim_name[32];
+};
+
+/* Olinks are links to odats */
+struct olink {
+  uint64_t ref_id;
+};
+
+union link_t {
+  struct olink olink;
+  struct vlink vlink;
+  struct svlink svlink;
+};
+
+/* From: Some odat ()To: Another odat (ref_id)*/
+struct link {
+  int type; //1 = olink, 2 = vlink, 3 = svlink
+  union link_t link_t;
+  struct cdat* classp;
+  int set_idx;
+  int ele_idx;
+};
+
+
+/* Odats: Odats consist of the object data necessary for
+   each object. Odats are sometimes referred to as archetypes
+   at compile-time, in order to distinguish the difference from
+   a runtime object and a compile-time object.
+   TODO: Need more info about objects at runtime, to described
+         the reasoning behind odat structure at compile-time*/
+
+struct root {
+  int x, y, z;
+};
+
+struct odat {
+  char name[32];
+  struct vdat* vdatp;
+  int vdat_id; //
+  int cdat_idx;
+  int hitbox;
+  uint64_t ref_id;
+  struct root root;
+  struct ref* refp; /* pointer to it's ref on ref_list */
+  void* quad_filep;
+};
+
+struct odat* curr_set_odatp; //when a set has elements, insert_set() can no longer
+                            //refer to its odat via curr_odat, so save the set odat. 
+
+/* A framesheet is a grouping of animation frames in
+   a single direction (N,W,S,E) */
+struct framesheet {
+  int width;
+  int height;
+  int num_frames;
+  void* frames[MAX_FRAMES];
+};
+
+/* A model is a collection of framesheets for every
+   direction (N,W,S,E,NW,NE,SW,SE)*/
+/* NAMED spritesheet */
+struct model {
+  char name[32];
+  struct framesheet spritesheet[8]; //one for each
+};
+
+/* Vdat: Vdats are the video data of each object. They can not be
+   created as a stand alone object (because they consist solely
+   of animation information and not the skeleton on which the
+   animation manipulates). Vdats have a list of models for every
+   animation that the vdats odat can do for that vdat*/
+struct vdat {
+  struct odat* creator; //pointer to odat that made this vdat
+  int num_models;
+  struct model model_list[MAX_MODELS];
+};
 
 /* Called after the cdat open operator has been recognized in grammar. Allocates
    the space for a cdat on the cdat_buf, pushes that pointer onto
@@ -68,6 +226,9 @@ insert_set(void);
    and odats. Eles have the added notion of a parent set, and so must be inserted
    into said parent set, but this is the only place they truly differ from sets. */
 
+void
+insert_set_vdatid(void);
+
 void
 insert_ele_label(char*, uint64_t);
 
@@ -88,7 +249,7 @@ void
 insert_ele(void);
 
 void
-insert_vdat(void);
+insert_ele_vdatid(void);
 
 /* Inserts the hitbox into the CURR_ODAT */
 void
@@ -100,7 +261,7 @@ insert_root(int, int, int);
 
 /* Inserts a quad into the CURR_ODAT */
 void
-insert_quad(int, int, int, uint64_t);
+insert_quad(void*);
 
 void
 insert_model(void);
@@ -111,3 +272,5 @@ insert_framesheet(char, char*, uint64_t, int, int, int);
 void
 insert_frame_pointer(char, void*);
 
+void
+alloc_vdat(void);