3 #include <ccan/list/list.h>
5 #include "../doc_extract.h"
7 #define REGISTER_TEST(name, ...) extern struct ccanlint name
9 /* 0 == Describe failed tests.
10 1 == Describe results for partial failures.
11 2 == One line per test, plus details of failures.
13 Mainly for debugging ccanlint:
14 3 == Describe every object built.
15 4 == Describe every action. */
20 /* The module name, ie. final element of dir name */
22 struct ccan_file *info_file;
24 /* Linked off deps. */
25 struct list_node list;
26 /* Where our final compiled output is */
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 deps;
47 struct manifest *get_manifest(const void *ctx, const char *dir);
50 struct list_node list;
51 struct ccan_file *file;
57 unsigned int score, total;
59 struct list_head per_file_errors;
63 struct list_node list;
65 /* More concise unique name of test. */
68 /* Unique name of test */
71 /* Can we run this test? Return string explaining why, if not. */
72 const char *(*can_run)(struct manifest *m);
74 /* keep is set if you should keep the results.
75 * If timeleft is set to 0, means it timed out.
76 * score is the result, and a talloc context freed after all our
77 * depends are done. */
78 void (*check)(struct manifest *m,
79 bool keep, unsigned int *timeleft, struct score *score);
81 /* Can we do something about it? (NULL if not) */
82 void (*handle)(struct manifest *m, struct score *score);
84 /* Options from _info. */
86 /* If not set, we'll give an error if they try to set options. */
89 /* comma-separated list of dependency keys. */
92 /* Internal use fields: */
93 /* Who depends on us? */
94 struct list_head dependencies;
95 /* How many things do we (still) depend on? */
96 unsigned int num_depends;
97 /* Did we skip a dependency? If so, must skip this, too. */
99 /* Did we fail a dependency? If so, skip and mark as fail. */
101 /* Did the user want to keep these results? */
105 /* Ask the user a yes/no question: the answer is NO if there's an error. */
106 bool ask(const char *question);
108 enum line_info_type {
109 PREPROC_LINE, /* Line starts with # */
110 CODE_LINE, /* Code (ie. not pure comment). */
111 DOC_LINE, /* Line with kernel-doc-style comment. */
112 COMMENT_LINE, /* (pure) comment line */
115 /* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
116 * and #if <SYMBOL>/#if !<SYMBOL> */
117 struct pp_conditions {
118 /* We're inside another ifdef? */
119 struct pp_conditions *parent;
131 /* Preprocessor information about each line. */
133 enum line_info_type type;
135 /* Is this actually a continuation of line above? (which ends in \) */
138 /* Conditions for this line to be compiled. */
139 struct pp_conditions *cond;
143 struct list_node list;
145 /* Name (usually, within m->dir). */
148 /* Full path name. */
151 /* Pristine version of the original file.
152 * Use get_ccan_file_contents to fill this. */
153 const char *contents;
154 size_t contents_size;
156 /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */
157 unsigned int num_lines;
159 struct line_info *line_info;
161 struct list_head *doc_sections;
163 /* If this file gets compiled (eg. .C file to .o file), result here. */
166 /* Compiled with coverage information. */
169 /* Leak output from valgrind. */
173 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
174 struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
176 /* Use this rather than accessing f->contents directly: loads on demand. */
177 const char *get_ccan_file_contents(struct ccan_file *f);
179 /* Use this rather than accessing f->lines directly: loads on demand. */
180 char **get_ccan_file_lines(struct ccan_file *f);
182 /* Use this rather than accessing f->lines directly: loads on demand. */
183 struct line_info *get_ccan_line_info(struct ccan_file *f);
191 /* Simple evaluator. If symbols are set this way, is this condition true?
192 * NULL values mean undefined, NULL symbol terminates. */
193 enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
195 const unsigned int *value, ...);
197 /* Get token if it's equal to token. */
198 bool get_token(const char **line, const char *token);
199 /* Talloc copy of symbol token, or NULL. Increment line. */
200 char *get_symbol_token(void *ctx, const char **line);
202 /* Similarly for ->doc_sections */
203 struct list_head *get_ccan_file_docs(struct ccan_file *f);
205 /* Append message about this file (and line, if non-zero) to the score->error */
206 void score_file_error(struct score *, struct ccan_file *f, unsigned line,
207 const char *errorfmt, ...);
210 extern struct ccanlint trailing_whitespace;
214 struct list_node node;
215 struct ccanlint *dependent;
218 /* Are we happy to compile stuff, or just non-intrusive tests? */
219 extern bool safe_mode;
221 /* Where is the ccan dir? Available after first manifest. */
222 extern const char *ccan_dir;
224 /* Compiler and CFLAGS, from config.h if available. */
225 extern char *compiler, *cflags;
227 /* Contents of config.h (or NULL if not found) */
228 extern const char *config_header;
230 #endif /* CCAN_LINT_H */