summaryrefslogtreecommitdiff
path: root/chill/include/ir_code.hh
diff options
context:
space:
mode:
Diffstat (limited to 'chill/include/ir_code.hh')
-rw-r--r--chill/include/ir_code.hh12
1 files changed, 12 insertions, 0 deletions
diff --git a/chill/include/ir_code.hh b/chill/include/ir_code.hh
index b6ebfcd..d695474 100644
--- a/chill/include/ir_code.hh
+++ b/chill/include/ir_code.hh
@@ -22,6 +22,18 @@
#ifndef IR_CODE_HH
#define IR_CODE_HH
+/*!
+ * \file
+ * \brief CHiLL's compiler intermediate representation interface that extends Omega's builder interface to accomodate compiler analyses and extra code generation.
+ *
+ * Unlike CG_outputRepr, IR_Symbol,IR_Ref and IR_Control are place holders
+ * to the underlying code, thus deleting or duplicating them does not affect
+ * the actual code. Similar to Omega builder's memory allocation strategy,
+ * all non-const pointer parameters of CG_outputRepr/IR_Symbol/IR_Ref/IR_Control
+ * are destroyed after the call.
+ */
+
+
#include <code_gen/CG_outputRepr.h>
#include <code_gen/CG_outputBuilder.h>
#include <vector>