1 #include <tools/ccanlint/ccanlint.h>
2 #include <tools/tools.h>
3 #include <ccan/talloc/talloc.h>
4 #include <ccan/str/str.h>
17 /* Creates and adds an example file. */
18 static char *add_example(struct manifest *m, struct ccan_file *source,
20 struct doc_section *example)
27 name = maybe_temp_file(m, ".c", keep,
28 talloc_asprintf(m, "%s/example-%s-%s",
33 f = new_ccan_file(m, talloc_dirname(m, name), talloc_basename(m, name));
34 talloc_steal(f, name);
35 list_add(&m->examples, &f->list);
37 fd = open(f->fullname, O_WRONLY | O_CREAT | O_EXCL, 0600);
39 return talloc_asprintf(m, "Creating temporary file %s: %s",
40 f->fullname, strerror(errno));
42 for (i = 0; i < example->num_lines; i++) {
43 if (write(fd, example->lines[i], strlen(example->lines[i]))
44 != strlen(example->lines[i])
45 || write(fd, "\n", 1) != 1) {
47 return "Failure writing to temporary file";
54 /* FIXME: We should have one example per function in header. */
56 bool info_example, header_example;
60 static void *extract_examples(struct manifest *m,
62 unsigned int *timeleft)
65 struct doc_section *d;
66 struct score *score = talloc(m, struct score);
68 score->info_example = score->header_example = false;
71 list_for_each(get_ccan_file_docs(m->info_file), d, list) {
72 if (streq(d->type, "example")) {
73 score->error = add_example(m, m->info_file, keep, d);;
76 score->info_example = true;
80 /* Check main header. */
81 list_for_each(&m->h_files, f, list) {
82 if (!strstarts(f->name, m->basename)
83 || strlen(f->name) != strlen(m->basename) + 2)
86 list_for_each(get_ccan_file_docs(f), d, list) {
87 if (streq(d->type, "example")) {
88 score->error = add_example(m, f, keep, d);
91 score->header_example = true;
98 static unsigned int score_examples(struct manifest *m, void *check_result)
100 struct score *score = check_result;
105 total += score->info_example;
106 total += score->header_example;
110 static const char *describe_examples(struct manifest *m,
113 struct score *score = check_result;
114 char *descrip = NULL;
119 if (!score->info_example)
120 descrip = talloc_asprintf(score,
121 "Your _info file has no module example.\n\n"
122 "There should be an Example: section of the _info documentation\n"
123 "which provides a concise toy program which uses your module\n");
125 if (!score->header_example)
126 descrip = talloc_asprintf(score,
127 "%sMain header file file has no examples\n\n"
128 "There should be an Example: section for each public function\n"
129 "demonstrating its use\n", descrip ? descrip : "");
134 struct ccanlint has_examples = {
135 .key = "has-examples",
136 .name = "_info and header files have examples",
137 .score = score_examples,
138 .check = extract_examples,
139 .describe = describe_examples,
143 REGISTER_TEST(has_examples, &has_info, NULL);