X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=b9965f75a5852364ef923ee98ca3b2e792745ceb;hp=19d53dbf12e4f5fb7bcd340e65087d10a452ebfb;hb=8de1e8a6faef77773cbf8ed237eb4e330143d2f2;hpb=016a19d260cd7f4afeb5b2b2cc28c8bbed1cd170;ds=sidebyside

diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h
index 19d53dbf..b9965f75 100644
--- a/tools/ccanlint/ccanlint.h
+++ b/tools/ccanlint/ccanlint.h
@@ -1,10 +1,11 @@
 #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, ...) 
+#define REGISTER_TEST(name, ...) extern struct ccanlint name
 
 /* 0 == Describe failed tests.
    1 == Describe results for partial failures.
@@ -15,6 +16,21 @@
    4 == Describe every action. */
 extern int verbose;
 
+enum license {
+	LICENSE_LGPLv2_PLUS,
+	LICENSE_LGPLv2,
+	LICENSE_LGPLv3,
+	LICENSE_LGPL,
+	LICENSE_GPLv2_PLUS,
+	LICENSE_GPLv2,
+	LICENSE_GPLv3,
+	LICENSE_GPL,
+	LICENSE_BSD,
+	LICENSE_MIT,
+	LICENSE_PUBLIC_DOMAIN,
+	LICENSE_UNKNOWN
+};
+
 struct manifest {
 	char *dir;
 	/* The module name, ie. final element of dir name */
@@ -42,21 +58,31 @@ struct manifest {
 
 	/* From tests/check_depends_exist.c */
 	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;
 };
 
@@ -87,7 +113,7 @@ struct ccanlint {
 	/* If not set, we'll give an error if they try to set options. */
 	bool takes_options;
 
-	/* comma-separated list of dependency keys. */
+	/* Space-separated list of dependency keys. */
 	const char *needs;
 
 	/* Internal use fields: */
@@ -203,9 +229,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;
@@ -222,4 +248,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 */