chiark / gitweb /
i18n: i18n-diff-auditor: debugging changes
[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 qp ($) {
114     my ($p) = @_;
115     $p =~ s{\\}{\\\\}g;
116     $p =~ s{\'}{\\'}g;
117     $p =~ s{\n}{\\n}g;
118     $p =~ s{\t}{\\t}g;
119     return "'$p'";
120 };
121
122 sub semiparse ($) {
123     ($_) = @_;
124     my @o;
125     #my $in = $_;
126     # entries contain
127     #   T     type
128     #   E     exact input text (does not contain here doc contents)
129     #   P     something to print in messages
130     #   V     value, only for: heredoc string
131     #   Q     quote characcter, only for: heredoc string
132     for (;;) {
133         s{^\s+}{};
134         if (s{^[\$\@\%]?[_0-9a-zA-Z]+}{}) {
135             push @o, { T => 'ident', E => $&, P => $& };
136         } elsif (s{^\<\<(['"]?)([A-Z_]+)\1}{}) {
137             my ($q,$d) = ($1,$2);
138             $q ||= '"';
139             push @o, { T => 'heredoc', Q => $q, Delim => $d,
140                        E => $&, P => "<<$q$d$q" };
141             s{^
142                 (                 .* \n     )
143                 ( (?: (?! $d \n ) .* \n )*? )
144                           $d         \n
145               }{ $1 }xe or die "missing end of here doc $d\n";
146             $o[$#o]{V} = $2;
147         } elsif (s{^ (["'])( (?: [^\\'"]
148                                | \\ [^"']
149                                | (?! \1 ) [^"]
150                               )*
151                        ) \1 }{}x) {
152             my ($q,$v) = ($1,$2);
153             push @o, { T => 'string', E => $&, P => "$q$q",
154                        Q => $q, V => $v};
155         } elsif (s{^$perlop_re|^\;}{}) {
156             push @o, { T => 'op', E => $&, P => $& };
157         } elsif (s/^[[{(]//) {
158             push @o, { T => 'bra', E => $&, P => $& };
159         } elsif (s/^[]})]//) {
160             push @o, { T => 'ket', E => $&, P => $& };
161         } elsif (s/^( [\$\@\%] )( \{ )//x) {
162             push @o, { T => 'deref', E => $1, P => $1 },
163                      { T => 'bra',   E => $2, P => $2 };
164         } elsif (s/^ [\$\@\%] [^[^{] //x) {
165             push @o, { T => 'specvar', E => $&, P => $& };
166         } elsif (!length) {
167             last;
168         } else {
169             m{^.{0,10}};
170             die "cannot tokenise \`$&'";
171         }
172     }
173     for (my $i=0; $i+2 < @o; $i++) {
174         next unless $o[$i+1]{E} eq '.';
175         my @inputs = @o[$i, $i+2];
176         #print STDERR Dumper(\@inputs);
177         next if grep { !is_string($_) } @inputs;
178         my $q = $inputs[0]{Q};
179         next if grep { $_->{Q} ne $q } @inputs;
180         my $new = { T => 'joinedstrings',
181                     E => (join '.', map { $_->{E} } @inputs),
182                     P => (join '.', map { $_->{P} } @inputs),
183                     V => (join '',  map { $_->{V} } @inputs),
184                     Q => $q,
185                   };
186         @o = (@o[0..$i-1], $new, @o[$i+3..$#o]);
187         $i--; # counteracts $i++
188     }
189     debug $ichunkstart, "semiparsed: ".join ' ', map { $_->{P} } @o;
190     # debug $ichunkstart, "semiparsed V: ".join ' ', map { defined $_->{V} ? ">$_->{V}<" : '-' } @o;
191     return @o;
192 }           
193
194 our @analysed_x;
195 our @analysed_y;
196
197 sub analyse_chunk_core () {
198     die "plain deletion\n" unless defined $after;
199     die "plain insertion\n" unless defined $before;
200     my @xs = semiparse $before;
201     my @ys = semiparse $after;
202     @analysed_x = @analysed_y = ();
203     my $next_something = sub {
204         my ($ary,$anal,$var,$what) = @_;
205         die "ran out of $what\n" unless @$ary;
206         my $r = shift @$ary;
207         push @$anal, $r->{P};
208         $$var = $r;
209     };
210     my ($x,$y);
211     my $next_x = sub { $next_something->(\@xs, \@analysed_x, \$x, 'before'); };
212     my $next_y = sub { $next_something->(\@ys, \@analysed_y, \$y, 'after' ); };
213     our @y_expect_suffix = ();
214     for (;;) {
215         while (my $e = shift @y_expect_suffix) {
216             $next_y->();
217             $y->{E} eq $e
218                 or die "suffix mismatch, expected $e got $y->{E}\n";
219         }
220         last unless @xs or @ys;
221         $next_x->();
222         $next_y->();
223         next if $x->{E} eq $y->{E};
224         next if $x->{E} eq 'sprintf' and $y->{E} eq 'f_';
225         next if $x->{E} eq 'die'     and $y->{E} eq 'confess';
226         if ($y->{E} eq '+'
227             and @ys >= 3
228             and $ys[0]{E} eq '('
229             and is_trans($ys[1])) {
230             $next_y->(); # (
231             $next_y->(); # __ f_ i_
232             @y_expect_suffix = ')';
233         } elsif ($y->{E} eq '('
234             and @ys > 2
235             and is_trans($ys[0])
236             and @analysed_y
237             and (grep { $_ eq $analysed_y[-1] } (qw( => [ { ? : . ),
238                                                  '(', ',') )) {
239             $next_y->(); # __ f_ i_
240             @y_expect_suffix = ')';
241         }
242         my $string_changed;
243         my $ye = $y->{E};
244         if (is_trans($y)) {
245             $next_y->();
246             die "__ on non-string $y->{P}\n"     unless is_string($y);
247             die "__ on was non-string $x->{P}\n" unless is_string($x);
248             if ($y->{Q} ne "'") {
249                 die "var subst in new string\n"
250                     if $y->{V} =~ m{(?<!\\) [\$\@]};
251             }
252             eval {
253                 die "__ string changed\n"       unless $y->{V} eq $x->{V};
254                 die "__ string quote changed\n" unless $y->{Q} eq $x->{Q};
255             };
256             $string_changed = $@;
257         }
258         if ($ye eq '__') {
259             $_ = $y->{V};
260             die "percent $& in __ ' string\n" if m{\%};
261             die $string_changed if length $string_changed;
262             next;
263         }
264         if ($ye eq 'i_') {
265             die $string_changed if length $string_changed;
266             next;
267         }
268         if ($ye eq 'f_') {
269             my $fmt = $y->{V};
270             die "no percent in _f string\n" unless $fmt =~ m{\%};
271             next unless $string_changed;
272             die "f_ old string '-quoted\n" if $x->{Q} ne '"';
273             my $xs = $x->{V};
274             my $exactly = sub {
275                 my ($lit, $what) = @_;
276                 my $xl = substr($xs, 0, length($lit));
277                 if ($xl ne $lit) {
278                     debug $ichunkstart, "not exactly x: ..".qp($xs);
279                     debug $ichunkstart, "not exactly y:   ".qp($lit);
280                     my $next = @ys ? $ys[0]{P} : '(end)';
281                     die "string contents mismatch near $what before $next\n";
282                 }
283                 $xs = substr($xs, length($lit));
284             };
285             for (;;) {
286                 #print STDERR Dumper($fmt, $xs, \@xs, @ys);
287                 if ($fmt !~ m{\%[^\%]}) {
288                     $exactly->($fmt, '(tail)');
289                     $fmt = '';
290                     die "text deleted from end of string: ".qp($xs)."\n"
291                         if length $xs;
292                     last;
293                 }
294                 $exactly->($`, '(literal)');
295                 $fmt = $';
296                 if ($& eq '%%') { $exactly->('%', '%%'); next; }
297                 elsif ($& ne '%s') { die "unhandled %-subst $&\n"; }
298                 $next_y->();
299                 die "expected comma, got $y->{P}\n" unless $y->{E} eq ',';
300                 if (!length $fmt and
301                     !length $xs and
302                     @xs and
303                     $xs[0]{E} eq '.') {
304                     # X has   "<earlier>" .                <something>
305                     # Y has   "<earlier>%s" [other args] , <something>
306                     $next_x->(); # eat the '.'
307                     next;
308                 }
309                 if ($xs =~ m{^\@}) {
310                     $next_y->();
311                     die "\@... => not string" unless is_string($y);
312                     die "\@... => $y->{P}" if $y->{Q} ne '"';
313                     $exactly->($y->{V}, $y->{P});
314                     next;
315                 }
316                 my $bras = 0;
317                 for (;;) {
318                     if (!$bras and !@ys) {
319                         last;
320                     }
321                     $next_y->();
322                     if (!$bras and
323                         (grep { $y->{E} eq $_ } qw( or xor and not ; :
324                                                     if unless while when )
325                          or $y->{E} eq ','
326                          or $y->{T} eq 'ket'
327                         )) {
328                         # lookahead shows close of containing scope
329                         # or lower precedence operator
330                         unshift @ys, $y;
331                         pop @analysed_y;
332                         last;
333                     }
334                     $xs =~ s{^\s+}{} if $bras;
335                     if (is_string($y) and $y->{Q} eq '"') {
336                         $exactly->($y->{V}, $y->{P});
337                         next;
338                     }
339                     $exactly->($y->{E}, $y->{P});
340                     if ($y->{T} eq 'bra' or $y->{E} eq '?') {
341                         $bras++;
342                     } elsif ($y->{T} eq 'ket' or $y->{E} eq ':') {
343                         die "too many kets at $y->{E}\n" unless $bras;
344                         $bras--;
345                     }
346                 }
347             }
348             next;
349         }
350         die "mismatch $x->{P} => $y->{P}\n";
351     }
352 }
353
354 sub analyse_chunk () {
355     for (;;) {
356         eval { analyse_chunk_core(); };
357         return unless length $@;
358         if ($@ =~ m{^missing end of here doc (\S+)\n}) {
359             # fudge this
360             $before .= "\n$1\n";
361             $after .= "\n$1\n";
362             next;
363         } else {
364             die $@;
365         }
366     }
367 }
368
369 our @report;
370 our $last_filehead = -1;
371
372 sub report_on_hunk () {
373     return unless @report;
374     if ($last_filehead != $ifilehead) {
375         foreach (my $i=$ifilehead; $i<$ifirsthunkhead; $i++) {
376             print $d[$i];
377         }
378         $last_filehead = $ifilehead;
379     }
380     my $dummy_r = { S => (scalar @d)+1, E => (scalar @d)+1 };
381     my $r;
382     for (my $i=$ihunkhead; ; $i++) {
383         for (;;) {
384             $r //= shift @report;
385             $r //= $dummy_r;
386             last if $i < $r->{E};
387             confess unless $r->{Done} == 03;
388             $r = undef;
389         }
390
391         last unless $i<$ihunkend;
392
393         foreach my $ds (@{ $debug[$i] }) {
394             print "# $ds\n";
395         }
396
397         if ($i == $r->{S}) {
398             print "!! $r->{M}";
399             $r->{Done} |= 01;
400         }
401         if ($i >= $r->{S}) {
402             print "!";
403             $r->{Done} |= 02;
404         } else {
405             print " ";
406         }
407         print $d[$i];
408     }
409     confess unless $r = $dummy_r;
410 }
411
412 for ($ifilehead = 0; l_ok $ifilehead; $ifilehead++) {
413     m{^diff} or next;
414     $ifirsthunkhead = $ifilehead;
415     while (l_ok $ifirsthunkhead and
416            m{^diff|^index|^---|^\Q+++\E}) {
417         $ifirsthunkhead++
418     }
419     $ihunkhead = $ifirsthunkhead;
420     while (l_ok $ihunkhead) {
421         m{^\@\@} or confess "$ihunkhead $_ ?";
422         my $i = $ihunkhead + 1;
423         for (; ; $i++) {
424             if (!l_ok $i or m{^ } or m{^\@\@}) {
425                 if (defined $ichunkstart) {
426                     $ichunkend = $i;
427                     eval { analyse_chunk(); 1; };
428                     if (length $@) {
429                         debug $ichunkstart, "done x: @analysed_x";
430                         debug $ichunkstart, "done y: @analysed_y";
431                         push @report, { M => $@,
432                                         S => $ichunkstart,
433                                         E => $ichunkend };
434                     }
435                     $ichunkstart = $ichunkend = $before = $after = undef;
436                 }
437                 l_ok $i or last;
438                 m{^\@\@} and last;
439             } elsif (m{^[-+]}) {
440                 my $which = $& eq '-' ? \$before : \$after;
441                 $ichunkstart //= $i;
442                 $$which //= '';
443                 $$which .= $';
444             } else {
445                 confess "$i $_ ?";
446             }
447         }
448         $ihunkend = $i;
449         report_on_hunk();
450         $ichunkend = $i;
451         $ihunkhead = $i;
452     }
453 }