1 /*=========================================================================
4 Module: $RCSfile: gdcmArgMgr.cxx,v $
6 Date: $Date: 2005/06/08 08:58:22 $
7 Version: $Revision: 1.4 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
22 #include <string.h> // For strlen
24 #include <string.h> // For strtok and strlen
25 #include <stdlib.h> // For strtol and strtod
27 #include "gdcmArgMgr.h"
31 //-------------------------------------------------------------------------
32 // Constructor / Destructor
36 * @param argc arguments count, as passed to main()
37 * @param argv pointers array on the arguments passed to main()
39 ArgMgr::ArgMgr(int argc, char *argv[])
46 /* Read the parameters of the command line *************************/
47 for ( ArgCount=0, nblettre=1 , i=0; i<argc; i++)
49 if ( FiltreLong(argv[i]) )
51 std::cout << "Argument too long ( > "
52 << ARG_LONG_MAX << ")" << std::endl;
55 if ( argv[i][0] == '@' )
57 nblettre += ArgLoadFromFile ( &argv[i][1] );
61 ArgLab [ArgCount] = strcpy ( (char *)malloc(strlen(argv[i])+1), argv[i] ) ;
62 nblettre += 1 + strlen(ArgLab[ArgCount]);
65 if (ArgCount >= ARGMAXCOUNT )
67 std::cout << "Too many Arguments ( more than "
68 << ARGMAXCOUNT << ")" << std::endl;
73 /* Fills an array with the alreadu used parameters ****/
74 ArgUsed = (char *)calloc (1, ArgCount );
76 /* Builds the full string with all the parameters **************/
77 Appel = (char *) calloc (1, nblettre );
79 for ( *Appel = '\0', i=0; i<ArgCount; i++)
81 strcat ( Appel, ArgLab [i] ) ;
82 strcat ( Appel, " " ) ;
85 /* Splitting label from label value *************************************/
86 for ( i=0; i<ArgCount; i++)
88 char * egaloufin = ArgLab[i] ;
89 while ( (*egaloufin != '\0') && (*egaloufin != '=') )
91 if ( *egaloufin ) *(egaloufin++) = '\0';
95 /* Set labels to upper-case (labels are not case sensitive ) *********/
96 for ( i=0; i<ArgCount; i++)
97 ArgLab[i] = Majuscule ( ArgLab[i] ) ;
99 /* Standard arguments are managed by ArgStdArgs **********************/
104 * \brief canonical destructor
108 for(int i=0;i<ArgCount;i++)
118 * \brief checks if a parameter exists in the command line
119 * @param searchParam label name
120 * @return true if parameter 'label' exists
121 * Actually, it returns 0 if label is not found
122 * else, returns the number of the spot it was found last time.
124 int ArgMgr::ArgMgrDefined( char *searchParam )
128 temp = Majuscule ( searchParam ) ;
129 for ( trouve = false, i = ArgCount-1; i>0; i-- )
131 trouve = ! strcmp( ArgLab[i], temp ) ;
135 for ( int j=1; j<i; j++)
137 if ( (!ArgUsed[j])&&(!strcmp(ArgLab[i],ArgLab[j])) )
147 * \brief Gets the parameter value, read on the command line
148 * @param param name of the searched parameter label
149 * @return Value, as a characters string, of the parameter
150 * whose label is given.
152 char *ArgMgr::ArgMgrValue ( char *param )
155 if ( (trouve = ArgMgrDefined ( param )) != false )
156 return ArgStr[trouve] ;
162 * \brief Search for the first not yet used label
163 * @return Pointer to a char array holding the first non used label
165 char *ArgMgr::ArgMgrUnused ( )
168 for ( i=ArgCount-1; i>0; i-- )
172 ArgMgrDefined(ArgLab[i]);
180 * \brief Prints unused labels, if any
181 * @return number of unused labels
183 int ArgMgr::ArgMgrPrintUnusedLabels ()
187 while ( (label=ArgMgrUnused())!=0 )
190 std::cout << "\n Unused Labels:" << std::endl
191 << "==============" << std::endl;
192 std::cout << "Label : " << label << " = "
193 << ArgMgrValue(label) << std::endl;
200 * \brief Prints program usage
201 * @param usage array of pointers to the documentation lines of the program.
202 * @return exception code
204 int ArgMgr::ArgMgrUsage(char **usage_text )
206 while ( *usage_text )
207 std::cout << std::endl << *(usage_text++);
208 std::cout << std::endl;
213 * \brief Forget it, right now ...
214 * Saves a char. array in a parameter file
215 * whose name is given on command line by : PARAMOUT=???
216 * or, as a default, by ARG_DEFAULT_PARAMOUT
217 * @param param char. array that defines the parameter:
218 * @return Entier correspondant au rang dans la liste de labels
220 int ArgMgr::ArgMgrSave ( char *param )
224 if ( *ArgParamOut == '\0' )
228 fd = fopen ( ArgParamOut, "a+" );
233 fd = fopen ( ArgParamOut, "w" );
237 fprintf ( fd, "%s\n", param );
243 * \brief Gets an int value passed as an argument to a program
244 * (use default value if not found)
245 * EXEMPLE: int dimx = ArgMgrGetInt ( "DIMX", 256 );
246 * @param label label name
247 * @param defaultVal default value
248 * @return parameter value
250 int ArgMgr::ArgMgrGetInt(char *label, int defaultVal)
252 return ( (ArgMgrDefined(label))
253 ? (atoi(ArgMgrValue(label)))
258 * \brief Gets a float value passed as an argument to a program
259 * (use default value if not found)
260 * EXEMPLE: float scale = ArgMgrGetFloat ( "SCALE", 0.33 );
261 * @param label label name
262 * @param defaultVal default value
263 * @return parameter value
265 float ArgMgr::ArgMgrGetFloat(char *label, float defaultVal)
267 return ( (ArgMgrDefined(label))
268 ? ((float)atof(ArgMgrValue(label)))
273 * \brief Gets a 'string' value passed as an argument to a program
274 * (use default value if not found)
275 * @param label label name
276 * @param defaultVal default value
277 * @return parameter value
279 char *ArgMgr::ArgMgrGetString(char *label, char *defaultVal)
281 return ( (ArgMgrDefined(label))
282 ? (ArgMgrValue(label))
287 * \brief Gets a value amongst a set of values
288 * (use default value if not found)
289 * EXEMPLE: int nlab = ArgMgrGetLabel("CONFIRM","NO\\YES", 0);
290 * @param label label name
291 * @param liste character Chain describing the various values.
292 * Value are separated by '\\'.
293 * Not case sensitive.
294 * @param val number of default value
295 * @return int : range of value amongst the values list
297 int ArgMgr::ArgMgrGetLabel (char *label, char *liste, int val )
303 tmp = (char *) malloc(strlen(liste)+1);
306 if ( (vallab = ArgMgrGetString(label,(char *)NULL)) != 0 )
308 for ( lab = strtok (tmp,"\\");
310 lab = strtok(0L,"\\"), i++ )
312 if ( strcmp(maj(lab),maj(vallab))==0)
322 * \brief Demands a value amongst a set of values (abort if not found)
323 * EXEMPLE: int nlab = ArgMgrWantLabel("CONFIRM","NO\\YES", usage);
324 * @param label label name
325 * @param liste character Chain describing the various values.
326 * Labels are separated by '\\'.
328 * @param usage Usage program (displayed if label not found)
329 * @return int : range of value amongst the values list
331 int ArgMgr::ArgMgrWantLabel (char *label, char *liste, char *usage[] )
336 if ( (vallab = ArgMgrGetString(label,0)) != 0 )
338 for ( lab = strtok (liste,"\\"); lab != 0; lab = strtok(0L,"\\"), i++ )
339 if ( strcmp(maj(lab),maj(vallab))==0)
348 * \brief Demands an int value passed as an argument to a program
349 * If not found usage is displayed and the prog aborted
350 * EXEMPLE: int dimx = ArgMgrWantInt ( "DIMX", usage );
351 * @param label label name
352 * @param usage Usage program (displayed if label not found)
353 * @return parameter value
355 int ArgMgr::ArgMgrWantInt (char *label, char **usage)
357 return ( (ArgMgrDefined(label) )
358 ? (atoi(ArgMgrValue(label) ) )
359 : (ArgMgrUsage(usage),1) );
363 * \brief Demands a float value passed as an argument to a program
364 * If not found usage is displayed and the prog aborted
365 * EXEMPLE: float scale = ArgMgrWantFloat ( "SCALE", usage );
366 * @param label label name
367 * @param usage Usage program (displayed if label not found)
368 * @return parameter value
370 float ArgMgr::ArgMgrWantFloat (char *label, char **usage)
372 return ( (ArgMgrDefined(label) )
373 ? ((float)atof(ArgMgrValue(label) ) )
374 : (ArgMgrUsage(usage),1.0) );
378 * \brief Demands a 'string' value passed as an argument to a program
379 * If not found usage is displayed and the prog aborted
380 * EXEMPLE: char *code = ArgMgrWantString ( "CODE", usage );
381 * @param label Parameter label
382 * @param usage Usage program (displayed if label not found)
383 * @return parameter value
385 char *ArgMgr::ArgMgrWantString(char *label, char **usage)
387 return ( (ArgMgrDefined(label) )
388 ? (ArgMgrValue(label) )
389 : (ArgMgrUsage(usage),(char*)0) );
393 * \brief decodage des elements d'un argument 'ensemble de STRING' de lgr qcq
394 * @param label label name
395 * @param number nb of found elements
396 * @return Pointer to the array
397 * Pointer NULL if error
399 char **ArgMgr::ArgMgrGetListOfString ( char *label, int *nbElem )
402 char *value = ArgMgrValue(label);
408 *nbElem = IdStrCountChar(value,',')+1; /* nb Elements = nb Commas +1 */
410 liste = (char **) malloc (sizeof(char*) * taille + strlen(value)+1);
413 value = strcpy( ((char*)liste)+sizeof(char*) * taille, value );
414 for ( elem = liste, chainecur = strtok(value,", ");
416 taille--, chainecur = (chainecur) ? strtok ( 0, ", " ) : 0 )
418 *(elem++) = chainecur;
424 * \brief decodage des elements d'un argument 'liste d'INTEGER' de lgr qcq
425 * @param label label name
426 * @param number nb of found elements
427 * @return Pointer to the array
428 * Pointer NULL if error
430 int *ArgMgr::ArgMgrGetListOfInt ( char *label, int *number )
432 char *value = ArgMgrValue(label);
438 *number = IdStrCountChar(value,',')+1; /* nb Elements = nb Commas +1 */
440 liste = (int *) calloc (1,sizeof(int)*taille );
448 *(elem++) = (int) strtol ( value, &value, 10 );
449 if ( *value == '\0' )
451 if ( *(value++) != ',' )
462 * \brief decodage des elements d'un argument 'liste de FLOAT' de lgr qcq
463 * @param label label name
464 * @param number taille de la liste trouvee
465 * @return Pointer vers le tableau de lgr 'taille'
468 float *ArgMgr::ArgMgrGetListOfFloat ( char *label, int *number )
470 char *value = ArgMgrValue(label);
476 *number = IdStrCountChar(value,',')+1; /* nb Elements = nb Commas +1 */
478 liste = (float *) calloc (1,sizeof(float)*taille );
486 *(elem++) = (float) strtod ( value, &value );
487 if ( *value == '\0' )
489 if ( *(value++) != ',' )
500 * \brief Counts the nb of occurrences of a given charact within a 'string'
501 * @param chaine Pointer to the 'string'
502 * @param caract charact to count
503 * @return occurence number
505 int ArgMgr::IdStrCountChar (char *chaine, int caract)
509 for ( ptr = chaine ; *ptr!='\0' ; ptr ++ )
516 * \brief renvoie 1 tableau contenant un ensemble de paires d'entiers
517 * @param value pointer vers la zone allouee contenant les
518 * intervalles (deb1,fin1, deb2,fin2, ...)
519 * @param number Pointer vers le nb de paires trouvees
520 * @return 1 tableau contenant un ensemble de paires d'entiers
522 int *ArgMgr::IdStrIntEnum ( char* value, int *number)
528 *number = IdStrCountChar(value,',')+1; /* nb Elements = nb Virgules +1 */
530 liste = (int *) calloc (1,sizeof(int)*2*taille );
538 liste[i] = (int) strtol ( value, &value, 10 );
539 if ( *value == '\0' )
544 if ( *(value++) != '-' )
551 liste[i+1] = (int) strtol ( value, &value, 10 );
553 if ( *value == '\0' )
555 if ( *(value++) != ',' )
566 * \brief renvoie 1 tableau contenant un ensemble de 'paires' de FLOAT
567 * @param value pointer vers la zone allouee contenant les
568 * paires (deb1,fin1, deb2,fin2, ...)
569 * @param number Pointer vers le nb de paires trouvees
570 * @return tableau contenant un ensemble de 'paires' de FLOAT
572 float *ArgMgr::IdStrFloatEnum (char *value, int *number)
577 *number = IdStrCountChar(value,',')+1; /* nb Elements = nb Virgules +1 */
579 liste = (float *) calloc (1,sizeof(float)*2*taille );
585 liste[i] = (float) strtod ( value, &value );
586 if ( *value == '\0' )
591 if ( *(value++) != '-' )
598 liste[i+1] = (float) strtod ( value, &value );
600 if ( *value == '\0' )
602 if ( *(value++) != ',' )
613 * \brief decodage des elements d'un argument 'paires d'int' de lgr quelconque
614 * @param label label name
615 * @param number taille de l'ensemble de paires trouvee
616 * @return Pointer vers le tableau de taille '2*nbElem'
617 * Pointer NULL si erreur
619 int *ArgMgr::ArgMgrGetIntEnum ( char *label, int *number )
621 char *value = ArgMgrValue(label);
625 liste = IdStrIntEnum(value, number);
630 * \brief decodage des elements d'un argument 'paires de float' de lgr quelconque
631 * @param label label name
632 * @param number taille de l'ensemble de paires trouvee
633 * @return Pointer vers le tableau de taille '2*nbElem'
634 * Pointer NULL si erreur
636 float *ArgMgr::ArgMgrGetFloatEnum ( char *label, int *number )
638 char *value = ArgMgrValue(label);
642 liste = IdStrFloatEnum(value, number);
646 //-----------------------------------------------------------------------------
649 //-----------------------------------------------------------------------------
652 /**************************************************************************
654 * Nom de la fonction : Majuscule *
655 * Role ............. : Creates a new Upper case char array. *
656 * parameters ....... : Pointer to the initial char array. * *
657 * Valeur retournee . : Pointer to the new Upper case char array. *
659 **************************************************************************/
660 char *ArgMgr::Majuscule (char *chaine )
662 char *ptr, *ptr2, *ptr3;
663 ptr2 = (char *)malloc(strlen(chaine)*sizeof(char)+1);
665 for ( ptr = chaine ; *ptr!='\0' ; ptr ++ )
667 *ptr3 = toupper ( * ptr ); ptr3++;
673 /**************************************************************************
675 * Nom de la fonction : FiltreLong *
676 * Role ............. : Stops the program if argument is too long. *
677 * ARG_LONG_MAX defines max length. *
678 * parameters ....... : Pointer to the argument. *
679 * Valeur retournee . : false if OK. *
681 **************************************************************************/
682 int ArgMgr::FiltreLong ( char *arg )
685 while ( (n++<ARG_LONG_MAX) && (*(arg++) != '\0') ) ;
686 return (n>=ARG_LONG_MAX) ;
689 /*------------------------------------------------------------------------
690 | Role : Reads a parameter from a file
691 | Return : Type : char *
692 | Role : pointer to the label
693 | parameters : param : char *
694 | Role : one where the parameter will be stored
696 | Role : File description (assumed to be open)
697 +------------------------------------------------------------------------*/
698 char *ArgMgr::LoadedParam ( char *param, FILE *fd )
705 /* remove spaces at the beginning****/
706 while ( isspace(carlu=fgetc (fd)) );
714 /* Read all the characters */
717 && ( ( (!quote)&&(!isspace(carlu)) )
718 ||( (quote)&& !(carlu=='\"') ) ) )
720 *(car++) = (char) carlu;
722 /* sans depasser la taille max*/
723 if ( nbcar >= ARG_LONG_MAX )
725 std::cout << "\nError: Argument too long ( > "
726 << ARG_LONG_MAX << ")in parameter file."
736 /*------------------------------------------------------------------------
737 | Role : Reading of arguments in a parameter file
738 | (this function is recursive).
739 | Return : Type : int
740 | Role : length needed to store all the parameters
741 | parameters : filename : char *
742 | Role : parameter File name
744 +------------------------------------------------------------------------*/
745 int ArgMgr::ArgLoadFromFile ( char *filename )
748 char param[ARG_LONG_MAX+1];
751 fch = fopen ( filename, ID_RFILE_TEXT );
752 while ( LoadedParam (param, fch ) )
754 int n = strlen(param);
757 nbl += ArgLoadFromFile ( ¶m[1] );
761 ArgLab [ArgCount] = strcpy ((char *) malloc(n+1), param ) ;
764 if ( ArgCount >= ARGMAXCOUNT )
772 /*------------------------------------------------------------------------
773 | Role : Standard parameters management (on command line)
774 | Return : Type : void
776 +------------------------------------------------------------------------*/
777 void ArgMgr::ArgStdArgs()
782 if ( (ArgParamOut=ArgMgrValue(ARG_LABEL_PARAMOUT))==0 )
783 ArgParamOut = ARG_DEFAULT_PARAMOUT;
784 if ( (logfile = ArgMgrValue(ARG_LABEL_LOGFILE))!=0)
786 if ( *logfile == '\0' )
787 logfile = (char *)ARG_DEFAULT_LOGFILE;
788 fd = fopen ( logfile, "a+" );
791 fprintf ( fd, "%s\n", Appel );
797 /*------------------------------------------------------------------------
798 | Role : Sets in Upper Case.
799 | Return : Type : char *
800 | parameters : char *
801 +------------------------------------------------------------------------*/
802 char *ArgMgr::maj ( char *a )
807 if ( *b<='z' && *b>='a' ) *b = *b+'A'-'a';
812 //-----------------------------------------------------------------------------
815 //-----------------------------------------------------------------------------
816 } // end namespace gdcm