chiark / gitweb /
i18n: i18n-diff-auditor: more debugging improvement
[dgit.git] / i18n-diff-auditor
1 #!/usr/bin/perl -w
2 use strict;
3 use Carp;
4 use Data::Dumper;
5 use Getopt::Long;
6
7 our $debug = 0;
8 GetOptions("debug|D+" => \$debug
9            );
10
11 our @debug;
12 sub debug ($$) {
13     my ($i,$s) = @_;
14     push @{ $debug[$i] }, $s if $debug;
15 }
16
17 my @d = <>;
18 unshift @d, "# dummy line to make line 1 index 1 in \@d\n";
19
20 our $i_last_l_ok = -1;
21 our $count_i_last_l_ok;
22
23 sub l_ok ($) {
24     my ($i) = @_;
25
26     if ($i == $i_last_l_ok) {
27         confess $i if $count_i_last_l_ok++ > 50;
28     } else {
29         $count_i_last_l_ok = 0;
30         $i_last_l_ok = $i;
31     }
32
33     return unless $i < @d;
34     $_ = $d[$i];
35     #print STDERR "L $i\n";
36     1;
37 }
38
39 sub l ($) {
40     my ($i) = @_;
41     confess $i unless l_ok $i;
42 };
43
44 our $perlop_text = <<'END'; # c&p from man perlop
45            left        terms and list operators (leftward)
46            left        ->
47            nonassoc    ++ --
48            right       **
49            right       ! ~ \ and unary + and -
50            left        =~ !~
51            left        * / % x
52            left        + - .
53            left        << >>
54            nonassoc    named unary operators
55            nonassoc    < > <= >= lt gt le ge
56            nonassoc    == != <=> eq ne cmp ~~
57            left        &
58            left        | ^
59            left        &&
60            left        || //
61            nonassoc    ..  ...
62            right       ?:
63            right       = += -= *= etc. goto last next redo dump
64            left        , =>
65            nonassoc    list operators (rightward)
66            right       not
67            left        and
68            left        or xor
69
70            **=    +=    *=    &=    &.=    <<=    &&=
71                   -=    /=    |=    |.=    >>=    ||=
72                   .=    %=    ^=    ^.=           //=
73                         x=
74 END
75
76 our $perlop_re;
77
78 sub prep_perlop () {
79     my @ops;
80     foreach (split /\n/, $perlop_text) {
81         next unless m{\S};
82         s{\s+$}{};
83         s{^\s+}{};
84         s{^(?: left | right | nonassoc ) \s+}{}x;
85         next if m{^terms and list operators};
86         next if m{^named unary};
87         next if m{^list operators};
88         s{ and unary.*}{};
89         s{ etc\. }{ };
90         s{\?\:}{ ? : };
91         foreach my $op (split /\s+/) {
92             next unless length $op;
93             next if $op =~ m{^\w+$};
94             $op =~ s/\W/\\$&/g;
95             push @ops, $op;
96         }
97     }
98     $perlop_re = '(?: '.(join ' | ', @ops).' )';
99     $perlop_re = qr{$perlop_re}x;
100     #print STDERR "$perlop_re\n";
101 }
102
103 prep_perlop();
104
105 our ($ifilehead, $ifirsthunkhead);
106 our ($ihunkhead, $ihunkend);
107 our ($ichunkstart, $ichunkend);
108 our ($before, $after);
109
110 sub is_string ($) { $_[0]{T} =~ m/heredoc|string/; }
111 sub is_trans ($) { grep { $_[0]{E} eq $_ } qw(__ f_ i_); }
112
113 sub semiparse ($) {
114     ($_) = @_;
115     my @o;
116     # entries contain
117     #   T     type
118     #   E     exact input text (does not contain here doc contents)
119     #   P     something to print in messages
120     #   V     value, only for: heredoc string
121     #   Q     quote characcter, only for: heredoc string
122     for (;;) {
123         s{^\s+}{};
124         if (s{^[\$\@\%]?[_0-9a-zA-Z]+}{}) {
125             push @o, { T => 'ident', E => $&, P => $& };
126         } elsif (s{^\<\<(['"]?)([A-Z_]+)\1}{}) {
127             my ($q,$d) = ($1,$2);
128             $q ||= '"';
129             push @o, { T => 'heredoc', Q => $q, Delim => $d,
130                        E => $&, P => "<<$q$d$q" };
131             s{^
132                 (             .* \n    )
133                 ( (?: (?! $d) .* \n )* )
134                           $d     \n
135               }{ $1 }xe or die "missing end of here doc $d\n";
136             $o[$#o]{V} = $2;
137         } elsif (s{^ (["'])( (?: [^\\'"]
138                                | \\ [^"']
139                                | (?! \1 ) [^"]
140                               )*
141                        ) \1 }{}x) {
142             my ($q,$v) = ($1,$2);
143             push @o, { T => 'string', E => $&, P => "$q$q",
144                        Q => $q, V => $v};
145         } elsif (s{^$perlop_re|^\;}{}) {
146             push @o, { T => 'op', E => $&, P => $& };
147         } elsif (s/^[[{(]//) {
148             push @o, { T => 'bra', E => $&, P => $& };
149         } elsif (s/^[]})]//) {
150             push @o, { T => 'ket', E => $&, P => $& };
151         } elsif (s/^( [\$\@\%] )( \{ )//x) {
152             push @o, { T => 'deref', E => $1, P => $1 },
153                      { T => 'bra',   E => $2, P => $2 };
154         } elsif (s/^ [\$\@\%] [^[^{] //x) {
155             push @o, { T => 'specvar', E => $&, P => $& };
156         } elsif (!length) {
157             last;
158         } else {
159             m{^.{0,10}};
160             die "cannot tokenise \`$&'";
161         }
162     }
163     for (my $i=0; $i+2 < @o; $i++) {
164         next unless $o[$i+1]{E} eq '.';
165         my @inputs = @o[$i, $i+2];
166         #print STDERR Dumper(\@inputs);
167         next if grep { !is_string($_) } @inputs;
168         my $q = $inputs[0]{Q};
169         next if grep { $_->{Q} ne $q } @inputs;
170         my $new = { T => 'joinedstrings',
171                     E => (join '.', map { $_->{E} } @inputs),
172                     P => (join '.', map { $_->{P} } @inputs),
173                     V => (join '',  map { $_->{V} } @inputs),
174                     Q => $q,
175                   };
176         @o = (@o[0..$i-1], $new, @o[$i+3..$#o]);
177         $i--; # counteracts $i++
178     }
179     debug $ichunkstart, "semiparsed: ".join ' ', map { $_->{P} } @o;
180     # debug $ichunkstart, "semiparsed V: ".join ' ', map { defined $_->{V} ? ">$_->{V}<" : '-' } @o;
181     return @o;
182 }           
183
184 our @analysed_x;
185 our @analysed_y;
186
187 sub analyse_chunk_core () {
188     die "plain deletion\n" unless defined $after;
189     die "plain insertion\n" unless defined $before;
190     my @xs = semiparse $before;
191     my @ys = semiparse $after;
192     @analysed_x = @analysed_y = ();
193     my $next_something = sub {
194         my ($ary,$anal,$var,$what) = @_;
195         die "ran out of $what\n" unless @$ary;
196         my $r = shift @$ary;
197         push @$anal, $r->{P};
198         $$var = $r;
199     };
200     my ($x,$y);
201     my $next_x = sub { $next_something->(\@xs, \@analysed_x, \$x, 'before'); };
202     my $next_y = sub { $next_something->(\@ys, \@analysed_y, \$y, 'after' ); };
203     our @y_expect_suffix = ();
204     for (;;) {
205         while (my $e = shift @y_expect_suffix) {
206             $next_y->();
207             $y->{E} eq $e
208                 or die "suffix mismatch, expected $e got $y->{E}\n";
209         }
210         last unless @xs or @ys;
211         $next_x->();
212         $next_y->();
213         next if $x->{E} eq $y->{E};
214         next if $x->{E} eq 'sprintf' and $y->{E} eq 'f_';
215         next if $x->{E} eq 'die'     and $y->{E} eq 'confess';
216         if ($y->{E} eq '+'
217             and @ys >= 3
218             and $ys[0]{E} eq '('
219             and is_trans($ys[1])) {
220             $next_y->(); # (
221             $next_y->(); # __ f_ i_
222             @y_expect_suffix = ')';
223         } elsif ($y->{E} eq '('
224             and @ys > 2
225             and is_trans($ys[0])
226             and @analysed_y
227             and (grep { $_ eq $analysed_y[-1] } (qw( => [ { ? : . ),
228                                                  '(', ',') )) {
229             $next_y->(); # __ f_ i_
230             @y_expect_suffix = ')';
231         }
232         my $string_changed;
233         my $ye = $y->{E};
234         if (is_trans($y)) {
235             $next_y->();
236             die "__ on non-string $y->{P}\n"     unless is_string($y);
237             die "__ on was non-string $x->{P}\n" unless is_string($x);
238             if ($y->{Q} ne "'") {
239                 die "var subst in new string\n"
240                     if $y->{V} =~ m{(?<!\\) [\$\@]};
241             }
242             eval {
243                 die "__ string changed\n"       unless $y->{V} eq $x->{V};
244                 die "__ string quote changed\n" unless $y->{Q} eq $x->{Q};
245             };
246             $string_changed = $@;
247         }
248         if ($ye eq '__') {
249             $_ = $y->{V};
250             die "percent $& in __ ' string\n" if m{\%};
251             die $string_changed if length $string_changed;
252             next;
253         }
254         if ($ye eq 'i_') {
255             die $string_changed if length $string_changed;
256             next;
257         }
258         if ($ye eq 'f_') {
259             my $fmt = $y->{V};
260             die "no percent in _f string\n" unless $fmt =~ m{\%};
261             next unless $string_changed;
262             die "f_ old string '-quoted\n" if $x->{Q} ne '"';
263             my $xs = $x->{V};
264             my $exactly = sub {
265                 my ($lit, $what) = @_;
266                 my $xl = substr($xs, 0, length($lit));
267                 if ($xl ne $lit) {
268                     my $xsp  = $xs;  $xsp  =~ s/\n/\\n/g;
269                     my $litp = $lit; $litp =~ s/\n/\\n/g;
270                     debug $ichunkstart, "not exactly x: ..\"$xsp\"";
271                     debug $ichunkstart, "not exactly y:  '$litp'";
272                     my $next = @ys ? $ys[0]{P} : '(end)';
273                     die "string contents mismatch near $what before $next\n";
274                 }
275                 $xs = substr($xs, length($lit));
276             };
277             for (;;) {
278                 if ($fmt !~ m{\%[^\%]}) {
279                     $exactly->($fmt, '(tail)');
280                     $fmt = '';
281                     die "text deleted from end of string\n" if length $xs;
282                     last;
283                 }
284                 $exactly->($`, '(literal)');
285                 $fmt = $';
286                 if ($& eq '%%') { $exactly->('%', '%%'); next; }
287                 elsif ($& ne '%s') { die "unhandled %-subst $&\n"; }
288                 $next_y->();
289                 die "expected comma, got $y->{P}\n" unless $y->{E} eq ',';
290                 if (!length $fmt and
291                     !length $xs and
292                     @xs and
293                     $xs[0]{E} eq '.') {
294                     # X has   "<earlier>" .                <something>
295                     # Y has   "<earlier>%s" [other args] , <something>
296                     $next_x->(); # eat the '.'
297                     next;
298                 }
299                 if ($xs =~ m{^\@}) {
300                     $next_y->();
301                     die "\@... => not string" unless is_string($y);
302                     die "\@... => $y->{P}" if $y->{Q} ne '"';
303                     $exactly->($y->{V}, $y->{P});
304                     next;
305                 }
306                 my $bras = 0;
307                 for (;;) {
308                     if (!$bras and !@ys) {
309                         last;
310                     }
311                     $next_y->();
312                     if (!$bras and
313                         (grep { $y->{E} eq $_ } qw( or xor and not ; :
314                                                     if unless while when )
315                          or $y->{E} eq ','
316                          or $y->{T} eq 'ket'
317                         )) {
318                         # lookahead shows close of containing scope
319                         # or lower precedence operator
320                         unshift @ys, $y;
321                         pop @analysed_y;
322                         last;
323                     }
324                     $xs =~ s{^\s+}{} if $bras;
325                     if (is_string($y) and $y->{Q} eq '"') {
326                         $exactly->($y->{V}, $y->{P});
327                         next;
328                     }
329                     $exactly->($y->{E}, $y->{P});
330                     if ($y->{T} eq 'bra' or $y->{E} eq '?') {
331                         $bras++;
332                     } elsif ($y->{T} eq 'ket' or $y->{E} eq ':') {
333                         die "too many kets at $y->{E}\n" unless $bras;
334                         $bras--;
335                     }
336                 }
337             }
338             next;
339         }
340         die "mismatch $x->{P} => $y->{P}\n";
341     }
342 }
343
344 sub analyse_chunk () {
345     for (;;) {
346         eval { analyse_chunk_core(); };
347         return unless length $@;
348         if ($@ =~ m{^missing end of here doc (\S+)\n}) {
349             # fudge this
350             $before .= "\n$1\n";
351             $after .= "\n$1\n";
352             next;
353         } else {
354             die $@;
355         }
356     }
357 }
358
359 our @report;
360 our $last_filehead = -1;
361
362 sub report_on_hunk () {
363     return unless @report;
364     if ($last_filehead != $ifilehead) {
365         foreach (my $i=$ifilehead; $i<$ifirsthunkhead; $i++) {
366             print $d[$i];
367         }
368         $last_filehead = $ifilehead;
369     }
370     my $dummy_r = { S => (scalar @d)+1, E => (scalar @d)+1 };
371     my $r;
372     for (my $i=$ihunkhead; ; $i++) {
373         for (;;) {
374             $r //= shift @report;
375             $r //= $dummy_r;
376             last if $i < $r->{E};
377             confess unless $r->{Done} == 03;
378             $r = undef;
379         }
380
381         last unless $i<$ihunkend;
382
383         foreach my $ds (@{ $debug[$i] }) {
384             print "# $ds\n";
385         }
386
387         if ($i == $r->{S}) {
388             print "!! $r->{M}";
389             $r->{Done} |= 01;
390         }
391         if ($i >= $r->{S}) {
392             print "!";
393             $r->{Done} |= 02;
394         } else {
395             print " ";
396         }
397         print $d[$i];
398     }
399     confess unless $r = $dummy_r;
400 }
401
402 for ($ifilehead = 0; l_ok $ifilehead; $ifilehead++) {
403     m{^diff} or next;
404     $ifirsthunkhead = $ifilehead;
405     while (l_ok $ifirsthunkhead and
406            m{^diff|^index|^---|^\Q+++\E}) {
407         $ifirsthunkhead++
408     }
409     $ihunkhead = $ifirsthunkhead;
410     while (l_ok $ihunkhead) {
411         m{^\@\@} or confess "$ihunkhead $_ ?";
412         my $i = $ihunkhead + 1;
413         for (; ; $i++) {
414             if (!l_ok $i or m{^ } or m{^\@\@}) {
415                 if (defined $ichunkstart) {
416                     $ichunkend = $i;
417                     eval { analyse_chunk(); 1; };
418                     if (length $@) {
419                         debug $ichunkstart, "done x: @analysed_x";
420                         debug $ichunkstart, "done y: @analysed_y";
421                         push @report, { M => $@,
422                                         S => $ichunkstart,
423                                         E => $ichunkend };
424                     }
425                     $ichunkstart = $ichunkend = $before = $after = undef;
426                 }
427                 l_ok $i or last;
428                 m{^\@\@} and last;
429             } elsif (m{^[-+]}) {
430                 my $which = $& eq '-' ? \$before : \$after;
431                 $ichunkstart //= $i;
432                 $$which //= '';
433                 $$which .= $';
434             } else {
435                 confess "$i $_ ?";
436             }
437         }
438         $ihunkend = $i;
439         report_on_hunk();
440         $ichunkend = $i;
441         $ihunkhead = $i;
442     }
443 }