ccanlint: Add -k option to keep results.
[ccan] / tools / ccanlint / ccanlint.h
index d832332dc757197280b6ac3c4eb79427781a0b75..ad38302861046cdab7475cbef03f22365b51db0f 100644 (file)
@@ -5,12 +5,14 @@
 #include "../doc_extract.h"
 
 #define REGISTER_TEST(name, ...) extern struct ccanlint name
-#include "generated-init-tests"
+#include "generated-compulsory-tests"
+#include "generated-normal-tests"
 #undef REGISTER_TEST
 
 #define REGISTER_TEST(name, ...) 
 
 struct manifest {
+       char *dir;
        /* The module name, ie. final element of dir name */
        char *basename;
        struct ccan_file *info_file;
@@ -22,32 +24,36 @@ 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;
 
        /* From tests/check_depends_exist.c */
        struct list_head dep_dirs;
-       /* From tests/check_depends_built.c */
-       struct list_head dep_objs;
 };
 
-struct manifest *get_manifest(const void *ctx);
+struct manifest *get_manifest(const void *ctx, const char *dir);
 
 struct ccanlint {
        struct list_node list;
 
+       /* More concise unique name of test. */
+       const char *key;
+
        /* Unique name of test */
        const char *name;
 
-       /* Total score that this test is worth.  0 means compulsory tests. */
+       /* Total score that this test is worth. */
        unsigned int total_score;
 
        /* Can we run this test?  Return string explaining why, if not. */
        const char *(*can_run)(struct manifest *m);
 
-       /* If this returns non-NULL, it means the check failed. */
-       void *(*check)(struct manifest *m);
+       /* If this returns non-NULL, it means the check failed.
+        * keep is set if you should keep the results.
+        * If timeleft is set to 0, means it timed out. */
+       void *(*check)(struct manifest *m, bool keep, unsigned int *timeleft);
 
        /* The non-NULL return from check is passed to one of these: */
 
@@ -69,6 +75,8 @@ struct ccanlint {
        bool 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. */
@@ -111,8 +119,12 @@ 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. */
        const char *contents;
@@ -124,10 +136,13 @@ 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;
 };
 
 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
-struct ccan_file *new_ccan_file(const void *ctx, char *name);
+struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
 
 /* Use this rather than accessing f->lines directly: loads on demand. */
 char **get_ccan_file_lines(struct ccan_file *f);
@@ -174,4 +189,7 @@ struct 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 */