X-Git-Url: https://git.ozlabs.org/?a=blobdiff_plain;f=tools%2Fccanlint%2Ftests%2Fexamples_compile.c;h=1b2360ed52e3820e13f65e24ece05e22a3dfff67;hb=03a596908b779bbb4b7c2f739c5e238f8c5d6390;hp=4f2d2c8a99189b058e7610b101cbcd264dca186c;hpb=afcb4f4dd0d88c699d816883d62c8cff5f37ca0d;p=ccan diff --git a/tools/ccanlint/tests/examples_compile.c b/tools/ccanlint/tests/examples_compile.c index 4f2d2c8a..1b2360ed 100644 --- a/tools/ccanlint/tests/examples_compile.c +++ b/tools/ccanlint/tests/examples_compile.c @@ -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,34 +119,30 @@ 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) +static char *start_main(char *ret, const char *why) { return talloc_asprintf_append(ret, - "/* Fake function wrapper inserted */\n" - "int main(int argc, char *argv[])\n" - "{\n"); + "/* The example %s, so fake function wrapper inserted */\n" + "int main(int argc, char *argv[])\n" + "{\n", why); } /* We only handle simple function definitions here. */ 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; @@ -177,7 +175,7 @@ static void strip_leading_whitespace(char **lines) lines[i] += min_span; } -static bool looks_internal(char **lines) +static bool looks_internal(char **lines, char **why) { unsigned int i; bool last_ended = true; /* Did last line finish a statement? */ @@ -187,34 +185,50 @@ static bool looks_internal(char **lines) 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. */ - if (strstarts(line, "if") && len == 2) + if (strstarts(line, "if") && len == 2) { + *why = "starts with if"; return true; - if (strstarts(line, "for") && len == 3) + } + if (strstarts(line, "for") && len == 3) { + *why = "starts with for"; return true; - if (strstarts(line, "while") && len == 5) + } + if (strstarts(line, "while") && len == 5) { + *why = "starts with while"; return true; - if (strstarts(line, "do") && len == 2) + } + if (strstarts(line, "do") && len == 2) { + *why = "starts with do"; return true; + } /* The losers. */ - if (strstarts(line, "#include")) + if (strstarts(line, "#include")) { + *why = "starts with #include"; return false; + } if (last_ended && strchr(line, '(')) { - if (strstarts(line, "static")) + if (strstarts(line, "static")) { + *why = "starts with static and contains ("; return false; - if (strends(line, ")")) + } + if (strends(line, ")")) { + *why = "contains ( and ends with )"; return false; + } } /* Single identifier then operator == inside function. */ if (last_ended && len - && ispunct(line[len+strspn(line+len, " ")])) + && ispunct(line[len+strspn(line+len, " ")])) { + *why = "starts with identifier then punctuation"; return true; + } last_ended = (strends(line, "}") || strends(line, ";") @@ -222,6 +236,7 @@ static bool looks_internal(char **lines) } /* No idea... Say yes? */ + *why = "gave no clues"; return true; } @@ -230,24 +245,35 @@ static char **combine(const void *ctx, char **lines, char **prev) { unsigned int i, lines_total, prev_total, count; char **ret; + const char *reasoning; + char *why = NULL; if (!prev) return NULL; /* If it looks internal, put prev at start. */ - if (looks_internal(lines)) { + if (looks_internal(lines, &why)) { count = 0; + reasoning = "seemed to belong inside a function"; } else { /* Try inserting in first elided position */ for (count = 0; lines[count]; count++) { if (strcmp(lines[count], "...") == 0) break; } - if (!lines[count]) + if (!lines[count]) { /* Try at start anyway? */ count = 0; - else + reasoning = "didn't seem to belong inside" + " a function, so we prepended the previous" + " example"; + } else { + reasoning = "didn't seem to belong inside" + " a function, so we put the previous example" + " at the first ..."; + count++; + } } for (i = 0; lines[i]; i++); @@ -256,17 +282,19 @@ static char **combine(const void *ctx, char **lines, char **prev) for (i = 0; prev[i]; i++); prev_total = i; - ret = talloc_array(ctx, char *, lines_total + prev_total + 1); - memcpy(ret, lines, count * sizeof(ret[0])); - memcpy(ret + count, prev, prev_total * sizeof(ret[0])); - memcpy(ret + count + prev_total, lines + count, + ret = talloc_array(ctx, char *, 1 +lines_total + prev_total + 1); + ret[0] = talloc_asprintf(ret, "/* The example %s, thus %s */\n", + why, reasoning); + memcpy(ret+1, lines, count * sizeof(ret[0])); + memcpy(ret+1 + count, prev, prev_total * sizeof(ret[0])); + memcpy(ret+1 + count + prev_total, lines + count, (lines_total - count + 1) * sizeof(ret[0])); return ret; } static char *mangle(struct manifest *m, char **lines) { - char *ret, *use_funcs = NULL; + char *ret, *use_funcs = NULL, *why; bool in_function = false, fake_function = false, has_main = false; unsigned int i; @@ -294,13 +322,16 @@ static char *mangle(struct manifest *m, char **lines) "extern char somestring[];\n" "char somestring[] = \"hello world\";\n"); - if (looks_internal(lines)) { + if (looks_internal(lines, &why)) { /* Wrap it all in main(). */ - ret = start_main(ret); + ret = start_main(ret, why); fake_function = true; in_function = true; has_main = true; - } + } else + ret = talloc_asprintf_append(ret, + "/* The example %s, so didn't wrap in main() */\n", + why); /* Primitive, very primitive. */ for (i = 0; lines[i]; i++) { @@ -311,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], "//")) { @@ -327,9 +358,9 @@ static char *mangle(struct manifest *m, char **lines) /* ... means elided code. */ if (strcmp(lines[i], "...") == 0) { if (!in_function && !has_main - && looks_internal(lines + i + 1)) { + && looks_internal(lines + i + 1, &why)) { /* This implies we start a function here. */ - ret = start_main(ret); + ret = start_main(ret, why); has_main = true; fake_function = true; in_function = true; @@ -341,14 +372,18 @@ static char *mangle(struct manifest *m, char **lines) ret = talloc_asprintf_append(ret, "%s\n", lines[i]); } - /* Need a main to link successfully. */ if (!has_main) { - ret = talloc_asprintf_append(ret, "int main(void)\n{\n"); + ret = talloc_asprintf_append(ret, + "/* Need a main to link successfully. */\n" + "int main(void)\n{\n"); fake_function = true; } - /* Get rid of unused warnings by printing addresses of static funcs. */ if (use_funcs) { + ret = talloc_asprintf_append(ret, + "/* Get rid of unused warnings" + " by printing addresses of" + " static funcs. */"); if (!fake_function) { ret = talloc_asprintf_append(ret, "int use_funcs(void);\n" @@ -392,92 +427,119 @@ static struct ccan_file *mangle_example(struct manifest *m, } close(fd); f->contents = talloc_steal(f, contents); + list_add(&m->mangled_examples, &f->list); 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); - struct ccan_file *mangle; char **prev = NULL; - score->score = 0; - score->errors = NULL; + score->total = 0; + score->pass = true; list_for_each(&m->examples, i, list) { - char *ret; + 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(score, m, i, keep); + 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 combining with previous (successful) example... */ if (prev) { char **new = combine(i, get_ccan_file_lines(i), prev); - talloc_free(ret); - mangle = mangle_example(m, i, new, keep); - ret = compile(score, m, mangle, keep); - if (!ret) { - prev = new; + mangle2 = mangle_example(m, i, new, keep); + ret2 = compile(i, m, mangle2, keep); + if (!ret2) { + if (!has_expected_output(new)) + prev = new; score->score++; continue; } } /* Try standalone. */ - talloc_free(ret); - mangle = mangle_example(m, i, get_ccan_file_lines(i), keep); - ret = compile(score, m, mangle, keep); - if (!ret) { - prev = get_ccan_file_lines(i); + 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 (!score->errors) - score->errors = ret; - else { - score->errors = talloc_append_string(score->errors, - ret); - talloc_free(ret); + 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" + "Errors: %s\n\n", + 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; } - 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, .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);