1 /* This merely extracts, doesn't do XML or anything. */
12 #include <ccan/talloc/talloc.h>
13 #include <ccan/str/str.h>
14 #include "doc_extract.h"
17 static char **grab_doc(char **lines, unsigned int num)
21 bool printing = false;
23 ret = talloc_array(NULL, char *, num+1);
26 for (i = 0; lines[i]; i++) {
27 if (streq(lines[i], "/**")) {
30 talloc_append_string(ret[num-1], "\n");
31 } else if (streq(lines[i], " */"))
34 if (strstarts(lines[i], " * "))
35 ret[num++] = talloc_strdup(ret, lines[i]+3);
36 else if (strstarts(lines[i], " *"))
37 ret[num++] = talloc_strdup(ret, lines[i]+2);
39 errx(1, "Malformed line %u", i);
46 static bool is_blank(const char *line)
48 return line && line[strspn(line, " \t\n")] == '\0';
51 static bool is_section(const char *line, bool one_liner)
55 if (!isupper(line[0]))
57 len = strspn(line, IDENT_CHARS" ");
61 /* If it can be a one-liner, a space is sufficient.*/
63 return (line[len+1] == ' ' || line[len+1] == '\t');
65 return line[len] == ':' && is_blank(line+len+1);
68 /* Summary line is form '<identifier> - ' */
69 static bool is_summary_line(const char *line)
73 id_len = strspn(line, IDENT_CHARS);
76 if (!strstarts(line + id_len, " - "))
82 static bool empty_section(struct doc_section *d)
86 for (i = 0; i < d->num_lines; i++)
87 if (!is_blank(d->lines[i]))
92 static struct doc_section *new_section(struct list_head *list,
96 struct doc_section *d;
100 /* If previous section was empty, delete it. */
101 d = list_tail(list, struct doc_section, list);
102 if (d && empty_section(d)) {
107 d = talloc(list, struct doc_section);
108 d->function = function;
109 lowertype = talloc_size(d, strlen(type) + 1);
110 /* Canonicalize type to lower case. */
111 for (i = 0; i < strlen(type)+1; i++)
112 lowertype[i] = tolower(type[i]);
117 list_add_tail(list, &d->list);
121 static void add_line(struct doc_section *curr, const char *line)
123 curr->lines = talloc_realloc(curr, curr->lines, char *,
125 curr->lines[curr->num_lines++] = talloc_strdup(curr->lines, line);
128 struct list_head *extract_doc_sections(char **rawlines, unsigned int num)
130 char **lines = grab_doc(rawlines, num);
131 const char *function = NULL;
132 struct doc_section *curr = NULL;
134 struct list_head *list;
136 list = talloc(NULL, struct list_head);
137 list_head_init(list);
139 for (i = 0; lines[i]; i++) {
140 if (is_summary_line(lines[i])) {
141 function = talloc_strndup(list, lines[i],
142 strcspn(lines[i], " "));
143 curr = new_section(list, function, "summary");
144 add_line(curr, strstr(lines[i], " - ") + 3);
145 curr = new_section(list, function, "description");
146 } else if (is_section(lines[i], false)) {
147 char *type = talloc_strndup(curr, lines[i],
148 strcspn(lines[i], ":"));
149 curr = new_section(list, function, type);
150 } else if (is_section(lines[i], true)) {
151 unsigned int sectlen = strcspn(lines[i], ":");
152 char *type = talloc_strndup(curr, lines[i], sectlen);
153 curr = new_section(list, function, type);
154 add_line(curr, lines[i] + sectlen + 1
155 + strspn(lines[i] + sectlen + 1, " \t"));
159 add_line(curr, lines[i]);