]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/tests/examples_exist.c
base64: fix for unsigned chars (e.g. ARM).
[ccan] / tools / ccanlint / tests / examples_exist.c
index 947d76a4a768751053e6830b4bb788cb2c56df77..61359596e1f693ed56a127c613724462e1f1f2d7 100644 (file)
@@ -1,7 +1,9 @@
 #include <tools/ccanlint/ccanlint.h>
 #include <tools/tools.h>
-#include <ccan/talloc/talloc.h>
 #include <ccan/str/str.h>
+#include <ccan/tal/path/path.h>
+#include <ccan/take/take.h>
+#include <ccan/cast/cast.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
 
 /* Creates and adds an example file. */
 static char *add_example(struct manifest *m, struct ccan_file *source,
-                        bool keep,
                         struct doc_section *example)
 {
-       char *name;
+       char *name, *linemarker;
        unsigned int i;
        int fd;
        struct ccan_file *f;
 
-       name = talloc_asprintf(m, "%s/example-%s-%s.c",
-                              talloc_dirname(m,
-                                             source->fullname),
-                              source->name,
-                              example->function);
+       name = tal_fmt(m, "example-%s-%s",
+                      source->name, example->function);
        /* example->function == 'struct foo' */
        while (strchr(name, ' '))
                *strchr(name, ' ') = '_';
 
-       name = maybe_temp_file(m, ".c", keep, name);
-       f = new_ccan_file(m, talloc_dirname(m, name), talloc_basename(m, name));
-       talloc_steal(f, name);
+       name = temp_file(m, ".c", take(name));
+       f = new_ccan_file(m, take(path_dirname(m, name)),
+                         take(path_basename(m, name)));
+       tal_steal(f, name);
        list_add_tail(&m->examples, &f->list);
 
        fd = open(f->fullname, O_WRONLY | O_CREAT | O_EXCL, 0600);
        if (fd < 0)
-               return talloc_asprintf(m, "Creating temporary file %s: %s",
-                                      f->fullname, strerror(errno));
+               return tal_fmt(m, "Creating temporary file %s: %s",
+                              f->fullname, strerror(errno));
+
+       /* Add #line to demark where we are from, so errors are correct! */
+       linemarker = tal_fmt(f, "#line %i \"%s\"\n",
+                            example->srcline+2, source->fullname);
+       if (write(fd, linemarker, strlen(linemarker)) != (int)strlen(linemarker)) {
+               close(fd);
+               return cast_const(char *, "Failure writing to temporary file");
+       }
 
        for (i = 0; i < example->num_lines; i++) {
                if (write(fd, example->lines[i], strlen(example->lines[i]))
                    != strlen(example->lines[i])
                    || write(fd, "\n", 1) != 1) {
                        close(fd);
-                       return "Failure writing to temporary file";
+                       return cast_const(char *,
+                                         "Failure writing to temporary file");
                }
        }
        close(fd);
@@ -57,8 +65,7 @@ static char *add_example(struct manifest *m, struct ccan_file *source,
 
 /* FIXME: We should have one example per function in header. */
 static void extract_examples(struct manifest *m,
-                            bool keep,
-                            unsigned int *timeleft,
+                            unsigned int *timeleft UNNEEDED,
                             struct score *score)
 {
        struct ccan_file *f, *mainh = NULL; /* gcc complains uninitialized */
@@ -68,23 +75,22 @@ static void extract_examples(struct manifest *m,
        score->total = 2;
        list_for_each(get_ccan_file_docs(m->info_file), d, list) {
                if (streq(d->type, "example")) {
-                       score->error = add_example(m, m->info_file, keep, d);
+                       score->error = add_example(m, m->info_file, d);
                        if (score->error)
                                return;
                        have_info_example = true;
                }
        }
 
-       /* Check main header. */
+       /* Check all headers for examples. */
        list_for_each(&m->h_files, f, list) {
-               if (!strstarts(f->name, m->basename)
-                   || strlen(f->name) != strlen(m->basename) + 2)
-                       continue;
+               if (strstarts(f->name, m->basename)
+                   && strlen(f->name) == strlen(m->basename) + 2)
+                       mainh = f;
 
-               mainh = f;
                list_for_each(get_ccan_file_docs(f), d, list) {
                        if (streq(d->type, "example")) {
-                               score->error = add_example(m, f, keep, d);
+                               score->error = add_example(m, f, d);
                                if (score->error)
                                        return;
                                have_header_example = true;
@@ -92,28 +98,26 @@ static void extract_examples(struct manifest *m,
                }
        }
 
+       /* We don't fail ccanlint for this. */
+       score->pass = true;
        if (have_info_example && have_header_example) {
                score->score = score->total;
-               score->pass = true;
                return;
        }
 
-       score->error = "Expect examples in header and _info";
        if (!have_info_example)
                score_file_error(score, m->info_file, 0, "No Example: section");
        if (!have_header_example)
                score_file_error(score, mainh, 0, "No Example: section");
 
        score->score = have_info_example + have_header_example;
-       /* We pass if we find any example. */
-       score->pass = score->score != 0;
 }
 
 struct ccanlint examples_exist = {
        .key = "examples_exist",
        .name = "_info and main header file have Example: sections",
        .check = extract_examples,
-       .needs = "info_exists"
+       .needs = "info_exists main_header_exists"
 };
 
 REGISTER_TEST(examples_exist);