fix warning
[libfirm] / scripts / gen_ir.py
index 636bcfe..b982d69 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"):
@@ -40,7 +59,7 @@ def format_irgassign(node):
        if hasattr(node, "knownBlock"):
                return ""
        else:
-               return "ir_graph *irg = get_Block_irg(block);\n"
+               return "ir_graph *irg = get_irn_irg(block);\n"
 
 def format_curblock(node):
        if hasattr(node, "knownBlock"):
@@ -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)
@@ -196,21 +225,33 @@ def preprocess_node(node):
        arguments = [ ]
        initattrs = [ ]
        for input in node.ins:
-               arguments.append(dict(type = "ir_node *", name = "irn_" + input[0]))
+               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"
 
        for attr in node.attrs:
                attr["fqname"] = "." + attr["name"]
-
-               if not "init" in attr:
-                       arguments.append(prepare_attr(attr))
+               if "init" in attr:
+                       continue
+               arguments.append(attr)
 
        # dynamic pin state means more constructor arguments
        if is_dynamic_pinned(node):
@@ -222,14 +263,20 @@ def preprocess_node(node):
                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(
                                fqname = ".exc.pin_state",
                                init   = "pin_state"
                        ))
+       if hasattr(node, "throws_init"):
+               initattrs.append(dict(
+                       fqname = ".exc.throws_exception",
+                       init   = node.throws_init
+               ))
 
        for arg in node.constructor_args:
                arguments.append(prepare_attr(arg))
@@ -282,8 +329,8 @@ ir_node *new_rd_{{node.name}}(
        res->attr.{{node.attrs_name}}{{attr["fqname"]}} = {{ attr["init"] -}};
        {%- endfor %}
        {{- node.init }}
-       res = optimize_node(res);
        irn_verify_irg(res, irg);
+       res = optimize_node(res);
        {{- node.init_after_opt }}
        return res;
 }
@@ -377,17 +424,17 @@ void (set_{{node.name}}_{{attr.name}})(ir_node *node, {{attr.type}} {{attr.name}
 {% endfor -%}
 
 {%- for node in nodes %}
-{%- for in in node.ins %}
-ir_node *(get_{{node.name}}_{{in[0]}})(const ir_node *node)
+{%- for input in node.ins %}
+ir_node *(get_{{node.name}}_{{input[0]}})(const ir_node *node)
 {
        assert(is_{{node.name}}(node));
-       return get_irn_n(node, {{node.ins.index(in)}});
+       return get_irn_n(node, n_{{node.name}}_{{input[0]}});
 }
 
-void (set_{{node.name}}_{{in[0]}})(ir_node *node, ir_node *{{in[0]|escape_keywords}})
+void (set_{{node.name}}_{{input[0]}})(ir_node *node, ir_node *{{input[0]|escape_keywords}})
 {
        assert(is_{{node.name}}(node));
-       set_irn_n(node, {{node.ins.index(in)}}, {{in[0]|escape_keywords}});
+       set_irn_n(node, n_{{node.name}}_{{input[0]}}, {{input[0]|escape_keywords}});
 }
 {% endfor %}
 {% endfor %}
@@ -413,6 +460,9 @@ void init_op(void)
                        {{node|attr_size}}
                        NULL
                {% endfilter %});
+       {%- if "fragile" in node.flags: %}
+       ir_op_set_fragile_indices(op_{{node.name}}, n_{{node.name}}_mem, pn_{{node.name}}_X_regular, pn_{{node.name}}_X_except);
+       {%- endif -%}
        {%- endfor %}
 
        be_init_op();
@@ -434,12 +484,25 @@ nodeops_h_template = env.from_string(
 
 #include "firm_types.h"
 
+#include "begin.h"
+
 /**
  * @addtogroup ir_node
  * @{
  */
 
 {% for node in nodes -%}
+{% if node.ins %}
+/**
+ * Input numbers for {{node.name}} node
+ */
+typedef enum {
+       {%- for input in node.ins %}
+       n_{{node.name}}_{{input[0]}},
+       {%- endfor %}
+       n_{{node.name}}_max = n_{{node.name}}_{{node.ins[-1][0]}}
+} n_{{node.name}};
+{% endif %}
 {% if node.outs %}
 /**
  * Projection numbers for result of {{node.name}} node (use for Proj nodes)
@@ -449,20 +512,72 @@ typedef enum {
        pn_{{node.name}}_{{out[0]}}
        {%- if out.__len__() > 2 %} = {{out[2]}}{% endif %}, /**< {{out[1]}} */
        {% endfor -%}
-       pn_{{node.name}}_max
+       pn_{{node.name}}_max = pn_{{node.name}}_{{node.outs[-1][0]}}
 } pn_{{node.name}};
 {% endif %}
 {%- endfor %}
 
 {% for node in nodes %}
-/** Return true of the node is a {{node.name}} node. */
+{%- 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 if the node is a {{node.name}} node. */
 FIRM_API int is_{{node.name}}(const ir_node *node);
 {%- endfor %}
 
 {% for node in nodes %}
-{% for in in node.ins -%}
-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}});
+{% for input in node.ins -%}
+FIRM_API ir_node *get_{{node.name}}_{{input[0]}}(const ir_node *node);
+FIRM_API void set_{{node.name}}_{{input[0]}}(ir_node *node, ir_node *{{input[0]|escape_keywords}});
 {% endfor -%}
 {% for attr in node.attrs|hasnot("noprop") -%}
 FIRM_API {{attr.type}} get_{{node.name}}_{{attr.name}}(const ir_node *node);
@@ -472,7 +587,10 @@ FIRM_API void set_{{node.name}}_{{attr.name}}(ir_node *node, {{attr.type}} {{att
 
 /** @} */
 
+#include "end.h"
+
 #endif
+
 ''')
 
 opcodes_h_template = env.from_string(
@@ -504,9 +622,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;
 
@@ -519,6 +636,7 @@ FIRM_API ir_op *get_op_{{node.name}}(void);
 {%- endfor %}
 
 #endif
+
 ''')
 
 #############################