ncurses 6.1 - patch 20180623
[ncurses.git] / test / tracemunch
1 #!/usr/bin/env perl
2 # $Id: tracemunch,v 1.20 2018/05/02 00:14:29 tom Exp $
3 ##############################################################################
4 # Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.                #
5 #                                                                            #
6 # Permission is hereby granted, free of charge, to any person obtaining a    #
7 # copy of this software and associated documentation files (the "Software"), #
8 # to deal in the Software without restriction, including without limitation  #
9 # the rights to use, copy, modify, merge, publish, distribute, distribute    #
10 # with modifications, sublicense, and/or sell copies of the Software, and to #
11 # permit persons to whom the Software is furnished to do so, subject to the  #
12 # following conditions:                                                      #
13 #                                                                            #
14 # The above copyright notice and this permission notice shall be included in #
15 # all copies or substantial portions of the Software.                        #
16 #                                                                            #
17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR #
18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   #
19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    #
20 # THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER      #
21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    #
22 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        #
23 # DEALINGS IN THE SOFTWARE.                                                  #
24 #                                                                            #
25 # Except as contained in this notice, the name(s) of the above copyright     #
26 # holders shall not be used in advertising or otherwise to promote the sale, #
27 # use or other dealings in this Software without prior written               #
28 # authorization.                                                             #
29 ##############################################################################
30 # tracemunch -- compactify ncurses trace logs
31 #
32 # The error logs produced by ncurses with tracing enabled can be very tedious
33 # to wade through.  This script helps by compacting runs of log lines that
34 # can be conveniently expressed as higher-level operations.
35
36 use strict;
37 use warnings;
38
39 our $putattr =
40     'PutAttrChar\(\{\{ ' . "'(.)'"
41   . ' = 0[0-7]+ \}\}\) at \(([0-9]+), ([0-9]+)\)';
42 our $waddnstr =
43   'waddnstr\(0x([[:xdigit:]]+),"([^\"]+)",[0-9]+\) called \{A_NORMAL\}';
44
45 our $scr_nums = 0;
46 our $thr_nums = 0;
47 our $try_nums = 0;
48 our $win_nums = 0;
49 our $curscr   = "";
50 our $newscr   = "";
51 our $stdscr   = "";
52 our %scr_addr;
53 our %thr_addr;
54 our %try_addr;
55 our %win_addr;
56
57 sub transaddr {
58     my $n;
59     my $arg = $_[0];
60
61     $arg =~ s/\b$curscr\b/curscr/g if ($curscr);
62     $arg =~ s/\b$newscr\b/newscr/g if ($newscr);
63     $arg =~ s/\b$stdscr\b/stdscr/g if ($stdscr);
64     foreach my $addr ( keys %scr_addr ) {
65         $n = $scr_addr{$addr};
66         $arg =~ s/\b$addr\b/screen$n/g if ( defined $n );
67     }
68     foreach my $addr ( keys %thr_addr ) {
69         $n = $thr_addr{$addr};
70         $arg =~ s/\b$addr\b/thread$n/g if ( defined $n );
71     }
72     foreach my $addr ( keys %try_addr ) {
73         $n = $try_addr{$addr};
74         $arg =~ s/\b$addr\b/tries_$n/g if ( defined $n );
75     }
76     foreach my $addr ( keys %win_addr ) {
77         $n = $win_addr{$addr};
78         $arg =~ s/\b$addr\b/window$n/g if ( defined $n );
79     }
80     if ( $arg =~ /add_wch\((window\d+,)?0x[[:xdigit:]]+\)/i ) {
81         $arg =~ s/(0x[[:xdigit:]]+)[)]/\&wch)/i;
82     }
83     elsif ( $arg =~ /color_content\((screen\d+,)?\d+(,0x[[:xdigit:]]+){3}/i ) {
84         $arg =~ s/(,0x[[:xdigit:]]+){3}[)]/,\&r,\&g,\&b)/i;
85     }
86     elsif ( $arg =~ /pair_content\((screen\d+,)?\d+(,0x[[:xdigit:]]+){2}/i ) {
87         $arg =~ s/(,0x[[:xdigit:]]+){2}[)]/,\&fg,\&bg)/i;
88     }
89
90     return $arg;
91 }
92
93 while (<STDIN>) {
94     my $addr;
95     my $n;
96     my $awaiting = "";
97
98   CLASSIFY: {
99
100         my $thread = "";
101         if ( $_ =~ /^(0x[[:xdigit:]]+):/ ) {
102             $thr_addr{$1} = ++$thr_nums unless defined $thr_addr{$1};
103             $thread = "thread" . $thr_addr{$1} . ":";
104             $_ =~ s/^[^:]*://;
105         }
106
107         # Transform window pointer addresses so it's easier to compare logs
108         $awaiting = "curscr" if ( $_ =~ /creating curscr/ );
109         $awaiting = "newscr" if ( $_ =~ /creating newscr/ );
110         $awaiting = "stdscr" if ( $_ =~ /creating stdscr/ );
111         $awaiting = "screen" if ( $_ =~ /^(\+ )*called \{new_prescr\(\)/ );
112         if ( $_ =~ /^create :window 0x([[:xdigit:]]+)/ ) {
113             $addr = "0x$1";
114             if ( $awaiting eq "curscr" ) {
115                 $curscr = $addr;
116             }
117             elsif ( $awaiting eq "newscr" ) {
118                 $newscr = $addr;
119             }
120             elsif ( $awaiting eq "stdscr" ) {
121                 $stdscr = $addr;
122             }
123             else {
124                 $win_addr{$addr} = $win_nums++;
125             }
126             $awaiting = "";
127         }
128         elsif ( $_ =~ /^(\+ )*called \{_nc_add_to_try\((0x[[:xdigit:]]+),/ ) {
129             $try_addr{$2} = ++$try_nums unless defined $try_addr{$2};
130         }
131         elsif ( $_ =~ /^(\+ )*_nc_alloc_screen_sp 0x([[:xdigit:]]+)/ ) {
132             $addr = "0x$2";
133             $scr_addr{$addr} = ++$scr_nums unless ( $scr_addr{$addr} );
134             $awaiting = "";
135         }
136         elsif ( $_ =~ /^(\+ )*return }0x([[:xdigit:]]+)/ ) {
137             $addr = "0x$2";
138             if ( $awaiting eq "screen" ) {
139                 $scr_addr{$addr} = ++$scr_nums unless ( $scr_addr{$addr} );
140             }
141         }
142         elsif ( $_ =~ /^\.\.\.deleted win=0x([[:xdigit:]]+)/ ) {
143             $addr = "0x$1";
144             $_    = &transaddr($_);
145             if ( $addr eq $curscr ) {
146                 $curscr = "";
147             }
148             elsif ( $addr eq $newscr ) {
149                 $newscr = "";
150             }
151             elsif ( $addr eq $stdscr ) {
152                 $stdscr = "";
153             }
154             else {
155                 undef $win_addr{$addr};
156             }
157         }
158
159         # Compactify runs of PutAttrChar calls (TR_CHARPUT)
160         if ( $_ =~ /$putattr/ ) {
161             my $putattr_chars = $1;
162             my $starty        = $2;
163             my $startx        = $3;
164             while (<STDIN>) {
165                 if ( $_ =~ /$putattr/ ) {
166                     $putattr_chars .= $1;
167                 }
168                 else {
169                     last;
170                 }
171             }
172             print
173 "RUN of PutAttrChar()s: \"$putattr_chars\" from ${starty}, ${startx}\n";
174             redo CLASSIFY;
175         }
176
177         # Compactify runs of waddnstr calls (TR_CALLS)
178         if ( $_ =~ /$waddnstr/ ) {
179             my $waddnstr_chars = $2;
180             my $winaddr        = $1;
181             while (<STDIN>) {
182                 if ( $_ =~ /$waddnstr/ && $1 eq $winaddr ) {
183                     $waddnstr_chars .= $2;
184                 }
185                 else {
186                     last;
187                 }
188             }
189             my $winaddstr = &transaddr($winaddr);
190             print "RUN of waddnstr()s: $winaddr, \"$waddnstr_chars\"\n";
191             redo CLASSIFY;
192         }
193
194         # More transformations can go here
195
196         # Repeated runs of anything
197         my $anyline     = &transaddr($_);
198         my $repeatcount = 1;
199         while (<STDIN>) {
200             if ( &transaddr($_) eq $anyline ) {
201                 $repeatcount++;
202             }
203             else {
204                 last;
205             }
206         }
207         if ( $repeatcount > 1 ) {
208             print "${repeatcount} REPEATS OF $anyline";
209         }
210         else {
211             print $thread . $anyline;
212         }
213         redo CLASSIFY if $_;
214
215     }    # :CLASSIFY
216 }
217
218 # tracemunch ends here