4 #include <ccan/list/list.h>
6 #include "../doc_extract.h"
9 #define REGISTER_TEST(name, ...) extern struct ccanlint name
11 /* 0 == Describe failed tests.
12 1 == Describe results for partial failures.
13 2 == One line per test, plus details of failures.
15 Mainly for debugging ccanlint:
16 3 == Describe every object built.
17 4 == Describe every action. */
29 /* The module name, ie. final element of dir name */
31 struct ccan_file *info_file;
33 /* Linked off deps. */
34 struct list_node list;
35 /* Where our final compiled output is */
36 char *compiled[COMPILE_TYPES];
38 struct list_head c_files;
39 struct list_head h_files;
41 struct list_head run_tests;
42 struct list_head api_tests;
43 struct list_head compile_ok_tests;
44 struct list_head compile_fail_tests;
45 struct list_head other_test_c_files;
46 struct list_head other_test_files;
48 struct list_head other_files;
49 struct list_head examples;
50 struct list_head mangled_examples;
52 /* From tests/check_depends_exist.c */
53 struct list_head deps;
55 /* From tests/license_exists.c */
59 /* Get the manifest for a given directory. */
60 struct manifest *get_manifest(const void *ctx, const char *dir);
62 /* Error in a particular file: stored off score->per_file_errors. */
64 struct list_node list;
65 struct ccan_file *file;
69 /* The score for an individual test. */
71 /* Starts as false: if not set to true, ccanlint exits non-zero.
72 * Thus it is usually set for compilation or other serious failures. */
74 /* Starts at 0 and 1 respectively. */
75 unsigned int score, total;
76 /* The error message to print. */
78 /* Per file errors, set by score_file_error() */
79 struct list_head per_file_errors;
83 struct list_node list;
85 /* More concise unique name of test. */
88 /* Unique name of test */
91 /* Can we run this test? Return string explaining why, if not. */
92 const char *(*can_run)(struct manifest *m);
94 /* Should we stop immediately if test fails? */
97 /* keep is set if you should keep the results.
98 * If timeleft is set to 0, means it timed out.
99 * score is the result, and a talloc context freed after all our
100 * depends are done. */
101 void (*check)(struct manifest *m,
102 bool keep, unsigned int *timeleft, struct score *score);
104 /* Can we do something about it? (NULL if not) */
105 void (*handle)(struct manifest *m, struct score *score);
107 /* Options from _info. */
109 /* If not set, we'll give an error if they try to set options. */
112 /* Space-separated list of dependency keys. */
115 /* Internal use fields: */
116 /* Who depends on us? */
117 struct list_head dependencies;
118 /* How many things do we (still) depend on? */
119 unsigned int num_depends;
120 /* Did we skip a dependency? If so, must skip this, too. */
122 /* Did we fail a dependency? If so, skip and mark as fail. */
124 /* Did the user want to keep these results? */
128 /* Ask the user a yes/no question: the answer is NO if there's an error. */
129 bool ask(const char *question);
131 enum line_info_type {
132 PREPROC_LINE, /* Line starts with # */
133 CODE_LINE, /* Code (ie. not pure comment). */
134 DOC_LINE, /* Line with kernel-doc-style comment. */
135 COMMENT_LINE, /* (pure) comment line */
138 /* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
139 * and #if <SYMBOL>/#if !<SYMBOL> */
140 struct pp_conditions {
141 /* We're inside another ifdef? */
142 struct pp_conditions *parent;
154 /* Preprocessor information about each line. */
156 enum line_info_type type;
158 /* Is this actually a continuation of line above? (which ends in \) */
161 /* Conditions for this line to be compiled. */
162 struct pp_conditions *cond;
166 struct list_node list;
168 /* Name (usually, within m->dir). */
171 /* Full path name. */
174 /* Pristine version of the original file.
175 * Use get_ccan_file_contents to fill this. */
176 const char *contents;
177 size_t contents_size;
179 /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */
180 unsigned int num_lines;
182 struct line_info *line_info;
184 struct list_head *doc_sections;
186 /* If this file gets compiled (eg. .C file to .o file), result here. */
187 char *compiled[COMPILE_TYPES];
189 /* Filename containing output from valgrind. */
192 /* Leak output from valgrind. */
195 /* Simplified stream (lowercase letters and single spaces) */
199 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
200 struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
202 /* Use this rather than accessing f->contents directly: loads on demand. */
203 const char *get_ccan_file_contents(struct ccan_file *f);
205 /* Use this rather than accessing f->lines directly: loads on demand. */
206 char **get_ccan_file_lines(struct ccan_file *f);
208 /* Use this rather than accessing f->lines directly: loads on demand. */
209 struct line_info *get_ccan_line_info(struct ccan_file *f);
211 /* Use this rather than accessing f->simplified directly: loads on demand. */
212 const char *get_ccan_simplified(struct ccan_file *f);
220 /* Simple evaluator. If symbols are set this way, is this condition true?
221 * NULL values mean undefined, NULL symbol terminates. */
222 enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
224 const unsigned int *value, ...);
226 /* Get token if it's equal to token. */
227 bool get_token(const char **line, const char *token);
228 /* Talloc copy of symbol token, or NULL. Increment line. */
229 char *get_symbol_token(void *ctx, const char **line);
231 /* Similarly for ->doc_sections */
232 struct list_head *get_ccan_file_docs(struct ccan_file *f);
234 /* Get NULL-terminated array options for this file for this test */
235 char **per_file_options(const struct ccanlint *test, struct ccan_file *f);
237 /* Append message about this file (and line, if non-zero) to the score->error */
238 void score_file_error(struct score *, struct ccan_file *f, unsigned line,
239 const char *errorfmt, ...);
241 /* Start a command in the background. */
242 void run_command_async(const void *ctx, unsigned int time_ms,
243 const char *fmt, ...);
245 /* Async version of compile_and_link. */
246 void compile_and_link_async(const void *ctx, unsigned int time_ms,
247 const char *cfile, const char *ccandir,
248 const char *objs, const char *compiler,
250 const char *libs, const char *outfile);
252 /* Get results of a command, returning ctx (and free it). */
253 void *collect_command(bool *ok, char **output);
256 extern struct ccanlint trailing_whitespace;
260 struct list_node node;
261 struct ccanlint *dependent;
264 /* Is this test excluded (cmdline or _info). */
265 bool is_excluded(const char *name);
267 /* Are we happy to compile stuff, or just non-intrusive tests? */
268 extern bool safe_mode;
270 /* Where is the ccan dir? Available after first manifest. */
271 extern const char *ccan_dir;
273 /* Compiler and CFLAGS, from config.h if available. */
274 extern const char *compiler, *cflags;
276 /* Contents of config.h (or NULL if not found) */
277 extern const char *config_header;
279 #endif /* CCAN_LINT_H */