X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=d73ffc6bade59bff35ec82a666d57afecededead;hp=40cb4195ffc65263ee2ef2bbb936fa3fd9e31707;hb=076877c266706ba432987195422a1e8653bd0c3b;hpb=7bb7cd58c2d9df126dd6072e5f3bec1eb4dc916b diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h index 40cb4195..d73ffc6b 100644 --- a/tools/ccanlint/ccanlint.h +++ b/tools/ccanlint/ccanlint.h @@ -4,7 +4,7 @@ #include #include "../doc_extract.h" -#define REGISTER_TEST(name, ...) +#define REGISTER_TEST(name, ...) extern struct ccanlint name /* 0 == Describe failed tests. 1 == Describe results for partial failures. @@ -44,18 +44,26 @@ struct manifest { struct list_head deps; }; +/* 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; }; @@ -86,7 +94,7 @@ struct ccanlint { /* If not set, we'll give an error if they try to set options. */ bool takes_options; - /* comma-separated list of dependency keys. */ + /* Space-separated list of dependency keys. */ const char *needs; /* Internal use fields: */ @@ -221,4 +229,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 */