X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=76e14a2aac0c8f9b77631dd4f296b55637dcf495;hp=d704d58d6b9fcbd0ee484badeee4b0ba969bb764;hb=13c2e75f28189c87d527c0c752de549f21cf505d;hpb=503dbd5986e381f8d56b3e7ce0ee00b839a42aa6

diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h
index d704d58d..76e14a2a 100644
--- a/tools/ccanlint/ccanlint.h
+++ b/tools/ccanlint/ccanlint.h
@@ -4,7 +4,25 @@
 #include <stdbool.h>
 #include "../doc_extract.h"
 
+#define REGISTER_TEST(name, ...) extern struct ccanlint name
+#include "generated-compulsory-tests"
+#include "generated-normal-tests"
+#undef REGISTER_TEST
+
+#define REGISTER_TEST(name, ...) 
+
+/* 0 == Describe failed tests.
+   1 == Describe results for partial failures.
+   2 == One line per test, plus details of failures.
+
+   Mainly for debugging ccanlint:
+   3 == Describe every object built.
+   4 == Describe every action. */
+extern int verbose;
+
 struct manifest {
+	char *dir;
+	/* The module name, ie. final element of dir name */
 	char *basename;
 	struct ccan_file *info_file;
 
@@ -15,35 +33,66 @@ struct manifest {
 	struct list_head api_tests;
 	struct list_head compile_ok_tests;
 	struct list_head compile_fail_tests;
+	struct list_head other_test_c_files;
 	struct list_head other_test_files;
 
 	struct list_head other_files;
+	struct list_head examples;
+	struct list_head mangled_examples;
+
+	/* From tests/check_depends_exist.c */
+	struct list_head dep_dirs;
 };
 
-struct manifest *get_manifest(void);
+struct manifest *get_manifest(const void *ctx, const char *dir);
 
-struct ccanlint {
+struct file_error {
 	struct list_node list;
+	struct ccan_file *file;
+	unsigned int line; /* 0 not to print */
+	const char *error;
+};
 
-	/* Unique name of test */
-	const char *name;
+struct score {
+	bool pass;
+	unsigned int score, total;
+	const char *error;
+	struct list_head per_file_errors;
+};
 
-	/* Total score that this test is worth.  0 means compulsory tests. */
-	unsigned int total_score;
+struct ccanlint {
+	struct list_node list;
 
-	/* If this returns non-NULL, it means the check failed. */
-	void *(*check)(struct manifest *m);
+	/* More concise unique name of test. */
+	const char *key;
 
-	/* The non-NULL return from check is passed to one of these: */
+	/* Unique name of test */
+	const char *name;
 
-	/* So, what did this get out of the total_score?  (NULL means 0). */
-	unsigned int (*score)(struct manifest *m, void *check_result);
+	/* Can we run this test?  Return string explaining why, if not. */
+	const char *(*can_run)(struct manifest *m);
 
-	/* Verbose description of what was wrong. */
-	const char *(*describe)(struct manifest *m, void *check_result);
+	/* keep is set if you should keep the results.
+	 * If timeleft is set to 0, means it timed out.
+	 * score is the result, and a talloc context freed after all our
+	 * depends are done. */
+	void (*check)(struct manifest *m,
+		      bool keep, unsigned int *timeleft, struct score *score);
 
 	/* Can we do something about it? (NULL if not) */
-	void (*handle)(struct manifest *m, void *check_result);
+	void (*handle)(struct manifest *m, struct score *score);
+
+	/* Internal use fields: */
+	/* Who depends on us? */
+	struct list_head dependencies;
+	/* How many things do we (still) depend on? */
+	unsigned int num_depends;
+	/* Did we skip a dependency?  If so, must skip this, too. */
+	const char *skip;
+	/* Did we fail a dependency?  If so, skip and mark as fail. */
+	bool skip_fail;
+	/* Did the user want to keep these results? */
+	bool keep_results;
 };
 
 /* Ask the user a yes/no question: the answer is NO if there's an error. */
@@ -86,10 +135,14 @@ struct line_info {
 struct ccan_file {
 	struct list_node list;
 
+	/* Name (usually, within m->dir). */
 	char *name;
 
+	/* Full path name. */
+	char *fullname;
+
 	/* Pristine version of the original file.
-	 * Use get_ccan_file_lines to fill this. */
+	 * Use get_ccan_file_contents to fill this. */
 	const char *contents;
 	size_t contents_size;
 
@@ -99,8 +152,20 @@ struct ccan_file {
 	struct line_info *line_info;
 
 	struct list_head *doc_sections;
+
+	/* If this file gets compiled (eg. .C file to .o file), result here. */
+	char *compiled;
+
+	/* Compiled with coverage information. */
+	char *cov_compiled;
 };
 
+/* A new ccan_file, with the given name (talloc_steal onto returned value). */
+struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
+
+/* Use this rather than accessing f->contents directly: loads on demand. */
+const char *get_ccan_file_contents(struct ccan_file *f);
+
 /* Use this rather than accessing f->lines directly: loads on demand. */
 char **get_ccan_file_lines(struct ccan_file *f);
 
@@ -128,16 +193,23 @@ char *get_symbol_token(void *ctx, const char **line);
 struct list_head *get_ccan_file_docs(struct ccan_file *f);
 
 
-/* Call the reporting on every line in the file.  sofar contains
- * previous results. */
-char *report_on_lines(struct list_head *files,
-		      char *(*report)(const char *),
-		      char *sofar);
-
-/* The critical tests which mean fail if they don't pass. */
-extern struct ccanlint no_info;
-extern struct ccanlint has_main_header;
+/* Add an error about this file (and line, if non-zero) to the score struct */
+void score_file_error(struct score *, struct ccan_file *f, unsigned line,
+		      const char *error);
 
 /* Normal tests. */
 extern struct ccanlint trailing_whitespace;
+
+/* Dependencies */
+struct dependent {
+	struct list_node node;
+	struct ccanlint *dependent;
+};
+
+/* Are we happy to compile stuff, or just non-intrusive tests? */
+extern bool safe_mode;
+
+/* Where is the ccan dir?  Available after first manifest. */
+extern const char *ccan_dir;
+
 #endif /* CCAN_LINT_H */