4 #include <ccan/list/list.h>
5 #include <ccan/dgraph/dgraph.h>
7 #include "../doc_extract.h"
10 #define REGISTER_TEST(name, ...) extern struct ccanlint name
12 /* 0 == Describe failed tests.
13 1 == Describe results for partial failures.
14 2 == One line per test, plus details of failures.
16 Mainly for debugging ccanlint:
17 3 == Describe every object built.
18 4 == Describe every action. */
30 /* The module name, ie. final element of dir name */
32 struct ccan_file *info_file;
34 /* Linked off deps. */
35 struct list_node list;
36 /* Where our final compiled output is */
37 char *compiled[COMPILE_TYPES];
39 struct list_head c_files;
40 struct list_head h_files;
42 struct list_head run_tests;
43 struct list_head api_tests;
44 struct list_head compile_ok_tests;
45 struct list_head compile_fail_tests;
46 struct list_head other_test_c_files;
47 struct list_head other_test_files;
49 struct list_head other_files;
50 struct list_head examples;
51 struct list_head mangled_examples;
53 /* From tests/check_depends_exist.c */
54 struct list_head deps;
56 /* From tests/license_exists.c */
60 /* Get the manifest for a given directory. */
61 struct manifest *get_manifest(const void *ctx, const char *dir);
63 /* Error in a particular file: stored off score->per_file_errors. */
65 struct list_node list;
66 struct ccan_file *file;
70 /* The score for an individual test. */
72 /* Starts as false: if not set to true, ccanlint exits non-zero.
73 * Thus it is usually set for compilation or other serious failures. */
75 /* Starts at 0 and 1 respectively. */
76 unsigned int score, total;
77 /* The error message to print. */
79 /* Per file errors, set by score_file_error() */
80 struct list_head per_file_errors;
84 /* More concise unique name of test. */
87 /* Unique name of test */
90 /* Can we run this test? Return string explaining why, if not. */
91 const char *(*can_run)(struct manifest *m);
93 /* Should we stop immediately if test fails? */
96 /* keep is set if you should keep the results.
97 * If timeleft is set to 0, means it timed out.
98 * score is the result, and a talloc context freed after all our
99 * depends are done. */
100 void (*check)(struct manifest *m,
101 bool keep, unsigned int *timeleft, struct score *score);
103 /* Can we do something about it? (NULL if not) */
104 void (*handle)(struct manifest *m, struct score *score);
106 /* Options from _info. */
108 /* If not set, we'll give an error if they try to set options. */
111 /* Space-separated list of dependency keys. */
114 /* Internal use fields: */
115 /* We are a node in a dependency graph. */
116 struct dgraph_node node;
117 /* Did we skip a dependency? If so, must skip this, too. */
119 /* Did we fail a dependency? If so, skip and mark as fail. */
121 /* Did the user want to keep these results? */
123 /* Have we already run this? */
127 /* Ask the user a yes/no question: the answer is NO if there's an error. */
128 bool ask(const char *question);
130 enum line_info_type {
131 PREPROC_LINE, /* Line starts with # */
132 CODE_LINE, /* Code (ie. not pure comment). */
133 DOC_LINE, /* Line with kernel-doc-style comment. */
134 COMMENT_LINE, /* (pure) comment line */
137 /* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
138 * and #if <SYMBOL>/#if !<SYMBOL> */
139 struct pp_conditions {
140 /* We're inside another ifdef? */
141 struct pp_conditions *parent;
153 /* Preprocessor information about each line. */
155 enum line_info_type type;
157 /* Is this actually a continuation of line above? (which ends in \) */
160 /* Conditions for this line to be compiled. */
161 struct pp_conditions *cond;
165 struct list_node list;
167 /* Name (usually, within m->dir). */
170 /* Full path name. */
173 /* Pristine version of the original file.
174 * Use get_ccan_file_contents to fill this. */
175 const char *contents;
176 size_t contents_size;
178 /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */
179 unsigned int num_lines;
181 struct line_info *line_info;
183 struct list_head *doc_sections;
185 /* If this file gets compiled (eg. .C file to .o file), result here. */
186 char *compiled[COMPILE_TYPES];
188 /* Filename containing output from valgrind. */
191 /* Leak output from valgrind. */
194 /* Simplified stream (lowercase letters and single spaces) */
198 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
199 struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
201 /* Use this rather than accessing f->contents directly: loads on demand. */
202 const char *get_ccan_file_contents(struct ccan_file *f);
204 /* Use this rather than accessing f->lines directly: loads on demand. */
205 char **get_ccan_file_lines(struct ccan_file *f);
207 /* Use this rather than accessing f->lines directly: loads on demand. */
208 struct line_info *get_ccan_line_info(struct ccan_file *f);
210 /* Use this rather than accessing f->simplified directly: loads on demand. */
211 const char *get_ccan_simplified(struct ccan_file *f);
219 /* Simple evaluator. If symbols are set this way, is this condition true?
220 * NULL values mean undefined, NULL symbol terminates. */
221 enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
223 const unsigned int *value, ...);
225 /* Get token if it's equal to token. */
226 bool get_token(const char **line, const char *token);
227 /* Talloc copy of symbol token, or NULL. Increment line. */
228 char *get_symbol_token(void *ctx, const char **line);
230 /* Similarly for ->doc_sections */
231 struct list_head *get_ccan_file_docs(struct ccan_file *f);
233 /* Get NULL-terminated array options for this file for this test */
234 char **per_file_options(const struct ccanlint *test, struct ccan_file *f);
236 /* Append message about this file (and line, if non-zero) to the score->error */
237 void score_file_error(struct score *, struct ccan_file *f, unsigned line,
238 const char *errorfmt, ...);
240 /* Start a command in the background. */
241 void run_command_async(const void *ctx, unsigned int time_ms,
242 const char *fmt, ...);
244 /* Async version of compile_and_link. */
245 void compile_and_link_async(const void *ctx, unsigned int time_ms,
246 const char *cfile, const char *ccandir,
247 const char *objs, const char *compiler,
249 const char *libs, const char *outfile);
251 /* Get results of a command, returning ctx (and free it). */
252 void *collect_command(bool *ok, char **output);
255 extern struct ccanlint trailing_whitespace;
259 struct list_node node;
260 struct ccanlint *dependent;
263 /* Is this test excluded (cmdline or _info). */
264 bool is_excluded(const char *name);
266 /* Called to add options from _info, once it's located. */
267 void add_info_options(struct ccan_file *info);
269 /* Are we happy to compile stuff, or just non-intrusive tests? */
270 extern bool safe_mode;
272 /* Where is the ccan dir? Available after first manifest. */
273 extern const char *ccan_dir;
275 /* Compiler and CFLAGS, from config.h if available. */
276 extern const char *compiler, *cflags;
278 /* Contents of config.h (or NULL if not found) */
279 extern const char *config_header;
281 #endif /* CCAN_LINT_H */