#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /* Creates and adds an example file. */ static char *add_example(struct manifest *m, struct ccan_file *source, bool keep, struct doc_section *example) { char *name; unsigned int i; int fd; struct ccan_file *f; name = talloc_asprintf(m, "%s/example-%s-%s.c", talloc_dirname(m, source->fullname), source->name, example->function); /* example->function == 'struct foo' */ while (strchr(name, ' ')) *strchr(name, ' ') = '_'; name = maybe_temp_file(m, ".c", keep, name); f = new_ccan_file(m, talloc_dirname(m, name), talloc_basename(m, name)); talloc_steal(f, name); list_add_tail(&m->examples, &f->list); fd = open(f->fullname, O_WRONLY | O_CREAT | O_EXCL, 0600); if (fd < 0) return talloc_asprintf(m, "Creating temporary file %s: %s", f->fullname, strerror(errno)); for (i = 0; i < example->num_lines; i++) { if (write(fd, example->lines[i], strlen(example->lines[i])) != strlen(example->lines[i]) || write(fd, "\n", 1) != 1) { close(fd); return "Failure writing to temporary file"; } } close(fd); return NULL; } /* FIXME: We should have one example per function in header. */ static void extract_examples(struct manifest *m, bool keep, unsigned int *timeleft, struct score *score) { struct ccan_file *f; struct doc_section *d; bool have_info_example = false, have_header_example = false; score->total = 2; list_for_each(get_ccan_file_docs(m->info_file), d, list) { if (streq(d->type, "example")) { score->error = add_example(m, m->info_file, keep, d); if (score->error) return; have_info_example = true; } } /* Check main header. */ list_for_each(&m->h_files, f, list) { if (!strstarts(f->name, m->basename) || strlen(f->name) != strlen(m->basename) + 2) continue; list_for_each(get_ccan_file_docs(f), d, list) { if (streq(d->type, "example")) { score->error = add_example(m, f, keep, d); if (score->error) return; have_header_example = true; } } } if (!have_info_example && !have_header_example) { score->error = "You don't have any Example: sections"; score->score = 0; } else if (!have_info_example) { score->error = "You don't have an Example: section in _info"; score->score = 1; score->pass = true; } else if (!have_header_example) { score->error = talloc_asprintf(score, "You don't have an Example: section in %s.h", m->basename); score->score = 1; score->pass = true; } else { score->score = score->total; score->pass = true; } } struct ccanlint has_examples = { .key = "has-examples", .name = "_info and header files have examples", .check = extract_examples, }; REGISTER_TEST(has_examples, &has_info, NULL);