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 /* If timeleft is set to 0, means it timed out.
97 * score is the result, and a talloc context freed after all our
98 * depends are done. */
99 void (*check)(struct manifest *m,
100 unsigned int *timeleft, struct score *score);
102 /* Can we do something about it? (NULL if not) */
103 void (*handle)(struct manifest *m, struct score *score);
105 /* Options from _info. */
107 /* If not set, we'll give an error if they try to set options. */
110 /* Space-separated list of dependency keys. */
113 /* Internal use fields: */
114 /* We are a node in a dependency graph. */
115 struct dgraph_node node;
116 /* Did we skip a dependency? If so, must skip this, too. */
118 /* Have we already run this? */
122 /* Ask the user a yes/no question: the answer is NO if there's an error. */
123 bool ask(const char *question);
125 enum line_info_type {
126 PREPROC_LINE, /* Line starts with # */
127 CODE_LINE, /* Code (ie. not pure comment). */
128 DOC_LINE, /* Line with kernel-doc-style comment. */
129 COMMENT_LINE, /* (pure) comment line */
132 /* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
133 * and #if <SYMBOL>/#if !<SYMBOL> */
134 struct pp_conditions {
135 /* We're inside another ifdef? */
136 struct pp_conditions *parent;
148 /* Preprocessor information about each line. */
150 enum line_info_type type;
152 /* Is this actually a continuation of line above? (which ends in \) */
155 /* Conditions for this line to be compiled. */
156 struct pp_conditions *cond;
160 struct list_node list;
162 /* Name (usually, within m->dir). */
165 /* Full path name. */
168 /* Pristine version of the original file.
169 * Use get_ccan_file_contents to fill this. */
170 const char *contents;
171 size_t contents_size;
173 /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */
174 unsigned int num_lines;
176 struct line_info *line_info;
178 struct list_head *doc_sections;
180 /* If this file gets compiled (eg. .C file to .o file), result here. */
181 char *compiled[COMPILE_TYPES];
183 /* Filename containing output from valgrind. */
186 /* Leak output from valgrind. */
189 /* Simplified stream (lowercase letters and single spaces) */
193 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
194 struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
196 /* Use this rather than accessing f->contents directly: loads on demand. */
197 const char *get_ccan_file_contents(struct ccan_file *f);
199 /* Use this rather than accessing f->lines directly: loads on demand. */
200 char **get_ccan_file_lines(struct ccan_file *f);
202 /* Use this rather than accessing f->lines directly: loads on demand. */
203 struct line_info *get_ccan_line_info(struct ccan_file *f);
205 /* Use this rather than accessing f->simplified directly: loads on demand. */
206 const char *get_ccan_simplified(struct ccan_file *f);
214 /* Simple evaluator. If symbols are set this way, is this condition true?
215 * NULL values mean undefined, NULL symbol terminates. */
216 enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
218 const unsigned int *value, ...);
220 /* Get token if it's equal to token. */
221 bool get_token(const char **line, const char *token);
222 /* Talloc copy of symbol token, or NULL. Increment line. */
223 char *get_symbol_token(void *ctx, const char **line);
225 /* Similarly for ->doc_sections */
226 struct list_head *get_ccan_file_docs(struct ccan_file *f);
228 /* Get NULL-terminated array options for this file for this test */
229 char **per_file_options(const struct ccanlint *test, struct ccan_file *f);
231 /* Append message about this file (and line, if non-zero) to the score->error */
232 void score_file_error(struct score *, struct ccan_file *f, unsigned line,
233 const char *errorfmt, ...);
235 /* Start a command in the background. */
236 void run_command_async(const void *ctx, unsigned int time_ms,
237 const char *fmt, ...);
239 /* Async version of compile_and_link. */
240 void compile_and_link_async(const void *ctx, unsigned int time_ms,
241 const char *cfile, const char *ccandir,
242 const char *objs, const char *compiler,
244 const char *libs, const char *outfile);
246 /* Get results of a command, returning ctx (and free it). */
247 void *collect_command(bool *ok, char **output);
250 extern struct ccanlint trailing_whitespace;
254 struct list_node node;
255 struct ccanlint *dependent;
258 /* Is this test excluded (cmdline or _info). */
259 bool is_excluded(const char *name);
261 /* Called to add options from _info, once it's located. */
262 void add_info_options(struct ccan_file *info);
264 /* Are we happy to compile stuff, or just non-intrusive tests? */
265 extern bool safe_mode;
267 /* Did the user want to keep all the results? */
268 extern bool keep_results;
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 */