X-Git-Url: https://git.ozlabs.org/?a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=16a410a98aecb3b3fa864d865515854f0e7ec572;hb=914fa0bf6ec0bbe165ddf917e73a1e207743ba1d;hp=51f555ecfb059a437a598108b367e1963c13e10b;hpb=650c775ff00cccd03fc84e7789a03c51d9839004;p=ccan

diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h
index 51f555ec..16a410a9 100644
--- a/tools/ccanlint/ccanlint.h
+++ b/tools/ccanlint/ccanlint.h
@@ -1,7 +1,8 @@
 #ifndef CCAN_LINT_H
 #define CCAN_LINT_H
-#include <list/list.h>
+#include <ccan/list/list.h>
 #include <stdbool.h>
+#include "../doc_extract.h"
 
 struct manifest {
 	char *basename;
@@ -11,6 +12,7 @@ struct manifest {
 	struct list_head h_files;
 
 	struct list_head run_tests;
+	struct list_head api_tests;
 	struct list_head compile_ok_tests;
 	struct list_head compile_fail_tests;
 	struct list_head other_test_files;
@@ -47,18 +49,80 @@ struct ccanlint {
 /* Ask the user a yes/no question: the answer is NO if there's an error. */
 bool ask(const char *question);
 
+enum line_info_type {
+	PREPROC_LINE, /* Line starts with # */
+	CODE_LINE, /* Code (ie. not pure comment). */
+	DOC_LINE, /* Line with kernel-doc-style comment. */
+	COMMENT_LINE, /* (pure) comment line */
+};
+
+/* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
+ * and #if <SYMBOL>/#if !<SYMBOL> */
+struct pp_conditions {
+	/* We're inside another ifdef? */
+	struct pp_conditions *parent;
+
+	enum {
+		PP_COND_IF,
+		PP_COND_IFDEF,
+		PP_COND_UNKNOWN,
+	} type;
+
+	bool inverse;
+	const char *symbol;
+};
+
+/* Preprocessor information about each line. */
+struct line_info {
+	enum line_info_type type;
+
+	/* Is this actually a continuation of line above? (which ends in \) */
+	bool continued;
+
+	/* Conditions for this line to be compiled. */
+	struct pp_conditions *cond;
+};
+
 struct ccan_file {
 	struct list_node list;
 
 	char *name;
 
+	/* Use get_ccan_file_lines / get_ccan_line_info to fill these. */
 	unsigned int num_lines;
 	char **lines;
+	struct line_info *line_info;
+
+	struct list_head *doc_sections;
 };
 
 /* Use this rather than accessing f->lines directly: loads on demand. */
 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);
+
+enum line_compiled {
+	NOT_COMPILED,
+	COMPILED,
+	MAYBE_COMPILED,
+};
+
+/* Simple evaluator.  If symbols are set this way, is this condition true?
+ * NULL values mean undefined, NULL symbol terminates. */
+enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
+				    const char *symbol,
+				    const unsigned int *value, ...);
+
+/* Get token if it's equal to token. */
+bool get_token(const char **line, const char *token);
+/* Talloc copy of symbol token, or NULL.  Increment line. */
+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,
@@ -71,6 +135,4 @@ extern struct ccanlint has_main_header;
 
 /* Normal tests. */
 extern struct ccanlint trailing_whitespace;
-
-
 #endif /* CCAN_LINT_H */