]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/tests/examples_compile.c
ccanlint: make compile commands return output.
[ccan] / tools / ccanlint / tests / examples_compile.c
index f9a919a1bfcf7d83748d026e79ec8eb2dd278601..1b2360ed52e3820e13f65e24ece05e22a3dfff67 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;
 }
 
@@ -101,7 +103,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++)
@@ -117,22 +119,17 @@ static char *compile(const void *ctx,
        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, &errmsg)) {
                talloc_free(file->compiled);
                file->compiled = NULL;
                return errmsg;
        }
+       talloc_free(errmsg);
        return NULL;
 }
 
-struct score {
-       unsigned int score;
-       char *errors;
-};
-
 static char *start_main(char *ret, const char *why)
 {
        return talloc_asprintf_append(ret,
@@ -145,7 +142,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;
@@ -188,7 +185,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 +342,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], "//")) {
@@ -434,112 +431,115 @@ 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 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;
 
-       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 = NULL, *ret2;
-               struct ccan_file *mangle1 = NULL, *mangle2;
+               char *ret, *ret1, *ret2 = NULL;
+               struct ccan_file *mangle1, *mangle2 = NULL;
+               char *err;
 
-               examples_compile.total_score++;
+               score->total++;
                /* 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);
+                       char **lines = get_ccan_file_lines(i);
+                       if (!has_expected_output(lines))
+                               prev = lines;
                        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;
-               }
-
-               /* Try combining with previous (successful) example... */
                if (prev) {
                        char **new = combine(i, get_ccan_file_lines(i), prev);
 
                        mangle2 = mangle_example(m, i, new, keep);
-                       ret2 = compile(i, m, mangle1, keep);
+                       ret2 = compile(i, m, mangle2, keep);
                        if (!ret2) {
-                               prev = new;
+                               if (!has_expected_output(new))
+                                       prev = new;
                                score->score++;
                                continue;
                        }
                }
 
-               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);
+               /* Try standalone. */
+               mangle1 = mangle_example(m, i, get_ccan_file_lines(i), keep);
+               ret1 = compile(i, m, mangle1, keep);
+               if (!ret1) {
+                       char **lines = get_ccan_file_lines(i);
+                       if (!has_expected_output(lines))
+                               prev = lines;
+                       score->score++;
+                       continue;
+               }
 
-               if (mangle2) {
-                       score->errors = talloc_asprintf_append(score->errors,
+               score->pass = false;
+               score->error = "Compiling extracted examples failed";
+               if (!verbose) {
+                       if (mangle2) 
+                               err = "Standalone, adding headers, "
+                                       "and including previous "
+                                       "example all failed";
+                       else
+                               err = "Standalone compile and"
+                                       " adding headers both failed";
+               } else {
+                       err = 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(i),
+                                             ret,
+                                             get_ccan_file_contents(mangle1),
+                                             ret1);
+
+                       if (mangle2)
+                               err = talloc_asprintf_append(err, 
+                                      "Combining with previous example:\n"
                                       "%s\n"
-                                      "%s: tried combining with"
-                                      " previous example:\n"
                                       "Errors: %s\n\n",
-                                      i->name,
                                       get_ccan_file_contents(mangle2),
                                       ret2);
                }
+               score_file_error(score, i, 0, err);
                /* This didn't work, so not a candidate for combining. */
                prev = NULL;
        }
-
-       if (strcmp(score->errors, "") == 0) {
-               talloc_free(score);
-               return NULL;
-       }
-       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;
 }
 
 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_objs, NULL);