/*!
\brief Print module usage description in HTML format.
*/
void G__usage_html(void)
{
struct Option *opt;
struct Flag *flag;
const char *type;
int new_prompt = 0;
new_prompt = G__uses_new_gisprompt();
if (!st->pgm_name) /* v.dave && r.michael */
st->pgm_name = G_program_name();
if (!st->pgm_name)
st->pgm_name = "??";
fprintf(stdout,
"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\">\n");
fprintf(stdout, "<html>\n<head>\n");
fprintf(stdout, "<title>GRASS GIS manual: %s</title>\n", st->pgm_name);
fprintf(stdout,
"<meta http-equiv=\"Content-Type\" content=\"text/html; charset=iso-8859-1\">\n");
fprintf(stdout,
"<link rel=\"stylesheet\" href=\"grassdocs.css\" type=\"text/css\">\n");
fprintf(stdout, "</head>\n");
fprintf(stdout, "<body bgcolor=\"white\">\n\n");
fprintf(stdout,
"<img src=\"grass_logo.png\" alt=\"GRASS logo\"><hr align=center size=6 noshade>\n\n");
fprintf(stdout, "<h2>%s</h2>\n", _("NAME"));
fprintf(stdout, "<em><b>%s</b></em> ", st->pgm_name);
if (st->module_info.label || st->module_info.description)
fprintf(stdout, " - ");
if (st->module_info.label)
fprintf(stdout, "%s<BR>\n", st->module_info.label);
if (st->module_info.description)
fprintf(stdout, "%s\n", st->module_info.description);
fprintf(stdout, "<h2>%s</h2>\n", _("KEYWORDS"));
if (st->module_info.keywords) {
G__print_keywords(stdout, NULL);
fprintf(stdout, "\n");
}
fprintf(stdout, "<h2>%s</h2>\n", _("SYNOPSIS"));
fprintf(stdout, "<b>%s</b><br>\n", st->pgm_name);
fprintf(stdout, "<b>%s help</b><br>\n", st->pgm_name);
fprintf(stdout, "<b>%s</b>", st->pgm_name);
/* print short version first */
if (st->n_flags) {
flag = &st->first_flag;
fprintf(stdout, " [-<b>");
while (flag != NULL) {
fprintf(stdout, "%c", flag->key);
flag = flag->next_flag;
}
fprintf(stdout, "</b>] ");
}
else
fprintf(stdout, " ");
if (st->n_opts) {
opt = &st->first_option;
while (opt != NULL) {
if (opt->key_desc != NULL)
type = opt->key_desc;
else
switch (opt->type) {
case TYPE_INTEGER:
type = "integer";
break;
case TYPE_DOUBLE:
type = "float";
break;
case TYPE_STRING:
type = "string";
break;
default:
type = "string";
break;
}
if (!opt->required)
fprintf(stdout, " [");
fprintf(stdout, "<b>%s</b>=<em>%s</em>", opt->key, type);
if (opt->multiple) {
fprintf(stdout, "[,<i>%s</i>,...]", type);
}
if (!opt->required)
fprintf(stdout, "] ");
opt = opt->next_opt;
fprintf(stdout, " ");
}
}
if (new_prompt)
fprintf(stdout, " [--<b>overwrite</b>] ");
fprintf(stdout, " [--<b>verbose</b>] ");
fprintf(stdout, " [--<b>quiet</b>] ");
fprintf(stdout, "\n");
/* now long version */
fprintf(stdout, "\n");
if (st->n_flags || new_prompt) {
flag = &st->first_flag;
fprintf(stdout, "<h3>%s:</h3>\n", _("Flags"));
fprintf(stdout, "<DL>\n");
while (st->n_flags && flag != NULL) {
fprintf(stdout, "<DT><b>-%c</b></DT>\n", flag->key);
if (flag->label) {
fprintf(stdout, "<DD>");
fprintf(stdout, "%s", flag->label);
fprintf(stdout, "</DD>\n");
}
if (flag->description) {
fprintf(stdout, "<DD>");
fprintf(stdout, "%s", flag->description);
fprintf(stdout, "</DD>\n");
}
flag = flag->next_flag;
fprintf(stdout, "\n");
}
if (new_prompt) {
fprintf(stdout, "<DT><b>--overwrite</b></DT>\n");
fprintf(stdout, "<DD>%s</DD>\n",
_("Allow output files to overwrite existing files"));
}
fprintf(stdout, "<DT><b>--verbose</b></DT>\n");
fprintf(stdout, "<DD>%s</DD>\n", _("Verbose module output"));
fprintf(stdout, "<DT><b>--quiet</b></DT>\n");
fprintf(stdout, "<DD>%s</DD>\n", _("Quiet module output"));
fprintf(stdout, "</DL>\n");
}
fprintf(stdout, "\n");
if (st->n_opts) {
opt = &st->first_option;
fprintf(stdout, "<h3>%s:</h3>\n", _("Parameters"));
fprintf(stdout, "<DL>\n");
while (opt != NULL) {
/* TODO: make this a enumeration type? */
if (opt->key_desc != NULL)
type = opt->key_desc;
else
switch (opt->type) {
case TYPE_INTEGER:
type = "integer";
break;
case TYPE_DOUBLE:
type = "float";
break;
case TYPE_STRING:
type = "string";
break;
default:
type = "string";
break;
}
fprintf(stdout, "<DT><b>%s</b>=<em>%s", opt->key, type);
if (opt->multiple) {
fprintf(stdout, "[,<i>%s</i>,...]", type);
}
fprintf(stdout, "</em></DT>\n");
if (opt->label) {
fprintf(stdout, "<DD>");
print_escaped_for_html(stdout, opt->label);
fprintf(stdout, "</DD>\n");
}
if (opt->description) {
fprintf(stdout, "<DD>");
print_escaped_for_html(stdout, opt->description);
fprintf(stdout, "</DD>\n");
}
if (opt->options) {
fprintf(stdout, "<DD>%s: <em>", _("Options"));
print_escaped_for_html(stdout, opt->options);
fprintf(stdout, "</em></DD>\n");
}
if (opt->def) {
fprintf(stdout, "<DD>%s: <em>", _("Default"));
print_escaped_for_html(stdout, opt->def);
fprintf(stdout, "</em></DD>\n");
}
if (opt->descs) {
int i = 0;
while (opt->opts[i]) {
if (opt->descs[i]) {
fprintf(stdout, "<DD><b>");
print_escaped_for_html(stdout, opt->opts[i]);
fprintf(stdout, "</b>: ");
print_escaped_for_html(stdout, opt->descs[i]);
fprintf(stdout, "</DD>\n");
}
i++;
}
}
opt = opt->next_opt;
fprintf(stdout, "\n");
}
fprintf(stdout, "</DL>\n");
}
fprintf(stdout, "</body>\n</html>\n");
}
void G__wps_print_process_description(void)
{
struct Option *opt;
struct Flag *flag;
char *type;
char *s, *top;
const char *value = NULL;
int i;
char *encoding;
int new_prompt = 0;
int store = 1;
int status = 1;
const char *identifier = NULL;
const char *title = NULL;
const char *abstract = NULL;
const char **keywords = NULL;
int data_type, is_input, is_output;
int num_raster_inputs = 0, num_raster_outputs = 0;
int num_vector_inputs = 0, num_vector_outputs = 0;
int num_strds_inputs = 0, num_strds_outputs = 0;
int num_stvds_inputs = 0, num_stvds_outputs = 0;
int min = 0, max = 0;
int num_keywords = 0;
int found_output = 0;
int is_tuple; /* Checks the key_descr for comma separated values */
int num_tuples; /* Counts the "," in key_descr */
new_prompt = G__uses_new_gisprompt();
/* gettext converts strings to encoding returned by nl_langinfo(CODESET) */
#if defined(HAVE_LANGINFO_H)
encoding = nl_langinfo(CODESET);
if (!encoding || strlen(encoding) == 0) {
encoding = "UTF-8";
}
#elif defined(__MINGW32__) && defined(USE_NLS)
encoding = locale_charset();
if (!encoding || strlen(encoding) == 0) {
encoding = "UTF-8";
}
#else
encoding = "UTF-8";
#endif
if (!st->pgm_name)
st->pgm_name = G_program_name();
if (!st->pgm_name)
st->pgm_name = "??";
/* the identifier of the process is the module name */
identifier = st->pgm_name;
if (st->module_info.description) {
title = st->module_info.description;
abstract = st->module_info.description;
}
if (st->module_info.keywords) {
keywords = st->module_info.keywords;
num_keywords = st->n_keys;
}
wps_print_process_descriptions_begin();
/* store and status are supported as default. The WPS server should change this if necessary */
wps_print_process_description_begin(store, status, identifier, title, abstract, keywords, num_keywords);
wps_print_data_inputs_begin();
/* Print the bounding box element with all the coordinate reference systems, which are supported by grass*/
/* Currently Disabled! A list of all proj4 supported EPSG coordinate reference systems must be implemented*/
if(1 == 0)
wps_print_bounding_box_data();
/* We parse only the inputs at the beginning */
if (st->n_opts) {
opt = &st->first_option;
while (opt != NULL) {
identifier = NULL;
title = NULL;
abstract = NULL;
keywords = NULL;
num_keywords = 0;
value = NULL;
is_input = 1;
is_output = 0;
is_tuple = 0;
num_tuples = 0;
data_type = TYPE_OTHER;
/* Check the gisprompt */
if (opt->gisprompt) {
const char *atts[] = { "age", "element", "prompt", NULL };
top = G_calloc(strlen(opt->gisprompt) + 1, 1);
strcpy(top, opt->gisprompt);
s = strtok(top, ",");
for (i = 0; s != NULL && atts[i] != NULL; i++) {
char *token = G_store(s);
/* we print only input parameter, sort out the output parameter */
if(strcmp(token, "new") == 0) {
is_input = 0;
is_output = 1;
}
if(strcmp(token, "raster") == 0)
{
data_type = TYPE_RASTER;
/* Count the raster inputs and outputs for default option creation */
if(is_input == 1)
num_raster_inputs++;
if(is_output == 1)
num_raster_outputs++;
}
if(strcmp(token, "vector") == 0)
{
data_type = TYPE_VECTOR;
if(is_input == 1)
num_vector_inputs++;
if(is_output == 1)
num_vector_outputs++;
}
/* Modules may have different types of space time datasets as inputs */
if(strcmp(token, "stds") == 0)
{
data_type = TYPE_STDS;
}
if(strcmp(token, "strds") == 0)
{
data_type = TYPE_STRDS;
if(is_input == 1)
num_strds_inputs++;
if(is_output == 1)
num_strds_outputs++;
}
if(strcmp(token, "stvds") == 0)
{
data_type = TYPE_STVDS;
if(is_input == 1)
num_stvds_inputs++;
if(is_output == 1)
num_stvds_outputs++;
}
if(strcmp(token, "file") == 0)
{
data_type = TYPE_PLAIN_TEXT;
}
s = strtok(NULL, ",");
G_free(token);
}
G_free(top);
}
/* Check the key description */
if (opt->key_desc) {
top = G_calloc(strlen(opt->key_desc) + 1, 1);
strcpy(top, opt->key_desc);
s = strtok(top, ",");
/* Count comma's */
for (i = 0; s != NULL; i++) {
num_tuples++;
s = strtok(NULL, ",");
}
if(num_tuples > 1)
is_tuple = 1;
G_free(top);
}
/* We have an input option */
if(is_input == 1)
{
switch (opt->type) {
case TYPE_INTEGER:
type = "integer";
break;
case TYPE_DOUBLE:
type = "float";
break;
case TYPE_STRING:
type = "string";
break;
default:
type = "string";
break;
}
identifier = opt->key;
if(opt->required == YES) {
if(is_tuple)
min = num_tuples;
else
min = 1;
} else {
min = 0;
}
if(opt->multiple == YES) {
max = 1024;
} else {
if(is_tuple)
max = num_tuples;
else
max = 1;
}
if(opt->label) {
title = opt->label;
}
if (opt->description) {
if(!opt->label)
title = opt->description;
else
abstract = opt->description;
}
if (opt->def) {
value = opt->def;
}
if (opt->options) {
/* TODO:
* add something like
* <range min="xxx" max="xxx"/>
* to <values> */
i = 0;
while (opt->opts[i]) {
i++;
}
keywords = opt->opts;
num_keywords = i;
}
if(data_type == TYPE_RASTER || data_type == TYPE_VECTOR ||
data_type == TYPE_STRDS || data_type == TYPE_STVDS ||
data_type == TYPE_STDS || data_type == TYPE_PLAIN_TEXT)
{
/* 2048 is the maximum size of the map in mega bytes */
wps_print_complex_input(min, max, identifier, title, abstract, 2048, data_type);
}
else
{
/* The keyword array is missused for options, type means the type of the value (integer, float ... )*/
wps_print_literal_input_output(WPS_INPUT, min, max, identifier, title,
abstract, type, 0, keywords, num_keywords, value, TYPE_OTHER);
}
}
opt = opt->next_opt;
}
}
/* Flags are always input options and can be false or true (boolean) */
if (st->n_flags) {
flag = &st->first_flag;
while (flag != NULL) {
/* The identifier is the flag "-x" */
char* ident = (char*)G_calloc(3, sizeof(char));
ident[0] = '-';
ident[1] = flag->key;
ident[2] = '\0';
title = NULL;
abstract = NULL;
if (flag->description) {
title = flag->description;
abstract = flag->description;
}
const char *val[] = {"true","false"};
wps_print_literal_input_output(WPS_INPUT, 0, 1, ident, title, NULL, "boolean", 0, val, 2, "false", TYPE_OTHER);
flag = flag->next_flag;
}
}
/* We have two default options, which define the resolution of the created mapset */
if(num_raster_inputs > 0 || num_raster_outputs > 0 || num_strds_inputs > 0 || num_strds_outputs > 0) {
wps_print_literal_input_output(WPS_INPUT, 0, 1, "grass_resolution_ns", "Resolution of the mapset in north-south direction in meters or degrees",
"This parameter defines the north-south resolution of the mapset in meter or degrees, which should be used to process the input and output raster data. To enable this setting, you need to specify north-south and east-west resolution.",
"float", 1, NULL, 0, NULL, TYPE_OTHER);
wps_print_literal_input_output(WPS_INPUT, 0, 1, "grass_resolution_ew", "Resolution of the mapset in east-west direction in meters or degrees",
"This parameter defines the east-west resolution of the mapset in meters or degrees, which should be used to process the input and output raster data. To enable this setting, you need to specify north-south and east-west resolution.",
"float", 1, NULL, 0, NULL, TYPE_OTHER);
}
/* In case multi band raster maps should be imported, the band number must be provided */
if(num_raster_inputs > 0)
wps_print_literal_input_output(WPS_INPUT, 0, 1, "grass_band_number", "Band to select for processing (default is all bands)",
"This parameter defines band number of the input raster files which should be processed. As default all bands are processed and used as single and multiple inputs for raster modules.",
"integer", 0, NULL, 0, NULL, TYPE_OTHER);
/* End of inputs */
wps_print_data_inputs_end();
/* Start of the outputs */
wps_print_process_outputs_begin();
found_output = 0;
/*parse the output. only raster maps, vector maps, space time raster and vector datasets plus stdout are supported */
if (st->n_opts) {
opt = &st->first_option;
while (opt != NULL) {
identifier = NULL;
title = NULL;
abstract = NULL;
value = NULL;
is_output = 0;
data_type = TYPE_OTHER;
if (opt->gisprompt) {
const char *atts[] = { "age", "element", "prompt", NULL };
top = G_calloc(strlen(opt->gisprompt) + 1, 1);
strcpy(top, opt->gisprompt);
s = strtok(top, ",");
for (i = 0; s != NULL && atts[i] != NULL; i++) {
char *token = G_store(s);
/* we print only the output parameter */
if(strcmp(token, "new") == 0)
is_output = 1;
if(strcmp(token, "raster") == 0)
{
data_type = TYPE_RASTER;
}
if(strcmp(token, "vector") == 0)
{
data_type = TYPE_VECTOR;
}
if(strcmp(token, "stds") == 0)
{
data_type = TYPE_STDS;
}
if(strcmp(token, "strds") == 0)
{
data_type = TYPE_STRDS;
}
if(strcmp(token, "stvds") == 0)
{
data_type = TYPE_STVDS;
}
if(strcmp(token, "file") == 0)
{
data_type = TYPE_PLAIN_TEXT;
}
s = strtok(NULL, ",");
G_free(token);
}
G_free(top);
}
/* Only single module output is supported!! */
if(is_output == 1)
{
if(opt->multiple == YES)
G_warning(_("Multiple outputs are not supported by WPS 1.0.0"));
identifier = opt->key;
if(opt->label) {
title = opt->label;
}
if (opt->description) {
if(!opt->label)
title = opt->description;
else
abstract = opt->description;
}
if(data_type == TYPE_RASTER || data_type == TYPE_VECTOR ||
data_type == TYPE_STRDS || data_type == TYPE_STVDS ||
data_type == TYPE_STDS || data_type == TYPE_PLAIN_TEXT) {
wps_print_complex_output(identifier, title, abstract, data_type);
found_output = 1;
}
}
opt = opt->next_opt;
}
/* we assume the computatuon output on stdout, if no raster/vector output was found*/
if(found_output == 0)
wps_print_complex_output("stdout", "Module output on stdout", "The output of the module written to stdout", TYPE_PLAIN_TEXT);
}
wps_print_process_outputs_end();
wps_print_process_description_end();
wps_print_process_descriptions_end();
}
/*!
\brief Print module usage description in HTML format.
*/
void G__usage_html(void)
{
struct Option *opt;
struct Flag *flag;
const char *type;
int new_prompt = 0;
new_prompt = G__uses_new_gisprompt();
if (!st->pgm_name) /* v.dave && r.michael */
st->pgm_name = G_program_name();
if (!st->pgm_name)
st->pgm_name = "??";
fprintf(stdout,
"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\">\n");
fprintf(stdout, "<html>\n<head>\n");
fprintf(stdout, "<title>GRASS GIS manual: %s</title>\n", st->pgm_name);
fprintf(stdout,
"<meta http-equiv=\"Content-Type\" content=\"text/html; charset=iso-8859-1\">\n");
fprintf(stdout,
"<link rel=\"stylesheet\" href=\"grassdocs.css\" type=\"text/css\">\n");
fprintf(stdout, "</head>\n");
fprintf(stdout, "<body bgcolor=\"white\">\n");
fprintf(stdout, "<div id=\"container\">\n\n");
fprintf(stdout,
"<a href=\"index.html\"><img src=\"grass_logo.png\" alt=\"GRASS logo\"></a>\n");
fprintf(stdout, "<hr class=\"header\">\n\n");
fprintf(stdout, "<h2>%s</h2>\n", _("NAME"));
fprintf(stdout, "<em><b>%s</b></em> ", st->pgm_name);
if (st->module_info.label || st->module_info.description)
fprintf(stdout, " - ");
if (st->module_info.label)
fprintf(stdout, "%s<BR>\n", st->module_info.label);
if (st->module_info.description)
fprintf(stdout, "%s\n", st->module_info.description);
fprintf(stdout, "<h2>%s</h2>\n", _("KEYWORDS"));
if (st->module_info.keywords) {
G__print_keywords(stdout, print_escaped_for_html_keywords);
fprintf(stdout, "\n");
}
fprintf(stdout, "<h2>%s</h2>\n", _("SYNOPSIS"));
fprintf(stdout, "<div id=\"name\"><b>%s</b><br></div>\n", st->pgm_name);
fprintf(stdout, "<b>%s --help</b><br>\n", st->pgm_name);
fprintf(stdout, "<div id=\"synopsis\"><b>%s</b>", st->pgm_name);
/* print short version first */
if (st->n_flags) {
flag = &st->first_flag;
fprintf(stdout, " [-<b>");
while (flag != NULL) {
fprintf(stdout, "%c", flag->key);
flag = flag->next_flag;
}
fprintf(stdout, "</b>] ");
}
else
fprintf(stdout, " ");
if (st->n_opts) {
opt = &st->first_option;
while (opt != NULL) {
if (opt->key_desc != NULL)
type = opt->key_desc;
else
switch (opt->type) {
case TYPE_INTEGER:
type = "integer";
break;
case TYPE_DOUBLE:
type = "float";
break;
case TYPE_STRING:
type = "string";
break;
default:
type = "string";
break;
}
if (!opt->required)
fprintf(stdout, " [");
fprintf(stdout, "<b>%s</b>=<em>%s</em>", opt->key, type);
if (opt->multiple) {
fprintf(stdout, "[,<i>%s</i>,...]", type);
}
if (!opt->required)
fprintf(stdout, "] ");
opt = opt->next_opt;
fprintf(stdout, " ");
}
}
if (new_prompt)
fprintf(stdout, " [--<b>overwrite</b>] ");
fprintf(stdout, " [--<b>help</b>] ");
fprintf(stdout, " [--<b>verbose</b>] ");
fprintf(stdout, " [--<b>quiet</b>] ");
fprintf(stdout, " [--<b>ui</b>] ");
fprintf(stdout, "\n</div>\n");
/* now long version */
fprintf(stdout, "\n");
fprintf(stdout, "<div id=\"flags\">\n");
fprintf(stdout, "<h3>%s:</h3>\n", _("Flags"));
fprintf(stdout, "<dl>\n");
if (st->n_flags) {
flag = &st->first_flag;
while (st->n_flags && flag != NULL) {
fprintf(stdout, "<dt><b>-%c</b></dt>\n", flag->key);
if (flag->label) {
fprintf(stdout, "<dd>");
fprintf(stdout, "%s", flag->label);
fprintf(stdout, "</dd>\n");
}
if (flag->description) {
fprintf(stdout, "<dd>");
fprintf(stdout, "%s", flag->description);
fprintf(stdout, "</dd>\n");
}
flag = flag->next_flag;
fprintf(stdout, "\n");
}
}
if (new_prompt) {
fprintf(stdout, "<dt><b>--overwrite</b></dt>\n");
fprintf(stdout, "<dd>%s</dd>\n",
_("Allow output files to overwrite existing files"));
}
/* these flags are always available */
fprintf(stdout, "<dt><b>--help</b></dt>\n");
fprintf(stdout, "<dd>%s</dd>\n", _("Print usage summary"));
fprintf(stdout, "<dt><b>--verbose</b></dt>\n");
fprintf(stdout, "<dd>%s</dd>\n", _("Verbose module output"));
fprintf(stdout, "<dt><b>--quiet</b></dt>\n");
fprintf(stdout, "<dd>%s</dd>\n", _("Quiet module output"));
fprintf(stdout, "<dt><b>--ui</b></dt>\n");
fprintf(stdout, "<dd>%s</dd>\n", _("Force launching GUI dialog"));
fprintf(stdout, "</dl>\n");
fprintf(stdout, "</div>\n");
fprintf(stdout, "\n");
fprintf(stdout, "<div id=\"parameters\">\n");
if (st->n_opts) {
opt = &st->first_option;
fprintf(stdout, "<h3>%s:</h3>\n", _("Parameters"));
fprintf(stdout, "<dl>\n");
while (opt != NULL) {
/* TODO: make this a enumeration type? */
if (opt->key_desc != NULL)
type = opt->key_desc;
else
switch (opt->type) {
case TYPE_INTEGER:
type = "integer";
break;
case TYPE_DOUBLE:
type = "float";
break;
case TYPE_STRING:
type = "string";
break;
default:
type = "string";
break;
}
fprintf(stdout, "<dt><b>%s</b>=<em>%s", opt->key, type);
if (opt->multiple) {
fprintf(stdout, "[,<i>%s</i>,...]", type);
}
fprintf(stdout, "</em>");
if (opt->required) {
fprintf(stdout, " <b>[required]</b>");
}
fprintf(stdout, "</dt>\n");
if (opt->label) {
fprintf(stdout, "<dd>");
print_escaped_for_html(stdout, opt->label);
fprintf(stdout, "</dd>\n");
}
if (opt->description) {
fprintf(stdout, "<dd>");
print_escaped_for_html(stdout, opt->description);
fprintf(stdout, "</dd>\n");
}
if (opt->options) {
fprintf(stdout, "<dd>%s: <em>", _("Options"));
print_escaped_for_html_options(stdout, opt->options);
fprintf(stdout, "</em></dd>\n");
}
if (opt->def) {
fprintf(stdout, "<dd>%s: <em>", _("Default"));
print_escaped_for_html(stdout, opt->def);
fprintf(stdout, "</em></dd>\n");
}
if (opt->descs) {
int i = 0;
while (opt->opts[i]) {
if (opt->descs[i]) {
fprintf(stdout, "<dd><b>");
if (opt->gisprompt) {
char *thumbnails = NULL;
if (strcmp(opt->gisprompt,
"old,colortable,colortable") == 0)
thumbnails = "colortables";
else if (strcmp(opt->gisprompt,
"old,barscale,barscale") == 0)
thumbnails = "barscales";
if (thumbnails)
fprintf(stdout, "<img width=\"80\" height=\"12\" "
"src=\"%s/%s.png\" alt=\"%s\">",
thumbnails, opt->opts[i], opt->opts[i]);
}
print_escaped_for_html(stdout, opt->opts[i]);
fprintf(stdout, "</b>: ");
print_escaped_for_html(stdout, opt->descs[i]);
fprintf(stdout, "</dd>\n");
}
i++;
}
}
opt = opt->next_opt;
fprintf(stdout, "\n");
}
fprintf(stdout, "</dl>\n");
}
fprintf(stdout, "</div>\n");
fprintf(stdout, "</body>\n</html>\n");
}
/*!
\brief Print module usage description in XML format.
*/
void G__usage_xml(void)
{
struct Option *opt;
struct Flag *flag;
char *type;
char *s, *top;
int i;
const char *encoding;
int new_prompt = 0;
new_prompt = G__uses_new_gisprompt();
/* gettext converts strings to encoding returned by nl_langinfo(CODESET) */
#if defined(HAVE_LANGINFO_H)
encoding = nl_langinfo(CODESET);
#elif defined(__MINGW32__) && defined(USE_NLS)
encoding = locale_charset();
#endif
if (!encoding || strlen(encoding) == 0)
encoding = "UTF-8";
#ifdef HAVE_ICONV_H
src_enc = encoding;
encoding = "UTF-8";
#endif
if (!st->pgm_name) /* v.dave && r.michael */
st->pgm_name = G_program_name();
if (!st->pgm_name)
st->pgm_name = "??";
fprintf(stdout, "<?xml version=\"1.0\" encoding=\"%s\"?>\n", encoding);
fprintf(stdout, "<!DOCTYPE task SYSTEM \"grass-interface.dtd\">\n");
fprintf(stdout, "<task name=\"%s\">\n", st->pgm_name);
if (st->module_info.label) {
fprintf(stdout, "\t<label>\n\t\t");
print_escaped_for_xml(stdout, st->module_info.label);
fprintf(stdout, "\n\t</label>\n");
}
if (st->module_info.description) {
fprintf(stdout, "\t<description>\n\t\t");
print_escaped_for_xml(stdout, st->module_info.description);
fprintf(stdout, "\n\t</description>\n");
}
if (st->module_info.keywords) {
fprintf(stdout, "\t<keywords>\n\t\t");
G__print_keywords(stdout, print_escaped_for_xml);
fprintf(stdout, "\n\t</keywords>\n");
}
/***** Don't use parameter-groups for now. We'll reimplement this later
***** when we have a concept of several mutually exclusive option
***** groups
if (st->n_opts || st->n_flags)
fprintf(stdout, "\t<parameter-group>\n");
*****
*****
*****/
if (st->n_opts) {
opt = &st->first_option;
while (opt != NULL) {
/* TODO: make this a enumeration type? */
switch (opt->type) {
case TYPE_INTEGER:
type = "integer";
break;
case TYPE_DOUBLE:
type = "float";
break;
case TYPE_STRING:
type = "string";
break;
default:
type = "string";
break;
}
fprintf(stdout, "\t<parameter "
"name=\"%s\" "
"type=\"%s\" "
"required=\"%s\" "
"multiple=\"%s\">\n",
opt->key,
type,
opt->required == YES ? "yes" : "no",
opt->multiple == YES ? "yes" : "no");
if (opt->label) {
fprintf(stdout, "\t\t<label>\n\t\t\t");
print_escaped_for_xml(stdout, opt->label);
fprintf(stdout, "\n\t\t</label>\n");
}
if (opt->description) {
fprintf(stdout, "\t\t<description>\n\t\t\t");
print_escaped_for_xml(stdout, opt->description);
fprintf(stdout, "\n\t\t</description>\n");
}
if (opt->key_desc) {
fprintf(stdout, "\t\t<keydesc>\n");
top = G_calloc(strlen(opt->key_desc) + 1, 1);
strcpy(top, opt->key_desc);
s = strtok(top, ",");
for (i = 1; s != NULL; i++) {
fprintf(stdout, "\t\t\t<item order=\"%d\">", i);
print_escaped_for_xml(stdout, s);
fprintf(stdout, "</item>\n");
s = strtok(NULL, ",");
}
fprintf(stdout, "\t\t</keydesc>\n");
G_free(top);
}
if (opt->gisprompt) {
const char *atts[] = { "age", "element", "prompt", NULL };
top = G_calloc(strlen(opt->gisprompt) + 1, 1);
strcpy(top, opt->gisprompt);
s = strtok(top, ",");
fprintf(stdout, "\t\t<gisprompt ");
for (i = 0; s != NULL && atts[i] != NULL; i++) {
fprintf(stdout, "%s=\"%s\" ", atts[i], s);
s = strtok(NULL, ",");
}
fprintf(stdout, "/>\n");
G_free(top);
}
if (opt->def) {
fprintf(stdout, "\t\t<default>\n\t\t\t");
print_escaped_for_xml(stdout, opt->def);
fprintf(stdout, "\n\t\t</default>\n");
}
if (opt->options) {
/* TODO:
* add something like
* <range min="xxx" max="xxx"/>
* to <values> */
i = 0;
fprintf(stdout, "\t\t<values>\n");
while (opt->opts[i]) {
fprintf(stdout, "\t\t\t<value>\n");
fprintf(stdout, "\t\t\t\t<name>");
print_escaped_for_xml(stdout, opt->opts[i]);
fprintf(stdout, "</name>\n");
if (opt->descs && opt->opts[i] && opt->descs[i]) {
fprintf(stdout, "\t\t\t\t<description>");
print_escaped_for_xml(stdout, opt->descs[i]);
fprintf(stdout, "</description>\n");
}
fprintf(stdout, "\t\t\t</value>\n");
i++;
}
fprintf(stdout, "\t\t</values>\n");
}
if (opt->guisection) {
fprintf(stdout, "\t\t<guisection>\n\t\t\t");
print_escaped_for_xml(stdout, opt->guisection);
fprintf(stdout, "\n\t\t</guisection>\n");
}
if (opt->guidependency) {
fprintf(stdout, "\t\t<guidependency>\n\t\t\t");
print_escaped_for_xml(stdout, opt->guidependency);
fprintf(stdout, "\n\t\t</guidependency>\n");
}
/* TODO:
* - key_desc?
* - there surely are some more. which ones?
*/
opt = opt->next_opt;
fprintf(stdout, "\t</parameter>\n");
}
}
if (st->n_flags) {
flag = &st->first_flag;
while (flag != NULL) {
fprintf(stdout, "\t<flag name=\"%c\">\n", flag->key);
if (flag->label) {
fprintf(stdout, "\t\t<label>\n\t\t\t");
print_escaped_for_xml(stdout, flag->label);
fprintf(stdout, "\n\t\t</label>\n");
}
if (flag->suppress_required)
fprintf(stdout, "\t\t<suppress_required/>\n");
if (flag->description) {
fprintf(stdout, "\t\t<description>\n\t\t\t");
print_escaped_for_xml(stdout, flag->description);
fprintf(stdout, "\n\t\t</description>\n");
}
if (flag->guisection) {
fprintf(stdout, " \t\t<guisection>\n\t\t\t");
print_escaped_for_xml(stdout, flag->guisection);
fprintf(stdout, "\n\t\t</guisection>\n");
}
flag = flag->next_flag;
fprintf(stdout, "\t</flag>\n");
}
}
/***** Don't use parameter-groups for now. We'll reimplement this later
***** when we have a concept of several mutually exclusive option
***** groups
if (st->n_opts || st->n_flags)
fprintf(stdout, "\t</parameter-group>\n");
*****
*****
*****/
if (new_prompt) {
/* overwrite */
fprintf(stdout, "\t<flag name=\"%s\">\n", "overwrite");
fprintf(stdout, "\t\t<description>\n\t\t\t");
print_escaped_for_xml(stdout,
_("Allow output files to overwrite existing files"));
fprintf(stdout, "\n\t\t</description>\n");
fprintf(stdout, "\t</flag>\n");
}
/* verbose */
fprintf(stdout, "\t<flag name=\"%s\">\n", "verbose");
fprintf(stdout, "\t\t<description>\n\t\t\t");
print_escaped_for_xml(stdout, _("Verbose module output"));
fprintf(stdout, "\n\t\t</description>\n");
fprintf(stdout, "\t</flag>\n");
/* quiet */
fprintf(stdout, "\t<flag name=\"%s\">\n", "quiet");
fprintf(stdout, "\t\t<description>\n\t\t\t");
print_escaped_for_xml(stdout, _("Quiet module output"));
fprintf(stdout, "\n\t\t</description>\n");
fprintf(stdout, "\t</flag>\n");
fprintf(stdout, "</task>\n");
}
static void usage(FILE *fp, int markers)
{
struct Option *opt;
struct Flag *flag;
char item[256];
const char *key_desc;
int maxlen;
int len, n;
int new_prompt = 0;
new_prompt = G__uses_new_gisprompt();
if (!st->pgm_name) /* v.dave && r.michael */
st->pgm_name = G_program_name();
if (!st->pgm_name)
st->pgm_name = "??";
if (st->module_info.label || st->module_info.description) {
fprintf(fp, "\n");
if (markers)
fprintf(fp, "{{{DESCRIPTION}}}\n");
fprintf(fp, "%s\n", _("Description:"));
if (st->module_info.label)
fprintf(fp, " %s\n", st->module_info.label);
if (st->module_info.description)
fprintf(fp, " %s\n", st->module_info.description);
}
if (st->module_info.keywords) {
fprintf(fp, "\n");
if (markers)
fprintf(fp, "{{{KEYWORDS}}}\n");
fprintf(fp, "%s\n ", _("Keywords:"));
G__print_keywords(fp, NULL);
fprintf(fp, "\n");
}
fprintf(fp, "\n");
if (markers)
fprintf(fp, "{{{USAGE}}}\n");
fprintf(fp, "%s\n ", _("Usage:"));
len = show(fp, st->pgm_name, 1);
/* Print flags */
if (st->n_flags) {
item[0] = ' ';
item[1] = '[';
item[2] = '-';
flag = &st->first_flag;
for (n = 3; flag != NULL; n++, flag = flag->next_flag)
item[n] = flag->key;
item[n++] = ']';
item[n] = 0;
len = show(fp, item, len);
}
maxlen = 0;
if (st->n_opts) {
opt = &st->first_option;
while (opt != NULL) {
if (opt->key_desc != NULL)
key_desc = opt->key_desc;
else if (opt->type == TYPE_STRING)
key_desc = "string";
else
key_desc = "value";
if (!opt->key) {
fprintf(stderr, "\n%s\n", _("ERROR: Option key not defined"));
exit(EXIT_FAILURE);
}
n = strlen(opt->key);
if (n > maxlen)
maxlen = n;
strcpy(item, " ");
if (!opt->required)
strcat(item, "[");
strcat(item, opt->key);
strcat(item, "=");
strcat(item, key_desc);
if (opt->multiple) {
strcat(item, "[,");
strcat(item, key_desc);
strcat(item, ",...]");
}
if (!opt->required)
strcat(item, "]");
len = show(fp, item, len);
opt = opt->next_opt;
}
}
if (new_prompt) {
strcpy(item, " [--overwrite]");
len = show(fp, item, len);
}
strcpy(item, " [--help]");
len = show(fp, item, len);
strcpy(item, " [--verbose]");
len = show(fp, item, len);
strcpy(item, " [--quiet]");
len = show(fp, item, len);
strcpy(item, " [--ui]");
len = show(fp, item, len);
fprintf(fp, "\n");
/* Print help info for flags */
fprintf(fp, "\n");
if (markers)
fprintf(fp, "{{{FLAGS}}}\n");
fprintf(fp, "%s\n", _("Flags:"));
if (st->n_flags) {
flag = &st->first_flag;
while (flag != NULL) {
fprintf(fp, " -%c ", flag->key);
if (flag->label) {
fprintf(fp, "%s\n", flag->label);
if (flag->description)
fprintf(fp, " %s\n", flag->description);
}
else if (flag->description) {
fprintf(fp, "%s\n", flag->description);
}
flag = flag->next_flag;
}
}
if (new_prompt)
fprintf(fp, " --o %s\n",
_("Allow output files to overwrite existing files"));
fprintf(fp, " --h %s\n", _("Print usage summary"));
fprintf(fp, " --v %s\n", _("Verbose module output"));
fprintf(fp, " --q %s\n", _("Quiet module output"));
fprintf(fp, " --qq %s\n", _("Super quiet module output"));
fprintf(fp, " --ui %s\n", _("Force launching GUI dialog"));
/* Print help info for options */
if (st->n_opts) {
fprintf(fp, "\n");
if (markers)
fprintf(fp, "{{{PARAMETERS}}}\n");
fprintf(fp, "%s\n", _("Parameters:"));
opt = &st->first_option;
while (opt != NULL) {
fprintf(fp, " %*s ", maxlen, opt->key);
if (opt->label) {
fprintf(fp, "%s\n", opt->label);
if (opt->description) {
fprintf(fp, " %*s %s\n",
maxlen, " ", opt->description);
}
}
else if (opt->description) {
fprintf(fp, "%s\n", opt->description);
}
if (opt->options)
show_options(fp, maxlen, opt->options);
/*
fprintf (fp, " %*s options: %s\n", maxlen, " ",
_(opt->options)) ;
*/
if (opt->def)
fprintf(fp, _(" %*s default: %s\n"), maxlen, " ",
opt->def);
if (opt->descs) {
int i = 0;
while (opt->opts[i]) {
if (opt->descs[i])
fprintf(fp, " %*s %s: %s\n",
maxlen, " ", opt->opts[i], opt->descs[i]);
i++;
}
}
opt = opt->next_opt;
}
}
}
