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
|
/*
* descriptions.c: manipulate man page descriptions
*
* Copyright (C) 2002, 2003, 2006, 2007, 2008, 2009, 2010, 2011 Colin Watson.
*
* This file is part of man-db.
*
* man-db is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* man-db is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with man-db; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif /* HAVE_CONFIG_H */
#include <stdbool.h>
#include <string.h>
#include <stdlib.h>
#include "gl_array_list.h"
#include "gl_xlist.h"
#include "xalloc.h"
#include "xstrndup.h"
#include "manconfig.h"
#include "debug.h"
#include "util.h"
#include "descriptions.h"
/* Free a page description. */
static void page_description_free (const void *value)
{
struct page_description *desc = (struct page_description *) value;
free (desc->name);
free (desc->whatis);
free (desc);
}
/* Parse the description in a whatis line returned by find_name() into a
* list of names and whatis descriptions.
*/
gl_list_t parse_descriptions (const char *base, const char *whatis)
{
const char *sep, *nextsep;
gl_list_t descs;
bool seen_base = false;
descs = gl_list_create_empty (GL_ARRAY_LIST, NULL, NULL,
page_description_free, true);
if (!whatis)
return descs;
sep = whatis;
while (sep) {
char *record;
size_t length;
const char *dash;
char *names;
const char *token;
/* Use a while loop so that we skip over things like the
* result of double line breaks.
*/
while (*sep == 0x11 || *sep == ' ')
++sep;
nextsep = strchr (sep, 0x11);
/* Get this record as a null-terminated string. */
if (nextsep)
length = (size_t) (nextsep - sep);
else
length = strlen (sep);
if (length == 0)
break;
record = xstrndup (sep, length);
debug ("record = '%s'\n", record);
/* Split the record into name and whatis description. */
dash = strstr (record, " - ");
if (dash)
names = xstrndup (record, dash - record);
else if (!gl_list_size (descs))
/* Some pages have a NAME section with just the page
* name and no whatis. We might as well include
* this.
*/
names = xstrdup (record);
else
/* Once at least one record has been seen, further
* cases where there is no whatis usually amount to
* garbage following the useful records, and can
* cause problems due to false WHATIS_MAN entries in
* the database. On the whole it seems best to
* ignore these.
*/
goto next;
for (token = strtok (names, ","); token;
token = strtok (NULL, ",")) {
char *name = trim_spaces (token);
struct page_description *desc;
/* Skip name tokens containing whitespace. They are
* almost never useful as manual page names.
*/
if (strpbrk (name, " \t") != NULL) {
free (name);
continue;
}
/* Allocate new description node. */
desc = xmalloc (sizeof *desc);
desc->name = name; /* steal memory */
desc->whatis = dash ? trim_spaces (dash + 3) : NULL;
gl_list_add_last (descs, desc);
if (base && STREQ (base, desc->name))
seen_base = true;
}
free (names);
next:
free (record);
sep = nextsep;
}
/* If it isn't there already, add the base name onto the returned
* list.
*/
if (base && !seen_base) {
struct page_description *desc = xmalloc (sizeof *desc);
desc->name = xstrdup (base);
desc->whatis = NULL;
if (gl_list_size (descs)) {
const struct page_description *first =
gl_list_get_at (descs, 0);
if (first->whatis)
desc->whatis = xstrdup (first->whatis);
}
gl_list_add_last (descs, desc);
}
return descs;
}
|
