ncurses 6.0 - patch 20170513
[ncurses.git] / test / tracemunch
1 #!/usr/bin/env perl
2 # $Id: tracemunch,v 1.9 2017/05/07 19:59:08 tom Exp $
3 ##############################################################################
4 # Copyright (c) 1998-2005,2017 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\\({{ '(.)' = 0[0-7]+ }}\\) at \\(([0-9]+), ([0-9]+)\\)";
41 our $waddnstr =
42   "waddnstr\\(0x([[:xdigit:]]+),\"([^\"]+)\",[0-9]+\\) called {A_NORMAL}";
43
44 our $scr_nums = 0;
45 our $try_nums = 0;
46 our $win_nums = 0;
47 our $curscr   = "";
48 our $newscr   = "";
49 our $stdscr   = "";
50 our %scr_addr;
51 our %try_addr;
52 our %win_addr;
53
54 sub transaddr {
55     my $n;
56     my $arg = $_[0];
57
58     $arg =~ s/\b$curscr\b/curscr/g if ($curscr);
59     $arg =~ s/\b$newscr\b/newscr/g if ($newscr);
60     $arg =~ s/\b$stdscr\b/stdscr/g if ($stdscr);
61     foreach my $addr ( keys %scr_addr ) {
62         $n = $scr_addr{$addr};
63         $arg =~ s/\b$addr\b/screen$n/g;
64     }
65     foreach my $addr ( keys %try_addr ) {
66         $n = $try_addr{$addr};
67         $arg =~ s/\b$addr\b/tries_$n/g;
68     }
69     foreach my $addr ( keys %win_addr ) {
70         $n = $win_addr{$addr};
71         $arg =~ s/\b$addr\b/window$n/g;
72     }
73
74     return $arg;
75 }
76
77 while (<STDIN>) {
78     my $addr;
79     my $n;
80     my $awaiting;
81
82   CLASSIFY: {
83
84         # Transform window pointer addresses so it's easier to compare logs
85         $awaiting = "curscr" if ( $_ =~ /creating curscr/ );
86         $awaiting = "newscr" if ( $_ =~ /creating newscr/ );
87         $awaiting = "stdscr" if ( $_ =~ /creating stdscr/ );
88         $awaiting = "screen" if ( $_ =~ /^(\+ )*called {new_prescr\(\)/ );
89         if ( $_ =~ /^create :window 0x([[:xdigit:]]+)/ ) {
90             $addr = "0x$1";
91             if ( $awaiting eq "curscr" ) {
92                 $curscr = $addr;
93             }
94             elsif ( $awaiting eq "newscr" ) {
95                 $newscr = $addr;
96             }
97             elsif ( $awaiting eq "stdscr" ) {
98                 $stdscr = $addr;
99             }
100             else {
101                 $win_addr{$addr} = $win_nums++;
102             }
103             $awaiting = "";
104         }
105         elsif ( $_ =~ /^(\+ )*called {_nc_add_to_try\((0x[[:xdigit:]]+),/ ) {
106             $try_addr{$2} = ++$try_nums unless defined $try_addr{$2};
107         }
108         elsif ( $_ =~ /^(\+ )*return }0x([[:xdigit:]]+)/ ) {
109             $addr = "0x$2";
110             if ( $awaiting eq "screen" ) {
111                 $scr_addr{$addr} = ++$scr_nums;
112             }
113         }
114         elsif ( $_ =~ /^\.\.\.deleted win=0x([[:xdigit:]]+)/ ) {
115             $addr = "0x$1";
116             $_    = &transaddr($_);
117             if ( $addr eq $curscr ) {
118                 $curscr = "";
119             }
120             elsif ( $addr eq $newscr ) {
121                 $newscr = "";
122             }
123             elsif ( $addr eq $stdscr ) {
124                 $stdscr = "";
125             }
126             else {
127                 undef $win_addr{$addr};
128             }
129         }
130
131         # Compactify runs of PutAttrChar calls (TR_CHARPUT)
132         if ( $_ =~ /$putattr/ ) {
133             my $putattr_chars = $1;
134             my $starty        = $2;
135             my $startx        = $3;
136             while (<STDIN>) {
137                 if ( $_ =~ /$putattr/ ) {
138                     $putattr_chars .= $1;
139                 }
140                 else {
141                     last;
142                 }
143             }
144             print
145 "RUN of PutAttrChar()s: \"$putattr_chars\" from ${starty}, ${startx}\n";
146             redo CLASSIFY;
147         }
148
149         # Compactify runs of waddnstr calls (TR_CALLS)
150         if ( $_ =~ /$waddnstr/ ) {
151             my $waddnstr_chars = $2;
152             my $winaddr        = $1;
153             while (<STDIN>) {
154                 if ( $_ =~ /$waddnstr/ && $1 eq $winaddr ) {
155                     $waddnstr_chars .= $2;
156                 }
157                 else {
158                     last;
159                 }
160             }
161             my $winaddstr = &transaddr($winaddr);
162             print "RUN of waddnstr()s: $winaddr, \"$waddnstr_chars\"\n";
163             redo CLASSIFY;
164         }
165
166         # More transformations can go here
167
168         # Repeated runs of anything
169         my $anyline     = &transaddr($_);
170         my $repeatcount = 1;
171         while (<STDIN>) {
172             if ( &transaddr($_) eq $anyline ) {
173                 $repeatcount++;
174             }
175             else {
176                 last;
177             }
178         }
179         if ( $repeatcount > 1 ) {
180             print "${repeatcount} REPEATS OF $anyline";
181         }
182         else {
183             print $anyline;
184         }
185         redo CLASSIFY if $_;
186
187     }    # :CLASSIFY
188 }
189
190 # tracemunch ends here