ccanlint: add simple check for comment referring to LICENSE file.

[ccan] / tools / ccanlint / ccanlint.h

diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h
index 0e57140018ffee1693bbf3f1010dd622316e1335..aec75ad97e524a3b42c19ac55244908903a2181f 100644 (file)
--- a/tools/ccanlint/ccanlint.h
+++ b/tools/ccanlint/ccanlint.h
@@ -1,19 +1,20 @@
 #ifndef CCAN_LINT_H
 #define CCAN_LINT_H
+#include "config.h"
 #include <ccan/list/list.h>
 #include <stdbool.h>
 #include "../doc_extract.h"
+#include "licenses.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 +23,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;
 
@@ -37,22 +43,32 @@ struct manifest {
        struct list_head mangled_examples;
 
        /* From tests/check_depends_exist.c */
-       struct list_head dep_dirs;
+       struct list_head deps;
+
+       /* From tests/license_exists.c */
+       enum license license;
 };
 
+/* 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; /* 0 not to print */
-       const char *error;
+       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;
-       const char *error;
+       /* The error message to print. */
+       char *error;
+       /* Per file errors, set by score_file_error() */
        struct list_head per_file_errors;
 };
 
@@ -78,6 +94,14 @@ struct ccanlint {
        /* Can we do something about it? (NULL if not) */
        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;
+
+       /* Space-separated list of dependency keys. */
+       const char *needs;
+
        /* Internal use fields: */
        /* Who depends on us? */
        struct list_head dependencies;
@@ -154,6 +178,12 @@ struct ccan_file {
 
        /* Compiled with coverage information. */
        char *cov_compiled;
+
+       /* Leak output from valgrind. */
+       char *leak_info;
+
+       /* Simplified stream (lowercase letters and single spaces) */
+       char *simplified;
 };
 
 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
@@ -168,6 +198,9 @@ char **get_ccan_file_lines(struct ccan_file *f);
 /* Use this rather than accessing f->lines directly: loads on demand. */
 struct line_info *get_ccan_line_info(struct ccan_file *f);
 
+/* Use this rather than accessing f->simplified directly: loads on demand. */
+const char *get_ccan_simplified(struct ccan_file *f);
+
 enum line_compiled {
        NOT_COMPILED,
        COMPILED,
@@ -188,10 +221,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);
 
-
-/* Add an error about this file (and line, if non-zero) to the score struct */
+/* 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 *error);
+                     const char *errorfmt, ...);
 
 /* Normal tests. */
 extern struct ccanlint trailing_whitespace;
@@ -208,4 +240,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 */