X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=6fcca5fa8eb26fbf40153e244a27c4d9e66e0922;hp=0e57140018ffee1693bbf3f1010dd622316e1335;hb=d8c9fdc0e6b70ab4fced949ee6488dc585a711f4;hpb=a40b318e7a07a452ae7456053727bd11b2fa49b4 diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index 0e571400..6fcca5fa 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -1,64 +1,47 @@ #ifndef CCAN_LINT_H #define CCAN_LINT_H +#include "config.h" #include +#include +#include #include #include "../doc_extract.h" +#include "../manifest.h" +#include "licenses.h" -#define REGISTER_TEST(name, ...) extern struct ccanlint name -#include "generated-compulsory-tests" -#include "generated-normal-tests" -#undef REGISTER_TEST +AUTODATA_TYPE(ccanlint_tests, struct ccanlint); +#define REGISTER_TEST(test) AUTODATA(ccanlint_tests, &test) -#define REGISTER_TEST(name, ...) +/* 0 == Describe failed tests. + 1 == Describe results for partial failures. + 2 == One line per test, plus details of failures. -/* 1 == Describe results for partial failures. - 2 == Describe gory details. - 3 == Describe every action. */ + Mainly for debugging ccanlint: + 3 == Describe every object built. + 4 == Describe every action. */ extern int verbose; -struct manifest { - char *dir; - /* The module name, ie. final element of dir name */ - char *basename; - struct ccan_file *info_file; - - struct list_head c_files; - struct list_head h_files; - - 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_c_files; - struct list_head other_test_files; - - struct list_head other_files; - struct list_head examples; - struct list_head mangled_examples; - - /* From tests/check_depends_exist.c */ - struct list_head dep_dirs; -}; - -struct manifest *get_manifest(const void *ctx, const char *dir); - +/* 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; /* 0 not to print */ - const char *error; + unsigned int line; }; +/* 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; - const char *error; + /* 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; @@ -68,27 +51,33 @@ struct ccanlint { /* Can we run this test? Return string explaining why, if not. */ const char *(*can_run)(struct manifest *m); - /* keep is set if you should keep the results. - * If timeleft is set to 0, means it timed out. + /* Should we stop immediately if test fails? */ + bool compulsory; + + /* If timeleft is set to 0, means it timed out. * score is the result, and a talloc context freed after all our * depends are done. */ void (*check)(struct manifest *m, - bool keep, unsigned int *timeleft, struct score *score); + unsigned int *timeleft, struct score *score); /* Can we do something about it? (NULL if not) */ 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: */ - /* Who depends on us? */ - struct list_head dependencies; - /* How many things do we (still) depend on? */ - unsigned int num_depends; + /* 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; - /* Did we fail a dependency? If so, skip and mark as fail. */ - bool skip_fail; - /* Did the user want to keep these results? */ - bool keep_results; + /* Have we already run this? */ + bool done; }; /* Ask the user a yes/no question: the answer is NO if there's an error. */ @@ -128,46 +117,12 @@ struct line_info { struct pp_conditions *cond; }; -struct ccan_file { - struct list_node list; - - /* Name (usually, within m->dir). */ - char *name; - - /* Full path name. */ - char *fullname; - - /* Pristine version of the original file. - * Use get_ccan_file_contents to fill this. */ - const char *contents; - size_t contents_size; - - /* Use get_ccan_file_lines / get_ccan_line_info to fill these. */ - unsigned int num_lines; - char **lines; - struct line_info *line_info; - - struct list_head *doc_sections; - - /* If this file gets compiled (eg. .C file to .o file), result here. */ - char *compiled; - - /* Compiled with coverage information. */ - char *cov_compiled; -}; - -/* A new ccan_file, with the given name (talloc_steal onto returned value). */ -struct ccan_file *new_ccan_file(const void *ctx, const char *dir, char *name); - -/* Use this rather than accessing f->contents directly: loads on demand. */ -const char *get_ccan_file_contents(struct ccan_file *f); - -/* Use this rather than accessing f->lines directly: loads on demand. */ -char **get_ccan_file_lines(struct ccan_file *f); - /* Use this rather than accessing f->lines directly: loads on demand. */ 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, @@ -188,10 +143,26 @@ char *get_symbol_token(void *ctx, const char **line); /* Similarly for ->doc_sections */ struct list_head *get_ccan_file_docs(struct ccan_file *f); +/* Get NULL-terminated array options for this file for this test */ +char **per_file_options(const struct ccanlint *test, struct ccan_file *f); -/* Add an error about this file (and line, if non-zero) to the score struct */ +/* 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 *error); + const char *errorfmt, ...); + +/* Start a command in the background. */ +void run_command_async(const void *ctx, unsigned int time_ms, + const char *fmt, ...); + +/* 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); /* Normal tests. */ extern struct ccanlint trailing_whitespace; @@ -202,10 +173,22 @@ struct dependent { 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 ccan_file *info); + /* Are we happy to compile stuff, or just non-intrusive tests? */ extern bool safe_mode; -/* Where is the ccan dir? Available after first manifest. */ -extern const char *ccan_dir; +/* Did the user want to keep all the results? */ +extern bool keep_results; + +/* Compiler and CFLAGS, from config.h if available. */ +extern const char *compiler, *cflags; + +/* Contents of config.h (or NULL if not found) */ +extern const char *config_header; #endif /* CCAN_LINT_H */