ccan/tools/ccanlint/compulsory_tests/has_info.c

#include <tools/ccanlint/ccanlint.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <limits.h>
#include <errno.h>
#include <stdlib.h>
#include <stdio.h>
#include <err.h>
#include <string.h>
#include <ccan/noerr/noerr.h>
#include <ccan/talloc/talloc.h>

static void *check_has_info(struct manifest *m,
			    bool keep,
			    unsigned int *timeleft)
{
	if (m->info_file)
		return NULL;
	return m;
}

static const char *describe_has_info(struct manifest *m, void *check_result)
{
	return "You have no _info file.\n\n"
	"The file _info contains the metadata for a ccan package: things\n"
	"like the dependencies, the documentation for the package as a whole\n"
	"and license information.\n";
}

static const char template[] = 
	"#include <string.h>\n"
	"#include \"config.h\"\n"
	"\n"
	"/**\n"
	" * %s - YOUR-ONE-LINE-DESCRIPTION-HERE\n"
	" *\n"
	" * This code ... YOUR-BRIEF-SUMMARY-HERE\n"
	" *\n"
	" * Example:\n"
	" *	FULLY-COMPILABLE-INDENTED-TRIVIAL-BUT-USEFUL-EXAMPLE-HERE\n"
	" */\n"
	"int main(int argc, char *argv[])\n"
	"{\n"
	"	/* Expect exactly one argument */\n"
	"	if (argc != 2)\n"
	"		return 1;\n"
	"\n"
	"	if (strcmp(argv[1], \"depends\") == 0) {\n"
	"		PRINTF-CCAN-PACKAGES-YOU-NEED-ONE-PER-LINE-IF-ANY\n"
	"		return 0;\n"
	"	}\n"
	"\n"
	"	return 1;\n"
	"}\n";

static void create_info_template(struct manifest *m, void *check_result)
{
	FILE *info;
	const char *filename;

	if (!ask("Should I create a template _info file for you?"))
		return;

	filename = talloc_asprintf(m, "%s/%s", m->dir, "_info");
	info = fopen(filename, "w");
	if (!info)
		err(1, "Trying to create a template _info in %s", filename);

	if (fprintf(info, template, m->basename) < 0) {
		unlink_noerr(filename);
		err(1, "Writing template into %s", filename);
	}
	fclose(info);
}

struct ccanlint has_info = {
	.key = "info",
	.name = "Module has _info file",
	.check = check_has_info,
	.describe = describe_has_info,
	.handle = create_info_template,
};

REGISTER_TEST(has_info, NULL);