]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.h
ccanlint: fix error with --target=build
[ccan] / tools / ccanlint / ccanlint.h
index e019c139d1a1f59deee3bc36000029cc98f5e2d8..458bed54e6acae9ec4b653c3f2c22ad67efcb8d0 100644 (file)
 
 #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;
 
+       /* Linked off deps. */
+       struct list_node list;
+       /* Where our final compiled output is */
+       char *compiled;
+
        struct list_head c_files;
        struct list_head h_files;
 
@@ -27,40 +42,55 @@ struct manifest {
        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;
-       /* From tests/check_depends_built.c */
-       struct list_head dep_objs;
+       struct list_head deps;
 };
 
-struct manifest *get_manifest(const void *ctx);
+struct manifest *get_manifest(const void *ctx, const char *dir);
+
+struct file_error {
+       struct list_node list;
+       struct ccan_file *file;
+       unsigned int line; /* 0 not to print */
+       const char *error;
+};
+
+struct score {
+       bool pass;
+       unsigned int score, total;
+       const char *error;
+       struct list_head per_file_errors;
+};
 
 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. */
-       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);
-
-       /* The non-NULL return from check is passed to one of these: */
-
-       /* So, what did this get out of the total_score?  (NULL means 0). */
-       unsigned int (*score)(struct manifest *m, void *check_result);
-
-       /* 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);
+
+       /* Options from _info. */
+       char *options;
+       /* If not set, we'll give an error if they try to set options. */
+       bool takes_options;
 
        /* Internal use fields: */
        /* Who depends on us? */
@@ -68,9 +98,11 @@ struct ccanlint {
        /* 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;
+       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. */
@@ -113,10 +145,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;
 
@@ -129,10 +165,16 @@ struct ccan_file {
 
        /* 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, char *name);
+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);
@@ -160,12 +202,9 @@ char *get_symbol_token(void *ctx, const char **line);
 /* Similarly for ->doc_sections */
 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);
+/* 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;
@@ -179,4 +218,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 */