]> git.ozlabs.org Git - ccan/blobdiff - tools/doc_extract.c
.gitignore: ignore configurator
[ccan] / tools / doc_extract.c
index b70325ea47f51a00f7db114024bbbc24e2089920..d7617a076a752e23c858d1ab75b74a504960c9c7 100644 (file)
@@ -1,52 +1,74 @@
 /* This merely extracts, doesn't do XML or anything. */
 #include <err.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <unistd.h>
 #include <string.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <stdbool.h>
-#include "talloc/talloc.h"
-#include "string/string.h"
-
+#include <stdio.h>
+#include <ccan/str/str.h>
+#include <ccan/str_talloc/str_talloc.h>
+#include <ccan/talloc/talloc.h>
+#include <ccan/grab_file/grab_file.h>
+#include "doc_extract.h"
 
 int main(int argc, char *argv[])
 {
-       unsigned int i, j;
+       unsigned int i;
+       const char *type;
+       const char *function = NULL;
 
-       for (i = 1; i < argc; i++) {
-               char *file;
-               char **lines;
-               bool printing = false, printed = false;
+       if (argc < 3)
+               errx(1, "Usage: doc_extract [--function=<funcname>] TYPE <file>...\n"
+                    "Where TYPE is functions|author|license|maintainer|summary|description|example|all");
 
-               file = grab_file(NULL, argv[i]);
+       if (strstarts(argv[1], "--function=")) {
+               function = argv[1] + strlen("--function=");
+               argv++;
+               argc--;
+       }
+
+       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], NULL);
                if (!file)
                        err(1, "Reading file %s", argv[i]);
-               lines = strsplit(file, file, "\n", NULL);
-
-               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);
+               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 {
+                       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;
 }
-
-               
-