X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=7df951084f3aec4dd1ddbec10072c0d879c735a4;hp=ac169fa81156b57452708208af65fecd05402fdf;hb=HEAD;hpb=7eb00644b848b551b2db5d9de40893e488c2790d diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index ac169fa8..7df95108 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -1,83 +1,209 @@ #ifndef CCAN_LINT_H #define CCAN_LINT_H +#include "config.h" #include +#include +#include +#include #include #include "../doc_extract.h" +#include "../manifest.h" +#include "../tools.h" +#include "licenses.h" -struct manifest { - char *basename; - struct ccan_file *info_file; +AUTODATA_TYPE(ccanlint_tests, struct ccanlint); +#define REGISTER_TEST(test) AUTODATA(ccanlint_tests, &test) - struct list_head c_files; - struct list_head h_files; +/* 0 == Describe failed tests. + 1 == Describe results for partial failures. + 2 == One line per test, plus details of failures. - struct list_head run_tests; - struct list_head api_tests; - struct list_head compile_ok_tests; - struct list_head compile_fail_tests; - struct list_head other_test_files; + Mainly for debugging ccanlint: + 3 == Describe every object built. + 4 == Describe every action. */ +extern int verbose; - struct list_head other_files; +/* Error in a particular file: stored off score->per_file_errors. */ +struct file_error { + struct list_node list; + struct ccan_file *file; + unsigned int line; }; -struct manifest *get_manifest(void); +/* The score for an individual test. */ +struct score { + /* Starts as false: if not set to true, ccanlint exits non-zero. + * Thus it is usually set for compilation or other serious failures. */ + bool pass; + /* Starts at 0 and 1 respectively. */ + unsigned int score, total; + /* The error message to print. */ + char *error; + /* Per file errors, set by score_file_error() */ + struct list_head per_file_errors; +}; struct ccanlint { - struct list_node list; + /* More concise unique name of test. */ + const char *key; /* Unique name of test */ const char *name; - /* Total score that this test is worth. 0 means compulsory tests. */ - unsigned int total_score; - - /* If this returns non-NULL, it means the check failed. */ - void *(*check)(struct manifest *m); + /* Can we run this test? Return string explaining why, if not. */ + const char *(*can_run)(struct manifest *m); - /* The non-NULL return from check is passed to one of these: */ + /* Should we stop immediately if test fails? */ + bool compulsory; - /* So, what did this get out of the total_score? (NULL means 0). */ - unsigned int (*score)(struct manifest *m, void *check_result); - - /* Verbose description of what was wrong. */ - const char *(*describe)(struct manifest *m, void *check_result); + /* If timeleft is set to 0, means it timed out. + * score is the result, and a tal context freed after all our + * depends are done. */ + void (*check)(struct manifest *m, + unsigned int *timeleft, struct score *score); /* Can we do something about it? (NULL if not) */ - void (*handle)(struct manifest *m, void *check_result); + void (*handle)(struct manifest *m, struct score *score); + + /* Options from _info. */ + char **options; + /* If not set, we'll give an error if they try to set options. */ + bool takes_options; + + /* Space-separated list of dependency keys. */ + const char *needs; + + /* Internal use fields: */ + /* We are a node in a dependency graph. */ + struct dgraph_node node; + /* Did we skip a dependency? If so, must skip this, too. */ + const char *skip; + /* Have we already run this? */ + bool done; }; /* Ask the user a yes/no question: the answer is NO if there's an error. */ bool ask(const char *question); -struct ccan_file { - struct list_node list; +enum line_info_type { + PREPROC_LINE, /* Line starts with # */ + CODE_LINE, /* Code (ie. not pure comment). */ + DOC_LINE, /* Line with kernel-doc-style comment. */ + COMMENT_LINE, /* (pure) comment line */ +}; - char *name; +/* So far, only do simple #ifdef/#ifndef/#if defined/#if !defined tests, + * and #if /#if ! */ +struct pp_conditions { + /* We're inside another ifdef? */ + struct pp_conditions *parent; - unsigned int num_lines; - char **lines; + enum { + PP_COND_IF, + PP_COND_IFDEF, + PP_COND_UNKNOWN, + } type; - struct list_head *doc_sections; + bool inverse; + const char *symbol; +}; + +/* Preprocessor information about each line. */ +struct line_info { + enum line_info_type type; + + /* Is this actually a continuation of line above? (which ends in \) */ + bool continued; + + /* Conditions for this line to be compiled. */ + struct pp_conditions *cond; }; /* Use this rather than accessing f->lines directly: loads on demand. */ -char **get_ccan_file_lines(struct ccan_file *f); +struct line_info *get_ccan_line_info(struct ccan_file *f); + +/* Use this rather than accessing f->simplified directly: loads on demand. */ +const char *get_ccan_simplified(struct ccan_file *f); + +enum line_compiled { + NOT_COMPILED, + COMPILED, + MAYBE_COMPILED, +}; + +/* Simple evaluator. If symbols are set this way, is this condition true? + * NULL values mean undefined, NULL symbol terminates. */ +enum line_compiled get_ccan_line_pp(struct pp_conditions *cond, + const char *symbol, + const unsigned int *value, ...); + +/* Get token if it's equal to token. */ +bool get_token(const char **line, const char *token); +/* Tal copy of symbol token, or NULL. Increment line. */ +char *get_symbol_token(void *ctx, const char **line); /* Similarly for ->doc_sections */ struct list_head *get_ccan_file_docs(struct ccan_file *f); -/* Call the reporting on every line in the file. sofar contains - * previous results. */ -char *report_on_lines(struct list_head *files, - char *(*report)(const char *), - char *sofar); +/* Get NULL-terminated array options for this file for this test */ +char **per_file_options(const struct ccanlint *test, struct ccan_file *f); + +/* Append message about this file (and line, if non-zero) to the score->error */ +void score_file_error(struct score *, struct ccan_file *f, unsigned line, + const char *errorfmt, ...); + +/* Append message to the score->error */ +void score_error(struct score *score, const char * source, + const char *errorfmt, ...); + +/* Start a command in the background. */ +void run_command_async(const void *ctx, unsigned int time_ms, + const char *fmt, ...); -/* The critical tests which mean fail if they don't pass. */ -extern struct ccanlint no_info; -extern struct ccanlint has_main_header; +/* Async version of compile_and_link. */ +void compile_and_link_async(const void *ctx, unsigned int time_ms, + const char *cfile, const char *ccandir, + const char *objs, const char *compiler, + const char *cflags, + const char *libs, const char *outfile); + +/* Get results of a command, returning ctx (and free it). */ +void *collect_command(bool *ok, char **output); + +/* Find manifest for this dir and return compiled _info filename. */ +char *get_or_compile_info(const void *ctx, const char *dir); /* Normal tests. */ extern struct ccanlint trailing_whitespace; +/* Dependencies */ +struct dependent { + struct list_node node; + struct ccanlint *dependent; +}; + +/* Is this test excluded (cmdline or _info). */ +bool is_excluded(const char *name); + +/* Called to add options from _info, once it's located. */ +void add_info_options(struct manifest *m); + +/* Are we happy to compile stuff, or just non-intrusive tests? */ +extern bool safe_mode; + +/* Did the user want to keep all the results? */ +extern bool keep_results; + +/* Did we find non-ccan dependencies? */ +extern bool non_ccan_deps; + +/* Did we fail to build? */ +extern bool build_failed; + +/* Contents of config.h (or NULL if not found) */ +extern const char *config_header; + +/* Where is the ccan dir? */ +extern const char *ccan_dir; #endif /* CCAN_LINT_H */