X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=9a4817092acecc6c08e67bffac7c43158bd3c1da;hp=33db1257eb126bbf9f59299175af05f13c5edaf6;hb=8af0812be4b3fcb82d82b70ea1b571225a76ca19;hpb=104125b2dd0a044fb3d68f9bc3b1b18c9f32ae2b

diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h
index 33db1257..9a481709 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
 
@@ -15,6 +17,13 @@
    4 == Describe every action. */
 extern int verbose;
 
+enum compile_type {
+	COMPILE_NORMAL,
+	COMPILE_NOFEAT,
+	COMPILE_COVERAGE,
+	COMPILE_TYPES
+};
+
 struct manifest {
 	char *dir;
 	/* The module name, ie. final element of dir name */
@@ -24,7 +33,7 @@ struct manifest {
 	/* Linked off deps. */
 	struct list_node list;
 	/* Where our final compiled output is */
-	char *compiled;
+	char *compiled[COMPILE_TYPES];
 
 	struct list_head c_files;
 	struct list_head h_files;
@@ -42,20 +51,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;
 };
 
@@ -82,11 +102,11 @@ struct ccanlint {
 	void (*handle)(struct manifest *m, struct score *score);
 
 	/* Options from _info. */
-	char *options;
+	char **options;
 	/* 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: */
@@ -161,13 +181,16 @@ struct ccan_file {
 	struct list_head *doc_sections;
 
 	/* If this file gets compiled (eg. .C file to .o file), result here. */
-	char *compiled;
+	char *compiled[COMPILE_TYPES];
 
-	/* Compiled with coverage information. */
-	char *cov_compiled;
+	/* Filename containing output from valgrind. */
+	char *valgrind_log;
 
 	/* 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 +205,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,
@@ -202,6 +228,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);
 
+/* Get NULL-terminated array options for this file for this test */
+char **per_file_options(const struct ccanlint *test, struct ccan_file *f);
+
 /* 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, ...);
@@ -215,6 +244,9 @@ struct dependent {
 	struct ccanlint *dependent;
 };
 
+/* Is this test excluded (cmdline or _info). */
+bool is_excluded(const char *name);
+
 /* Are we happy to compile stuff, or just non-intrusive tests? */
 extern bool safe_mode;