X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fdoc_extract.c;h=d7617a076a752e23c858d1ab75b74a504960c9c7;hp=0a5752c1db2d725094c99400bc84ab8a3c37afe3;hb=3953aaa384210378777cc06f5e7d7f40e44a20e8;hpb=5dfeaf275800bf027dd4bc830d4815ba83e54a14 diff --git a/tools/doc_extract.c b/tools/doc_extract.c index 0a5752c1..d7617a07 100644 --- a/tools/doc_extract.c +++ b/tools/doc_extract.c @@ -1,177 +1,74 @@ /* This merely extracts, doesn't do XML or anything. */ #include -#include -#include -#include #include -#include -#include -#include -#include -#include "talloc/talloc.h" -#include "string/string.h" - -static char **grab_doc(const char *fname) -{ - char *file; - char **lines, **ret; - unsigned int i, num; - bool printing = false, printed = false; - - file = grab_file(NULL, fname, NULL); - if (!file) - err(1, "Reading file %s", fname); - lines = strsplit(file, file, "\n", &num); - ret = talloc_array(NULL, char *, num+1); - - num = 0; - for (i = 0; lines[i]; i++) { - if (streq(lines[i], "/**")) { - printing = true; - if (printed++) - talloc_append_string(ret[num], "\n"); - } else if (streq(lines[i], " */")) - printing = false; - else if (printing) { - if (strstarts(lines[i], " * ")) - ret[num++] = talloc_strdup(ret, lines[i]+3); - else if (strstarts(lines[i], " *")) - ret[num++] = talloc_strdup(ret, lines[i]+2); - else - errx(1, "Malformed line %s:%u", fname, i); - } - } - ret[num] = NULL; - talloc_free(file); - return ret; -} - -static bool is_blank(const char *line) -{ - return line && line[strspn(line, " \t\n")] == '\0'; -} - -static bool is_section(const char *line, bool maybe_one_liner) -{ - unsigned int len; - - len = strcspn(line, " \t\n:"); - if (len == 0) - return false; - - if (line[len] != ':') - return false; - - /* If it can be a one-liner, a space is sufficient.*/ - if (maybe_one_liner && (line[len+1] == ' ' || line[len+1] == '\t')) - return true; - - return line[len] == ':' && is_blank(line+len+1); -} - - -static bool end_section(const char *line) -{ - return !line || is_section(line, true); -} - -static unsigned int find_section(char **lines, const char *name, - bool maybe_one_liner) -{ - unsigned int i; - - for (i = 0; lines[i]; i++) { - if (!is_section(lines[i], maybe_one_liner)) - continue; - if (strncasecmp(lines[i], name, strlen(name)) != 0) - continue; - if (lines[i][strlen(name)] == ':') - break; - } - return i; -} +#include +#include +#include +#include +#include +#include "doc_extract.h" int main(int argc, char *argv[]) { unsigned int i; const char *type; + const char *function = NULL; if (argc < 3) - errx(1, "Usage: doc_extract TYPE ...\n" - "Where TYPE is author|licence|maintainer|summary|description|example|all"); + errx(1, "Usage: doc_extract [--function=] TYPE ...\n" + "Where TYPE is functions|author|license|maintainer|summary|description|example|all"); + + if (strstarts(argv[1], "--function=")) { + function = argv[1] + strlen("--function="); + argv++; + argc--; + } type = argv[1]; for (i = 2; i < argc; i++) { - unsigned int line; - char **lines = grab_doc(argv[i]); - - if (!lines[0]) - errx(1, "No documentation in file"); - - /* Simple one-line fields. */ - if (streq(type, "author") - || streq(type, "maintainer") - || streq(type, "licence")) { - line = find_section(lines, type, true); - if (lines[line]) { - const char *p = strchr(lines[line], ':') + 1; - p += strspn(p, " \t\n"); - if (p[0] == '\0') { - /* Must be on next line. */ - if (end_section(lines[line+1])) - errx(1, "Malformed %s", type); - puts(lines[line+1]); - } else - puts(p); + char *file, **lines; + unsigned int num; + struct list_head *list; + struct doc_section *d; + + file = grab_file(NULL, argv[i], NULL); + if (!file) + err(1, "Reading file %s", argv[i]); + lines = strsplit(file, file, "\n", &num); + + list = extract_doc_sections(lines, num); + if (list_empty(list)) + errx(1, "No documentation in file %s", argv[i]); + talloc_free(file); + + if (streq(type, "functions")) { + const char *last = NULL; + list_for_each(list, d, list) { + if (d->function) { + if (!last || !streq(d->function, last)) + printf("%s\n", d->function); + last = d->function; + } } - } else if (streq(type, "summary")) { - /* Summary comes after - on first line. */ - char *dash; - - dash = strchr(lines[0], '-'); - if (!dash) - errx(1, "Malformed first line: no -"); - dash += strspn(dash, "- "); - puts(dash); - } else if (streq(type, "description")) { - line = 1; - while (is_blank(lines[line])) - line++; - - while (!end_section(lines[line])) - puts(lines[line++]); - } else if (streq(type, "example")) { - line = find_section(lines, type, false); - if (lines[line]) { - unsigned int strip; - line++; - - while (is_blank(lines[line])) - line++; - - /* Examples can be indented. Take cue - * from first non-blank line. */ - if (lines[line]) - strip = strspn(lines[line], " \t"); - - while (!end_section(lines[line])) { - if (strspn(lines[line], " \t") >= strip) - puts(lines[line] + strip); - else - puts(lines[line]); - line++; + } else { + unsigned int j; + list_for_each(list, d, list) { + if (function) { + if (!d->function) + continue; + if (!streq(d->function, function)) + continue; } + if (streq(type, "all")) + printf("%s:\n", d->type); + else if (!streq(d->type, type)) + continue; + + for (j = 0; j < d->num_lines; j++) + printf("%s\n", d->lines[j]); } - } else if (streq(type, "all")) { - for (line = 0; lines[line]; line++) - puts(lines[line]); - } else - errx(1, "Unknown type '%s'", type); - - talloc_free(lines); + } + talloc_free(list); } return 0; } - - -