3 #include <ccan/list/list.h>
5 #include "../doc_extract.h"
7 #define REGISTER_TEST(name, ...) extern struct ccanlint name
8 #include "generated-compulsory-tests"
9 #include "generated-normal-tests"
12 #define REGISTER_TEST(name, ...)
14 /* 0 == Describe failed tests.
15 1 == Describe results for partial failures.
16 2 == One line per test, plus details of failures.
18 Mainly for debugging ccanlint:
19 3 == Describe every object built.
20 4 == Describe every action. */
25 /* The module name, ie. final element of dir name */
27 struct ccan_file *info_file;
29 struct list_head c_files;
30 struct list_head h_files;
32 struct list_head run_tests;
33 struct list_head api_tests;
34 struct list_head compile_ok_tests;
35 struct list_head compile_fail_tests;
36 struct list_head other_test_c_files;
37 struct list_head other_test_files;
39 struct list_head other_files;
40 struct list_head examples;
41 struct list_head mangled_examples;
43 /* From tests/check_depends_exist.c */
44 struct list_head dep_dirs;
47 struct manifest *get_manifest(const void *ctx, const char *dir);
50 struct list_node list;
51 struct ccan_file *file;
52 unsigned int line; /* 0 not to print */
58 unsigned int score, total;
60 struct list_head per_file_errors;
64 struct list_node list;
66 /* More concise unique name of test. */
69 /* Unique name of test */
72 /* Can we run this test? Return string explaining why, if not. */
73 const char *(*can_run)(struct manifest *m);
75 /* keep is set if you should keep the results.
76 * If timeleft is set to 0, means it timed out.
77 * score is the result, and a talloc context freed after all our
78 * depends are done. */
79 void (*check)(struct manifest *m,
80 bool keep, unsigned int *timeleft, struct score *score);
82 /* Can we do something about it? (NULL if not) */
83 void (*handle)(struct manifest *m, struct score *score);
85 /* Options from _info. */
87 /* If not set, we'll give an error if they try to set options. */
90 /* Internal use fields: */
91 /* Who depends on us? */
92 struct list_head dependencies;
93 /* How many things do we (still) depend on? */
94 unsigned int num_depends;
95 /* Did we skip a dependency? If so, must skip this, too. */
97 /* Did we fail a dependency? If so, skip and mark as fail. */
99 /* Did the user want to keep these results? */
103 /* Ask the user a yes/no question: the answer is NO if there's an error. */
104 bool ask(const char *question);
106 enum line_info_type {
107 PREPROC_LINE, /* Line starts with # */
108 CODE_LINE, /* Code (ie. not pure comment). */
109 DOC_LINE, /* Line with kernel-doc-style comment. */
110 COMMENT_LINE, /* (pure) comment line */
113 /* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
114 * and #if <SYMBOL>/#if !<SYMBOL> */
115 struct pp_conditions {
116 /* We're inside another ifdef? */
117 struct pp_conditions *parent;
129 /* Preprocessor information about each line. */
131 enum line_info_type type;
133 /* Is this actually a continuation of line above? (which ends in \) */
136 /* Conditions for this line to be compiled. */
137 struct pp_conditions *cond;
141 struct list_node list;
143 /* Name (usually, within m->dir). */
146 /* Full path name. */
149 /* Pristine version of the original file.
150 * Use get_ccan_file_contents to fill this. */
151 const char *contents;
152 size_t contents_size;
154 /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */
155 unsigned int num_lines;
157 struct line_info *line_info;
159 struct list_head *doc_sections;
161 /* If this file gets compiled (eg. .C file to .o file), result here. */
164 /* Compiled with coverage information. */
168 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
169 struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
171 /* Use this rather than accessing f->contents directly: loads on demand. */
172 const char *get_ccan_file_contents(struct ccan_file *f);
174 /* Use this rather than accessing f->lines directly: loads on demand. */
175 char **get_ccan_file_lines(struct ccan_file *f);
177 /* Use this rather than accessing f->lines directly: loads on demand. */
178 struct line_info *get_ccan_line_info(struct ccan_file *f);
186 /* Simple evaluator. If symbols are set this way, is this condition true?
187 * NULL values mean undefined, NULL symbol terminates. */
188 enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
190 const unsigned int *value, ...);
192 /* Get token if it's equal to token. */
193 bool get_token(const char **line, const char *token);
194 /* Talloc copy of symbol token, or NULL. Increment line. */
195 char *get_symbol_token(void *ctx, const char **line);
197 /* Similarly for ->doc_sections */
198 struct list_head *get_ccan_file_docs(struct ccan_file *f);
200 /* Add an error about this file (and line, if non-zero) to the score struct */
201 void score_file_error(struct score *, struct ccan_file *f, unsigned line,
205 extern struct ccanlint trailing_whitespace;
209 struct list_node node;
210 struct ccanlint *dependent;
213 /* Are we happy to compile stuff, or just non-intrusive tests? */
214 extern bool safe_mode;
216 /* Where is the ccan dir? Available after first manifest. */
217 extern const char *ccan_dir;
219 #endif /* CCAN_LINT_H */