]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.h
alloc: fix missing header in compilation of example.
[ccan] / tools / ccanlint / ccanlint.h
index d704d58d6b9fcbd0ee484badeee4b0ba969bb764..0bfb6a62cff5d88d99489b13b432c026beb8513e 100644 (file)
@@ -4,7 +4,21 @@
 #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, ...) 
+
+/* 1 == Describe results for partial failures.
+   2 == Describe gory details.
+   3 == 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,24 +29,37 @@ 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;
+
+       /* 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 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;
 
-       /* If this returns non-NULL, it means the check failed. */
-       void *(*check)(struct manifest *m);
+       /* 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.
+        * 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: */
 
@@ -44,6 +71,18 @@ struct ccanlint {
 
        /* Can we do something about it? (NULL if not) */
        void (*handle)(struct manifest *m, void *check_result);
+
+       /* 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. */
+       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. */
@@ -86,10 +125,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 +142,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);
 
@@ -134,10 +189,19 @@ 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;
-
 /* 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 */