X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=16600cff4d0e83411b9c6aab1e5722fc718838c8;hp=804f80249d9204b362032e592c29a52d5e7b66b6;hb=4c6f5a73a0817641571fad7383ec3604487889f8;hpb=08f8cff8f22fee31b74f8301cc5d6494e5ff7160 diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index 804f8024..16600cff 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -1,13 +1,40 @@ #ifndef CCAN_LINT_H #define CCAN_LINT_H +#include "config.h" #include #include #include "../doc_extract.h" +#include "licenses.h" + +#define REGISTER_TEST(name, ...) extern struct ccanlint name + +/* 0 == Describe failed tests. + 1 == Describe results for partial failures. + 2 == One line per test, plus details of failures. + + Mainly for debugging ccanlint: + 3 == Describe every object built. + 4 == Describe every action. */ +extern int verbose; + +enum compile_type { + COMPILE_NORMAL, + COMPILE_NOFEAT, + COMPILE_COVERAGE, + COMPILE_TYPES +}; struct manifest { + char *dir; + /* The module name, ie. final element of dir name */ char *basename; struct ccan_file *info_file; + /* Linked off deps. */ + struct list_node list; + /* Where our final compiled output is */ + char *compiled[COMPILE_TYPES]; + struct list_head c_files; struct list_head h_files; @@ -15,35 +42,87 @@ struct manifest { 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 deps; + + /* From tests/license_exists.c */ + enum license license; }; -struct manifest *get_manifest(void); +/* Get the manifest for a given directory. */ +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; +}; + +/* 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; + /* Can we run this test? Return string explaining why, if not. */ + const char *(*can_run)(struct manifest *m); - /* If this returns non-NULL, it means the check failed. */ - void *(*check)(struct manifest *m); + /* Should we stop immediately if test fails? */ + bool compulsory; - /* The non-NULL return from check is passed to one of these: */ - - /* 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); + /* keep is set if you should keep the results. + * 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); /* 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: */ + /* Who depends on us? */ + struct list_head dependencies; + /* How many things do we (still) depend on? */ + unsigned int num_depends; + /* 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; }; /* Ask the user a yes/no question: the answer is NO if there's an error. */ @@ -86,48 +165,115 @@ struct line_info { 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[COMPILE_TYPES]; + + /* Filename containing output from valgrind. */ + char *valgrind_log; + + /* Leak output from valgrind. */ + char *leak_info; + + /* Simplified stream (lowercase letters and single spaces) */ + char *simplified; }; +/* 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, MAYBE_COMPILED, }; -/* Simple evaluator: if this pre-processor symbol is defined to this - * value, is this line compiled? (Other symbols assumed undefined) */ +/* 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, - unsigned int value); + const unsigned int *value, ...); + +/* Get token if it's equal to token. */ +bool get_token(const char **line, const char *token); +/* Talloc 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); +/* 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, ...); -/* 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); +/* 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); /* 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); + +/* 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; + +/* 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 */