4 #include <ccan/list/list.h>
5 #include <ccan/dgraph/dgraph.h>
6 #include <ccan/autodata/autodata.h>
8 #include "../doc_extract.h"
9 #include "../manifest.h"
12 AUTODATA_TYPE(ccanlint_tests, struct ccanlint);
13 #define REGISTER_TEST(test) AUTODATA(ccanlint_tests, &test)
15 /* 0 == Describe failed tests.
16 1 == Describe results for partial failures.
17 2 == One line per test, plus details of failures.
19 Mainly for debugging ccanlint:
20 3 == Describe every object built.
21 4 == Describe every action. */
24 /* Error in a particular file: stored off score->per_file_errors. */
26 struct list_node list;
27 struct ccan_file *file;
31 /* The score for an individual test. */
33 /* Starts as false: if not set to true, ccanlint exits non-zero.
34 * Thus it is usually set for compilation or other serious failures. */
36 /* Starts at 0 and 1 respectively. */
37 unsigned int score, total;
38 /* The error message to print. */
40 /* Per file errors, set by score_file_error() */
41 struct list_head per_file_errors;
45 /* More concise unique name of test. */
48 /* Unique name of test */
51 /* Can we run this test? Return string explaining why, if not. */
52 const char *(*can_run)(struct manifest *m);
54 /* Should we stop immediately if test fails? */
57 /* If timeleft is set to 0, means it timed out.
58 * score is the result, and a talloc context freed after all our
59 * depends are done. */
60 void (*check)(struct manifest *m,
61 unsigned int *timeleft, struct score *score);
63 /* Can we do something about it? (NULL if not) */
64 void (*handle)(struct manifest *m, struct score *score);
66 /* Options from _info. */
68 /* If not set, we'll give an error if they try to set options. */
71 /* Space-separated list of dependency keys. */
74 /* Internal use fields: */
75 /* We are a node in a dependency graph. */
76 struct dgraph_node node;
77 /* Did we skip a dependency? If so, must skip this, too. */
79 /* Have we already run this? */
83 /* Ask the user a yes/no question: the answer is NO if there's an error. */
84 bool ask(const char *question);
87 PREPROC_LINE, /* Line starts with # */
88 CODE_LINE, /* Code (ie. not pure comment). */
89 DOC_LINE, /* Line with kernel-doc-style comment. */
90 COMMENT_LINE, /* (pure) comment line */
93 /* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
94 * and #if <SYMBOL>/#if !<SYMBOL> */
95 struct pp_conditions {
96 /* We're inside another ifdef? */
97 struct pp_conditions *parent;
109 /* Preprocessor information about each line. */
111 enum line_info_type type;
113 /* Is this actually a continuation of line above? (which ends in \) */
116 /* Conditions for this line to be compiled. */
117 struct pp_conditions *cond;
120 /* Use this rather than accessing f->lines directly: loads on demand. */
121 struct line_info *get_ccan_line_info(struct ccan_file *f);
123 /* Use this rather than accessing f->simplified directly: loads on demand. */
124 const char *get_ccan_simplified(struct ccan_file *f);
132 /* Simple evaluator. If symbols are set this way, is this condition true?
133 * NULL values mean undefined, NULL symbol terminates. */
134 enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
136 const unsigned int *value, ...);
138 /* Get token if it's equal to token. */
139 bool get_token(const char **line, const char *token);
140 /* Talloc copy of symbol token, or NULL. Increment line. */
141 char *get_symbol_token(void *ctx, const char **line);
143 /* Similarly for ->doc_sections */
144 struct list_head *get_ccan_file_docs(struct ccan_file *f);
146 /* Get NULL-terminated array options for this file for this test */
147 char **per_file_options(const struct ccanlint *test, struct ccan_file *f);
149 /* Append message about this file (and line, if non-zero) to the score->error */
150 void score_file_error(struct score *, struct ccan_file *f, unsigned line,
151 const char *errorfmt, ...);
153 /* Start a command in the background. */
154 void run_command_async(const void *ctx, unsigned int time_ms,
155 const char *fmt, ...);
157 /* Async version of compile_and_link. */
158 void compile_and_link_async(const void *ctx, unsigned int time_ms,
159 const char *cfile, const char *ccandir,
160 const char *objs, const char *compiler,
162 const char *libs, const char *outfile);
164 /* Get results of a command, returning ctx (and free it). */
165 void *collect_command(bool *ok, char **output);
167 /* Find manifest for this dir and return compiled _info filename. */
168 char *get_or_compile_info(const void *ctx, const char *dir);
171 extern struct ccanlint trailing_whitespace;
175 struct list_node node;
176 struct ccanlint *dependent;
179 /* Is this test excluded (cmdline or _info). */
180 bool is_excluded(const char *name);
182 /* Called to add options from _info, once it's located. */
183 void add_info_options(struct ccan_file *info);
185 /* Are we happy to compile stuff, or just non-intrusive tests? */
186 extern bool safe_mode;
188 /* Did the user want to keep all the results? */
189 extern bool keep_results;
191 /* Compiler and CFLAGS, from config.h if available. */
192 extern const char *compiler, *cflags;
194 /* Contents of config.h (or NULL if not found) */
195 extern const char *config_header;
197 /* Where is the ccan dir? */
198 extern const char *ccan_dir;
200 #endif /* CCAN_LINT_H */