]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/tests/examples_compile.c
ccanlint: handle nested modules when mentioned in examples.
[ccan] / tools / ccanlint / tests / examples_compile.c
index ff9e529b645a8d46b39f4c4a2e2c976221402905..7d8803c6973db2cc4213915a30caa1e3aa67d5f3 100644 (file)
@@ -1,6 +1,8 @@
 #include <tools/ccanlint/ccanlint.h>
 #include <tools/tools.h>
 #include <ccan/talloc/talloc.h>
+#include <ccan/str_talloc/str_talloc.h>
+#include <ccan/cast/cast.h>
 #include <ccan/str/str.h>
 #include <sys/types.h>
 #include <sys/stat.h>
@@ -11,7 +13,7 @@
 #include <ctype.h>
 #include <assert.h>
 #include <err.h>
-#include "../compulsory_tests/build.h"
+#include "build.h"
 
 static const char *can_run(struct manifest *m)
 {
@@ -29,28 +31,28 @@ static void add_mod(struct manifest ***deps, struct manifest *m)
        (*deps)[num] = m;
 }
 
-static bool have_mod(struct manifest *deps[], const char *basename)
+static bool have_mod(struct manifest *deps[], const char *modname)
 {
        unsigned int i;
 
        for (i = 0; i < talloc_get_size(deps) / sizeof(*deps); i++)
-               if (strcmp(deps[i]->basename, basename) == 0)
+               if (strcmp(deps[i]->modname, modname) == 0)
                        return true;
        return false;
 }
 
-static void add_dep(struct manifest ***deps, const char *basename)
+static void add_dep(struct manifest ***deps, const char *modname)
 {
        unsigned int i;
        struct manifest *m;
        char *errstr;
 
-       if (have_mod(*deps, basename))
+       if (have_mod(*deps, modname))
                return;
 
        m = get_manifest(*deps, talloc_asprintf(*deps, "%s/ccan/%s",
-                                               ccan_dir, basename));
-       errstr = build_submodule(m);
+                                               ccan_dir, modname));
+       errstr = build_submodule(m, cflags, COMPILE_NORMAL);
        if (errstr)
                errx(1, "%s", errstr);
 
@@ -61,7 +63,8 @@ static void add_dep(struct manifest ***deps, const char *basename)
        if (m->info_file) {
                char **infodeps;
 
-               infodeps = get_deps(m, m->dir, false, &m->info_file->compiled);
+               infodeps = get_deps(m, m->dir, "depends", false,
+                                   get_or_compile_info);
 
                for (i = 0; infodeps[i]; i++) {
                        if (strstarts(infodeps[i], "ccan/"))
@@ -70,60 +73,76 @@ static void add_dep(struct manifest ***deps, const char *basename)
        }
 }
 
-static char *obj_list(struct manifest *m, struct ccan_file *f)
+static struct manifest **get_example_deps(struct manifest *m,
+                                         struct ccan_file *f)
 {
+       char **lines;
        struct manifest **deps = talloc_array(f, struct manifest *, 0);
-       char **lines, *list;
-       unsigned int i;
 
        /* This one for a start. */
-       add_dep(&deps, m->basename);
+       add_dep(&deps, m->modname);
 
        /* Other modules implied by includes. */
        for (lines = get_ccan_file_lines(f); *lines; lines++) {
-               unsigned preflen = strspn(*lines, " \t");
-               if (strstarts(*lines + preflen, "#include <ccan/")) {
-                       char *modname;
-
-                       modname = talloc_strdup(f, *lines + preflen
-                                               + strlen("#include <ccan/"));
-                       modname[strcspn(modname, "/")] = '\0';
+               char *modname;
+               if (strreg(f, *lines,
+                           "^[ \t]*#[ \t]*include[ \t]*[<\"]"
+                          "ccan/+(.+)/+[^/]+\\.h", &modname)) {
                        if (!have_mod(deps, modname))
                                add_dep(&deps, modname);
                }
        }
 
-       list = talloc_strdup(f, "");
-       for (i = 0; i < talloc_get_size(deps) / sizeof(*deps); i++) {
-               if (deps[i]->compiled)
+       return deps;
+}
+
+static char *example_obj_list(const void *ctx, struct manifest **deps)
+{
+       char *list = talloc_strdup(ctx, "");
+       unsigned int i;
+
+       for (i = 0; i < talloc_array_length(deps); i++) {
+               if (deps[i]->compiled[COMPILE_NORMAL])
                        list = talloc_asprintf_append(list, " %s",
-                                                     deps[i]->compiled);
+                                                     deps[i]->compiled
+                                                     [COMPILE_NORMAL]);
        }
        return list;
 }
 
-static char *lib_list(const struct manifest *m)
+static char *example_lib_list(const void *ctx, struct manifest **deps)
 {
-       unsigned int i, num;
-       char **libs = get_libs(m, m->dir, &num, &m->info_file->compiled);
-       char *ret = talloc_strdup(m, "");
-
-       for (i = 0; i < num; i++)
-               ret = talloc_asprintf_append(ret, "-l%s ", libs[i]);
-       return ret;
+       char *list = talloc_strdup(ctx, "");
+       char **libs;
+       unsigned int i, j;
+
+       /* FIXME: This doesn't uniquify. */
+       for (i = 0; i < talloc_array_length(deps); i++) {
+               libs = get_libs(ctx, deps[i]->dir, NULL, get_or_compile_info);
+               for (j = 0; libs[j]; j++)
+                       list = talloc_asprintf_append(list, "-l%s ", libs[j]);
+       }
+       return list;
 }
 
+/* FIXME: Test with reduced features! */
 static bool compile(const void *ctx,
                    struct manifest *m,
                    struct ccan_file *file,
-                   bool keep, char **output)
+                   char **output)
 {
-       file->compiled = maybe_temp_file(ctx, "", keep, file->fullname);
+       struct manifest **deps = get_example_deps(m, file);
+
+       file->compiled[COMPILE_NORMAL] = temp_file(ctx, "", file->fullname);
        if (!compile_and_link(ctx, file->fullname, ccan_dir,
-                             obj_list(m, file),
-                             "", lib_list(m), file->compiled, output)) {
-               talloc_free(file->compiled);
-               file->compiled = NULL;
+                             example_obj_list(file, deps),
+                             compiler, cflags,
+                             example_lib_list(file, deps),
+                             file->compiled[COMPILE_NORMAL],
+                             output)) {
+               /* Don't keep failures, even with --keep */
+               unlink(file->compiled[COMPILE_NORMAL]);
+               file->compiled[COMPILE_NORMAL] = NULL;
                return false;
        }
        return true;
@@ -141,13 +160,13 @@ static char *start_main(char *ret, const char *why)
 static char *add_func(char *others, const char *line)
 {
        const char *p, *end = strchr(line, '(') - 1;
-       while (isspace(*end)) {
+       while (cisspace(*end)) {
                end--;
                if (end == line)
                        return others;
        }
 
-       for (p = end; isalnum(*p) || *p == '_'; p--) {
+       for (p = end; cisalnum(*p) || *p == '_'; p--) {
                if (p == line)
                        return others;
        }
@@ -184,58 +203,72 @@ static bool looks_internal(char **lines, char **why)
                const char *line = lines[i] + strspn(lines[i], " \t");
                unsigned len = strspn(line, IDENT_CHARS);
 
-               if (!line[0] || isspace(line[0]) || strstarts(line, "//"))
+               if (!line[0] || cisspace(line[0]) || strstarts(line, "//")
+                   || strstarts(line, "#line"))
                        continue;
 
+               assert(line[strlen(line)-1] != '\n');
+
                /* The winners. */
                if (strstarts(line, "if") && len == 2) {
-                       *why = "starts with if";
+                       *why = cast_const(char *, "starts with if");
                        return true;
                }
                if (strstarts(line, "for") && len == 3) {
-                       *why = "starts with for";
+                       *why = cast_const(char *, "starts with for");
                        return true;
                }
                if (strstarts(line, "while") && len == 5) {
-                       *why = "starts with while";
+                       *why = cast_const(char *, "starts with while");
                        return true;
                }
                if (strstarts(line, "do") && len == 2) {
-                       *why = "starts with do";
+                       *why = cast_const(char *, "starts with do");
                        return true;
                }
 
                /* The losers. */
                if (strstarts(line, "#include")) {
-                       *why = "starts with #include";
+                       *why = cast_const(char *, "starts with #include");
                        return false;
                }
 
                if (last_ended && strchr(line, '(')) {
                        if (strstarts(line, "static")) {
-                               *why = "starts with static and contains (";
+                               *why = cast_const(char *,
+                                                 "starts with static"
+                                                 " and contains (");
                                return false;
                        }
                        if (strends(line, ")")) {
-                               *why = "contains ( and ends with )";
+                               *why = cast_const(char *,
+                                                 "contains ( and ends with )");
                                return false;
                        }
                }
 
+               /* Previously prepended. */
+               if (strstr(line, "didn't seem to belong inside a function")) {
+                       *why = cast_const(char *, "Comment said so");
+                       return false;
+               }
+
                /* Single identifier then operator == inside function. */
                if (last_ended && len
-                   && ispunct(line[len+strspn(line+len, " ")])) {
-                       *why = "starts with identifier then punctuation";
+                   && cispunct(line[len+strspn(line+len, " ")])) {
+                       *why = cast_const(char *, "starts with identifier"
+                                         " then punctuation");
                        return true;
                }
 
                last_ended = (strends(line, "}")
                              || strends(line, ";")
+                             || strends(line, "*/")
                              || streq(line, "..."));
        }
 
        /* No idea... Say yes? */
-       *why = "gave no clues";
+       *why = cast_const(char *, "gave no clues");
        return true;
 }
 
@@ -282,7 +315,7 @@ static char **combine(const void *ctx, char **lines, char **prev)
        prev_total = i;
 
        ret = talloc_array(ctx, char *, 1 +lines_total + prev_total + 1);
-       ret[0] = talloc_asprintf(ret, "/* The example %s, thus %s */\n",
+       ret[0] = talloc_asprintf(ret, "/* The example %s, thus %s */",
                                 why, reasoning);
        memcpy(ret+1, lines, count * sizeof(ret[0]));
        memcpy(ret+1 + count, prev, prev_total * sizeof(ret[0]));
@@ -310,23 +343,24 @@ static char *mangle(struct manifest *m, char **lines)
        bool in_function = false, fake_function = false, has_main = false;
        unsigned int i;
 
-       ret = talloc_strdup(m, "/* Prepend a heap of headers. */\n"
-                           "#include <assert.h>\n"
-                           "#include <err.h>\n"
-                           "#include <errno.h>\n"
-                           "#include <fcntl.h>\n"
-                           "#include <limits.h>\n"
-                           "#include <stdbool.h>\n"
-                           "#include <stdint.h>\n"
-                           "#include <stdio.h>\n"
-                           "#include <stdlib.h>\n"
-                           "#include <string.h>\n"
-                           "#include <sys/stat.h>\n"
-                           "#include <sys/types.h>\n"
-                           "#include <unistd.h>\n");
-       ret = talloc_asprintf_append(ret, "/* Include header from module. */\n"
-                                    "#include <ccan/%s/%s.h>\n",
-                                    m->basename, m->basename);
+       ret = talloc_asprintf(m, 
+                             "/* Include header from module. */\n"
+                             "#include <ccan/%s/%s.h>\n"
+                             "/* Prepend a heap of headers. */\n"
+                             "#include <assert.h>\n"
+                             "#include <err.h>\n"
+                             "#include <errno.h>\n"
+                             "#include <fcntl.h>\n"
+                             "#include <limits.h>\n"
+                             "#include <stdbool.h>\n"
+                             "#include <stdint.h>\n"
+                             "#include <stdio.h>\n"
+                             "#include <stdlib.h>\n"
+                             "#include <string.h>\n"
+                             "#include <sys/stat.h>\n"
+                             "#include <sys/types.h>\n"
+                             "#include <unistd.h>\n",
+                             m->modname, m->basename);
 
        ret = talloc_asprintf_append(ret, "/* Useful dummy functions. */\n"
                                     "extern int somefunc(void);\n"
@@ -356,7 +390,7 @@ static char *mangle(struct manifest *m, char **lines)
                } else {
                        /* Character at start of line, with ( and no ;
                         * == function start.  Ignore comments. */
-                       if (!isspace(line[0])
+                       if (!cisspace(line[0])
                            && strchr(line, '(')
                            && !strchr(line, ';')
                            && !strstr(line, "//")) {
@@ -415,16 +449,15 @@ static char *mangle(struct manifest *m, char **lines)
 
 static struct ccan_file *mangle_example(struct manifest *m,
                                        struct ccan_file *example,
-                                       char **lines,
-                                       bool keep)
+                                       char **lines)
 {
        char *name, *contents;
        int fd;
        struct ccan_file *f;
 
-       name = maybe_temp_file(example, ".c", keep, 
-                              talloc_asprintf(m, "%s/mangled-%s",
-                                              m->dir, example->name));
+       name = temp_file(example, ".c",
+                        talloc_asprintf(m, "%s/mangled-%s",
+                                        m->dir, example->name));
        f = new_ccan_file(example,
                          talloc_dirname(example, name),
                          talloc_basename(example, name));
@@ -465,7 +498,6 @@ static bool has_expected_output(char **lines)
 static unsigned int try_compiling(struct manifest *m,
                                  struct ccan_file *i,
                                  char **prev,
-                                 bool keep,
                                  struct ccan_file *mangled[3],
                                  bool res[3],
                                  char *err[3],
@@ -475,7 +507,7 @@ static unsigned int try_compiling(struct manifest *m,
 
        /* Try standalone. */
        mangled[0] = i;
-       res[0] = compile(i, m, mangled[0], keep, &err[0]);
+       res[0] = compile(i, m, mangled[0], &err[0]);
        lines[0] = get_ccan_file_lines(i);
        if (res[0] && streq(err[0], ""))
                return 1;
@@ -483,8 +515,8 @@ static unsigned int try_compiling(struct manifest *m,
        if (prev) {
                lines[1] = combine(i, get_ccan_file_lines(i), prev);
 
-               mangled[1] = mangle_example(m, i, lines[1], keep);
-               res[1] = compile(i, m, mangled[1], keep, &err[1]);
+               mangled[1] = mangle_example(m, i, lines[1]);
+               res[1] = compile(i, m, mangled[1], &err[1]);
                if (res[1] && streq(err[1], "")) {
                        return 2;
                }
@@ -494,13 +526,13 @@ static unsigned int try_compiling(struct manifest *m,
 
        /* Try standalone. */
        lines[num] = get_ccan_file_lines(i);
-       mangled[num] = mangle_example(m, i, lines[num], keep);
-       res[num] = compile(i, m, mangled[num], keep, &err[num]);
+       mangled[num] = mangle_example(m, i, lines[num]);
+       res[num] = compile(i, m, mangled[num], &err[num]);
 
        return num+1;
 }
 
-static void build_examples(struct manifest *m, bool keep,
+static void build_examples(struct manifest *m,
                           unsigned int *timeleft, struct score *score)
 {
        struct ccan_file *i;
@@ -516,14 +548,14 @@ static void build_examples(struct manifest *m, bool keep,
                bool res[3];
                unsigned num, j;
                char **lines[3];
-               char *error;
+               const char *error;
 
                score->total++;
 
                /* Simplify our dumb parsing. */
                strip_leading_whitespace(get_ccan_file_lines(i));
 
-               num = try_compiling(m, i, prev, keep, file, res, err, lines);
+               num = try_compiling(m, i, prev, file, res, err, lines);
 
                /* First look for a compile without any warnings. */
                for (j = 0; j < num; j++) {
@@ -542,25 +574,23 @@ static void build_examples(struct manifest *m, bool keep,
                                        prev = lines[j];
                                score->score++;
                                warnings = true;
-                               score->error = "Compiling extracted example"
-                                       " gave warnings";
-                               error = talloc_asprintf(score,
-                                       "Example:\n"
-                                       "%s\n"
-                                       "Compiler:\n"
-                                       "%s",
-                                       get_ccan_file_contents(file[j]),
-                                       err[j]);
-                               score_file_error(score, file[j], 0, error);
+                               score_file_error(score, file[j], 0,
+                                                "Compiling extracted example"
+                                                " gave warnings:\n"
+                                                "Example:\n"
+                                                "%s\n"
+                                                "Compiler:\n"
+                                                "%s",
+                                                get_ccan_file_contents(file[j]),
+                                                err[j]);
                                goto next;
                        }
                }
 
                score->pass = false;
-               score->error = "Compiling extracted examples failed";
                if (!verbose) {
                        if (num == 3)
-                               error = "Standalone, adding headers, "
+                               error = "Compiling standalone, adding headers, "
                                        "and including previous "
                                        "example all failed";
                        else
@@ -598,7 +628,7 @@ static void build_examples(struct manifest *m, bool keep,
                                      err[1]);
                        }
                }
-               score_file_error(score, i, 0, error);
+               score_file_error(score, i, 0, "%s", error);
                /* This didn't work, so not a candidate for combining. */
                prev = NULL;
 
@@ -619,6 +649,7 @@ struct ccanlint examples_compile = {
        .name = "Module examples compile",
        .check = build_examples,
        .can_run = can_run,
+       .needs = "examples_exist module_builds"
 };
 
-REGISTER_TEST(examples_compile, &has_examples, &build, NULL);
+REGISTER_TEST(examples_compile);