added everything to src

[henge/apc.git] / src / ir.h

diff --git a/src/ir.h b/src/ir.h
new file mode 100755 (executable)
index 0000000..0d271b1
--- /dev/null
+++ b/src/ir.h
@@ -0,0 +1,16 @@
+\r
+\r
+/*!@file\r
+\brief   Intermediate Representation (IR) between Directory Structure and Engine Input\r
+\details The IR serves as a storage structure that is populated during the\r
+         parsing of the input directory structure. After parsing is complete,\r
+         the IR will be condensed (removed of excess allocated space) and then\r
+         output as the input for the engine. In this file we describe the semantic actions\r
+         that are called at each step, and the memory buffers that they populate.\r
+         See parser.y for the description on how the input grammar is constructed,\r
+         and where/when semantic actions are called.\r
+         TODO: or just write it here.\r
+\author  Jordan Lavatai\r
+\date    Aug 2016\r
+----------------------------------------------------------------------------*/\r
+\r