handle empty comments in automatic emitters right
[libfirm] / ir / be / scripts / generate_emitter.pl
1 #!/usr/bin/perl -w
2
3 # This script generates C code which emits assembler code for the
4 # assembler ir nodes. It takes a "emit" key from the node specification
5 # and substitutes lines starting with . with a corresponding fprintf().
6 # Creation: 2005/11/07
7 # $Id$
8
9 use strict;
10 use Data::Dumper;
11
12 my $specfile   = $ARGV[0];
13 my $target_dir = $ARGV[1];
14
15 our $arch;
16 our $comment_string;
17 our %nodes;
18
19 # include spec file
20
21 my $return;
22
23 no strict "subs";
24 unless ($return = do $specfile) {
25         warn "couldn't parse $specfile: $@" if $@;
26         warn "couldn't do $specfile: $!"    unless defined $return;
27         warn "couldn't run $specfile"       unless $return;
28 }
29 use strict "subs";
30
31 my $comment_string_quoted = quotemeta($comment_string);
32
33 my $target_c = $target_dir."/gen_".$arch."_emitter.c";
34 my $target_h = $target_dir."/gen_".$arch."_emitter.h";
35
36 # stacks for output
37 my @obst_func;   # stack for the emit functions
38 my @obst_register;  # stack for emitter register code
39 my $line;
40
41 foreach my $op (keys(%nodes)) {
42         my %n = %{ $nodes{"$op"} };
43
44         # skip this node description if no emit information is available
45         next if (!$n{"emit"} || length($n{"emit"}) < 1);
46
47         $line = "static void emit_".$arch."_".$op."(const ir_node *n, $arch\_emit_env_t *env)";
48         push(@obst_func, $line." {\n  FILE *F = env->out;\n");
49         push(@obst_func, "  char cmd_buf[256], cmnt_buf[256];\n");
50         push(@obst_func, "  const lc_arg_env_t *arg_env = $arch\_get_arg_env();\n\n");
51         push(@obst_register, "  BE_EMIT($op);\n");
52
53         my @emit = split(/\n/, $n{"emit"});
54
55         foreach my $template (@emit) {
56                 # substitute only lines, starting with a '.'
57                 if ($template =~ /^(\d*)\.\s*/) {
58                         my $indent = "  "; # default indent is 2 spaces
59
60                         $indent = " " x $1 if ($1 && $1 > 0);
61                         # remove indent, dot and trailing spaces
62                         $template =~ s/^\d*\.\s*//;
63                         my $fmt = $template;
64                         my $cnt = 0;
65                         my $buf = 'cmd_buf';
66
67                         push(@obst_func, "  cmnt_buf[0] = '\\0';\n");
68                         foreach $template (split(/$comment_string_quoted/, $fmt, 2)) {
69                                 my @params;
70                                 my $res = "";
71                                 $cnt++;
72
73                                 $template =~ s/(\\t)*$//;
74
75                                 if ($cnt == 2) {
76                                         # add the comment begin string
77                                         $res .= $comment_string;
78                                         $buf  = "cmnt_buf";
79                                 }
80
81                                 # substitute all format parameter
82                                 while ($template =~ /\%([ASDX])(\d)|\%([COM])|\%(\w+)/) {
83                                         $res  .= $`;      # get everything before the match
84
85                                         if ($1 && $1 eq "S") {
86                                                 push(@params, "n");
87                                                 $res .= "%".$2."S"; # substitute %Sx with %xS
88                                         }
89                                         elsif ($1 && $1 eq "D") {
90                                                 push(@params, "n");
91                                                 $res .= "%".$2."D"; # substitute %Dx with %xD
92                                         }
93                                         elsif ($1 && $1 eq "X") {
94                                                 push(@params, "n");
95                                                 $res .= "%".$2."X"; # substitute %Xx with %xX
96                                         }
97                                         elsif ($1 && $1 eq "A") {
98                                                 push(@params, "get_irn_n(n, ".($2 - 1).")");
99                                                 $res .= "%+F";
100                                         }
101                                         elsif ($3) {
102                                                 push(@params, "n");
103                                                 $res .= "%".$3;
104                                         }
105                                         elsif ($4) {  # backend provided function to call, has to return a string
106                                                 push(@params, $4."(n, env)");
107                                                 $res .= "\%s";
108                                         }
109
110                                         $template = $'; # scan everything after the match
111                                 }
112                                 $res .= $template; # get the remaining string
113
114                                 my $parm = "";
115                                 $parm = ", ".join(", ", @params) if (@params);
116
117                                 push(@obst_func, $indent.'lc_esnprintf(arg_env, '.$buf.', 256, "'.$res.'"'.$parm.');'."\n");
118                         }
119                 }
120                 else {
121                         push(@obst_func, $template,"\n");
122                 }
123         }
124
125         push(@obst_func, '  lc_efprintf(arg_env, F, "\t%-35s %-60s /* %+F (%+G) */\n", cmd_buf, cmnt_buf, n, n);'."\n");
126         push(@obst_func, "}\n\n");
127 }
128
129 open(OUT, ">$target_h") || die("Could not open $target_h, reason: $!\n");
130
131 my $creation_time = localtime(time());
132
133 my $tmp = uc($arch);
134
135 print OUT<<EOF;
136 #ifndef _GEN_$tmp\_EMITTER_H_
137 #define _GEN_$tmp\_EMITTER_H_
138
139 /**
140  * Function prototypes for the emitter functions.
141  * DO NOT EDIT THIS FILE, your changes will be lost.
142  * Edit $specfile instead.
143  * created by: $0 $specfile $target_dir
144  * date:       $creation_time
145  */
146
147 #include "irnode.h"
148 #include "$arch\_emitter.h"
149
150 void $arch\_register_spec_emitters(void);
151
152 #endif /* _GEN_$tmp\_EMITTER_H_ */
153
154 EOF
155
156 close(OUT);
157
158 open(OUT, ">$target_c") || die("Could not open $target_c, reason: $!\n");
159
160 $creation_time = localtime(time());
161
162 print OUT<<EOF;
163 /**
164  * Generated functions to emit code for assembler ir nodes.
165  * DO NOT EDIT THIS FILE, your changes will be lost.
166  * Edit $specfile instead.
167  * created by: $0 $specfile $target_dir
168  * date:       $creation_time
169  */
170 #ifdef HAVE_CONFIG_H
171 #include "config.h"
172 #endif
173
174 #include <stdio.h>
175
176 #include "irnode.h"
177 #include "irop_t.h"
178 #include "irprog_t.h"
179
180 #include "gen_$arch\_emitter.h"
181 #include "$arch\_new_nodes.h"
182
183 EOF
184
185 print OUT @obst_func;
186
187 print OUT<<EOF;
188 /**
189  * Enters the emitter functions for handled nodes into the generic
190  * pointer of an opcode.
191  */
192 void $arch\_register_spec_emitters(void) {
193
194 #define BE_EMIT(a) op_$arch\_##a->ops.generic = (op_func)emit_$arch\_##a
195
196   /* generated emitter functions */
197 EOF
198
199 print OUT @obst_register;
200
201 print OUT<<EOF;
202
203 #undef BE_EMIT
204 }
205
206 EOF
207
208 close(OUT);