X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Ftests%2Fexamples_compile.c;h=5b0195d6ca2a526dd877f63bd8035a0798b915e6;hp=f9a919a1bfcf7d83748d026e79ec8eb2dd278601;hb=2d4243996a4ace6d4eac1da460dd5bbcb31304ce;hpb=5378c864f9c37f39d906f599285da25a7db0c9fe

diff --git a/tools/ccanlint/tests/examples_compile.c b/tools/ccanlint/tests/examples_compile.c
index f9a919a1..5b0195d6 100644
--- a/tools/ccanlint/tests/examples_compile.c
+++ b/tools/ccanlint/tests/examples_compile.c
@@ -10,98 +10,102 @@
 #include <unistd.h>
 #include <ctype.h>
 #include <assert.h>
+#include <err.h>
+#include "../compulsory_tests/build.h"
 
 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;
 }
 
-/* FIXME: We should build if it doesn't exist... */
-static bool expect_obj_file(const char *dir)
+static void add_mod(struct manifest ***deps, struct manifest *m)
 {
-	struct manifest *dep_man;
-	bool has_c_files;
-
-	dep_man = get_manifest(dir, dir);
-
-	/* If it has C files, we expect an object file built from them. */
-	has_c_files = !list_empty(&dep_man->c_files);
-	talloc_free(dep_man);
-	return has_c_files;
+	unsigned int num = talloc_get_size(*deps) / sizeof(*deps);
+	*deps = talloc_realloc(NULL, *deps, struct manifest *, num + 1);
+	(*deps)[num] = m;
 }
 
-static char *add_dep(const struct manifest *m, char *list, const char *mod)
+static bool have_mod(struct manifest *deps[], const char *basename)
 {
-	char **deps, *obj;
 	unsigned int i;
 
-	/* Not ourselves. */
-	if (streq(m->basename, mod))
-		return list;
+	for (i = 0; i < talloc_get_size(deps) / sizeof(*deps); i++)
+		if (strcmp(deps[i]->basename, basename) == 0)
+			return true;
+	return false;
+}
 
-	/* Not if there's no object file for that module */
-	if (!expect_obj_file(talloc_asprintf(list, "%s/ccan/%s", ccan_dir,mod)))
-		return list;
+static void add_dep(struct manifest ***deps, const char *basename)
+{
+	unsigned int i;
+	struct manifest *m;
+	char *errstr;
 
-	obj = talloc_asprintf(list, "%s/ccan/%s.o", ccan_dir, mod);
+	if (have_mod(*deps, basename))
+		return;
 
-	/* Not anyone we've already included. */
-	if (strstr(list, obj))
-		return list;
+	m = get_manifest(*deps, talloc_asprintf(*deps, "%s/ccan/%s",
+						ccan_dir, basename));
+	errstr = build_submodule(m);
+	if (errstr)
+		errx(1, "%s", errstr);
 
-	list = talloc_asprintf_append(list, " %s", obj);
+	add_mod(deps, m);
 
 	/* Get that modules depends as well... */
 	assert(!safe_mode);
-	deps = get_deps(m, talloc_asprintf(list, "%s/ccan/%s", ccan_dir, mod),
-			false, NULL);
+	if (m->info_file) {
+		char **infodeps;
 
-	for (i = 0; deps[i]; i++) {
-		if (strstarts(deps[i], "ccan/"))
-			list = add_dep(m, list, deps[i] + strlen("ccan/"));
+		infodeps = get_deps(m, m->dir, false, &m->info_file->compiled);
+
+		for (i = 0; infodeps[i]; i++) {
+			if (strstarts(infodeps[i], "ccan/"))
+				add_dep(deps, infodeps[i] + strlen("ccan/"));
+		}
 	}
-	return list;
 }
 
-static char *obj_list(const struct manifest *m, struct ccan_file *f)
+static char *obj_list(struct manifest *m, struct ccan_file *f)
 {
-	char *list = talloc_strdup(m, "");
-	struct ccan_file *i;
-	char **lines;
-
-	/* Object files for this module. */
-	list_for_each(&m->c_files, i, list)
-		list = talloc_asprintf_append(list, " %s", i->compiled);
+	struct manifest **deps = talloc_array(f, struct manifest *, 0);
+	char **lines, *list;
+	unsigned int i;
 
-	/* 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);
-	}
+	/* This one for a start. */
+	add_dep(&deps, m->basename);
 
 	/* 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/")) {
-			const char *mod;
-			unsigned modlen;
+			char *modname;
 
-			mod = *lines + preflen + strlen("#include <ccan/");
-			modlen = strcspn(mod, "/");
-			mod = talloc_strndup(f, mod, modlen);
-			list = add_dep(m, list, mod);
+			modname = talloc_strdup(f, *lines + preflen
+						+ strlen("#include <ccan/"));
+			modname[strcspn(modname, "/")] = '\0';
+			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)
+			list = talloc_asprintf_append(list, " %s",
+						      deps[i]->compiled);
+	}
 	return list;
 }
 
 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. */
@@ -295,6 +291,19 @@ static char **combine(const void *ctx, char **lines, char **prev)
 	return ret;
 }
 
+/* Only handles very simple comments. */
+static char *strip_comment(const void *ctx, const char *orig_line)
+{
+	char *p, *ret = talloc_strdup(ctx, orig_line);
+
+	p = strstr(ret, "/*");
+	if (!p)
+		p = strstr(ret, "//");
+	if (p)
+		*p = '\0';
+	return ret;
+}
+
 static char *mangle(struct manifest *m, char **lines)
 {
 	char *ret, *use_funcs = NULL, *why;
@@ -338,28 +347,30 @@ static char *mangle(struct manifest *m, char **lines)
 
 	/* Primitive, very primitive. */
 	for (i = 0; lines[i]; i++) {
+		char *line = strip_comment(ret, lines[i]);
+
 		/* } at start of line ends a function. */
 		if (in_function) {
-			if (lines[i][0] == '}')
+			if (line[0] == '}')
 				in_function = false;
 		} else {
 			/* Character at start of line, with ( and no ;
 			 * == function start.  Ignore comments. */
-			if (!isblank(lines[i][0])
-			    && strchr(lines[i], '(')
-			    && !strchr(lines[i], ';')
-			    && !strstr(lines[i], "//")) {
+			if (!isspace(line[0])
+			    && strchr(line, '(')
+			    && !strchr(line, ';')
+			    && !strstr(line, "//")) {
 				in_function = true;
-				if (strncmp(lines[i], "int main", 8) == 0)
+				if (strncmp(line, "int main", 8) == 0)
 					has_main = true;
-				if (strncmp(lines[i], "static", 6) == 0) {
+				if (strncmp(line, "static", 6) == 0) {
 					use_funcs = add_func(use_funcs,
-							     lines[i]);
+							     line);
 				}
 			}
 		}
 		/* ... means elided code. */
-		if (strcmp(lines[i], "...") == 0) {
+		if (strcmp(line, "...") == 0) {
 			if (!in_function && !has_main
 			    && looks_internal(lines + i + 1, &why)) {
 				/* This implies we start a function here. */
@@ -386,7 +397,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 +445,180 @@ 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 = NULL, *ret2;
-		struct ccan_file *mangle1 = NULL, *mangle2;
+		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, mangle1, 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";
+				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);
+				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\n"
-				       "%s: tried combining with"
-				       " previous example:\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);