]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/tests/examples_compile.c
ccanlint: examples_compile depends on build, which depends on build_objs
[ccan] / tools / ccanlint / tests / examples_compile.c
index 80c5ba631375e58bd24d78463b6aa65139434679..ae0d16d62a8cedd81a5542f88c55dd2c98d71e6c 100644 (file)
@@ -15,6 +15,8 @@ static const char *can_run(struct manifest *m)
 {
        if (safe_mode)
                return "Safe mode enabled";
+       if (list_empty(&m->examples))
+               return "No examples to compile";
        return NULL;
 }
 
@@ -65,20 +67,22 @@ static char *add_dep(const struct manifest *m, char *list, const char *mod)
        return list;
 }
 
+/* FIXME: Merge this into one place. */
 static char *obj_list(const struct manifest *m, struct ccan_file *f)
 {
        char *list = talloc_strdup(m, "");
-       struct ccan_file *i;
+       struct manifest *subm;
        char **lines;
 
-       /* Object files for this module. */
-       list_for_each(&m->c_files, i, list)
-               list = talloc_asprintf_append(list, " %s", i->compiled);
+       /* This module. */
+       if (m->compiled)
+               list = talloc_asprintf_append(list, " %s", m->compiled);
 
        /* Other ccan modules we depend on. */
-       list_for_each(&m->dep_dirs, i, list) {
-               if (i->compiled)
-                       list = talloc_asprintf_append(list, " %s", i->compiled);
+       list_for_each(&m->deps, subm, list) {
+               if (subm->compiled)
+                       list = talloc_asprintf_append(list, " %s",
+                                                     subm->compiled);
        }
 
        /* Other modules implied by includes. */
@@ -101,7 +105,7 @@ static char *obj_list(const struct manifest *m, struct ccan_file *f)
 static char *lib_list(const struct manifest *m)
 {
        unsigned int i, num;
-       char **libs = get_libs(m, ".", &num, &m->info_file->compiled);
+       char **libs = get_libs(m, m->dir, &num, &m->info_file->compiled);
        char *ret = talloc_strdup(m, "");
 
        for (i = 0; i < num; i++)
@@ -109,30 +113,22 @@ static char *lib_list(const struct manifest *m)
        return ret;
 }
 
-static char *compile(const void *ctx,
-                    struct manifest *m,
-                    struct ccan_file *file,
-                    bool keep)
+static bool compile(const void *ctx,
+                   struct manifest *m,
+                   struct ccan_file *file,
+                   bool keep, char **output)
 {
-       char *errmsg;
-
        file->compiled = maybe_temp_file(ctx, "", keep, file->fullname);
-       errmsg = compile_and_link(ctx, file->fullname, ccan_dir,
-                                 obj_list(m, file),
-                                 "", lib_list(m), file->compiled);
-       if (errmsg) {
+       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;
-               return errmsg;
+               return false;
        }
-       return NULL;
+       return true;
 }
 
-struct score {
-       unsigned int score;
-       char *errors;
-};
-
 static char *start_main(char *ret, const char *why)
 {
        return talloc_asprintf_append(ret,
@@ -145,7 +141,7 @@ 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 (isblank(*end)) {
+       while (isspace(*end)) {
                end--;
                if (end == line)
                        return others;
@@ -157,7 +153,7 @@ static char *add_func(char *others, const char *line)
        }
 
        return talloc_asprintf_append(others, "printf(\"%%p\", %.*s);\n",
-                                     (unsigned)(end - p + 1), p);
+                                     (unsigned)(end - p), p+1);
 }
 
 static void strip_leading_whitespace(char **lines)
@@ -188,7 +184,7 @@ 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] || isblank(line[0]) || strstarts(line, "//"))
+               if (!line[0] || isspace(line[0]) || strstarts(line, "//"))
                        continue;
 
                /* The winners. */
@@ -345,7 +341,7 @@ static char *mangle(struct manifest *m, char **lines)
                } else {
                        /* Character at start of line, with ( and no ;
                         * == function start.  Ignore comments. */
-                       if (!isblank(lines[i][0])
+                       if (!isspace(lines[i][0])
                            && strchr(lines[i], '(')
                            && !strchr(lines[i], ';')
                            && !strstr(lines[i], "//")) {
@@ -386,7 +382,7 @@ static char *mangle(struct manifest *m, char **lines)
                ret = talloc_asprintf_append(ret,
                                             "/* Get rid of unused warnings"
                                             " by printing addresses of"
-                                            " static funcs. */");
+                                            " static funcs. */\n");
                if (!fake_function) {
                        ret = talloc_asprintf_append(ret,
                                                     "int use_funcs(void);\n"
@@ -434,112 +430,173 @@ static struct ccan_file *mangle_example(struct manifest *m,
        return f;
 }
 
-static void *build_examples(struct manifest *m, bool keep,
-                           unsigned int *timeleft)
+/* If an example has expected output, it's complete and should not be
+ * included in future examples. */
+static bool has_expected_output(char **lines)
+{
+       unsigned int i;
+
+       for (i = 0; lines[i]; i++) {
+               char *p = lines[i] + strspn(lines[i], " \t");
+               if (!strstarts(p, "//"))
+                       continue;
+               p += strspn(p, "/ ");
+               if (strncasecmp(p, "given", strlen("given")) == 0)
+                       return true;
+       }
+       return false;
+}
+
+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],
+                                 char **lines[3])
+{
+       unsigned int num;
+
+       /* Try standalone. */
+       mangled[0] = i;
+       res[0] = compile(i, m, mangled[0], keep, &err[0]);
+       lines[0] = get_ccan_file_lines(i);
+       if (res[0] && streq(err[0], ""))
+               return 1;
+
+       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]);
+               if (res[1] && streq(err[1], "")) {
+                       return 2;
+               }
+               num = 2;
+       } else
+               num = 1;
+
+       /* 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]);
+
+       return num+1;
+}
+
+static void build_examples(struct manifest *m, bool keep,
+                          unsigned int *timeleft, struct score *score)
 {
        struct ccan_file *i;
-       struct score *score = talloc(m, struct score);
        char **prev = NULL;
+       bool warnings = false;
 
-       score->score = 0;
-       score->errors = talloc_strdup(score, "");
+       score->total = 0;
+       score->pass = true;
 
-       examples_compile.total_score = 0;
        list_for_each(&m->examples, i, list) {
-               char *ret, *ret1, *ret2 = NULL;
-               struct ccan_file *mangle1, *mangle2 = NULL;
+               char *err[3];
+               struct ccan_file *file[3] = { NULL, NULL, NULL };
+               bool res[3];
+               unsigned num, j;
+               char **lines[3];
+               char *error;
+
+               score->total++;
 
-               examples_compile.total_score++;
                /* Simplify our dumb parsing. */
                strip_leading_whitespace(get_ccan_file_lines(i));
-               ret = compile(i, m, i, keep);
-               if (!ret) {
-                       prev = get_ccan_file_lines(i);
-                       score->score++;
-                       continue;
-               }
 
-               /* Try standalone. */
-               mangle1 = mangle_example(m, i, get_ccan_file_lines(i), keep);
-               ret1 = compile(i, m, mangle1, keep);
-               if (!ret1) {
-                       prev = get_ccan_file_lines(i);
-                       score->score++;
-                       continue;
-               }
+               num = try_compiling(m, i, prev, keep, file, res, err, lines);
 
-               /* Try combining with previous (successful) example... */
-               if (prev) {
-                       char **new = combine(i, get_ccan_file_lines(i), prev);
+               /* First look for a compile without any warnings. */
+               for (j = 0; j < num; j++) {
+                       if (res[j] && streq(err[j], "")) {
+                               if (!has_expected_output(lines[j]))
+                                       prev = lines[j];
+                               score->score++;
+                               goto next;
+                       }
+               }
 
-                       mangle2 = mangle_example(m, i, new, keep);
-                       ret2 = compile(i, m, mangle2, keep);
-                       if (!ret2) {
-                               prev = new;
+               /* Now accept anything which succeeded. */
+               for (j = 0; j < num; j++) {
+                       if (res[j]) {
+                               if (!has_expected_output(lines[j]))
+                                       prev = lines[j];
                                score->score++;
-                               continue;
+                               warnings = true;
+                               score->error = "Compiling extracted example"
+                                       " gave warnings";
+                               score_file_error(score, file[j], 0, err[j]);
+                               goto next;
                        }
                }
 
-               score->errors = talloc_asprintf_append(score->errors,
-                                      "%s: tried standalone example:\n"
-                                      "%s\n"
-                                      "Errors: %s\n\n",
-                                      i->name,
-                                      get_ccan_file_contents(i),
-                                      ret);
-               score->errors = talloc_asprintf_append(score->errors,
-                                      "%s: tried adding headers, wrappers:\n"
-                                      "%s\n"
-                                      "Errors: %s\n\n",
-                                      i->name,
-                                      get_ccan_file_contents(mangle1),
-                                      ret1);
-
-               if (mangle2) {
-                       score->errors = talloc_asprintf_append(score->errors,
-                                      "%s: tried combining with"
-                                      " previous example:\n"
-                                      "%s\n"
-                                      "Errors: %s\n\n",
-                                      i->name,
-                                      get_ccan_file_contents(mangle2),
-                                      ret2);
+               score->pass = false;
+               score->error = "Compiling extracted examples failed";
+               if (!verbose) {
+                       if (num == 3)
+                               error = "Standalone, adding headers, "
+                                       "and including previous "
+                                       "example all failed";
+                       else
+                               error = "Standalone compile and"
+                                       " adding headers both failed";
+               } else {
+                       if (num == 3) {
+                               error = talloc_asprintf(score,
+                                     "Standalone example:\n"
+                                     "%s\n"
+                                     "Errors: %s\n\n"
+                                     "Combining with previous example:\n"
+                                     "%s\n"
+                                     "Errors: %s\n\n"
+                                     "Adding headers, wrappers:\n"
+                                     "%s\n"
+                                     "Errors: %s\n\n",
+                                     get_ccan_file_contents(file[0]),
+                                     err[0],
+                                     get_ccan_file_contents(file[1]),
+                                     err[1],
+                                     get_ccan_file_contents(file[2]),
+                                     err[2]);
+                       } else {
+                               error = talloc_asprintf(score,
+                                     "Standalone example:\n"
+                                     "%s\n"
+                                     "Errors: %s\n\n"
+                                     "Adding headers, wrappers:\n"
+                                     "%s\n"
+                                     "Errors: %s\n\n",
+                                     get_ccan_file_contents(file[0]),
+                                     err[0],
+                                     get_ccan_file_contents(file[1]),
+                                     err[1]);
+                       }
                }
+               score_file_error(score, i, 0, error);
                /* This didn't work, so not a candidate for combining. */
                prev = NULL;
-       }
 
-       if (strcmp(score->errors, "") == 0) {
-               talloc_free(score);
-               return NULL;
+       next:
+               ;
        }
-       return score;
-}
 
-static unsigned int score_examples(struct manifest *m, void *check_result)
-{
-       struct score *score = check_result;
-       return score->score;
-}
-
-static const char *describe(struct manifest *m, void *check_result)
-{
-       struct score *score = check_result;
-       if (verbose >= 2 && score->errors)
-               return talloc_asprintf(m, "Compile errors building examples:\n"
-                                      "%s", score->errors);
-       return NULL;
+       /* An extra point if they all compiled without warnings. */
+       if (!list_empty(&m->examples)) {
+               score->total++;
+               if (!warnings)
+                       score->score++;
+       }
 }
 
 struct ccanlint examples_compile = {
        .key = "examples-compile",
        .name = "Module examples compile",
-       .score = score_examples,
-       .total_score = 3, /* This gets changed to # examples, if they exist */
        .check = build_examples,
-       .describe = describe,
        .can_run = can_run,
 };
 
-REGISTER_TEST(examples_compile, &has_examples, NULL);
+REGISTER_TEST(examples_compile, &has_examples, &build, NULL);