tools: trim leading whitespace in documentation extract.

[ccan] / tools / ccanlint / ccanlint.h

diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h
index 0bfb6a62cff5d88d99489b13b432c026beb8513e..23b6492dff68759576fd593f0a74b3e4850cbf32 100644 (file)
--- a/tools/ccanlint/ccanlint.h
+++ b/tools/ccanlint/ccanlint.h
@@ -1,19 +1,19 @@
 #ifndef CCAN_LINT_H
 #define CCAN_LINT_H
+#include "config.h"
 #include <ccan/list/list.h>
 #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.
 
-/* 1 == Describe results for partial failures.
-   2 == Describe gory details.
-   3 == Describe every action. */
+   Mainly for debugging ccanlint:
+   3 == Describe every object built.
+   4 == Describe every action. */
 extern int verbose;
 
 struct manifest {
@@ -22,6 +22,11 @@ struct manifest {
        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;
 
@@ -34,13 +39,35 @@ struct manifest {
 
        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 list_head deps;
 };
 
+/* Get the manifest for a given directory. */
 struct manifest *get_manifest(const void *ctx, const char *dir);
 
+/* Error in a particular file: stored off score->per_file_errors. */
+struct file_error {
+       struct list_node list;
+       struct ccan_file *file;
+       unsigned int line;
+};
+
+/* The score for an individual test. */
+struct score {
+       /* Starts as false: if not set to true, ccanlint exits non-zero.
+        * Thus it is usually set for compilation or other serious failures. */
+       bool pass;
+       /* Starts at 0 and 1 respectively. */
+       unsigned int score, total;
+       /* The error message to print. */
+       char *error;
+       /* Per file errors, set by score_file_error() */
+       struct list_head per_file_errors;
+};
+
 struct ccanlint {
        struct list_node list;
 
@@ -50,27 +77,26 @@ struct ccanlint {
        /* 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.
-        * 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: */
+       /* 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);
 
-       /* So, what did this get out of the total_score?  (NULL means 0). */
-       unsigned int (*score)(struct manifest *m, void *check_result);
+       /* Can we do something about it? (NULL if not) */
+       void (*handle)(struct manifest *m, struct score *score);
 
-       /* Verbose description of what was wrong. */
-       const char *(*describe)(struct manifest *m, void *check_result);
+       /* Options from _info. */
+       char *options;
+       /* If not set, we'll give an error if they try to set options. */
+       bool takes_options;
 
-       /* Can we do something about it? (NULL if not) */
-       void (*handle)(struct manifest *m, void *check_result);
+       /* Space-separated list of dependency keys. */
+       const char *needs;
 
        /* Internal use fields: */
        /* Who depends on us? */
@@ -78,7 +104,7 @@ 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? */
@@ -148,6 +174,9 @@ struct ccan_file {
 
        /* Compiled with coverage information. */
        char *cov_compiled;
+
+       /* Leak output from valgrind. */
+       char *leak_info;
 };
 
 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
@@ -182,12 +211,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);
+/* Append message about this file (and line, if non-zero) to the score->error */
+void score_file_error(struct score *, struct ccan_file *f, unsigned line,
+                     const char *errorfmt, ...);
 
 /* Normal tests. */
 extern struct ccanlint trailing_whitespace;
@@ -204,4 +230,10 @@ extern bool safe_mode;
 /* Where is the ccan dir?  Available after first manifest. */
 extern const char *ccan_dir;
 
+/* Compiler and CFLAGS, from config.h if available. */
+extern const char *compiler, *cflags;
+
+/* Contents of config.h (or NULL if not found) */
+extern const char *config_header;
+
 #endif /* CCAN_LINT_H */