gylwrap
8.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
eval '(exit $?0)' && eval 'exec perl -wS "$0" "$@"'
& eval 'exec perl -wS "$0" $argv:q'
if 0;
use strict;
use warnings;
use Getopt::Long qw(:config gnu_getopt no_ignore_case require_order auto_version);
use File::Basename;
use File::Temp qw(tempdir);
use Pod::Man;
use Pod::Usage;
use Cwd 'abs_path';
use List::Regexp;
=head1 NAME
gylwrap - wrapper for yacc, lex and similar programs
=head1 SYNOPSIS
B<gylwrap>
[B<-c?>]
[B<--compatibility>]
[B<--yyrepl=>I<PREFIX>]
[B<--yysym=>I<STRING>]
[B<--stdout>]
[B<--help>]
[B<--version>]
I<COMMAND>
I<INPUT>
I<OUTPUT> I<DESIRED>...
B<ylwrap>
[B<-?>]
[B<--yyrepl=>I<PREFIX>]
[B<--yysym=>I<STRING>]
[B<--stdout>]
[B<--help>]
[B<--version>]
I<INPUT>
[I<OUTPUT> I<DESIRED>]...
B<--> I<PROGRAM> [I<ARGS>]
=head1 DESCRIPTION
Wraps B<lex> and B<yacc> invocations to rename their output files.
It also ensures that multiple I<COMMAND> instances can be invoked
in a single directory in parallel and allows for renaming global
symbols to avoid clashes when multiple parsers and/or lexers are
linked in a single executable.
To achieve this, B<gylwrap> creates a temporary directory, changes
to it, and runs I<COMMAND> (which may contain arguments and options)
with I<INPUT> as its last argument. Upon successful exit, it processes
the I<OUTPUT> I<DESIRED> pairs. Each I<OUTPUT> file is then renamed
to the file I<DESIRED>, taking care to fix up any eventual B<#line>
directives.
If B<--yyrepl=I<PREFIX>> is given, the global symbols that can cause
name clashes are renamed by replacing the initial B<yy> with I<PREFIX>.
For a list of symbols that are subject for replacement, inspect the
B<@sym> variable at the start of the script. Additional names can be
added to this list using the B<--yysym> option.
If given the B<--compatibility> option or if invoked as B<ylwrap>,
the tool runs in compatibility mode, mimicking the behavior of the
standard B<ylwrap> utility from GNU Automake. Command line arguments
consist of two lists, separated by B<-->. The left-hand side list
supplies the I<OUTPUT>,I<DESIRED> pairs, and the right-hand side one
supplies the command and its arguments.
In both modes, prior to running the command, the program looks for file
B<gylwrap.conf> in the same directory as the I<INPUT> file. If found,
the file is sourced. Empty lines and comments (introduced by the hash
sign) are ignored. Rest of lines are either option assignements, or
section headings.
Option assignements have the form B<I<OPTION> = I<VALUE>>, and generally,
have the same meaning as the corresponding command line option without
the leading two dashes:
=over 4
=item B<yyrepl => I<PREFIX>
Replace the B<yy> prefix with I<PREFIX> in the identifiers.
=item B<stdout = 1>
Enable the B<--stdout> option.
=item B<yysym => I<NAME>
Add I<NAME> to the list of symbols suitable for prefix replacement.
This keyword can appear multiple times.
=item B<flags => I<STRING>
Add I<STRING> to the invocation of I<COMMAND>. This is useful, if you
have several parsers in the same directory, and some of them require
the B<-d> option, while others don't.
=back
Section headers have the form B<[I<FILE>]>. The settings under a
section header have effect only if I<FILE> is the same as the I<INPUT>
command line argument.
=head1 OPTIONS
=over 4
=item B<-c>, B<--compatibility>
Run in compatibility mode.
=item B<--stdout>
Redirect I<COMMAND>'s standard output to the first I<OUTPUT>.
=item B<--yyrepl=>I<PREFIX>
Replace the B<yy> prefix in global symbols with I<PREFIX>.
=item B<--yysym=>I<SYMBOL>
Add I<SYMBOL> to the list of symbols subject for replacement.
=item B<-?>, B<--help>
Displays help text and exit
=item B<--version>
Displays program version and exits.
=back
=head1 NOTE
This script is an improved version of the B<ylwrap> script, included
in the GNU Automake distribution.
=cut
# List of symbols suitable for prefix replacements. See the
# options --yyrepl and --yysym, and similar statements in the configuration
# file.
my @yysym = qw(
yymaxdepth
yyparse
yylex
yyerror
yylval
yychar
yydebug
yypact
yyr1
yyr2
yydef
yychk
yypgo
yyact
yyexca
yyerrflag
yynerrs
yyps
yypv
yys
yy_yys
yystate
yytmp
yyv
yy_yyv
yyval
yylloc
yyreds
yytoks
yylhs
yylen
yydefred
yydgoto
yysindex
yyrindex
yygindex
yytable
yycheck
yyname
yyrule
);
our $VERSION = '1.00';
# If prefix replacement is requested, the list above is assembled into
# a single regular expression, stored here.
my $yyrx;
# String to replace the "yy" prefix with.
my $yyrepl;
# If set, redirect the stdout from the command to the first output file.
my $stdout;
# Input directory with special characters escaped, for "#line" directive
# fixup.
my $input_rx;
# Configuration settings from the "gylwrap.conf" file. Indexed by
# input file name. Default entry is ''.
my %config;
# Name of the first output file. This is used in compatibility mode to
# avoid bailing out if one of the output files (except the principal one)
# does not exist.
my $parser;
# Name this program was invoked as.
my $progname = basename($0);
my $compat = $progname eq 'ylwrap'; # True if running in compatibility mode
# List of files created during the run, for cleanup purposes.
my @created;
sub filter {
my ($from, $to) = @_;
my $target = basename($to);
my $ifd;
unless (open($ifd, '<', $from)) {
if ($compat) {
return if $from ne $parser;
}
die "can't open input file $from: $!";
}
open(my $ofd, '>', $to)
or die "can't open output file $to: $!";
push @created, $to;
while (<$ifd>) {
if (/^#/) {
s{$input_rx/}{};
s{"$from"}{"$target"};
}
if ($yyrx) {
s{\byy($yyrx)\b}{${yyrepl}$1}g;
}
print $ofd $_
}
close $ifd;
close $ofd;
}
sub readconf {
my $file = shift;
open(my $fd, '<', $file)
or die "can't open $file: $!";
my $key = '';
while (<$fd>) {
chomp;
s/^\s+//;
if (/^#/ || /^$/) {
next;
} elsif (/^\[(.+)\]/) {
$key = $1;
} elsif (m/(.+?)\s*=\s*(.+)$/) {
if ($1 eq 'yysym') {
push @{$config{$key}{$1}}, $2;
} else {
$config{$key}{$1} = $2;
}
} else {
print STDERR "$file:$.: unrecognized line\n";
}
}
close($fd);
}
my ($command, $input, @output);
GetOptions("yyrepl=s" => \$yyrepl,
"yysym=s@" => \@yysym,
"stdout" => \$stdout,
"compatibility|c" => \$compat,
"help|?" => sub {
pod2usage(-exitstatus => 0, -verbose => 2);
}
) or exit(1);
if ($compat) {
$input = shift @ARGV;
while (my $arg = shift @ARGV) {
last if ($arg eq '--');
push @output, $arg;
}
$command = join(' ', @ARGV);
} else {
pod2usage(-exitstatus => 1, -verbose => 0, -output => \*STDERR)
unless @ARGV >= 2;
($command, $input, @output) = @ARGV;
}
pod2usage(-exitstatus => 1, -verbose => 0, -output => \*STDERR)
unless (@output && (@output % 2) == 0);
# Make sure input file name is absolute
$input = abs_path($input);
my $input_dir = dirname($input);
$input_rx = qr($input_dir);
my $confile = "$input_dir/gylwrap.conf";
readconf($confile) if -r $confile;
my $input_base = basename($input);
unless ($stdout) {
$stdout = $config{$input_base}{stdout} || $config{''}{stdout};
}
unless ($yyrepl) {
$yyrepl = $config{$input_base}{yyrepl} || $config{''}{yyrepl};
}
if ($yyrepl) {
push @yysym, @{$config{$input_base}{yysym}}
if exists $config{$input_base}{yysym};
push @yysym, @{$config{''}{yysym}}
if exists $config{''}{yysym};
if ($yyrepl) {
$yyrx = regexp_opt({ type => 'pcre' }, map { s/^yy//; $_ } @yysym);
}
}
my $prog = $command;
$prog =~ s/\s.*$//;
if (my $flags = $config{$input_base}{flags} || $config{''}{flags}) {
$command .= ' ' . $flags;
}
$parser = $output[0];
$command .= ' '.$input;
if ($stdout) {
$command .= '>'.$parser;
}
# Create working directory
my $wd = tempdir("ylXXXXXX", DIR => '.', CLEANUP => 1)
or die "cannot create temporary directory";
chdir $wd
or die "cannot change to the temporary directory";
END {
if ($?) {
unlink @created;
}
chdir "..";
}
system($command);
if ($? == -1) {
print STDERR "$prog: $!\n";
exit(127);
} elsif ($? & 127) {
print STDERR "$prog died with signal ".($? & 127)."\n";
exit(127);
} else {
my $code = $? >> 8;
exit($code) if $code;
}
while (my $from = shift @output) {
my $to = shift @output;
$to = '../' . $to unless $to =~ m{^/};
filter($from, $to);
}
exit 0;