X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=0c73716a714cfeafe80b0337490802dd610d73cc;hp=8c2ee0e8826b5ff0ba974f888f879a6953721e8e;hb=b55c668069884a1dd0078fb7598c7371ce6c98a9;hpb=078a975a68b7b9fe3d2ce45afdf7b6df1135557b diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index 8c2ee0e8..0c73716a 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -5,15 +5,14 @@ #include "../doc_extract.h" #define REGISTER_TEST(name, ...) extern struct ccanlint name -#include "generated-compulsory-tests" -#include "generated-normal-tests" -#undef REGISTER_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 { @@ -22,6 +21,11 @@ struct manifest { char *basename; struct ccan_file *info_file; + /* Linked off deps. */ + struct list_node list; + /* Where our final compiled output is */ + char *compiled; + struct list_head c_files; struct list_head h_files; @@ -37,11 +41,24 @@ struct manifest { struct list_head mangled_examples; /* From tests/check_depends_exist.c */ - struct list_head dep_dirs; + struct list_head deps; }; struct manifest *get_manifest(const void *ctx, const char *dir); +struct file_error { + struct list_node list; + struct ccan_file *file; + unsigned int line; +}; + +struct score { + bool pass; + unsigned int score, total; + char *error; + struct list_head per_file_errors; +}; + struct ccanlint { struct list_node list; @@ -51,27 +68,26 @@ struct ccanlint { /* Unique name of test */ const char *name; - /* Total score that this test is worth. */ - 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. - * keep is set if you should keep the results. - * If timeleft is set to 0, means it timed out. */ - void *(*check)(struct manifest *m, bool keep, unsigned int *timeleft); - - /* The non-NULL return from check is passed to one of these: */ + /* 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); - /* So, what did this get out of the total_score? (NULL means 0). */ - unsigned int (*score)(struct manifest *m, void *check_result); + /* Can we do something about it? (NULL if not) */ + void (*handle)(struct manifest *m, struct score *score); - /* Verbose description of what was wrong. */ - const char *(*describe)(struct manifest *m, void *check_result); + /* Options from _info. */ + char *options; + /* If not set, we'll give an error if they try to set options. */ + bool takes_options; - /* Can we do something about it? (NULL if not) */ - void (*handle)(struct manifest *m, void *check_result); + /* comma-separated list of dependency keys. */ + const char *needs; /* Internal use fields: */ /* Who depends on us? */ @@ -149,6 +165,9 @@ struct ccan_file { /* Compiled with coverage information. */ char *cov_compiled; + + /* Leak output from valgrind. */ + char *leak_info; }; /* A new ccan_file, with the given name (talloc_steal onto returned value). */ @@ -183,12 +202,9 @@ 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); +/* 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, ...); /* Normal tests. */ extern struct ccanlint trailing_whitespace; @@ -205,4 +221,10 @@ 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 char *compiler, *cflags; + +/* Contents of config.h (or NULL if not found) */ +extern const char *config_header; + #endif /* CCAN_LINT_H */