/usr/include/InsightToolkit/Utilities/MetaIO/metaCommand.h is in libinsighttoolkit3-dev 3.20.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 | /*============================================================================
MetaIO
Copyright 2000-2010 Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include "metaTypes.h"
#ifndef ITKMetaIO_METACOMMAND_H
#define ITKMetaIO_METACOMMAND_H
#ifdef _MSC_VER
#pragma warning ( disable : 4786 )
#pragma warning ( disable : 4251 )
#endif
#include <stdlib.h>
#include <string>
#include <vector>
#include <list>
#include <map>
#if (METAIO_USE_NAMESPACE)
namespace METAIO_NAMESPACE {
#endif
class METAIO_EXPORT MetaCommand
{
public:
typedef enum {DATA_NONE,DATA_IN,DATA_OUT} DataEnumType;
typedef enum {INT,FLOAT,CHAR,STRING,LIST,FLAG,BOOL,IMAGE,ENUM,FILE} TypeEnumType;
struct Field{
METAIO_STL::string name;
METAIO_STL::string description;
METAIO_STL::string value;
TypeEnumType type;
DataEnumType externaldata;
METAIO_STL::string rangeMin;
METAIO_STL::string rangeMax;
bool required;
bool userDefined;
};
struct Option{
METAIO_STL::string name;
METAIO_STL::string description;
METAIO_STL::string tag;
METAIO_STL::string longtag;
METAIO_STL::string label;
METAIO_STL::vector<Field> fields;
bool required;
bool userDefined;
bool complete;
};
struct ParameterGroup{
METAIO_STL::string name;
METAIO_STL::string description;
METAIO_STL::vector<METAIO_STL::string> options;
bool advanced;
};
typedef METAIO_STL::vector<Option> OptionVector;
typedef METAIO_STL::vector<ParameterGroup> ParameterGroupVector;
MetaCommand();
~MetaCommand() {}
bool SetOption(Option option);
bool SetOption(METAIO_STL::string name,
METAIO_STL::string tag,
bool required,
METAIO_STL::string description,
METAIO_STL::vector<Field> fields);
bool SetOption(METAIO_STL::string name,
METAIO_STL::string tag,
bool required,
METAIO_STL::string description,
TypeEnumType type = FLAG,
METAIO_STL::string defVal = "",
DataEnumType externalData = DATA_NONE);
/** Fields are added in order */
bool AddField(METAIO_STL::string name,
METAIO_STL::string description,
TypeEnumType type,
DataEnumType externalData = DATA_NONE,
METAIO_STL::string rangeMin = "",
METAIO_STL::string rangeMax = ""
);
/** For backward compatibility */
bool AddField(METAIO_STL::string name,
METAIO_STL::string description,
TypeEnumType type,
bool externalData );
/** Add a field to an option */
bool AddOptionField(METAIO_STL::string optionName,
METAIO_STL::string name,
TypeEnumType type,
bool required=true,
METAIO_STL::string defVal = "",
METAIO_STL::string description = "",
DataEnumType externalData = DATA_NONE);
/** Set the range of value as an option */
bool SetOptionRange(METAIO_STL::string optionName,
METAIO_STL::string name,
METAIO_STL::string rangeMin,
METAIO_STL::string rangeMax);
/** Set the list of values that can be used with an option */
bool SetOptionEnumerations(METAIO_STL::string optionName,
METAIO_STL::string name,
METAIO_STL::string optionEnums);
/** Set the long tag for the option */
bool SetOptionLongTag(METAIO_STL::string optionName,
METAIO_STL::string longTag);
/** Set the label for the option */
bool SetOptionLabel(METAIO_STL::string optionName,
METAIO_STL::string label);
/** Set the group for a field or an option
* If the group doesn't exist it is automatically created. */
bool SetParameterGroup(METAIO_STL::string optionName,
METAIO_STL::string groupName,
METAIO_STL::string groupDescription="",
bool advanced=false);
/** Collect all the information until the next tag
* \warning this function works only if the field is of type String */
void SetOptionComplete(METAIO_STL::string optionName,
bool complete);
/** Get the values given the option name */
bool GetValueAsBool(METAIO_STL::string optionName,
METAIO_STL::string fieldName="");
bool GetValueAsBool(Option option,
METAIO_STL::string fieldName="");
float GetValueAsFloat(METAIO_STL::string optionName,
METAIO_STL::string fieldName="");
float GetValueAsFloat(Option option,
METAIO_STL::string fieldName="");
int GetValueAsInt(METAIO_STL::string optionName,
METAIO_STL::string fieldName="");
int GetValueAsInt(Option option,
METAIO_STL::string fieldName="");
METAIO_STL::string GetValueAsString(METAIO_STL::string optionName,
METAIO_STL::string fieldName="");
METAIO_STL::string GetValueAsString(Option option,
METAIO_STL::string fieldName="");
METAIO_STL::list< METAIO_STL::string > GetValueAsList(
METAIO_STL::string optionName);
METAIO_STL::list< METAIO_STL::string > GetValueAsList(Option option);
bool GetOptionWasSet(METAIO_STL::string optionName);
bool GetOptionWasSet(Option option);
/** List the options */
void ListOptions();
void ListOptionsXML();
void ListOptionsSlicerXML();
void ListOptionsSimplified(bool extended=true);
Option * GetOptionByMinusTag(METAIO_STL::string minusTag);
Option * GetOptionByTag(METAIO_STL::string minusTag);
bool OptionExistsByMinusTag(METAIO_STL::string minusTag);
bool Parse(int argc, char* argv[]);
/** Given an XML buffer fill in the command line arguments */
bool ParseXML(const char* buffer);
/** Export the current command line arguments to a Grid Application
* Description file */
bool ExportGAD(bool dynamic=false);
/** Extract the date from cvs date */
METAIO_STL::string ExtractDateFromCVS(METAIO_STL::string date);
void SetDateFromCVS(METAIO_STL::string date);
/** Extract the version from cvs date */
METAIO_STL::string ExtractVersionFromCVS(METAIO_STL::string version);
void SetVersionFromCVS(METAIO_STL::string version);
/** Set the version of the app */
METAIO_STL::string GetVersion()
{ return m_Version; }
void SetVersion(const char* version)
{ m_Version=version; }
/** Get the name of the application */
METAIO_STL::string GetApplicationName()
{ return m_ExecutableName; }
/** Set the date of the app */
METAIO_STL::string GetDate()
{ return m_Date; }
void SetDate(const char* date)
{ m_Date=date; }
void SetName(const char* name)
{ m_Name=name; }
/** Set the description */
void SetDescription(const char* description)
{ m_Description=description; }
METAIO_STL::string GetDescription() const
{return m_Description;}
/** Set the author */
void SetAuthor(const char* author)
{ m_Author=author; }
METAIO_STL::string GetAuthor() const
{return m_Author;}
/** Set the acknowledgments */
void SetAcknowledgments(const char* acknowledgments)
{ m_Acknowledgments=acknowledgments; }
METAIO_STL::string GetAcknowledgments() const
{return m_Acknowledgments;}
/** Set the category */
void SetCategory(const char* category)
{ m_Category=category; }
METAIO_STL::string GetCategory() const
{return m_Category;}
long GetOptionId(Option* option);
/** Return the list of options */
const OptionVector & GetOptions()
{ return m_OptionVector; }
/** Return the list of parse options */
const OptionVector & GetParsedOptions()
{ return m_ParsedOptionVector; }
void SetHelpCallBack(void (* newHelpCallBack)(void))
{ m_HelpCallBack = newHelpCallBack; }
METAIO_STL::string TypeToString(TypeEnumType type);
TypeEnumType StringToType(const char* type);
void SetVerbose(bool verbose) {m_Verbose = verbose;}
void SetParseFailureOnUnrecognizedOption(bool fail)
{ m_FailOnUnrecognizedOption = fail; }
/** Return true if we got the --xml */
bool GotXMLFlag()
{
return m_GotXMLFlag;
}
/** Disable the deprecated warnings */
void DisableDeprecatedWarnings();
/** Load arguments from XML file.
* The second argument when set to true allows
* external classes to use this function to parse XML
* arguments. */
bool LoadArgumentsFromXML(const char* filename,
bool createMissingArguments=false);
protected:
/** Small XML helper */
METAIO_STL::string GetXML(const char* buffer,
const char* desc,
unsigned long pos);
METAIO_STL::string m_Version;
METAIO_STL::string m_Date;
METAIO_STL::string m_Name;
METAIO_STL::string m_Description;
METAIO_STL::string m_Author;
METAIO_STL::string m_ExecutableName;
METAIO_STL::string m_Acknowledgments;
METAIO_STL::string m_Category;
ParameterGroupVector m_ParameterGroup;
private:
void (* m_HelpCallBack)(void);
/** Set the value of an option or a field
* This is used when importing command line arguments
* from XML */
bool SetOptionValue(const char* optionName,
const char* name,
const char* value,
bool createMissingArgument=false);
OptionVector m_OptionVector;
OptionVector m_ParsedOptionVector; // We store the parsed option in
// case we have multiple options
bool m_Verbose;
bool m_FailOnUnrecognizedOption;
bool m_GotXMLFlag;
bool m_DisableDeprecatedWarnings;
// Use when write --xml
void WriteXMLOptionToCout(METAIO_STL::string optionName,unsigned int& index);
}; // end of class
#if (METAIO_USE_NAMESPACE)
};
#endif
#endif
|