X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=aec75ad97e524a3b42c19ac55244908903a2181f;hp=33db1257eb126bbf9f59299175af05f13c5edaf6;hb=2bce880a453a64d2d1dfc2e48184553ff4f2550b;hpb=caf366998b97b7cc29bc1f33c285feb2f5d33bff

diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h
index 33db1257..aec75ad9 100644
--- a/tools/ccanlint/ccanlint.h
+++ b/tools/ccanlint/ccanlint.h
@@ -1,8 +1,10 @@
 #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
 
@@ -42,20 +44,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;
 };
 
+/* 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;
 };
 
@@ -86,7 +99,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: */
@@ -168,6 +181,9 @@ struct ccan_file {
 
 	/* 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). */
@@ -182,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,