41a4606c40fe260644ce24471a5eca66225ca686
[ccan] / tools / ccanlint / ccanlint.h
1 #ifndef CCAN_LINT_H
2 #define CCAN_LINT_H
3 #include <ccan/list/list.h>
4 #include <stdbool.h>
5 #include "../doc_extract.h"
6
7 #define REGISTER_TEST(name, ...) extern struct ccanlint name
8 #include "generated-compulsory-tests"
9 #include "generated-normal-tests"
10 #undef REGISTER_TEST
11
12 #define REGISTER_TEST(name, ...) 
13
14 /* 0 == Describe failed tests.
15    1 == Describe results for partial failures.
16    2 == One line per test, plus details of failures.
17
18    Mainly for debugging ccanlint:
19    3 == Describe every object built.
20    4 == Describe every action. */
21 extern int verbose;
22
23 struct manifest {
24         char *dir;
25         /* The module name, ie. final element of dir name */
26         char *basename;
27         struct ccan_file *info_file;
28
29         /* Linked off deps. */
30         struct list_node list;
31         /* Where our final compiled output is */
32         char *compiled;
33
34         struct list_head c_files;
35         struct list_head h_files;
36
37         struct list_head run_tests;
38         struct list_head api_tests;
39         struct list_head compile_ok_tests;
40         struct list_head compile_fail_tests;
41         struct list_head other_test_c_files;
42         struct list_head other_test_files;
43
44         struct list_head other_files;
45         struct list_head examples;
46         struct list_head mangled_examples;
47
48         /* From tests/check_depends_exist.c */
49         struct list_head deps;
50 };
51
52 struct manifest *get_manifest(const void *ctx, const char *dir);
53
54 struct file_error {
55         struct list_node list;
56         struct ccan_file *file;
57         unsigned int line; /* 0 not to print */
58         const char *error;
59 };
60
61 struct score {
62         bool pass;
63         unsigned int score, total;
64         const char *error;
65         struct list_head per_file_errors;
66 };
67
68 struct ccanlint {
69         struct list_node list;
70
71         /* More concise unique name of test. */
72         const char *key;
73
74         /* Unique name of test */
75         const char *name;
76
77         /* Can we run this test?  Return string explaining why, if not. */
78         const char *(*can_run)(struct manifest *m);
79
80         /* keep is set if you should keep the results.
81          * If timeleft is set to 0, means it timed out.
82          * score is the result, and a talloc context freed after all our
83          * depends are done. */
84         void (*check)(struct manifest *m,
85                       bool keep, unsigned int *timeleft, struct score *score);
86
87         /* Can we do something about it? (NULL if not) */
88         void (*handle)(struct manifest *m, struct score *score);
89
90         /* Options from _info. */
91         char *options;
92         /* If not set, we'll give an error if they try to set options. */
93         bool takes_options;
94
95         /* Internal use fields: */
96         /* Who depends on us? */
97         struct list_head dependencies;
98         /* How many things do we (still) depend on? */
99         unsigned int num_depends;
100         /* Did we skip a dependency?  If so, must skip this, too. */
101         const char *skip;
102         /* Did we fail a dependency?  If so, skip and mark as fail. */
103         bool skip_fail;
104         /* Did the user want to keep these results? */
105         bool keep_results;
106 };
107
108 /* Ask the user a yes/no question: the answer is NO if there's an error. */
109 bool ask(const char *question);
110
111 enum line_info_type {
112         PREPROC_LINE, /* Line starts with # */
113         CODE_LINE, /* Code (ie. not pure comment). */
114         DOC_LINE, /* Line with kernel-doc-style comment. */
115         COMMENT_LINE, /* (pure) comment line */
116 };
117
118 /* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests,
119  * and #if <SYMBOL>/#if !<SYMBOL> */
120 struct pp_conditions {
121         /* We're inside another ifdef? */
122         struct pp_conditions *parent;
123
124         enum {
125                 PP_COND_IF,
126                 PP_COND_IFDEF,
127                 PP_COND_UNKNOWN,
128         } type;
129
130         bool inverse;
131         const char *symbol;
132 };
133
134 /* Preprocessor information about each line. */
135 struct line_info {
136         enum line_info_type type;
137
138         /* Is this actually a continuation of line above? (which ends in \) */
139         bool continued;
140
141         /* Conditions for this line to be compiled. */
142         struct pp_conditions *cond;
143 };
144
145 struct ccan_file {
146         struct list_node list;
147
148         /* Name (usually, within m->dir). */
149         char *name;
150
151         /* Full path name. */
152         char *fullname;
153
154         /* Pristine version of the original file.
155          * Use get_ccan_file_contents to fill this. */
156         const char *contents;
157         size_t contents_size;
158
159         /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */
160         unsigned int num_lines;
161         char **lines;
162         struct line_info *line_info;
163
164         struct list_head *doc_sections;
165
166         /* If this file gets compiled (eg. .C file to .o file), result here. */
167         char *compiled;
168
169         /* Compiled with coverage information. */
170         char *cov_compiled;
171
172         /* Leak output from valgrind. */
173         char *leak_info;
174 };
175
176 /* A new ccan_file, with the given name (talloc_steal onto returned value). */
177 struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name);
178
179 /* Use this rather than accessing f->contents directly: loads on demand. */
180 const char *get_ccan_file_contents(struct ccan_file *f);
181
182 /* Use this rather than accessing f->lines directly: loads on demand. */
183 char **get_ccan_file_lines(struct ccan_file *f);
184
185 /* Use this rather than accessing f->lines directly: loads on demand. */
186 struct line_info *get_ccan_line_info(struct ccan_file *f);
187
188 enum line_compiled {
189         NOT_COMPILED,
190         COMPILED,
191         MAYBE_COMPILED,
192 };
193
194 /* Simple evaluator.  If symbols are set this way, is this condition true?
195  * NULL values mean undefined, NULL symbol terminates. */
196 enum line_compiled get_ccan_line_pp(struct pp_conditions *cond,
197                                     const char *symbol,
198                                     const unsigned int *value, ...);
199
200 /* Get token if it's equal to token. */
201 bool get_token(const char **line, const char *token);
202 /* Talloc copy of symbol token, or NULL.  Increment line. */
203 char *get_symbol_token(void *ctx, const char **line);
204
205 /* Similarly for ->doc_sections */
206 struct list_head *get_ccan_file_docs(struct ccan_file *f);
207
208 /* Add an error about this file (and line, if non-zero) to the score struct */
209 void score_file_error(struct score *, struct ccan_file *f, unsigned line,
210                       const char *error);
211
212 /* Normal tests. */
213 extern struct ccanlint trailing_whitespace;
214
215 /* Dependencies */
216 struct dependent {
217         struct list_node node;
218         struct ccanlint *dependent;
219 };
220
221 /* Are we happy to compile stuff, or just non-intrusive tests? */
222 extern bool safe_mode;
223
224 /* Where is the ccan dir?  Available after first manifest. */
225 extern const char *ccan_dir;
226
227 #endif /* CCAN_LINT_H */