X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=b9965f75a5852364ef923ee98ca3b2e792745ceb;hp=f5f7b51d8bbb89078d83fa82aa356c305856da70;hb=8de1e8a6faef77773cbf8ed237eb4e330143d2f2;hpb=a791eb1e4c369104f90c543fe9ebafcae113ead8;ds=sidebyside diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index f5f7b51d..b9965f75 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -1,15 +1,11 @@ #ifndef CCAN_LINT_H #define CCAN_LINT_H +#include "config.h" #include #include #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. @@ -20,12 +16,32 @@ 4 == Describe every action. */ extern int verbose; +enum license { + LICENSE_LGPLv2_PLUS, + LICENSE_LGPLv2, + LICENSE_LGPLv3, + LICENSE_LGPL, + LICENSE_GPLv2_PLUS, + LICENSE_GPLv2, + LICENSE_GPLv3, + LICENSE_GPL, + LICENSE_BSD, + LICENSE_MIT, + LICENSE_PUBLIC_DOMAIN, + LICENSE_UNKNOWN +}; + 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; + struct list_head c_files; struct list_head h_files; @@ -41,22 +57,32 @@ struct manifest { struct list_head mangled_examples; /* From tests/check_depends_exist.c */ - struct list_head dep_dirs; + struct list_head deps; + + /* From tests/license_exists.c */ + enum license license; }; +/* 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; /* 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; }; @@ -87,6 +113,9 @@ struct ccanlint { /* 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; @@ -163,6 +192,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). */ @@ -197,9 +229,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); -/* 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, ...); /* Normal tests. */ extern struct ccanlint trailing_whitespace; @@ -216,4 +248,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 const char *compiler, *cflags; + +/* Contents of config.h (or NULL if not found) */ +extern const char *config_header; + #endif /* CCAN_LINT_H */