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
|
# ex:ts=8 sw=4:
# $OpenBSD: Unformated.pm,v 1.2 2004/12/24 00:00:05 espie Exp $
# Copyright (c) 2000-2004 Marc Espie <espie@openbsd.org>
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
use strict;
use warnings;
package OpenBSD::Makewhatis::Unformated;
# add_unformated_subject($lines, $toadd, $section, $filename, $toexpand):
#
# build subject from list of $toadd lines, and add it to the list
# of current subjects as section $section
#
sub add_unformated_subject
{
my ($subjects, $toadd, $section, $filename, $toexpand, $picky) = @_;
my $exp = sub {
if (defined $toexpand->{$_[0]}) {
return $toexpand->{$_[0]};
} else {
print STDERR "$filename: can't expand $_[0]\n";
return "";
}
};
local $_ = join(' ', @$toadd);
# do interpolations
s/\\\*\((..)/&$exp($1)/ge;
s/\\\*\[(.*?)\]/&$exp($1)/ge;
# horizontal space adjustments
while (s/\\s[-+]?\d+//g)
{}
# unbreakable spaces
s/\\\s+/ /g;
# unbreakable em dashes
s/\\\|\\\(em\\\|/-/g;
# em dashes
s/\\\(em\s+/- /g;
# em dashes in the middle of lines
s/\\\(em/-/g;
s/\\\*[LO]//g;
s/\\\(tm/(tm)/g;
# font changes
s/\\f[BIRP]//g;
s/\\f\(..//g;
# fine space adjustments
while (s/\\[vh]\'.*?\'//g)
{}
unless (s/\s+\\-\s+/ ($section) - / || s/\s*\\\-/ ($section) -/ ||
s/\s-\s/ ($section) - /) {
print STDERR "Weird subject line in $filename:\n$_\n" if $picky;
# Try guessing where the separation falls...
s/\s+\:\s+/ ($section) - / || s/\S+\s+/$& ($section) - / || s/\s*$/ ($section) - (empty subject)/;
}
# other dashes
s/\\-/-/g;
# escaped characters
s/\\\&(.)/$1/g;
s/\\\|/|/g;
# gremlins...
s/\\c//g;
# sequence of spaces
s/\s+$//;
s/^\s+//;
s/\s+/ /g;
# some damage control
if (m/^\Q($section) - \E/) {
print STDERR "Rejecting non-subject line from $filename:\n$_\n"
if $picky;
return;
}
push(@$subjects, $_);
}
# $lines = handle($file, $filename, $picky)
#
# handle an unformated manpage in $file
#
# may return several subjects, perl(3p) do !
#
sub handle
{
my ($f, $filename, $picky) = @_;
my @lines = ();
my %toexpand = ();
my $so_found = 0;
my $found_th = 0;
my $found_old = 0;
my $found_dt = 0;
my $found_new = 0;
# subject/keep is the only way to deal with Nm/Nd pairs
my @subject = ();
my @keep = ();
my $nd_seen = 0;
local $_;
# retrieve basename of file
my ($name, $section) = $filename =~ m|(?:.*/)?(.*)\.([\w\d]+)|;
# scan until macro
while (<$f>) {
next unless m/^\./ || $found_old || $found_new;
next if m/^\.\\\"/;
if (m/^\.\s*de/) {
while (<$f>) {
last if m/^\.\s*\./;
}
next;
}
if (m/^\.\s*ds\s+(\S+)\s+/) {
chomp($toexpand{$1} = $');
next;
}
# Some cross-refs just link to another manpage
$so_found = 1 if m/^\.\s*so/;
if (m/^\.\s*TH/ || m/^\.\s*th/) {
# in pricky mode, we should try to match these
# ($name2, $section2) = m/^\.(?:TH|th)\s+(\S+)\s+(\S+)/;
# scan until first section
$found_th = 1;
next;
}
if ($found_th && !$found_old && (m/^\.\s*SH/ || m/^\.\s*sh/)) {
$found_old = 1;
next;
}
if (m/^\.\s*Dt/) {
$section .= "/$1" if (m/^\.\s*Dt\s+\S+\s+\d\S*\s+(\S+)/);
$found_dt = 1;
next;
}
if ($found_dt && !$found_new && m/^\.\s*Sh/) {
$found_new = 1;
next;
}
if ($found_old) {
last if m/^\.\s*(?:SH|sh|SS|ss|nf|LI)/;
# several subjects in one manpage
if (m/^\.\s*(?:PP|Pp|br|PD|LP|sp)/) {
add_unformated_subject(\@lines, \@subject,
$section, $filename, \%toexpand, $picky)
if @subject != 0;
@subject = ();
next;
}
next if m/^\'/ || m/^\.\s*tr\s+/ || m/^\.\s*\\\"/ ||
m/^\.\s*sv/ || m/^\.\s*Vb\s+/ || m/\.\s*HP\s+/;
# Motif index entries, don't do anything for now.
next if m/^\.\s*iX/;
# Some other index (cook)
next if m/^\.\s*XX/;
chomp;
s/\.\s*(?:B|I|IR|SM|BR)\s+//;
if (m/^\.\s*(\S\S)/) {
print STDERR "$filename: not grokking $_\n"
if $picky;
next;
}
push(@subject, $_) unless m/^\s*$/;
next;
}
if ($found_new) {
last if m/^\.\s*Sh/;
s/\s,/,/g;
if (s/^\.\s*(\S\S)\s+//) {
my $macro = $1;
next if $macro eq "\\\"";
s/\"(.*?)\"/$1/g;
s/\\-/-/g;
$macro eq 'Xr' and s/^(\S+)\s+(\d\S*)/$1 ($2)/;
$macro eq 'Ox' and s/^/OpenBSD /;
$macro eq 'Nx' and s/^/NetBSD /;
if ($macro eq 'Nd') {
if (@keep != 0) {
add_unformated_subject(\@lines, \@keep,
$section, $filename, \%toexpand, $picky);
@keep = ();
}
push(@subject, "\\-");
$nd_seen = 1;
}
if ($nd_seen && $macro eq 'Nm') {
@keep = @subject;
@subject = ();
$nd_seen = 0;
}
}
push(@subject, $_) unless m/^\s*$/;
}
}
if ($found_th && !$found_old) {
print STDERR "Couldn't find subject in old manpage $filename\n";
}
if ($found_dt && !$found_new) {
print STDERR "Couldn't find subject in new manpage $filename\n";
}
unshift(@subject, @keep) if @keep != 0;
add_unformated_subject(\@lines, \@subject, $section,
$filename, \%toexpand, $picky) if @subject != 0;
if (!$so_found && !$found_old && !$found_new) {
print STDERR "Unknown manpage type $filename\n";
}
return \@lines;
}
1;
|
