X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fdoc_extract.c;h=c8ecbf8e6965240c02630884bc64b9af44ccfdf6;hp=b4ac0d3e6e144e6daa33d188d895baf12b874063;hb=165727526f785b05f67f3d88f9518a0a840acbbf;hpb=650c775ff00cccd03fc84e7789a03c51d9839004;ds=sidebyside diff --git a/tools/doc_extract.c b/tools/doc_extract.c index b4ac0d3e..c8ecbf8e 100644 --- a/tools/doc_extract.c +++ b/tools/doc_extract.c @@ -1,107 +1,74 @@ /* This merely extracts, doesn't do XML or anything. */ #include -#include -#include -#include #include -#include -#include -#include -#include -#include "talloc/talloc.h" - -/* Is A == B ? */ -#define streq(a,b) (strcmp((a),(b)) == 0) - -/* Does A start with B ? */ -#define strstarts(a,b) (strncmp((a),(b),strlen(b)) == 0) - -/* This version adds one byte (for nul term) */ -static void *grab_file(void *ctx, const char *filename) -{ - unsigned int max = 16384, size = 0; - int ret, fd; - char *buffer; - - if (streq(filename, "-")) - fd = dup(STDIN_FILENO); - else - fd = open(filename, O_RDONLY, 0); - - if (fd < 0) - return NULL; - - buffer = talloc_array(ctx, char, max+1); - while ((ret = read(fd, buffer + size, max - size)) > 0) { - size += ret; - if (size == max) - buffer = talloc_realloc(ctx, buffer, char, max*=2 + 1); - } - if (ret < 0) { - talloc_free(buffer); - buffer = NULL; - } else - buffer[size] = '\0'; - close(fd); - return buffer; -} +#include +#include +#include +#include +#include +#include "doc_extract.h" -/* This is a dumb one which copies. We could mangle instead. */ -static char **split(const char *text) +int main(int argc, char *argv[]) { - char **lines = NULL; - unsigned int max = 64, num = 0; + unsigned int i; + const char *type; + const char *function = NULL; - lines = talloc_array(text, char *, max+1); + if (argc < 3) + errx(1, "Usage: doc_extract [--function=] TYPE ...\n" + "Where TYPE is functions|author|licence|maintainer|summary|description|example|all"); - while (*text != '\0') { - unsigned int len = strcspn(text, "\n"); - lines[num] = talloc_array(lines, char, len + 1); - memcpy(lines[num], text, len); - lines[num][len] = '\0'; - text += len + 1; - if (++num == max) - lines = talloc_realloc(text, lines, char *, max*=2 + 1); + if (strstarts(argv[1], "--function=")) { + function = argv[1] + strlen("--function="); + argv++; + argc--; } - lines[num] = NULL; - return lines; -} - -int main(int argc, char *argv[]) -{ - unsigned int i, j; - for (i = 1; i < argc; i++) { - char *file; - char **lines; - bool printing = false, printed = false; + type = argv[1]; + for (i = 2; i < argc; i++) { + char *file, **lines; + unsigned int num; + struct list_head *list; + struct doc_section *d; - file = grab_file(NULL, argv[i]); + file = grab_file(NULL, argv[i], NULL); if (!file) err(1, "Reading file %s", argv[i]); - lines = split(file); + lines = strsplit(file, file, "\n", &num); - for (j = 0; lines[j]; j++) { - if (streq(lines[j], "/**")) { - printing = true; - if (printed++) - puts("\n"); - } else if (streq(lines[j], " */")) - printing = false; - else if (printing) { - if (strstarts(lines[j], " * ")) - puts(lines[j] + 3); - else if (strstarts(lines[j], " *")) - puts(lines[j] + 2); - else - errx(1, "Malformed line %s:%u", - argv[i], j); + 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 { + 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]); } } - talloc_free(file); + talloc_free(list); } return 0; } - - -