Prepared for diff.
[libfirm] / scripts / gen_ir.py
index c6badca..7ab1731 100755 (executable)
@@ -17,6 +17,17 @@ def format_nodeparameters(node):
        parameters = map(lambda arg: arg["type"] + " " + arg["name"], node.arguments)
        return format_parameterlist(parameters)
 
+def format_nodeparametershelp(node):
+       res = ""
+       for param in node.arguments:
+               res += " * @param %-9s %s\n" % (param["name"], param["comment"])
+       return res
+
+def format_a_an(text):
+       if text[0] in "aAeEuUoOiI":
+               return "an " + text
+       return "a " + text
+
 def format_blockparameter(node):
        if hasattr(node, "knownBlock"):
                if hasattr(node, "knownGraph"):
@@ -25,6 +36,14 @@ def format_blockparameter(node):
        else:
                return "ir_node *block"
 
+def format_blockparameterhelp(node):
+       if hasattr(node, "knownBlock"):
+               if hasattr(node, "knownGraph"):
+                       return ""
+               return " * @param irg       The IR graph the node belongs to.\n"
+       else:
+               return " * @param block     The IR block the node belongs to.\n"
+
 def format_blockargument(node):
        if hasattr(node, "knownBlock"):
                if hasattr(node, "knownGraph"):
@@ -62,14 +81,14 @@ def format_insdecl(node):
                res += "\n\tNEW_ARR_A(ir_node *, r_in, r_arity);"
                i = 0
                for input in node.ins:
-                       res += "\n\tr_in[" + `i` + "] = irn_" + input + ";"
+                       res += "\n\tr_in[" + `i` + "] = irn_" + input[0] + ";"
                        i += 1
                res += "\n\tmemcpy(&r_in[" + `insarity` + "], in, sizeof(ir_node *) * arity);\n\t"
        else:
                res = "ir_node *in[" + `arity` + "];"
                i = 0
                for input in node.ins:
-                       res += "\n\tin[" + `i` + "] = irn_" + input + ";"
+                       res += "\n\tin[" + `i` + "] = irn_" + input[0] + ";"
                        i += 1
        return res
 
@@ -160,10 +179,13 @@ def format_parameters(string):
        return format_arguments(string, voidwhenempty = True)
 
 env = Environment()
+env.filters['a_an']            = format_a_an
 env.filters['parameterlist']   = format_parameterlist
 env.filters['nodearguments']   = format_nodearguments
 env.filters['nodeparameters']  = format_nodeparameters
+env.filters['nodeparametershelp'] = format_nodeparametershelp
 env.filters['blockparameter']  = format_blockparameter
+env.filters['blockparameterhelp'] = format_blockparameterhelp
 env.filters['blockargument']   = format_blockargument
 env.filters['irgassign']       = format_irgassign
 env.filters['curblock']        = format_curblock
@@ -182,9 +204,16 @@ env.filters['escape_keywords'] = format_escape_keywords
 
 def prepare_attr(attr):
        if "init" in attr:
-               return dict(type = attr["type"], name = attr["name"], init = attr["init"])
+               return dict(
+                       type = attr["type"],
+                       name = attr["name"],
+                       init = attr["init"],
+                       comment = attr["comment"])
        else:
-               return dict(type = attr["type"], name = attr["name"])
+               return dict(
+                       type = attr["type"],
+                       name = attr["name"],
+                       comment = attr["comment"])
 
 def preprocess_node(node):
        verify_node(node)
@@ -195,89 +224,69 @@ def preprocess_node(node):
        # construct node arguments
        arguments = [ ]
        initattrs = [ ]
-       specialconstrs = [ ]
        for input in node.ins:
-               arguments.append(dict(type = "ir_node *", name = "irn_" + input))
+               arguments.append(dict(
+                               type    = "ir_node *",
+                               name    = "irn_" + input[0],
+                               comment = input[1]))
 
        if node.arity == "variable" or node.arity == "dynamic":
-               arguments.append(dict(type = "int", name = "arity"))
-               arguments.append(dict(type = "ir_node **", name = "in"))
+               arguments.append(dict(
+                               type    = "int",
+                               name    = "arity",
+                               comment = "size of additional inputs array"))
+               arguments.append(dict(
+                               type    = "ir_node *const *",
+                               name    = "in",
+                               comment = "additional inputs"))
 
        if not hasattr(node, "mode"):
-               arguments.append(dict(type = "ir_mode *", name = "mode"))
+               arguments.append(dict(
+                               type    = "ir_mode *",
+                               name    = "mode",
+                               comment = "mode of the operations result"))
                node.mode = "mode"
 
-       attrs_with_special = 0
        for attr in node.attrs:
-               attr.setdefault("initname", "." + attr["name"])
-
-               if "special" in attr:
-                       if not "init" in attr:
-                               print "Node type %s has an attribute with a \"special\" entry but without \"init\"" % node.name
-                               sys.exit(1)
-
-                       if attrs_with_special != 0:
-                               print "Node type %s has more than one attribute with a \"special\" entry" % node.name
-                               sys.exit(1)
-
-                       attrs_with_special += 1
-
-                       if "prefix" in attr["special"]:
-                               specialname = attr["special"]["prefix"] + node.name
-                       elif "suffix" in attr["special"]:
-                               specialname = node.name + attr["special"]["suffix"]
-                       else:
-                               print "Unknown special constructor type for node type %s" % node.name
-                               sys.exit(1)
-
-                       specialconstrs.append(
-                               dict(
-                                       constrname = specialname,
-                                       attr = attr
-                               )
-                       )
-               elif not "init" in attr:
-                       arguments.append(prepare_attr(attr))
+               attr["fqname"] = "." + attr["name"]
+               if "init" in attr:
+                       continue
+               arguments.append(attr)
 
        # dynamic pin state means more constructor arguments
        if is_dynamic_pinned(node):
                if hasattr(node, "pinned_init"):
                        initattrs.append(dict(
-                               initname = ".exc.pin_state",
-                               init     = node.pinned_init
+                               fqname = ".exc.pin_state",
+                               init   = node.pinned_init
                        ))
                else:
                        node.constructor_args.append(
                                dict(
-                                       name = "pin_state",
-                                       type = "op_pin_state"
+                                       name    = "pin_state",
+                                       type    = "op_pin_state",
+                                       comment = "pinned state",
                                )
                        )
                        initattrs.append(dict(
-                               initname = ".exc.pin_state",
-                               init     = "pin_state"
+                               fqname = ".exc.pin_state",
+                               init   = "pin_state"
                        ))
 
        for arg in node.constructor_args:
                arguments.append(prepare_attr(arg))
-               if arg["type"] == "ir_cons_flags":
-                       name = arg["name"]
-                       initattrs.append(dict(initname = ".exc.pin_state",
-                               init = name + " & cons_floats ? op_pin_state_floats : op_pin_state_pinned"))
-                       initattrs.append(dict(initname = ".volatility",
-                               init = name + " & cons_volatile ? volatility_is_volatile : volatility_non_volatile"))
-                       initattrs.append(dict(initname = ".aligned",
-                               init = name + " & cons_unaligned ? align_non_aligned : align_is_aligned"))
 
        node.arguments = arguments
        node.initattrs = initattrs
-       node.special_constructors = specialconstrs
 
 #############################
 
-constructor_template = env.from_string('''
+gen_ircons_c_inl_template = env.from_string(
+'''/* Warning: automatically generated code */
 
-ir_node *new_rd_{{node.constrname}}(
+{%- for node in nodes %}
+{%- if not node.noconstructor %}
+ir_node *new_rd_{{node.name}}(
        {%- filter parameters %}
                dbg_info *dbgi
                {{node|blockparameter}}
@@ -306,27 +315,28 @@ ir_node *new_rd_{{node.constrname}}(
        }
        {%- endif %}
        {%- for attr in node.attrs %}
-       res->attr.{{node.attrs_name}}{{attr["initname"]}} =
+       res->attr.{{node.attrs_name}}{{attr["fqname"]}} =
                {%- if "init" in attr %} {{ attr["init"] -}};
                {%- else              %} {{ attr["name"] -}};
                {%- endif %}
        {%- endfor %}
        {%- for attr in node.initattrs %}
-       res->attr.{{node.attrs_name}}{{attr["initname"]}} = {{ attr["init"] -}};
+       res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}};
        {%- endfor %}
        {{- node.init }}
        res = optimize_node(res);
        irn_verify_irg(res, irg);
+       {{- node.init_after_opt }}
        return res;
 }
 
-ir_node *new_r_{{node.constrname}}(
+ir_node *new_r_{{node.name}}(
                {%- filter parameters %}
                        {{node|blockparameter}}
                        {{node|nodeparameters}}
                {% endfilter %})
 {
-       return new_rd_{{node.constrname}}(
+       return new_rd_{{node.name}}(
                {%- filter arguments %}
                        NULL
                        {{node|blockargument}}
@@ -334,7 +344,7 @@ ir_node *new_r_{{node.constrname}}(
                {% endfilter %});
 }
 
-ir_node *new_d_{{node.constrname}}(
+ir_node *new_d_{{node.name}}(
                {%- filter parameters %}
                        dbg_info *dbgi
                        {{node|nodeparameters}}
@@ -342,7 +352,7 @@ ir_node *new_d_{{node.constrname}}(
 {
        ir_node *res;
        assert(get_irg_phase_state(current_ir_graph) == phase_building);
-       res = new_rd_{{node.constrname}}(
+       res = new_rd_{{node.name}}(
                {%- filter parameters %}
                        dbgi
                        {{node|curblock}}
@@ -351,21 +361,23 @@ ir_node *new_d_{{node.constrname}}(
        return res;
 }
 
-ir_node *new_{{node.constrname}}(
+ir_node *new_{{node.name}}(
                {%- filter parameters %}
                        {{node|nodeparameters}}
                {% endfilter %})
 {
-       return new_d_{{node.constrname}}(
+       return new_d_{{node.name}}(
                {%- filter arguments %}
                        NULL
                        {{node|nodearguments}}
                {% endfilter %});
 }
+{% endif %}
+{%- endfor %}
 ''')
 
-irnode_h_template = env.from_string('''
-/* Warning: automatically generated code */
+irnode_h_template = env.from_string(
+'''/* Warning: automatically generated code */
 
 {%- for node in nodes|isnot('custom_is') %}
 static inline int _is_{{node.name}}(const ir_node *node)
@@ -381,8 +393,8 @@ static inline int _is_{{node.name}}(const ir_node *node)
 
 ''')
 
-irnode_template = env.from_string('''
-/* Warning: automatically generated code */
+irnode_template = env.from_string(
+'''/* Warning: automatically generated code */
 {% for node in nodes %}
 int (is_{{node.name}})(const ir_node *node)
 {
@@ -408,23 +420,23 @@ void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}
 
 {%- for node in nodes %}
 {%- for in in node.ins %}
-ir_node *(get_{{node.name}}_{{in}})(const ir_node *node)
+ir_node *(get_{{node.name}}_{{in[0]}})(const ir_node *node)
 {
        assert(is_{{node.name}}(node));
        return get_irn_n(node, {{node.ins.index(in)}});
 }
 
-void (set_{{node.name}}_{{in}})(ir_node *node, ir_node *{{in|escape_keywords}})
+void (set_{{node.name}}_{{in[0]}})(ir_node *node, ir_node *{{in[0]|escape_keywords}})
 {
        assert(is_{{node.name}}(node));
-       set_irn_n(node, {{node.ins.index(in)}}, {{in|escape_keywords}});
+       set_irn_n(node, {{node.ins.index(in)}}, {{in[0]|escape_keywords}});
 }
 {% endfor %}
 {% endfor %}
 ''')
 
-irop_template = env.from_string('''
-/* Warning: automatically generated code */
+irop_template = env.from_string(
+'''/* Warning: automatically generated code */
 {% for node in nodes %}
 ir_op *op_{{node.name}}; ir_op *get_op_{{node.name}}(void) { return op_{{node.name}}; }
 {%- endfor %}
@@ -457,8 +469,8 @@ void finish_op(void)
 
 ''')
 
-nodeops_h_template = env.from_string('''
-/* Warning: automatically generated code */
+nodeops_h_template = env.from_string(
+'''/* Warning: automatically generated code */
 #ifndef FIRM_IR_NODEOPS_H
 #define FIRM_IR_NODEOPS_H
 
@@ -484,6 +496,58 @@ typedef enum {
 {% endif %}
 {%- endfor %}
 
+{% for node in nodes %}
+{%- if not node.noconstructor %}
+/**
+ * Construct {{node.name|a_an}} node.
+ *
+ * @param dbgi      A pointer to debug information.
+{{ node|blockparameterhelp -}}
+{{ node|nodeparametershelp -}}
+ */
+FIRM_API ir_node *new_rd_{{node.name}}(
+       {%- filter parameters %}
+               dbg_info *dbgi
+               {{node|blockparameter}}
+               {{node|nodeparameters}}
+       {% endfilter %});
+
+/**
+ * Construct {{node.name|a_an}} node.
+ *
+{{ node|blockparameterhelp -}}
+{{ node|nodeparametershelp -}}
+ */
+FIRM_API ir_node *new_r_{{node.name}}(
+       {%- filter parameters %}
+               {{node|blockparameter}}
+               {{node|nodeparameters}}
+       {% endfilter %});
+
+/**
+ * Construct {{node.name|a_an}} node.
+ *
+ * @param dbgi      A pointer to debug information.
+{{ node|nodeparametershelp -}}
+ */
+FIRM_API ir_node *new_d_{{node.name}}(
+       {%- filter parameters %}
+               dbg_info *dbgi
+               {{node|nodeparameters}}
+       {% endfilter %});
+
+/**
+ * Construct {{node.name|a_an}} node.
+ *
+{{ node|nodeparametershelp -}}
+ */
+FIRM_API ir_node *new_{{node.name}}(
+       {%- filter parameters %}
+               {{node|nodeparameters}}
+       {% endfilter %});
+{%- endif %}
+{% endfor %}
+
 {% for node in nodes %}
 /** Return true of the node is a {{node.name}} node. */
 FIRM_API int is_{{node.name}}(const ir_node *node);
@@ -491,8 +555,8 @@ FIRM_API int is_{{node.name}}(const ir_node *node);
 
 {% for node in nodes %}
 {% for in in node.ins -%}
-FIRM_API ir_node *get_{{node.name}}_{{in}}(const ir_node *node);
-void set_{{node.name}}_{{in}}(ir_node *node, ir_node *{{in|escape_keywords}});
+FIRM_API ir_node *get_{{node.name}}_{{in[0]}}(const ir_node *node);
+void set_{{node.name}}_{{in[0]}}(ir_node *node, ir_node *{{in[0]|escape_keywords}});
 {% endfor -%}
 {% for attr in node.attrs|hasnot("noprop") -%}
 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
@@ -503,10 +567,11 @@ FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{att
 /** @} */
 
 #endif
+
 ''')
 
-opcodes_h_template = env.from_string('''
-/* Warning: automatically generated code */
+opcodes_h_template = env.from_string(
+'''/* Warning: automatically generated code */
 #ifndef FIRM_IR_OPCODES_H
 #define FIRM_IR_OPCODES_H
 
@@ -534,9 +599,8 @@ typedef enum ir_opcode {
        beo_IncSP,
        beo_Start,
        beo_FrameAddr,
-       beo_Barrier,
        /* last backend node number */
-       beo_Last = beo_Barrier,
+       beo_Last = beo_FrameAddr,
        iro_MaxOpcode
 } ir_opcode;
 
@@ -549,6 +613,7 @@ FIRM_API ir_op *get_op_{{node.name}}(void);
 {%- endfor %}
 
 #endif
+
 ''')
 
 #############################
@@ -574,24 +639,10 @@ def main(argv):
        # hardcoded path to libfirm/include/libfirm
        gendir2 = argv[2] + "/../../include/libfirm"
 
-       # List of TODOs
-       niymap = [ "ASM", "Const", "Phi", "SymConst" ]
-
        real_nodes = prepare_nodes()
-       file = open(gendir + "/gen_ir_cons.c.inl", "w")
-       for node in real_nodes:
-               if node.name in niymap:
-                       continue
-
-               if not isAbstract(node) and not hasattr(node, "noconstructor"):
-                       file.write(constructor_template.render(vars()))
 
-                       if hasattr(node, "special_constructors"):
-                               for special in node.special_constructors:
-                                       node.constrname = special["constrname"]
-                                       special["attr"]["init"] = special["attr"]["special"]["init"]
-                                       file.write(constructor_template.render(vars()))
-       file.write("\n")
+       file = open(gendir + "/gen_ir_cons.c.inl", "w")
+       file.write(gen_ircons_c_inl_template.render(nodes = real_nodes))
        file.close()
 
        file = open(gendir + "/gen_irnode.h", "w")