[asterisk-commits] russell: trunk r72922 - /trunk/main/pbx.c

[SVN commits to the Asterisk project]

Author: russell
Date: Mon Jul  2 12:11:53 2007
New Revision: 72922

URL: http://svn.digium.com/view/asterisk?view=rev&rev=72922
Log:
Add "core dump funcdocs" CLI command

Modified:
    trunk/main/pbx.c

Modified: trunk/main/pbx.c
URL: http://svn.digium.com/view/asterisk/trunk/main/pbx.c?view=diff&rev=72922&r1=72921&r2=72922
==============================================================================
--- trunk/main/pbx.c (original)
+++ trunk/main/pbx.c Mon Jul  2 12:11:53 2007
@@ -3154,7 +3154,7 @@
 }
 
 #ifdef AST_DEVMODE
-static char *handle_core_dumpappdocs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
+static char *handle_core_dump_appdocs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 {
 	struct ast_app *app;
 	FILE *f;
@@ -3203,6 +3203,85 @@
 			break;
 	}
 	AST_RWLIST_UNLOCK(&apps);
+
+	fclose(f);
+
+	ast_cli(a->fd, "Documentation has been dumped to %s\n", fn);
+
+	return CLI_SUCCESS;
+}
+
+static void funcdocs_write_section(FILE *f, const char *name)
+{
+	char *section, *cur;
+
+	cur = section = alloca(strlen(name) * 2 + 1);
+
+	for (; *name; name++) {
+		if (*name == '_')
+			*cur++ = '\\';
+		*cur++ = *name;
+	}
+	*cur = '\0';
+
+	fprintf(f, "\\section{%s}\n", section);
+}
+
+static char *handle_core_dump_funcdocs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
+{
+	struct ast_custom_function *acf;
+	FILE *f;
+	char *funcname = NULL;
+	const char *fn = "/tmp/ast_funcdocs.tex";
+
+	switch (cmd) {
+	case CLI_INIT:
+		e->command = "core dump funcdocs";
+		e->usage =
+			"Usage: core dump funcdocs [function]\n"
+			"       Dump Application documentation to /tmp/ast_funcdocs.tex.\n";
+		return NULL;
+	case CLI_GENERATE:
+		return NULL;
+	}
+
+	if (a->argc == e->args + 1)
+		funcname = a->argv[e->args];
+	else if (a->argc != e->args)
+		return CLI_SHOWUSAGE;
+
+	if (!(f = fopen(fn, "w+"))) {
+		ast_cli(a->fd, "Unable to open %s for writing!\n", fn);
+		return CLI_FAILURE;
+	}
+
+	fprintf(f, "%% This file is automatically generated by the \"core dump funcdocs\" CLI command.  Any manual edits will be lost.\n");
+
+	AST_RWLIST_RDLOCK(&acf_root);
+	AST_RWLIST_TRAVERSE(&acf_root, acf, acflist) {
+		if (funcname && strcasecmp(acf->name, funcname))
+			continue;
+
+		funcdocs_write_section(f, acf->name);
+
+		fprintf(f, "\\subsection{Syntax}\n"
+				"\\begin{verbatim}\n"
+				"%s\n"
+				"\\end{verbatim}\n"
+				"\\subsection{Synopsis}\n"
+				"\\begin{verbatim}\n"
+				"%s\n"
+				"\\end{verbatim}\n"
+				"\\subsection{Description}\n"
+				"\\begin{verbatim}\n"
+				"%s\n"
+				"\\end{verbatim}\n\n\n", 
+				acf->syntax, acf->synopsis, acf->desc);
+
+		if (funcname)
+			break;
+	}
+	AST_RWLIST_UNLOCK(&acf_root);
 
 	fclose(f);
 
@@ -3879,7 +3958,8 @@
 	show_application_help, complete_show_application },
 
 #ifdef AST_DEVMODE
-	NEW_CLI(handle_core_dumpappdocs, "Dump application documentation in LaTeX format"),
+	NEW_CLI(handle_core_dump_appdocs, "Dump application documentation in LaTeX format"),
+	NEW_CLI(handle_core_dump_funcdocs, "Dump function documentation in LaTeX format"),
 #endif
 
 	{ { "core", "set", "global", NULL },