123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712 |
- /**
- * \file parser.c
- *
- * \brief GIS Library - Argument parsing functions.
- *
- * Parses the command line provided through argc and argv. Example:
- * Assume the previous calls:
- *
- * opt1 = G_define_option() ;
- * opt1->key = "map",
- * opt1->type = TYPE_STRING,
- * opt1->required = YES,
- * opt1->checker = sub,
- * opt1->description= "Name of an existing raster map" ;
- *
- * opt2 = G_define_option() ;
- * opt2->key = "color",
- * opt2->type = TYPE_STRING,
- * opt2->required = NO,
- * opt2->answer = "white",
- * opt2->options = "red,orange,blue,white,black",
- * opt2->description= "Color used to display the map" ;
- *
- * opt3 = G_define_option() ;
- * opt3->key = "number",
- * opt3->type = TYPE_DOUBLE,
- * opt3->required = NO,
- * opt3->answer = "12345.67",
- * opt3->options = "0-99999",
- * opt3->description= "Number to test parser" ;
- *
- * G_parser() will respond to the following command lines as described:
- *
- * command (No command line arguments)
- * Parser enters interactive mode.
- *
- * command map=map.name
- * Parser will accept this line. Map will be set to "map.name", the
- * 'a' and 'b' flags will remain off and the num option will be set
- * to the default of 5.
- *
- * command -ab map=map.name num=9
- * command -a -b map=map.name num=9
- * command -ab map.name num=9
- * command map.name num=9 -ab
- * command num=9 -a map=map.name -b
- * These are all treated as acceptable and identical. Both flags are
- * set to on, the map option is "map.name" and the num option is "9".
- * Note that the "map=" may be omitted from the command line if it
- * is part of the first option (flags do not count).
- *
- * command num=12
- * This command line is in error in two ways. The user will be told
- * that the "map" option is required and also that the number 12 is
- * out of range. The acceptable range (or list) will be printed.
- *
- * (C) 2001-2008 by the GRASS Development Team
- *
- * This program is free software under the GNU General Public License
- * (>=v2). Read the file COPYING that comes with GRASS for details.
- *
- * \author Radim Blazek
- *
- * \date 2003-2008
- *
- */
- #include <grass/config.h>
- #if defined(HAVE_LANGINFO_H)
- #include <langinfo.h>
- #endif
- #include <stdio.h>
- #include <stdlib.h>
- #include <string.h>
- #include <ctype.h>
- #include <unistd.h>
- #include <stdarg.h>
- #include <sys/types.h>
- #include <grass/gis.h>
- #include <grass/glocale.h>
- #include <grass/spawn.h>
- #define BAD_SYNTAX 1
- #define OUT_OF_RANGE 2
- #define MISSING_VALUE 3
- #define AMBIGUOUS 4
- #define REPLACED 5
- #define KEYLENGTH 64
- struct Item
- {
- struct Option *option;
- struct Flag *flag;
- struct Item *next_item;
- };
- static struct state {
- int no_interactive;
- int n_opts;
- int n_flags;
- int overwrite;
- int quiet;
- int has_required;
- struct GModule module_info; /* general information on the corresponding module */
- const char *pgm_name;
- struct Flag first_flag; /* First flag in a linked list */
- struct Flag *current_flag; /* Pointer for traversing list */
- struct Option first_option;
- struct Option *current_option;
- struct Item first_item;
- struct Item *current_item;
- int n_items;
- } state;
- static struct state *st = &state;
- static void show_options(int, const char *);
- static int show(const char *, int);
- static int set_flag(int);
- static int contains(const char *, int);
- static int is_option(const char *);
- static int set_option(char *);
- static int check_opts();
- static int check_an_opt(const char *, int, const char *, const char **, char **);
- static int check_int(const char *, const char **);
- static int check_double(const char *, const char **);
- static int check_string(const char *, const char **, int *);
- static int check_required(void);
- static void split_opts(void);
- static int check_multiple_opts(void);
- static int check_overwrite(void);
- static void split_gisprompt(const char *, char *, char *, char *);
- static void G_gui(void);
- static void G_tcltk(void);
- static void G_usage_xml(void);
- static void G_usage_html(void);
- static void G_script(void);
- /**
- * \brief Disables the ability of the parser to operate interactively.
- *
- * When a user calls a command with no arguments on the command line,
- * the parser will enter its own standardized interactive session in
- * which all flags and options are presented to the user for input. A
- * call to <i>G_disable_interactive()</i> disables the parser's
- * interactive prompting.
- *
- * \return always returns 0
- */
- void G_disable_interactive(void)
- {
- st->no_interactive = 1;
- }
- /**
- * \brief Initializes a Flag struct.
- *
- * Allocates memory for the Flag structure and returns a pointer to this
- * memory (of <i>type struct Flag *</i>).<br>
- *
- * Flags are always represented by single letters. A user "turns them on"
- * at the command line using a minus sign followed by the character
- * representing the flag.
- *
- * \return Flag * Pointer to a Flag struct
- */
- struct Flag *G_define_flag(void)
- {
- struct Flag *flag;
- struct Item *item;
- /* Allocate memory if not the first flag */
- if (st->n_flags) {
- flag = (struct Flag *)G_malloc(sizeof(struct Flag));
- st->current_flag->next_flag = flag;
- }
- else
- flag = &st->first_flag;
- /* Zero structure */
- G_zero((char *)flag, sizeof(struct Flag));
- st->current_flag = flag;
- st->n_flags++;
- if (st->n_items) {
- item = (struct Item *)G_malloc(sizeof(struct Item));
- st->current_item->next_item = item;
- }
- else
- item = &st->first_item;
- G_zero((char *)item, sizeof(struct Item));
- item->flag = flag;
- item->option = NULL;
- st->current_item = item;
- st->n_items++;
- return (flag);
- }
- /**
- * \brief Initializes an Option struct.
- *
- * Allocates memory for the Option structure and returns a pointer to
- * this memory (of <i>type struct Option *</i>).<br>
- *
- * Options are provided by user on command line using the standard
- * format: <i>key=value</i>. Options identified as REQUIRED must be
- * specified by user on command line. The option string can either
- * specify a range of values (e.g. "10-100") or a list of acceptable
- * values (e.g. "red,orange,yellow"). Unless the option string is NULL,
- * user provided input will be evaluated agaist this string.
- *
- * \return Option * Pointer to an Option struct
- */
- struct Option *G_define_option(void)
- {
- struct Option *opt;
- struct Item *item;
- /* Allocate memory if not the first option */
- if (st->n_opts) {
- opt = (struct Option *)G_malloc(sizeof(struct Option));
- st->current_option->next_opt = opt;
- }
- else
- opt = &st->first_option;
- /* Zero structure */
- G_zero((char *)opt, sizeof(struct Option));
- opt->required = NO;
- opt->multiple = NO;
- opt->answer = NULL;
- opt->answers = NULL;
- opt->def = NULL;
- opt->checker = NULL;
- opt->options = NULL;
- opt->key_desc = NULL;
- opt->gisprompt = NULL;
- opt->label = NULL;
- opt->opts = NULL;
- opt->description = NULL;
- opt->descriptions = NULL;
- opt->guisection = NULL;
- st->current_option = opt;
- st->n_opts++;
- if (st->n_items) {
- item = (struct Item *)G_malloc(sizeof(struct Item));
- st->current_item->next_item = item;
- }
- else
- item = &st->first_item;
- G_zero((char *)item, sizeof(struct Item));
- item->option = opt;
- item->flag = NULL;
- st->current_item = item;
- st->n_items++;
- return (opt);
- }
- /**
- * \brief Create standardised Option structure.
- *
- * This function will create a standardised Option structure
- * defined by parameter opt. A list of valid parameters can be found in gis.h.
- * It allocates memory for the Option structure and returns a pointer to
- * this memory (of <i>type struct Option *</i>).<br>
- *
- * If an invalid parameter was specified a empty Option structure will
- * be returned (not NULL).
- *
- * - general:
- * - G_OPT_DB_WHERE
- * - G_OPT_DB_COLUMN
- * - G_OPT_DB_COLUMNS
- * - G_OPT_DB_TABLE
- * - G_OPT_DB_DRIVER
- * - G_OPT_DB_DATABASE
- *
- * - imagery:
- * - G_OPT_I_GROUP
- * - G_OPT_I_SUBGROUP
- *
- * - raster:
- * - G_OPT_R_INPUT
- * - G_OPT_R_INPUTS
- * - G_OPT_R_OUTPUT
- * - G_OPT_R_MAP
- * - G_OPT_R_MAPS
- * - G_OPT_R_BASE
- * - G_OPT_R_COVER
- * - G_OPT_R_ELEV
- * - G_OPT_R_ELEVS
- *
- * - raster3d:
- * - G_OPT_R3_INPUT
- * - G_OPT_R3_INPUTS
- * - G_OPT_R3_OUTPUT
- * - G_OPT_R3_MAP
- * - G_OPT_R3_MAPS
- *
- * - vector:
- * - G_OPT_V_INPUT
- * - G_OPT_V_INPUTS
- * - G_OPT_V_OUTPUT
- * - G_OPT_V_MAP
- * - G_OPT_V_MAPS
- * - G_OPT_V_TYPE
- * - G_OPT_V_FIELD
- * - G_OPT_V_CAT
- * - G_OPT_V_CATS
- *
- * \param[in] opt Type of Option struct to create
- *
- * \return Option * Pointer to an Option struct
- */
- struct Option *G_define_standard_option(int opt)
- {
- struct Option *Opt;
- Opt = G_define_option();
- switch (opt) {
- case G_OPT_DB_WHERE:
- Opt->key = "where";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "sql_query";
- Opt->required = NO;
- Opt->label = _("WHERE conditions of SQL statement without 'where' keyword");
- Opt->description = _("Example: income < 1000 and inhab >= 10000");
- break;
- case G_OPT_DB_TABLE:
- Opt->key = "table";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->description = _("Table name");
- Opt->gisprompt = "old_dbtable,dbtable,dbtable";
- break;
- case G_OPT_DB_DRIVER:
- Opt->key = "driver";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->description = _("Driver name");
- Opt->gisprompt = "old_dbdriver,dbdriver,dbdriver";
- break;
- case G_OPT_DB_DATABASE:
- Opt->key = "database";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->description = _("Database name");
- Opt->gisprompt = "old_dbname,dbname,dbname";
- break;
- case G_OPT_DB_COLUMN:
- Opt->key = "column";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = NO;
- Opt->description = _("Name of attribute column");
- Opt->gisprompt = "old_dbcolumn,dbcolumn,dbcolumn";
- break;
- case G_OPT_DB_COLUMNS:
- Opt->key = "columns";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->multiple = YES;
- Opt->description = _("Name of attribute column(s)");
- Opt->gisprompt = "old_table,table,dbcolumn";
- break;
- /* imagery group */
- case G_OPT_I_GROUP:
- Opt->key = "group";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,group,group";
- Opt->description = _("Name of input imagery group");
- break;
- case G_OPT_I_SUBGROUP:
- Opt->key = "subgroup";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,subgroup,subgroup";
- Opt->description = _("Name of input imagery subgroup");
- break;
- /* raster maps */
- case G_OPT_R_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of input raster map");
- break;
- case G_OPT_R_INPUTS:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of input raster map(s)");
- break;
- case G_OPT_R_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,cell,raster";
- Opt->description = _("Name for output raster map");
- break;
- case G_OPT_R_MAP:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of input raster map");
- break;
- case G_OPT_R_MAPS:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of input raster map(s)");
- break;
- case G_OPT_R_BASE:
- Opt->key = "base";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of base raster map");
- break;
- case G_OPT_R_COVER:
- Opt->key = "cover";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of cover raster map");
- break;
- case G_OPT_R_ELEV:
- Opt->key = "elevation";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of elevation raster map");
- break;
- case G_OPT_R_ELEVS:
- Opt->key = "elevation";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,cell,raster";
- Opt->description = _("Name of elevation raster map(s)");
- break;
- /*g3d maps */
- case G_OPT_R3_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,grid3,3d-raster";
- Opt->description = _("Name of input raster3d map");
- break;
- case G_OPT_R3_INPUTS:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,grid3,3d-raster";
- Opt->description = _("Name of input raster3d map(s)");
- break;
- case G_OPT_R3_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,grid3,3d-raster";
- Opt->description = _("Name for output raster3d map");
- break;
- case G_OPT_R3_MAP:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,grid3,3d-raster";
- Opt->description = _("Name of input raster3d map");
- break;
- case G_OPT_R3_MAPS:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,grid3,3d-raster";
- Opt->description = _("Name of input raster3d map(s)");
- break;
- /*vector maps */
- case G_OPT_V_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,vector,vector";
- Opt->description = _("Name of input vector map");
- break;
- case G_OPT_V_INPUTS:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,vector,vector";
- Opt->description = _("Name of input vector map(s)");
- break;
- case G_OPT_V_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new,vector,vector";
- Opt->description = _("Name for output vector map");
- break;
- case G_OPT_V_MAP:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old,vector,vector";
- Opt->description = _("Name of input vector map");
- break;
- case G_OPT_V_MAPS:
- Opt->key = "map";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->multiple = YES;
- Opt->gisprompt = "old,vector,vector";
- Opt->description = _("Name of input vector map(s)");
- break;
- case G_OPT_V_TYPE:
- Opt->key = "type";
- Opt->type = TYPE_STRING;
- Opt->required = NO;
- Opt->multiple = YES;
- Opt->answer = "point,line,boundary,centroid,area";
- Opt->options = "point,line,boundary,centroid,area";
- Opt->label = _("Type");
- Opt->description = _("Feature type(s)");
- break;
- case G_OPT_V_FIELD:
- Opt->key = "layer";
- Opt->type = TYPE_INTEGER;
- Opt->required = NO;
- Opt->answer = "1";
- Opt->label = _("Layer number");
- Opt->description =
- _("A single vector map can be connected to multiple database "
- "tables. This number determines which table to use.");
- Opt->gisprompt = "old_layer,layer,layer";
- break;
- case G_OPT_V_CAT:
- Opt->key = "cat";
- Opt->type = TYPE_INTEGER;
- Opt->required = NO;
- Opt->description = _("Category value");
- break;
- case G_OPT_V_CATS:
- Opt->key = "cats";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "range";
- Opt->required = NO;
- Opt->label = _("Category values");
- Opt->description = _("Example: 1,3,7-9,13");
- break;
- /* files */
- case G_OPT_F_INPUT:
- Opt->key = "input";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "old_file,file,input";
- Opt->description = _("Name of input file");
- break;
- case G_OPT_F_OUTPUT:
- Opt->key = "output";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = YES;
- Opt->gisprompt = "new_file,file,output";
- Opt->description = _("Name for output file");
- break;
- case G_OPT_F_SEP:
- Opt->key = "fs";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "character";
- Opt->required = NO;
- Opt->answer = "|";
- Opt->description = _("Field separator");
- break;
- /* colors */
- case G_OPT_C_FG:
- Opt->key = "color";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->answer = DEFAULT_FG_COLOR;
- Opt->gisprompt = "old_color,color,color";
- Opt->label = _("Color");
- Opt->description = _("Either a standard color name or R:G:B triplet");
- break;
- case G_OPT_C_BG:
- Opt->key = "bgcolor";
- Opt->type = TYPE_STRING;
- Opt->key_desc = "name";
- Opt->required = NO;
- Opt->answer = DEFAULT_BG_COLOR;
- Opt->gisprompt = "old_color,color,color_none";
- Opt->label = _("Background color");
- Opt->description =
- _("Either a standard GRASS color, R:G:B triplet, or \"none\"");
- break;
- }
- return (Opt);
- }
- /**
- * \brief Initializes a new module.
- *
- * \return GModule * Pointer to a GModule struct
- */
- struct GModule *G_define_module(void)
- {
- struct GModule *module;
- /* Allocate memory */
- module = &st->module_info;
- /* Zero structure */
- G_zero((char *)module, sizeof(struct GModule));
- return (module);
- }
- /* The main parsing routine */
- /**
- * \brief Parse command line.
- *
- * The command line parameters <b>argv</b> and the number of parameters
- * <b>argc</b> from the main() routine are passed directly to
- * <i>G_parser()</i>. <i>G_parser()</i> accepts the command line input
- * entered by the user, and parses this input according to the input
- * options and/or flags that were defined by the programmer.<br>
- *
- * <b>Note:</b> The only functions which can legitimately be called
- * before G_parser() are:<br>
- * <ul>
- * <li>G_gisinit()</li>
- * <li>G_no_gisinit()</li>
- * <li>G_define_module()</li>
- * <li>G_define_flag()</li>
- * <li>G_define_option()</li>
- * <li>G_define_standard_option()</li>
- * <li>G_disable_interactive()</li>
- * </ul>
- *
- * The usual order a module calls functions is:<br>
- * <ul>
- * <li>G_gisinit()</li>
- * <li>G_define_module()</li>
- * <li>G_define_{flag,option}()</li>
- * <li>G_parser()</li>
- * </ul>
- *
- * \param[in] argc number of arguments
- * \param[in] argv argument list
- * \return 0 on success
- * \return -1 on error and calls <b>G_usage()</b>
- */
- int G_parser(int argc, char **argv)
- {
- int need_first_opt;
- int opt_checked = 0;
- int error;
- char *ptr, *tmp_name;
- int i;
- struct Option *opt;
- char force_gui = FALSE;
- error = 0;
- need_first_opt = 1;
- i = strlen(tmp_name = G_store(argv[0]));
- while (--i >= 0) {
- if (G_is_dirsep(tmp_name[i])) {
- tmp_name += i + 1;
- break;
- }
- }
- G_basename(tmp_name, "exe");
- st->pgm_name = tmp_name;
- /* Stash default answers */
- opt = &st->first_option;
- while (opt != NULL) {
- if (opt->required)
- st->has_required = 1;
- /* Parse options */
- if (opt->options) {
- int cnt = 0;
- char **tokens, delm[2];
- delm[0] = ',';
- delm[1] = '\0';
- tokens = G_tokenize(opt->options, delm);
- i = 0;
- while (tokens[i]) {
- cnt++;
- i++;
- }
- opt->opts =
- (const char **)G_calloc(cnt + 1, sizeof(const char *));
- i = 0;
- while (tokens[i]) {
- opt->opts[i] = G_store(tokens[i]);
- i++;
- }
- G_free_tokens(tokens);
- if (opt->descriptions) {
- delm[0] = ';';
- opt->descs =
- (const char **)G_calloc(cnt + 1, sizeof(const char *));
- tokens = G_tokenize(opt->descriptions, delm);
- i = 0;
- while (tokens[i]) {
- int j, found;
- if (!tokens[i + 1])
- break;
- j = 0;
- found = 0;
- while (opt->opts[j]) {
- if (strcmp(opt->opts[j], tokens[i]) == 0) {
- found = 1;
- break;
- }
- j++;
- }
- if (!found) {
- G_warning(_("BUG in descriptions, option '%s' in <%s> does not exist"),
- tokens[i], opt->key);
- }
- else {
- opt->descs[j] = G_store(tokens[i + 1]);
- }
- i += 2;
- }
- G_free_tokens(tokens);
- }
- }
- /* Copy answer */
- if (opt->multiple && opt->answers && opt->answers[0]) {
- opt->answer = (char *)G_malloc(strlen(opt->answers[0]) + 1);
- strcpy(opt->answer, opt->answers[0]);
- for (i = 1; opt->answers[i]; i++) {
- opt->answer = (char *)G_realloc(opt->answer,
- strlen(opt->answer) +
- strlen(opt->answers[i]) + 2);
- strcat(opt->answer, ",");
- strcat(opt->answer, opt->answers[i]);
- }
- }
- opt->def = opt->answer;
- opt = opt->next_opt;
- }
- /* If there are NO arguments, go interactive */
- if (argc < 2 && st->has_required && !st->no_interactive && isatty(0)) {
- G_gui();
- return -1;
- }
- else if (argc < 2 && st->has_required && isatty(0)) {
- G_usage();
- return -1;
- }
- else if (argc >= 2) {
- /* If first arg is "help" give a usage/syntax message */
- if (strcmp(argv[1], "help") == 0 ||
- strcmp(argv[1], "-help") == 0 || strcmp(argv[1], "--help") == 0) {
- G_usage();
- exit(EXIT_SUCCESS);
- }
- /* If first arg is "--interface-description" then print out
- * a xml description of the task */
- if (strcmp(argv[1], "--interface-description") == 0) {
- G_usage_xml();
- exit(EXIT_SUCCESS);
- }
- /* If first arg is "--html-description" then print out
- * a html description of the task */
- if (strcmp(argv[1], "--html-description") == 0) {
- G_usage_html();
- exit(EXIT_SUCCESS);
- }
- /* If first arg is "--tcltk" then generate
- * code for tcltkgrass */
- if (strcmp(argv[1], "--tcltk") == 0) {
- G_tcltk();
- exit(EXIT_SUCCESS);
- }
- /* If first arg is "--script" then then generate
- * g.parser boilerplate */
- if (strcmp(argv[1], "--script") == 0) {
- G_script();
- exit(EXIT_SUCCESS);
- }
- /* Loop thru all command line arguments */
- while (--argc) {
- ptr = *(++argv);
- /* Overwrite option */
- if (strcmp(ptr, "--o") == 0 || strcmp(ptr, "--overwrite") == 0) {
- st->overwrite = 1;
- }
- /* Verbose option */
- else if (strcmp(ptr, "--v") == 0 || strcmp(ptr, "--verbose") == 0) {
- char buff[32];
- /* print everything: max verbosity level */
- st->module_info.verbose = G_verbose_max();
- sprintf(buff, "GRASS_VERBOSE=%d", G_verbose_max());
- putenv(G_store(buff));
- if (st->quiet == 1) {
- G_warning(_("Use either --quiet or --verbose flag, not both. Assuming --verbose."));
- }
- st->quiet = -1;
- }
- /* Quiet option */
- else if (strcmp(ptr, "--q") == 0 || strcmp(ptr, "--quiet") == 0) {
- char buff[32];
- /* print nothing, but errors and warnings */
- st->module_info.verbose = G_verbose_min();
- sprintf(buff, "GRASS_VERBOSE=%d", G_verbose_min());
- putenv(G_store(buff));
- if (st->quiet == -1) {
- G_warning(_("Use either --quiet or --verbose flag, not both. Assuming --quiet."));
- }
- st->quiet = 1; /* for passing to gui init */
- }
- /* Force gui to come up */
- else if (strcmp(ptr, "--ui") == 0) {
- force_gui = TRUE;
- }
- /* If we see a flag */
- else if (*ptr == '-') {
- while (*(++ptr))
- error += set_flag(*ptr);
- }
- /* If we see standard option format (option=val) */
- else if (is_option(ptr)) {
- error += set_option(ptr);
- need_first_opt = 0;
- }
- /* If we see the first option with no equal sign */
- else if (need_first_opt && st->n_opts) {
- st->first_option.answer = G_store(ptr);
- need_first_opt = 0;
- }
- /* If we see the non valid argument (no "=", just argument) */
- else if (contains(ptr, '=') == 0) {
- fprintf(stderr, _("Sorry <%s> is not a valid option\n"), ptr);
- error = 1;
- }
- }
- }
- /* Run the gui if it was specifically requested */
- if (force_gui) {
- G_gui();
- return -1;
- }
- /* Split options where multiple answers are OK */
- split_opts();
- /* Check multiple options */
- error += check_multiple_opts();
- /* Check answers against options and check subroutines */
- if (!opt_checked)
- error += check_opts();
- /* Make sure all required options are set */
- error += check_required();
- if (error) {
- if (G_verbose() > G_verbose_min())
- G_usage();
- return -1;
- }
- if (check_overwrite())
- return -1;
- return (0);
- }
- static int uses_new_gisprompt(void)
- {
- struct Option *opt;
- char age[KEYLENGTH];
- char element[KEYLENGTH];
- char desc[KEYLENGTH];
- if (st->module_info.overwrite)
- return 1;
- /* figure out if any of the options use a "new" gisprompt */
- /* This is to see if we should spit out the --o flag */
- if (st->n_opts) {
- opt = &st->first_option;
- while (opt != NULL) {
- if (opt->gisprompt) {
- split_gisprompt(opt->gisprompt, age, element, desc);
- if (strcmp(age, "new") == 0)
- return 1;
- }
- opt = opt->next_opt;
- }
- }
- return 0;
- }
- /**
- * \brief Command line help/usage message.
- *
- * Calls to <i>G_usage()</i> allow the programmer to print the usage
- * message at any time. This will explain the allowed and required
- * command line input to the user. This description is given according
- * to the programmer's definitions for options and flags. This function
- * becomes useful when the user enters options and/or flags on the
- * command line that are syntactically valid to the parser, but
- * functionally invalid for the command (e.g. an invalid file name.)<br>
- * For example, the parser logic doesn't directly support grouping
- * options. If two options be specified together or not at all, the
- * parser must be told that these options are not required and the
- * programmer must check that if one is specified the other must be as
- * well. If this additional check fails, then <i>G_parser()</i> will
- * succeed, but the programmer can then call <i>G_usage()</i> to print
- * the standard usage message and print additional information about how
- * the two options work together.
- *
- * \return
- */
- void G_usage(void)
- {
- struct Option *opt;
- struct Flag *flag;
- char item[256];
- const char *key_desc;
- int maxlen;
- int len, n;
- int new_prompt = 0;
- new_prompt = 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(stderr, _("\nDescription:\n"));
- if (st->module_info.label)
- fprintf(stderr, " %s\n", st->module_info.label);
- if (st->module_info.description)
- fprintf(stderr, " %s\n", st->module_info.description);
- }
- if (st->module_info.keywords) {
- fprintf(stderr, _("\nKeywords:\n"));
- fprintf(stderr, " %s\n", st->module_info.keywords);
- }
- fprintf(stderr, _("\nUsage:\n "));
- len = show(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(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";
- 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(item, len);
- opt = opt->next_opt;
- }
- }
- if (new_prompt) {
- strcpy(item, " [--overwrite]");
- len = show(item, len);
- }
- strcpy(item, " [--verbose]");
- len = show(item, len);
- strcpy(item, " [--quiet]");
- len = show(item, len);
- fprintf(stderr, "\n");
- /* Print help info for flags */
- fprintf(stderr, _("\nFlags:\n"));
- if (st->n_flags) {
- flag = &st->first_flag;
- while (flag != NULL) {
- fprintf(stderr, " -%c ", flag->key);
- if (flag->label) {
- fprintf(stderr, "%s\n", flag->label);
- if (flag->description)
- fprintf(stderr, " %s\n", flag->description);
- }
- else if (flag->description) {
- fprintf(stderr, "%s\n", flag->description);
- }
- flag = flag->next_flag;
- }
- }
- if (new_prompt)
- fprintf(stderr, " --o %s\n",
- _("Allow output files to overwrite existing files"));
- fprintf(stderr, " --v %s\n", _("Verbose module output"));
- fprintf(stderr, " --q %s\n", _("Quiet module output"));
- /* Print help info for options */
- if (st->n_opts) {
- fprintf(stderr, _("\nParameters:\n"));
- opt = &st->first_option;
- while (opt != NULL) {
- fprintf(stderr, " %*s ", maxlen, opt->key);
- if (opt->label) {
- fprintf(stderr, "%s\n", opt->label);
- if (opt->description) {
- fprintf(stderr, " %*s %s\n",
- maxlen, " ", opt->description);
- }
- }
- else if (opt->description) {
- fprintf(stderr, "%s\n", opt->description);
- }
- if (opt->options)
- show_options(maxlen, opt->options);
- /*
- fprintf (stderr, " %*s options: %s\n", maxlen, " ",
- _(opt->options)) ;
- */
- if (opt->def)
- fprintf(stderr, _(" %*s default: %s\n"), maxlen, " ",
- opt->def);
- if (opt->descs) {
- int i = 0;
- while (opt->opts[i]) {
- if (opt->descs[i])
- fprintf(stderr, " %*s %s: %s\n",
- maxlen, " ", opt->opts[i], opt->descs[i]);
- i++;
- }
- }
- opt = opt->next_opt;
- }
- }
- }
- /**
- * \brief Formats text for XML.
- *
- * \param[in,out] fp file to write to
- * \param[in] str string to write
- */
- static void print_escaped_for_xml(FILE * fp, const char *str)
- {
- for (; *str; str++) {
- switch (*str) {
- case '&':
- fputs("&", fp);
- break;
- case '<':
- fputs("<", fp);
- break;
- case '>':
- fputs(">", fp);
- break;
- default:
- fputc(*str, fp);
- }
- }
- }
- /**
- * \brief Format text for HTML output
- */
- #define do_escape(c,escaped) case c: fputs(escaped,f);break
- static void print_escaped_for_html(FILE * f, const char *str)
- {
- const char *s;
- for (s = str; *s; s++) {
- switch (*s) {
- do_escape('&', "&");
- do_escape('<', "<");
- do_escape('>', ">");
- do_escape('\n', "<br>");
- default:
- fputc(*s, f);
- }
- }
- }
- #undef do_escape
- /**
- \brief Print module usage description in XML format.
- **/
- static void G_usage_xml(void)
- {
- struct Option *opt;
- struct Flag *flag;
- char *type;
- char *s, *top;
- int i;
- char *encoding;
- int new_prompt = 0;
- new_prompt = 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";
- }
- #else
- 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");
- print_escaped_for_xml(stdout, st->module_info.keywords);
- 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");
- }
- /* 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->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");
- }
- /**
- \brief Print module usage description in HTML format.
- **/
- static void G_usage_html(void)
- {
- struct Option *opt;
- struct Flag *flag;
- const char *type;
- int new_prompt = 0;
- new_prompt = 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: %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) {
- fprintf(stdout, "%s", st->module_info.keywords);
- 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");
- }
- /**
- \brief Print a module parameter template to assist with creating shell script wrappers.
- **/
- static void G_script(void)
- {
- FILE *fp = stdout;
- char *type;
- fprintf(fp, "#!/bin/sh\n\n");
- fprintf(fp,
- "############################################################################\n");
- fprintf(fp, "#\n");
- fprintf(fp, "# MODULE: %s_wrapper\n", G_program_name());
- fprintf(fp, "# AUTHOR(S): %s\n", G_whoami());
- fprintf(fp, "# PURPOSE: \n");
- fprintf(fp, "# COPYRIGHT: (C) 2008 GRASS Development Team/%s\n",
- G_whoami());
- fprintf(fp, "#\n");
- fprintf(fp,
- "# This program is free software; you can redistribute it and/or modify\n");
- fprintf(fp,
- "# it under the terms of the GNU General Public License as published by\n");
- fprintf(fp,
- "# the Free Software Foundation; either version 2 of the License, or\n");
- fprintf(fp, "# (at your option) any later version.\n");
- fprintf(fp, "#\n");
- fprintf(fp,
- "# This program is distributed in the hope that it will be useful,\n");
- fprintf(fp,
- "# but WITHOUT ANY WARRANTY; without even the implied warranty of\n");
- fprintf(fp,
- "# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n");
- fprintf(fp, "# GNU General Public License for more details.\n");
- fprintf(fp, "#\n");
- fprintf(fp,
- "#############################################################################/\n");
- fprintf(fp, "#%%Module\n");
- if (st->module_info.label)
- fprintf(fp, "#%% label: %s\n", st->module_info.label);
- if (st->module_info.description)
- fprintf(fp, "#%% description: %s\n", st->module_info.description);
- if (st->module_info.keywords)
- fprintf(fp, "#%% keywords: %s\n", st->module_info.keywords);
- fprintf(fp, "#%%End\n");
- if (st->n_flags) {
- struct Flag *flag;
- for (flag = &st->first_flag; flag; flag = flag->next_flag) {
- fprintf(fp, "#%%Flag\n");
- fprintf(fp, "#%% key: %c\n", flag->key);
- if (flag->label)
- fprintf(fp, "#%% label: %s\n", flag->label);
- if (flag->description)
- fprintf(fp, "#%% description: %s\n", flag->description);
- if (flag->guisection)
- fprintf(fp, "#%% guisection: %s\n", flag->guisection);
- fprintf(fp, "#%%End\n");
- }
- }
- if (st->n_opts) {
- struct Option *opt;
- for (opt = &st->first_option; opt; opt = opt->next_opt) {
- switch (opt->type) {
- case TYPE_INTEGER:
- type = "integer";
- break;
- case TYPE_DOUBLE:
- type = "double";
- break;
- case TYPE_STRING:
- type = "string";
- break;
- default:
- type = "string";
- break;
- }
- fprintf(fp, "#%%Option\n");
- fprintf(fp, "#%% key: %s\n", opt->key);
- fprintf(fp, "#%% type: %s\n", type);
- fprintf(fp, "#%% required: %s\n", opt->required ? "yes" : "no");
- fprintf(fp, "#%% multiple: %s\n", opt->multiple ? "yes" : "no");
- if (opt->options)
- fprintf(fp, "#%% options: %s\n", opt->options);
- if (opt->key_desc)
- fprintf(fp, "#%% key_desc: %s\n", opt->key_desc);
- if (opt->label)
- fprintf(fp, "#%% label: %s\n", opt->label);
- if (opt->description)
- fprintf(fp, "#%% description: %s\n", opt->description);
- if (opt->descriptions)
- fprintf(fp, "#%% descriptions: %s\n", opt->descriptions);
- if (opt->answer)
- fprintf(fp, "#%% answer: %s\n", opt->answer);
- if (opt->gisprompt)
- fprintf(fp, "#%% gisprompt: %s\n", opt->gisprompt);
- if (opt->guisection)
- fprintf(fp, "#%% guisection: %s\n", opt->guisection);
- fprintf(fp, "#%%End\n");
- }
- }
- fprintf(fp,
- "\nif [ -z \"$GISBASE\" ] ; then\n"
- " echo \"You must be in GRASS GIS to run this program.\" 1>&2\n"
- " exit 1\n"
- "fi\n"
- "\n"
- "if [ \"$1\" != \"@ARGS_PARSED@\" ] ; then\n"
- " exec g.parser \"$0\" \"$@\"\n"
- "fi\n" "\n" "# CODE GOES HERE\n" "\n");
- }
- /**
- \brief Generates tcltk dialog.
- \param[out] fp File to store tcltk code
- **/
- static void generate_tcl(FILE * fp)
- {
- int new_prompt = uses_new_gisprompt();
- const char *type;
- int optn;
- fprintf(fp, "begin_dialog {%s} {\n", st->pgm_name);
- fprintf(fp, " label {%s}\n", st->module_info.label ? st->module_info.label : "");
- fprintf(fp, " desc {%s}\n",
- st->module_info.description ? st->module_info.description : "");
- fprintf(fp, " key {%s}\n",
- st->module_info.keywords ? st->module_info.keywords : "");
- fprintf(fp, "}\n");
- optn = 1;
- if (st->n_flags) {
- struct Flag *flag;
- for (flag = &st->first_flag; flag; flag = flag->next_flag, optn++) {
- fprintf(fp, "add_flag %d {\n", optn);
- fprintf(fp, " name {%c}\n", flag->key);
- fprintf(fp, " desc {%s}\n", flag->description);
- fprintf(fp, " answer %d\n", flag->answer);
- /* It should be up to the gui as to what
- to do with the label and description */
- fprintf(fp, " label {%s}\n", flag->label ? flag->label : "");
- fprintf(fp, " guisection {%s}\n",
- flag->guisection ? flag->guisection : "");
- fprintf(fp, "}\n");
- }
- }
- if (st->n_opts) {
- struct Option *opt;
- for (opt = &st->first_option; opt; opt = opt->next_opt, optn++) {
- 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(fp, "add_option %d {\n", optn);
- fprintf(fp, " name {%s}\n", opt->key);
- fprintf(fp, " type {%s}\n", type);
- fprintf(fp, " multi %d\n", opt->multiple);
- fprintf(fp, " desc {%s}\n", opt->description);
- fprintf(fp, " required %d\n", opt->required);
- fprintf(fp, " options {%s}\n", opt->options ? opt->options : "");
- fprintf(fp, " descs {%s}\n",
- opt->descriptions ? opt->descriptions : "");
- fprintf(fp, " answer {%s}\n", opt->answer ? opt->answer : "");
- fprintf(fp, " prompt {%s}\n",
- opt->gisprompt ? opt->gisprompt : "");
- /* It should be up to the gui as to what
- to do with the label and description */
- fprintf(fp, " label {%s}\n", opt->label ? opt->label : "");
- fprintf(fp, " guisection {%s}\n",
- opt->guisection ? opt->guisection : "");
- fprintf(fp, "}\n");
- }
- }
- if (new_prompt) {
- fprintf(fp, "add_xflag %d {\n", optn);
- fprintf(fp, " name {overwrite}\n");
- fprintf(fp, " desc {%s}\n",
- _("Allow output files to overwrite existing files"));
- fprintf(fp, " answer %d\n", st->overwrite);
- fprintf(fp, " label {%s}\n", _("Allow overwrite"));
- fprintf(fp, " guisection {}\n");
- fprintf(fp, "}\n");
- optn++;
- }
- fprintf(fp, "add_xflag %d {\n", optn);
- fprintf(fp, " name {quiet}\n");
- fprintf(fp, " desc {%s}\n", _("Run with minimal output messages"));
- fprintf(fp, " answer %d\n", st->quiet);
- fprintf(fp, " label {%s}\n", _("Run quietly"));
- fprintf(fp, " guisection {}\n");
- fprintf(fp, "}\n");
- optn++;
- fprintf(fp, "end_dialog %d\n", optn - 1);
- }
- /**
- \brief Build Tcl/Tk GUI dialog
- **/
- static void G_gui_tcltk(void)
- {
- FILE *fp;
- if (!st->pgm_name)
- st->pgm_name = G_program_name();
- if (!st->pgm_name)
- st->pgm_name = "??";
- #ifdef __MINGW32__
- if (getenv("GRASS_DEBUG_GUI"))
- fp = G_popen("tee gui_dump.tcl | %GRASS_WISH%", "w");
- else
- fp = G_popen("%GRASS_WISH%", "w");
- #else
- if (getenv("GRASS_DEBUG_GUI"))
- fp = G_popen("tee gui_dump.tcl | $GRASS_WISH", "w");
- else
- fp = G_popen("$GRASS_WISH", "w");
- #endif
- if (!fp)
- G_fatal_error(_("Unable to spawn the 'wish' program"));
- fprintf(fp, "source $env(GISBASE)/etc/gui.tcl\n");
- generate_tcl(fp);
- G_pclose(fp);
- }
- /**
- \brief Build wxPython GUI dialog
- **/
- static void G_gui_wx(void)
- {
- char script[GPATH_MAX];
- if (!st->pgm_name)
- st->pgm_name = G_program_name();
- if (!st->pgm_name)
- G_fatal_error(_("Unable to determine program name"));
- sprintf(script, "%s/etc/wxpython/gui_modules/menuform.py",
- getenv("GISBASE"));
- G_spawn("python", "menuform.py", script, st->pgm_name, NULL);
- }
- /**
- \brief Invoke GUI dialog
- Use G_gui_wx() or G_gui_tcltk() to generate GUI dialog.
- G_gui_tcltk() is called by default (if GRASS_GUI is not defined)
- **/
- static void G_gui(void)
- {
- /* read environment variables first then internal GRASS variable */
- char *gui = getenv("GRASS_GUI");
- if (!gui) {
- gui = G_getenv("GRASS_GUI");
- }
- if (gui && strcmp(gui, "wxpython") == 0)
- G_gui_wx();
- else
- G_gui_tcltk();
- return;
- }
- /**
- \brief Send Tcl/Tk code to tcltkgrass
- **/
- static void G_tcltk(void)
- {
- if (!st->pgm_name)
- st->pgm_name = G_program_name();
- if (!st->pgm_name)
- st->pgm_name = "??";
- generate_tcl(stdout);
- }
- /**************************************************************************
- *
- * The remaining routines are all local (static) routines used to support
- * the parsing process.
- *
- **************************************************************************/
- static void show_options(int maxlen, const char *str)
- {
- char *buff = G_store(str);
- char *p1, *p2;
- int totlen, len;
- fprintf(stderr, _(" %*s options: "), maxlen, " ");
- totlen = maxlen + 13;
- p1 = buff;
- while ((p2 = G_index(p1, ','))) {
- *p2 = '\0';
- len = strlen(p1) + 1;
- if ((len + totlen) > 76) {
- totlen = maxlen + 13;
- fprintf(stderr, "\n %*s", maxlen + 13, " ");
- }
- fprintf(stderr, "%s,", p1);
- totlen += len;
- p1 = p2 + 1;
- }
- len = strlen(p1);
- if ((len + totlen) > 76)
- fprintf(stderr, "\n %*s", maxlen + 13, " ");
- fprintf(stderr, "%s\n", p1);
- G_free(buff);
- }
- static int show(const char *item, int len)
- {
- int n;
- n = strlen(item) + (len > 0);
- if (n + len > 76) {
- if (len)
- fprintf(stderr, "\n ");
- len = 0;
- }
- fprintf(stderr, "%s", item);
- return n + len;
- }
- static int set_flag(int f)
- {
- struct Flag *flag;
- /* Flag is not valid if there are no flags to set */
- if (!st->n_flags) {
- fprintf(stderr, _("Sorry, <%c> is not a valid flag\n"), f);
- return (1);
- }
- /* Find flag with corrrect keyword */
- flag = &st->first_flag;
- while (flag != NULL) {
- if (flag->key == f) {
- flag->answer = 1;
- return (0);
- }
- flag = flag->next_flag;
- }
- fprintf(stderr, _("Sorry, <%c> is not a valid flag\n"), f);
- return (1);
- }
- /* contents() is used to find things strings with characters like commas and
- * dashes.
- */
- static int contains(const char *s, int c)
- {
- while (*s) {
- if (*s == c)
- return (1);
- s++;
- }
- return (0);
- }
- static int is_option(const char *string)
- {
- int n = strspn(string, "abcdefghijklmnopqrstuvwxyz0123456789_");
- return n > 0 && string[n] == '=' && string[0] != '_' && string[n-1] != '_';
- }
- static int set_option(char *string)
- {
- struct Option *at_opt = NULL;
- struct Option *opt = NULL;
- int got_one;
- size_t key_len;
- char the_key[KEYLENGTH];
- char *ptr;
- for (ptr = the_key; *string != '='; ptr++, string++)
- *ptr = *string;
- *ptr = '\0';
- string++;
- /* Find option with best keyword match */
- got_one = 0;
- key_len = strlen(the_key);
- for (at_opt = &st->first_option; at_opt != NULL; at_opt = at_opt->next_opt) {
- if (at_opt->key == NULL || strncmp(the_key, at_opt->key, key_len))
- continue;
- got_one++;
- opt = at_opt;
- /* changed 1/15/91 -dpg old code is in parser.old */
- /* overide ambiguous check, if we get an exact match */
- if (strlen(at_opt->key) == key_len) {
- opt = at_opt;
- got_one = 1;
- break;
- }
- }
- if (got_one > 1) {
- fprintf(stderr, _("Sorry, <%s=> is ambiguous\n"), the_key);
- return (1);
- }
- /* If there is no match, complain */
- if (got_one == 0) {
- fprintf(stderr, _("Sorry, <%s> is not a valid parameter\n"), the_key);
- return (1);
- }
- /* Allocate memory where answer is stored */
- if (opt->count++) {
- opt->answer = (char *)G_realloc(opt->answer,
- strlen(opt->answer) + strlen(string) +
- 2);
- strcat(opt->answer, ",");
- strcat(opt->answer, string);
- }
- else
- opt->answer = G_store(string);
- return (0);
- }
- static int check_opts(void)
- {
- struct Option *opt;
- int error;
- int ans;
- error = 0;
- if (!st->n_opts)
- return (0);
- opt = &st->first_option;
- while (opt != NULL) {
- /* Check answer against options if any */
- if (opt->options && opt->answer) {
- if (opt->multiple == 0)
- error += check_an_opt(opt->key, opt->type,
- opt->options, opt->opts, &opt->answer);
- else {
- for (ans = 0; opt->answers[ans] != '\0'; ans++)
- error += check_an_opt(opt->key, opt->type,
- opt->options, opt->opts, &opt->answers[ans]);
- }
- }
- /* Check answer against user's check subroutine if any */
- if (opt->checker)
- error += opt->checker(opt->answer);
- opt = opt->next_opt;
- }
- return (error);
- }
- static int check_an_opt(const char *key, int type, const char *options,
- const char **opts, char **answerp)
- {
- const char *answer = *answerp;
- int error;
- int found;
- error = 0;
- switch (type) {
- case TYPE_INTEGER:
- error = check_int(answer, opts);
- break;
- case TYPE_DOUBLE:
- error = check_double(answer, opts);
- break;
- case TYPE_STRING:
- error = check_string(answer, opts, &found);
- break;
- }
- switch (error) {
- case 0:
- break;
- case BAD_SYNTAX:
- fprintf(stderr,
- _("\nERROR: illegal range syntax for parameter <%s>\n"), key);
- fprintf(stderr, _(" Presented as: %s\n"), options);
- break;
- case OUT_OF_RANGE:
- fprintf(stderr,
- _("\nERROR: value <%s> out of range for parameter <%s>\n"),
- answer, key);
- fprintf(stderr, _(" Legal range: %s\n"), options);
- break;
- case MISSING_VALUE:
- fprintf(stderr, _("\nERROR: Missing value for parameter <%s>\n"),
- key);
- break;
- case AMBIGUOUS:
- fprintf(stderr, _("\nERROR: value <%s> ambiguous for parameter <%s>\n"),
- answer, key);
- fprintf(stderr, _(" valid options: %s\n"), options);
- break;
- case REPLACED:
- *answerp = G_store(opts[found]);
- error = 0;
- break;
- }
- return error;
- }
- static int check_int(const char *ans, const char **opts)
- {
- int d, i;
- if (sscanf(ans, "%d", &d) != 1)
- return MISSING_VALUE;
- for (i = 0; opts[i]; i++) {
- const char *opt = opts[i];
- int lo, hi;
- if (contains(opt, '-')) {
- if (sscanf(opt, "%d-%d", &lo, &hi) == 2) {
- if (d >= lo && d <= hi)
- return 0;
- }
- else if (sscanf(opt, "-%d", &hi) == 1) {
- if (d <= hi)
- return 0;
- }
- else if (sscanf(opt, "%d-", &lo) == 1) {
- if (d >= lo)
- return 0;
- }
- else
- return BAD_SYNTAX;
- }
- else {
- if (sscanf(opt, "%d", &lo) == 1) {
- if (d == lo)
- return 0;
- }
- else
- return BAD_SYNTAX;
- }
- }
- return OUT_OF_RANGE;
- }
- static int check_double(const char *ans, const char **opts)
- {
- double d;
- int i;
- if (sscanf(ans, "%lf", &d) != 1)
- return MISSING_VALUE;
- for (i = 0; opts[i]; i++) {
- const char *opt = opts[i];
- double lo, hi;
- if (contains(opt, '-')) {
- if (sscanf(opt, "%lf-%lf", &lo, &hi) == 2) {
- if (d >= lo && d <= hi)
- return 0;
- }
- else if (sscanf(opt, "-%lf", &hi) == 1) {
- if (d <= hi)
- return 0;
- }
- else if (sscanf(opt, "%lf-", &lo) == 1) {
- if (d >= lo)
- return 0;
- }
- else
- return BAD_SYNTAX;
- }
- else {
- if (sscanf(opt, "%lf", &lo) == 1) {
- if (d == lo)
- return 0;
- }
- else
- return BAD_SYNTAX;
- }
- }
- return OUT_OF_RANGE;
- }
- static int check_string(const char *ans, const char **opts, int *result)
- {
- int len = strlen(ans);
- int found = 0;
- int i;
- for (i = 0; opts[i]; i++) {
- if (strcmp(ans, opts[i]) == 0)
- return 0;
- if (strncmp(ans, opts[i], len) == 0) {
- *result = i;
- found++;
- }
- }
- switch (found) {
- case 0: return OUT_OF_RANGE;
- case 1: return REPLACED;
- default: return AMBIGUOUS;
- }
- }
- static int check_required(void)
- {
- struct Option *opt;
- int err;
- err = 0;
- if (!st->n_opts)
- return (0);
- opt = &st->first_option;
- while (opt != NULL) {
- if (opt->required && opt->answer == NULL) {
- fprintf(stderr,
- _("\nERROR: Required parameter <%s> not set:\n (%s).\n"),
- opt->key, opt->description);
- err++;
- }
- opt = opt->next_opt;
- }
- return (err);
- }
- static void split_opts(void)
- {
- struct Option *opt;
- char *ptr1;
- char *ptr2;
- int allocated;
- int ans_num;
- int len;
- if (!st->n_opts)
- return;
- opt = &st->first_option;
- while (opt != NULL) {
- if ( /*opt->multiple && */ (opt->answer != NULL)) {
- /* Allocate some memory to store array of pointers */
- allocated = 10;
- opt->answers = (char **)G_malloc(allocated * sizeof(char *));
- ans_num = 0;
- ptr1 = opt->answer;
- opt->answers[ans_num] = NULL;
- for (;;) {
- for (len = 0, ptr2 = ptr1; *ptr2 != '\0' && *ptr2 != ',';
- ptr2++, len++) ;
- if (len > 0) { /* skip ,, */
- opt->answers[ans_num] = (char *)G_malloc(len + 1);
- G_copy(opt->answers[ans_num], ptr1, len);
- opt->answers[ans_num][len] = 0;
- ans_num++;
- if (ans_num >= allocated) {
- allocated += 10;
- opt->answers =
- (char **)G_realloc((char *)opt->answers,
- allocated * sizeof(char *));
- }
- opt->answers[ans_num] = NULL;
- }
- if (*ptr2 == '\0')
- break;
- ptr1 = ptr2 + 1;
- if (*ptr1 == '\0')
- break;
- }
- }
- opt = opt->next_opt;
- }
- }
- static int check_multiple_opts(void)
- {
- struct Option *opt;
- const char *ptr;
- int n_commas;
- int n;
- int error;
- if (!st->n_opts)
- return (0);
- error = 0;
- opt = &st->first_option;
- while (opt != NULL) {
- if ((opt->answer != NULL) && (opt->key_desc != NULL)) {
- /* count commas */
- n_commas = 1;
- for (ptr = opt->key_desc; *ptr != '\0'; ptr++)
- if (*ptr == ',')
- n_commas++;
- /* count items */
- for (n = 0; opt->answers[n] != '\0'; n++) ;
- /* if not correct multiple of items */
- if (n % n_commas) {
- fprintf(stderr,
- _("\nERROR: option <%s> must be provided in multiples of %d\n"),
- opt->key, n_commas);
- fprintf(stderr, _(" You provided %d items:\n"), n);
- fprintf(stderr, " %s\n", opt->answer);
- error++;
- }
- }
- opt = opt->next_opt;
- }
- return (error);
- }
- /* Check for all 'new' if element already exists */
- static int check_overwrite(void)
- {
- struct Option *opt;
- char age[KEYLENGTH];
- char element[KEYLENGTH];
- char desc[KEYLENGTH];
- int error = 0;
- char *overstr;
- int over;
- st->module_info.overwrite = 0;
- if (!st->n_opts)
- return (0);
- over = 0;
- /* Check the GRASS OVERWRITE variable */
- if ((overstr = G__getenv("OVERWRITE"))) {
- over = atoi(overstr);
- }
- /* Check the GRASS_OVERWRITE environment variable */
- if ((overstr = getenv("GRASS_OVERWRITE"))) {
- if (atoi(overstr))
- over = 1;
- }
- if (st->overwrite || over) {
- st->module_info.overwrite = 1;
- /* Set the environment so that programs run in a script also obey --o */
- putenv("GRASS_OVERWRITE=1");
- /* No need to check options for existing files if overwrite is true */
- return error;
- }
- opt = &st->first_option;
- while (opt != NULL) {
- if ((opt->answer != NULL) && (opt->gisprompt != NULL)) {
- split_gisprompt(opt->gisprompt, age, element, desc);
- if (strcmp(age, "new") == 0) {
- int i;
- for (i = 0; opt->answers[i]; i++) {
- if (G_find_file(element, opt->answers[i], G_mapset())) { /* found */
- if (!st->overwrite && !over) {
- if (G_info_format() != G_INFO_FORMAT_GUI) {
- fprintf(stderr,
- _("ERROR: option <%s>: <%s> exists.\n"),
- opt->key, opt->answers[i]);
- }
- else {
- fprintf(stderr,
- "GRASS_INFO_ERROR(%d,1): option <%s>: <%s> exists.\n",
- getpid(), opt->key, opt->answers[i]);
- fprintf(stderr, "GRASS_INFO_END(%d,1)\n",
- getpid());
- }
- error = 1;
- }
- }
- }
- }
- }
- opt = opt->next_opt;
- }
- return (error);
- }
- static void split_gisprompt(const char *gisprompt, char *age, char *element,
- char *desc)
- {
- const char *ptr1;
- char *ptr2;
- for (ptr1 = gisprompt, ptr2 = age; *ptr1 != '\0'; ptr1++, ptr2++) {
- if (*ptr1 == ',')
- break;
- *ptr2 = *ptr1;
- }
- *ptr2 = '\0';
- for (ptr1++, ptr2 = element; *ptr1 != '\0'; ptr1++, ptr2++) {
- if (*ptr1 == ',')
- break;
- *ptr2 = *ptr1;
- }
- *ptr2 = '\0';
- for (ptr1++, ptr2 = desc; *ptr1 != '\0'; ptr1++, ptr2++) {
- if (*ptr1 == ',')
- break;
- *ptr2 = *ptr1;
- }
- *ptr2 = '\0';
- }
- /**
- * \brief Creates command to run non-interactive.
- *
- * Creates a command-line that runs the current command completely
- * non-interactive.
- *
- * \return char * Pointer to a char string
- */
- char *G_recreate_command(void)
- {
- char *buff;
- char flg[4];
- char *cur;
- const char *tmp;
- struct Flag *flag;
- struct Option *opt;
- int n, len, slen;
- int nalloced = 0;
- G_debug(3, "G_recreate_command()");
- /* Flag is not valid if there are no flags to set */
- buff = G_calloc(1024, sizeof(char));
- nalloced += 1024;
- tmp = G_program_name();
- len = strlen(tmp);
- if (len >= nalloced) {
- nalloced += (1024 > len) ? 1024 : len + 1;
- buff = G_realloc(buff, nalloced);
- }
- cur = buff;
- strcpy(cur, tmp);
- cur += len;
- if (st->n_flags) {
- flag = &st->first_flag;
- while (flag != '\0') {
- if (flag->answer == 1) {
- flg[0] = ' ';
- flg[1] = '-';
- flg[2] = flag->key;
- flg[3] = '\0';
- slen = strlen(flg);
- if (len + slen >= nalloced) {
- nalloced +=
- (nalloced + 1024 > len + slen) ? 1024 : slen + 1;
- buff = G_realloc(buff, nalloced);
- cur = buff + len;
- }
- strcpy(cur, flg);
- cur += slen;
- len += slen;
- }
- flag = flag->next_flag;
- }
- }
- opt = &st->first_option;
- while (opt != '\0') {
- if (opt->answer != '\0' && opt->answers[0] != NULL) {
- slen = strlen(opt->key) + strlen(opt->answers[0]) + 4; /* +4 for: ' ' = " " */
- if (len + slen >= nalloced) {
- nalloced += (nalloced + 1024 > len + slen) ? 1024 : slen + 1;
- buff = G_realloc(buff, nalloced);
- cur = buff + len;
- }
- strcpy(cur, " ");
- cur++;
- strcpy(cur, opt->key);
- cur = strchr(cur, '\0');
- strcpy(cur, "=");
- cur++;
- if (opt->type == TYPE_STRING) {
- strcpy(cur, "\"");
- cur++;
- }
- strcpy(cur, opt->answers[0]);
- cur = strchr(cur, '\0');
- len = cur - buff;
- for (n = 1; opt->answers[n] != NULL && opt->answers[n] != '\0';
- n++) {
- if (opt->answers[n] == NULL)
- break;
- slen = strlen(opt->answers[n]) + 2; /* +2 for , " */
- if (len + slen >= nalloced) {
- nalloced +=
- (nalloced + 1024 > len + slen) ? 1024 : slen + 1;
- buff = G_realloc(buff, nalloced);
- cur = buff + len;
- }
- strcpy(cur, ",");
- cur++;
- strcpy(cur, opt->answers[n]);
- cur = strchr(cur, '\0');
- len = cur - buff;
- }
- if (opt->type == TYPE_STRING) {
- strcpy(cur, "\"");
- cur++;
- len = cur - buff;
- }
- }
- opt = opt->next_opt;
- }
- return (buff);
- }
|