Parser for config files; validation

Detailed Description

Classes for configuration file parsing, content validation and conversion.

Transformation of configuration file to destination variables

Transformation consists of several groups of classes:

Parsed file: pf_File and its members are exact memory representation of the structure of a configuration file. pf_* classes are filled by a bison generated parser.
Configuration values: Classes, derived from cfg_Base (i.e. cfg_Partition and its members) do the validation and transformation of string values from pf_File to target values that they hold (numbers, vectors...). They "know" the file contents.
Conversion classes: Classes, derived from val_Value do transformation from a single string value to a single target value. They represent the rules of transformation.
Rule vector: val_RuleVec contains a collection of rules that are used by cfg_Base::Convert() to convert val_File's content's values to target values.

Transformation consists of several major stages:

Parsing of configuration file to an intermediate structure pf_File.
pf_File (or one of its subparts) is an input to a constructor (or some other function that fills the members) of a class, derived from cfg_Base (e.g. cfg_Partition).
Constructor of cfg_Base's successor defines a collection of rules (derivations from val_Value) in an instance of val_RuleVec. It calls cfg_Base::Convert() which does the actual tranformaton, based on specified rules.
If cfg_Base::Convert() encounters a subgroup (pf_Group) inside pf_File's structure to convert, it calls virtual function ConvertGroup(), which has to be implemented by the derived class. Default implementation supposes an error.
ConvertGroup() decides which of its subparts (members) must be parsed from the specified arguments and calls a constructor of the member with the group as a parameter.

For more information see also ivd-doc\Design\LLD_Architecture\IVD_Architecture_LLD_Parser.vsd

How to use the parser for your own configuration file?

Define the parameters that you need in a configuration file.
Define its names and the structure (sections, nesting, ...).
Define the memory structure for the parsed variables.
Define the lower/upper limit for each of the variables and its format.
Decide on one class for the main structure and (optional) multiple to contain member (sub)structures.
Create classes, derived from cfg_Content to hold target values.

Implement constructor my_Main(const pf_File &a_parsedFile). The constructor should first call cfg_Base::ConvertFileHeader() and then fill an instance of val_RuleVec with rules. Rules are instances of derivations of val_Value, created with new.

NOTE: val_RuleVec calls delete on each of the elements of the vector when it goes out of scope.

cfg_Base::Convert() function is then called for common section and all of the other sections. Example of a constructor:

my_Main::my_Main(const pf_File &a_parsedFile) {
    static const string c_partID = "IVDPartition";

    static const string c_migChangeTrig = "fileChangeTrigger";
    static const string c_migMinFileAge = "minFileAge";
    static const string c_migMaxJobSize = "maxMigJobSize";
    
    ConvertFileHeader(a_parsedFile);
    val_RuleVec rules;

    rules.Add(new val_String(c_partID, cfg_Limit(1, 1024)), this->ivdPartition);
    rules.Add(new val_String(c_migChangeTrig, cfg_Limit(1, 255)), this->fileChangeTrigger);
    rules.Add(new val_Duration(c_migMinFileAge, cfg_Limit(1, 10000)), this->minFileAge);
    rules.Add(new val_Size(c_migMaxJobSize, cfg_Limit(1, LONG_MAX)), this->maxMigJobSize);

    //Validate and convert common section
    Convert(a_parsedFile.m_common, rules);

    //Validate and convert other sections
    for (unsigned int i = 0; i < a_parsedFile.m_sections.size(); i++) {
        // if section name is needed here it is: i->first 
        Convert(a_parsedFile.m_sections.At(i) , rules);
    };
}

cfg_Base::Convert() will call virtual function cfg_Base::ConvertGroup() for each group that it encounters. If your configuration file will have groups, then you will have to implement your own ConvertGroup(). An example:

void my_Main::ConvertGroup(const string &a_grpName, const pf_Group &a_group) {
    log_FUNC_A_m(ConvertGroup, "a_grpName " << a_grpName);

    static const string c_tree = "Tree";
    static const string c_client = "Client";

    if ( strcasecmp(a_group.grpType.c_str(), c_tree.c_str()) == 0 ) {
        pm_Tree tree(a_grpName, a_group);
        this->trees.push_back(tree);
    }
    else if ( strcasecmp(a_group.grpType.c_str(), c_client.c_str()) == 0 ) {
        pm_Client client(a_grpName, a_group);
        this->clients.push_back(client);
    }
    else {
        log_WRN_m("Unknown group type: " << a_grpName);
    }
}

Note that my_Tree and my_Client are also derived from cfg_Base, so the constructors take pf_Group parameters to instantiate from. my_Tree and my_Client can also have subgroups of their own. They would simply define their own ConvertGroup() functions.

As seen above, member structures (classes) must be able to instantiate themselves from pf_Group parameter. Example:

pm_Client::pm_Client(const string &a_name, const pf_Group &a_group) {
    static const string c_filesystem = "FileSystem";

    this->name = a_name;

    val_RuleVec  rules;
    rules.Add(new val_String(c_filesystem, cfg_Limit(1, 1024)), this->fileSystem);

    Convert(a_group, rules);
}

There are several already defined rule classes that you can use for conversion. For additional information on creating new rules, please see val_Value.

See also:: val_Value

Define Documentation

#define cfg_BASE_HEADER_FILEDATE "Date"

Definition at line 55 of file cfg_defines.h.

Referenced by mif_CfgRep::ReplaceDate().

#define cfg_BASE_HEADER_FILETYPE "FileType"

Definition at line 53 of file cfg_defines.h.

#define cfg_BASE_HEADER_FILEUSER "User"

Definition at line 56 of file cfg_defines.h.

Referenced by mif_CfgRep::ReplaceUser().

#define cfg_BASE_HEADER_FILEVERSION "Version"

Definition at line 54 of file cfg_defines.h.

Referenced by mif_CfgRep::ReplaceVersion().

#define cfg_DAY (24*cfg_HOUR)

Definition at line 41 of file cfg_defines.h.

Referenced by job_Manager::RemoveFromList(), hsm_FHmigc::Run(), and val_Duration::Validate().

#define cfg_DEF_ADPATH ""

Definition at line 385 of file cfg_defines.h.


Classes
class	ap_Argument
class	cfg_Base
class	cfg_DriveType
class	cfg_DriveVendor
class	cfg_DriveSettings
class	cfg_Library
class	cfg_LibraryFile
class	cfg_PMClient
	This class is member of cfg_pmCfg. More...
class	cfg_PMTree
	This class is member of cfg_pmCfg. More...
class	cfg_PMFileExpiration
	This class is member of cfg_pmCfg. More...
class	cfg_PMCfg
	cfg_PMCfg is derived from val_Base to handle configuration of the IVD Partition Manager. More...
class	cfg_RMHost
	This class is member of cfg_RMDrive. More...
class	cfg_RMDrive
	cfg_RMDrive is derived from val_Base to handle configuration of the IVD Resource Manager Configuration for Drive. More...
class	cfg_RMLibrary
	cfg_RMLibrary is derived from val_Base to handle configuration of the IVD Resource Manager Configuration for Drive. More...
class	cfg_RMPool
class	cfg_Server
	cfg_Server is derived from cfg_Base to handle configuration of the IVD Server. More...
class	cfg_CliBase
	This class is a base for parsed and validated data specified in cli. More...
class	cfg_CliRecover
class	cfg_CliCheck
class	cfg_CliJob
class	cfg_CliLibrary
class	cfg_CliDrive
class	cfg_CliPool
class	cfg_CliMedium
class	cfg_CliSystem
class	cfg_CliPartition
class	cfg_CliBak
class	cfg_Cli_fsc
class	cfg_Cli_hsm
class	cfg_CliDD
class	cfg_CliCreateFile
class	cfg_CliFile
class	cfg_ivddbg
class	pf_Component
	Base class for components of a parsed file. More...
class	pf_Elem
class	pf_List
class	pf_ValueBase
class	pf_Value
class	pf_ValueList
class	pf_Group
class	pf_Section
class	pf_SectionList
class	pf_File
class	val_Limit
class	val_Element< ET >
class	val_BasicValue
class	val_RangeValue
class	val_ValueList
class	val_LiteralValue
class	val_Value
	Base class for all of the conversion (or rule) classes that convert any string to a basic type. More...
class	val_RuleVec
	Container for conversion rules. More...
class	val_String
class	val_StrictString
	StrictString does check leading and trailing spaces plus new lines inside string. More...
class	val_Path
class	val_Bool
class	val_Integer
class	val_Duration
class	val_Time
class	val_Size
class	val_Percentage
class	val_ObjectName
class	val_Hostname
class	val_CliCommand
class	val_LibType
class	val_PoolType
class	val_MediaFamilyType
class	val_SysVolLocationType
class	val_FSType
class	val_DriveCapab
class	val_DbgLevel
class	val_DbgFlags
class	val_Range< CNV, DT >
class	val_List< CNV, DT >
	This template is used to make rules for conversion to vectors of values from some list-type input (eg cfg_Val_t of type CFGVAL_LIST). More...
class	val_SlotList
class	val_FileNamePattern
class	val_FileNamePatternList
Defines
#define	cfg_INFINITE (LONG_MAX)
#define	cfg_MINUTE (60)
#define	cfg_HOUR (60*cfg_MINUTE)
#define	cfg_DAY (24*cfg_HOUR)
#define	cfg_YEAR (365*cfg_DAY)
#define	cfg_KILOBYTE (1024)
#define	cfg_MEGABYTE (1024*cfg_KILOBYTE)
#define	cfg_GIGABYTE (1024LL*cfg_MEGABYTE)
#define	cfg_TERABYTE (1024LL*cfg_GIGABYTE)
#define	cfg_UNLIMITED "UNLIMITED"
#define	cfg_BASE_HEADER_FILETYPE "FileType"
#define	cfg_BASE_HEADER_FILEVERSION "Version"
#define	cfg_BASE_HEADER_FILEDATE "Date"
#define	cfg_BASE_HEADER_FILEUSER "User"
#define	cfg_MIN_FILE_TYPE (1)
#define	cfg_MAX_FILE_TYPE (255)
#define	cfg_MIN_FILE_VERSION (1)
#define	cfg_MAX_FILE_VERSION cfg_INFINITE
#define	cfg_MIN_FILE_DATE (0)
#define	cfg_MAX_FILE_DATE cfg_INFINITE
#define	cfg_MIN_FILE_USER (0)
#define	cfg_MAX_FILE_USER (255)
#define	cfg_MAX_FILENAME ivd_MAX_FILENAME
#define	cfg_MAX_PATHNAME ivd_MAX_PATHNAME
#define	cfg_MIN_PATHNAME (1)
#define	cfg_MIN_HOSTNAME (1)
#define	cfg_MAX_HOSTNAME rmdb_MAX_HOSTNAME
#define	cfg_FILE_VAR_HOST "Host"
#define	cfg_FILE_VAR_CLIENT "Client"
#define	cfg_MIN_OPTION_NAME (1)
#define	cfg_MAX_OPTION_NAME (50)
#define	cfg_MIN_MEDIAFAMILY_NAME cfg_MIN_OPTION_NAME
#define	cfg_MAX_MEDIAFAMILY_NAME cfg_MAX_OPTION_NAME
#define	cfg_MIN_CTRLDEVICE (1)
#define	cfg_MAX_CTRLDEVICE rmdb_MAX_CTRLDEVICE
#define	cfg_MIN_BLOCK_SIZE_KB ivd_MIN_BLOCK_SIZE_KB
#define	cfg_MAX_BLOCK_SIZE_KB (1536)
#define	cfg_MIN_BLOCK_SIZE (cfg_MIN_BLOCK_SIZE_KB*cfg_KILOBYTE)
#define	cfg_MAX_BLOCK_SIZE (cfg_MAX_BLOCK_SIZE_KB*cfg_KILOBYTE)
#define	cfg_DEF_BLOCK_SIZE "32KB"
#define	cfg_MIN_CAPABILITIES_NAME cfg_MIN_OPTION_NAME
#define	cfg_MAX_CAPABILITIES_NAME cfg_MAX_OPTION_NAME
#define	CFG_LINK_LATEST "latest"
#define	cfg_MIN_LIBRARY_NAME (1)
#define	cfg_MAX_LIBRARY_NAME rmdb_MAX_LIBRARYNAME
#define	cfg_MIN_LIBRARY_TYPE cfg_MIN_OPTION_NAME
#define	cfg_MAX_LIBRARY_TYPE cfg_MAX_OPTION_NAME
#define	cfg_MIN_SLOTS_NAME (1)
#define	cfg_MAX_SLOTS_NAME rmdb_MAX_SLOTADDR
#define	cfg_MIN_MAILSLOTS_NAME (1)
#define	cfg_MAX_MAILSLOTS_NAME rmdb_MAX_SLOTADDR
#define	cfg_MAX_SLOT_NUM (50000)
#define	cfg_MIN_DRIVE_NAME (1)
#define	cfg_MAX_DRIVE_NAME rmdb_MAX_DRIVENAME
#define	cfg_MIN_DRIVEIDX (1)
#define	cfg_MAX_DRIVEIDX rmdb_MAX_DRIVEIDX
#define	cfg_MIN_POOL_NAME (1)
#define	cfg_MAX_POOL_NAME rmdb_MAX_MEDIAPOOLNAME
#define	cfg_MIN_POOL_TYPE (0)
#define	cfg_MAX_POOL_TYPE (INT_MAX)
#define	cfg_DEF_POOL_TYPE "regular"
#define	cfg_MIN_MEDIA_AGE (30*cfg_DAY)
#define	cfg_MAX_MEDIA_AGE cfg_INFINITE
#define	cfg_DEF_MEDIA_AGE "60M"
#define	cfg_MIN_READ_WRITE (10)
#define	cfg_MAX_READ_WRITE cfg_INFINITE
#define	cfg_DEF_READ_WRITE "30000"
#define	cfg_MIN_NUM_OF_VOL (1)
#define	cfg_MAX_NUM_OF_VOL (32)
#define	cfg_DEF_NUM_OF_VOL "1"
#define	cfg_MIN_LOC_OF_SYS_VOL (1)
#define	cfg_MAX_LOC_OF_SYS_VOL (6)
#define	cfg_DEF_LOC_OF_SYS_VOL "None"
#define	cfg_MIN_SYSTEM_VOL_SIZE (0)
#define	cfg_MAX_SYSTEM_VOL_SIZE (10*cfg_GIGABYTE)
#define	cfg_DEF_SYSTEM_VOL_SIZE "512MB"
#define	cfg_MIN_VOL_SIZE (100*cfg_MEGABYTE)
#define	cfg_MAX_VOL_SIZE (2000*cfg_GIGABYTE)
#define	cfg_DEF_VOL_SIZE "100GB"
#define	cfg_MIN_PARTITION_NAME (1)
#define	cfg_MAX_PARTITION_NAME rmdb_MAX_PARTITIONNAME
#define	cfg_MIN_MINFILEAGE (1)
#define	cfg_MAX_MINFILEAGE (2*cfg_DAY)
#define	cfg_DEF_MINFILEAGE "10m"
#define	cfg_MIN_FILE_HEAD_SIZE (256)
#define	cfg_MAX_FILE_HEAD_SIZE (100*cfg_KILOBYTE)
#define	cfg_DEF_FILE_HEAD_SIZE cfg_MIN_FILE_HEAD_SIZE
#define	cfg_MIN_MAXMIGJOBSIZE cfg_MIN_FILE_HEAD_SIZE
#define	cfg_MAX_MAXMIGJOBSIZE (500*cfg_GIGABYTE)
#define	cfg_DEF_MAXMIGJOBSIZE "50MB"
#define	cfg_MIN_MINWAITTIME (1)
#define	cfg_MAX_MINWAITTIME (24*cfg_HOUR)
#define	cfg_DEF_MINWAITTIME "10m"
#define	cfg_MIN_MINNUMMIGFILES (1)
#define	cfg_MAX_MINNUMMIGFILES (10000)
#define	cfg_DEF_MINNUMMIGFILES "1"
#define	cfg_MIN_MINMIGSIZE cfg_MIN_FILE_HEAD_SIZE
#define	cfg_MAX_MINMIGSIZE (1*cfg_TERABYTE)
#define	cfg_DEF_MINMIGSIZE "100MB"
#define	cfg_MIN_MAXWAITTIME (1)
#define	cfg_MAX_MAXWAITTIME (5*cfg_DAY)
#define	cfg_DEF_MAXWAITTIME "30m"
#define	cfg_MIN_MAXNUMMIGFILES (1)
#define	cfg_MAX_MAXNUMMIGFILES (130000)
#define	cfg_DEF_MAXNUMMIGFILES "1000"
#define	cfg_MIN_MAXMIGSIZE (cfg_MEGABYTE)
#define	cfg_MAX_MAXMIGSIZE (5*cfg_TERABYTE)
#define	cfg_DEF_MAXMIGSIZE "500MB"
#define	cfg_MIN_FORCEDMIGWATERMARK (1)
#define	cfg_MAX_FORCEDMIGWATERMARK (50)
#define	cfg_DEF_FORCEDMIGWATERMARK (5)
#define	cfg_MIN_HIGHWATERMARK (10)
#define	cfg_MAX_HIGHWATERMARK (95)
#define	cfg_DEF_HIGHWATERMARK "85%"
#define	cfg_MIN_LOWWATERMARK (0)
#define	cfg_MAX_LOWWATERMARK (90)
#define	cfg_DEF_LOWWATERMARK "35%"
#define	cfg_MIN_CRITICALWATERMARK (80)
#define	cfg_MAX_CRITICALWATERMARK (100)
#define	cfg_DEF_CRITICALWATERMARK "95%"
#define	cfg_MIN_RELEASE_INTERVAL (1)
#define	cfg_MAX_RELEASE_INTERVAL (cfg_DAY)
#define	cfg_DEF_RELEASE_INTERVAL "30s"
#define	cfg_MAX_START_RELEASE_EARLY (1)
#define	cfg_DEF_START_RELEASE_EARLY "0"
#define	cfg_MIN_START_RELEASE_NUMF (500)
#define	cfg_MAX_START_RELEASE_NUMF (10000)
#define	cfg_DEF_START_RELEASE_NUMF "1000"
#define	cfg_MIN_START_RELEASE_TIME (1)
#define	cfg_MAX_START_RELEASE_TIME (cfg_MINUTE)
#define	cfg_DEF_START_RELEASE_TIME "5"
#define	cfg_MIN_MIGRETENTIONTIME (1)
#define	cfg_MAX_MIGRETENTIONTIME (INT_MAX)
#define	cfg_DEF_MIGRETENTIONTIME "2h"
#define	cfg_MIN_RECALLRETENTIONTIME (1)
#define	cfg_MAX_RECALLRETENTIONTIME (INT_MAX)
#define	cfg_DEF_RECALLRETENTIONTIME "24h"
#define	cfg_MIN_MINFILESIZE (0)
#define	cfg_MAX_MINFILESIZE cfg_MEGABYTE
#define	cfg_DEF_MINFILESIZE "2kb"
#define	cfg_MIN_RECALL_TIMEOUT (1)
#define	cfg_MAX_RECALL_TIMEOUT (8*cfg_HOUR)
#define	cfg_DEF_RECALL_TIMEOUT "15m"
#define	cfg_MIN_MAXNUMDRIVES_P (0)
#define	cfg_MAX_MAXNUMDRIVES_P (64)
#define	cfg_DEF_MAXNUMDRIVES_P "64"
#define	cfg_MIN_MAXNUMDRIVESRECALL_P (0)
#define	cfg_MAX_MAXNUMDRIVESRECALL_P (64)
#define	cfg_DEF_MAXNUMDRIVESRECALL_P "64"
#define	cfg_MIN_MAXNUMDRIVESMIG_P (0)
#define	cfg_MAX_MAXNUMDRIVESMIG_P (64)
#define	cfg_DEF_MAXNUMDRIVESMIG_P "64"
#define	cfg_MIN_MAXNUMDRIVESREORG_P (0)
#define	cfg_MAX_MAXNUMDRIVESREORG_P (64)
#define	cfg_DEF_MAXNUMDRIVESREORG_P "64"
#define	cfg_MIN_MAXNUMDRIVESRECOVERY_P (0)
#define	cfg_MAX_MAXNUMDRIVESRECOVERY_P (64)
#define	cfg_DEF_MAXNUMDRIVESRECOVERY_P "20"
#define	cfg_MIN_MAXNUMDRIVESMAINT_P (0)
#define	cfg_MAX_MAXNUMDRIVESMAINT_P (64)
#define	cfg_DEF_MAXNUMDRIVESMAINT_P "20"
#define	cfg_MIN_RESNUMDRIVES (0)
#define	cfg_MAX_RESNUMDRIVES (64)
#define	cfg_DEF_RESNUMDRIVES "0"
#define	cfg_MIN_RESNUMDRIVESRECALL (0)
#define	cfg_MAX_RESNUMDRIVESRECALL (64)
#define	cfg_DEF_RESNUMDRIVESRECALL "0"
#define	cfg_MIN_RESNUMDRIVESMIG (0)
#define	cfg_MAX_RESNUMDRIVESMIG (64)
#define	cfg_DEF_RESNUMDRIVESMIG "0"
#define	cfg_MIN_RESNUMDRIVESREORG (0)
#define	cfg_MAX_RESNUMDRIVESREORG (64)
#define	cfg_DEF_RESNUMDRIVESREORG "0"
#define	cfg_MIN_PARTPRIORITY (0)
#define	cfg_MAX_PARTPRIORITY (100)
#define	cfg_DEF_PARTPRIORITY "50"
#define	cfg_MIN_PARTRECALLPRIORITY (0)
#define	cfg_MAX_PARTRECALLPRIORITY (100)
#define	cfg_DEF_PARTRECALLPRIORITY "80"
#define	cfg_MIN_PARTMIGPRIORITY (0)
#define	cfg_MAX_PARTMIGPRIORITY (100)
#define	cfg_DEF_PARTMIGPRIORITY "20"
#define	cfg_MIN_PARTREORGPRIORITY (0)
#define	cfg_MAX_PARTREORGPRIORITY (100)
#define	cfg_DEF_PARTREORGPRIORITY "10"
#define	cfg_MIN_PARTRECOVERYPRIORITY (0)
#define	cfg_MAX_PARTRECOVERYPRIORITY (100)
#define	cfg_DEF_PARTRECOVERYPRIORITY "100"
#define	cfg_MIN_PARTMAINTPRIORITY (0)
#define	cfg_MAX_PARTMAINTPRIORITY (100)
#define	cfg_DEF_PARTMAINTPRIORITY "80"
#define	cfg_MIN_FSCMODE (1)
#define	cfg_MAX_FSCMODE (1)
#define	cfg_DEF_FSCMODE "1"
#define	cfg_MIN_FSTYPE_P (1)
#define	cfg_MAX_FSTYPE_P (50)
#define	cfg_DEF_FSTYPE_P "REGULAR"
#define	cfg_MIN_WORMTIMEOUT (0)
#define	cfg_MAX_WORMTIMEOUT (7200)
#define	cfg_DEF_WORMTIMEOUT "450s"
#define	cfg_MIN_FILESYSTEM_ID (1)
#define	cfg_MAX_FILESYSTEM_ID (255)
#define	cfg_MIN_ADPATH (0)
#define	cfg_MAX_ADPATH ivd_MAX_PATHNAME
#define	cfg_DEF_ADPATH ""
#define	cfg_MIN_DISABLEAUTOMATICMIGRATIONS (0)
#define	cfg_MAX_DISABLEAUTOMATICMIGRATIONS (1)
#define	cfg_DEF_DISABLEAUTOMATICMIGRATIONS "0"
#define	cfg_MIN_EXPIRATIONAGE cfg_DAY
#define	cfg_MAX_EXPIRATIONAGE cfg_INFINITE
#define	cfg_DEF_EXPIRATIONAGE cfg_UNLIMITED
#define	cfg_MIN_CONFHISTORY (1)
#define	cfg_MAX_CONFHISTORY (999)
#define	cfg_DEF_CONFHISTORY (10)
#define	cfg_MIN_MAXNUMDRIVESRECALL (0)
#define	cfg_MAX_MAXNUMDRIVESRECALL (64)
#define	cfg_DEF_MAXNUMDRIVESRECALL "20"
#define	cfg_MIN_MAXNUMDRIVESRECOVERY (0)
#define	cfg_MAX_MAXNUMDRIVESRECOVERY (64)
#define	cfg_DEF_MAXNUMDRIVESRECOVERY "20"
#define	cfg_MIN_MAXNUMDRIVESMAINT (0)
#define	cfg_MAX_MAXNUMDRIVESMAINT (64)
#define	cfg_DEF_MAXNUMDRIVESMAINT "20"
#define	cfg_MIN_MAXNUMDRIVESMIGRATION (0)
#define	cfg_MAX_MAXNUMDRIVESMIGRATION (64)
#define	cfg_DEF_MAXNUMDRIVESMIGRATION "20"
#define	cfg_MIN_MAXNUMDRIVESADMIN (0)
#define	cfg_MAX_MAXNUMDRIVESADMIN (64)
#define	cfg_DEF_MAXNUMDRIVESADMIN "20"
#define	cfg_MIN_RESOURCEALLOCATIONTRESHOLD (0)
#define	cfg_MAX_RESOURCEALLOCATIONTRESHOLD (100)
#define	cfg_DEF_RESOURCEALLOCATIONTRESHOLD "50%"
#define	cfg_MIN_RESOURCEALLOCATIONTHRESHOLD (0)
#define	cfg_MAX_RESOURCEALLOCATIONTHRESHOLD (100)
#define	cfg_DEF_RESOURCEALLOCATIONTHRESHOLD "50%"
#define	cfg_MIN_TIMESTEP (0)
#define	cfg_MAX_TIMESTEP (10000)
#define	cfg_DEF_TIMESTEP "2"
#define	cfg_MIN_PHASEFACTOR (0)
#define	cfg_MAX_PHASEFACTOR (100000)
#define	cfg_DEF_PHASEFACTOR "500"
#define	cfg_MIN_SYSTEMMAXMEMORYBUFFERSIZE (0)
#define	cfg_MAX_SYSTEMMAXMEMORYBUFFERSIZE cfg_GIGABYTE
#define	cfg_DEF_SYSTEMMAXMEMORYBUFFERSIZE (10*cfg_MEGABYTE)
#define	cfg_MIN_SYSTEMADMINPRIORITY (0)
#define	cfg_MAX_SYSTEMADMINPRIORITY (10000)
#define	cfg_DEF_SYSTEMADMINPRIORITY "1000"
#define	cfg_MIN_SYSTEMBACKUPPRIORITY 0
#define	cfg_MAX_SYSTEMBACKUPPRIORITY 10000
#define	cfg_DEF_SYSTEMBACKUPPRIORITY "1000"
#define	cfg_MIN_CLI_ARGLEN (1)
#define	cfg_MAX_CLI_ARGLEN (255)
#define	cfg_MD5SUM_LEN (32)
#define	cfg_TIME_STAMP_LEN (15)
#define	cfg_MIN_BACKUP_NUM (1)
#define	cfg_MAX_BACKUP_NUM (1000)
#define	cfg_MIN_MIGID (0)
#define	cfg_MAX_MIGID (ULLONG_MAX)
#define	cfg_MIN_VOLUME_NUM (1)
#define	cfg_MAX_VOLUME_NUM (255)
#define	cfg_MIN_MEDIUM_KEY (1)
#define	cfg_MAX_MEDIUM_KEY (65536)
#define	cfg_MIN_JOB_PRIORITY_MOD (1)
#define	cfg_MAX_JOB_PRIORITY_MOD (INT_MAX)
#define	cfg_MIN_CFG_REVISION_NO (0)
#define	cfg_MAX_CFG_REVISION_NO cfg_MAX_CONFHISTORY
#define	cfg_MIN_FILEID (1)
#define	cfg_MAX_FILEID (UINT_MAX)
#define	cfg_MIN_JOBID (20000000000000LL)
#define	cfg_MAX_JOBID (21000000000000LL)
Typedefs
typedef vector< ap_Argument * >	ap_Argument_p_v_t
typedef ap_Argument_p_v_t::iterator	ap_Argument_p_v_i
typedef vector< val_Element < string > >::iterator	val_ElementString_i
typedef vector< val_Element < UInt32_t > >::iterator	val_ElementUInt32_i
typedef struct yy_buffer_state *	YY_BUFFER_STATE
typedef val_Range < val_StrictString, string >	val_StrictStringRange
typedef val_Range< val_Integer, Int8_t >	val_Int8Range
typedef val_Range< val_Integer, Int16_t >	val_Int16Range
typedef val_Range< val_Integer, Int32_t >	val_Int32Range
typedef val_Range< val_Integer, Int64_t >	val_Int64Range
typedef val_Range< val_Integer, UInt8_t >	val_UInt8Range
typedef val_Range< val_Integer, UInt16_t >	val_UInt16Range
typedef val_Range< val_Integer, UInt32_t >	val_UInt32Range
typedef val_Range< val_Integer, UInt64_t >	val_UInt64Range
typedef val_Range < val_DriveCapab, ivd_DriveCapab_e >	val_DriveCapabRange
typedef val_List < val_StrictString, string >	val_StrictStringList
typedef val_List< val_Integer, Int8_t >	val_Int8List
typedef val_List< val_Integer, Int16_t >	val_Int16List
typedef val_List< val_Integer, Int32_t >	val_Int32List
typedef val_List< val_Integer, Int64_t >	val_Int64List
typedef val_List< val_Integer, UInt8_t >	val_UInt8List
typedef val_List< val_Integer, UInt16_t >	val_UInt16List
typedef val_List< val_Integer, UInt32_t >	val_UInt32List
typedef val_List< val_Integer, UInt64_t >	val_UInt64List
typedef val_List < val_DriveCapab, ivd_DriveCapab_e >	val_DriveCapabList
typedef val_List< val_Path, string >	val_PathList
typedef val_Range< val_Path, string >	val_PathRange
typedef val_StrictString	val_WildCard
typedef val_StrictString	val_IP
typedef val_StrictString	val_TimeOfDay
typedef val_StrictString	val_EMail
typedef val_Time	val_Date
Enumerations
enum	ap_ArgType_e { at_CLI, at_COMMAND, at_OPTION, at_PARAMETER, at_MULTIPAR, at_GROUP }
enum	ap_Presence_e { pr_OPTIONAL, pr_MANDATORY, pr_ELEMENTSPEC }
enum	pf_ValType_e { PF_SIMPLE, PF_RANGE, PF_LIST, PF_GROUP, PF_INCLFILE, PF_COMMENT, PF_UNDEFINED }
enum	ElemType_e { el_Unknown, el_Simple, el_Range }
Functions
template<class T>
int	cfg_FindGroupByName (vector< T > a_grpVector, string a_name)
ostream &	operator<< (ostream &a_os, const pf_Value &a_val)
ostream &	operator<< (ostream &a_os, const pf_Section &a_sec)
ostream &	operator<< (ostream &a_os, const pf_SectionList &a_list)
IVD_PARSER_DECL_d ostream &	operator<< (ostream &a_os, const pf_ValueList &a_list)
IVD_PARSER_DECL_d ostream &	operator<< (ostream &a_os, const pf_File &a_file)
void	cmn_GC (pf_Component a_garbage, vector< pf_Component > &a_gcVec)
	Simple garbage collector.
Variables
const char *const	ap_valCmdName
const char *const	ap_valArg0Name
bool	ap_showHidden
IVD_PARSER_DECL_d const ap_Argument	ivdRecover
IVD_PARSER_DECL_d const ap_Argument	ivdJob
IVD_PARSER_DECL_d const ap_Argument	ivdPool
IVD_PARSER_DECL_d const ap_Argument	ivdCheck
IVD_PARSER_DECL_d const ap_Argument	ivdMedium
IVD_PARSER_DECL_d const ap_Argument	ivdPartition
IVD_PARSER_DECL_d const ap_Argument	ivd_fsc
IVD_PARSER_DECL_d const ap_Argument	ivdfile
IVD_PARSER_DECL_d const ap_Argument	ivdDD
IVD_PARSER_DECL_d const ap_Argument	ivdArch
IVD_PARSER_DECL_d const ap_Argument	ivd_hsm
const char *const	pf_FileTypeVarName_s

at_CLI
at_COMMAND
at_OPTION
at_PARAMETER
at_MULTIPAR
at_GROUP

PF_SIMPLE
PF_RANGE
PF_LIST
PF_GROUP
PF_INCLFILE
PF_COMMENT
PF_UNDEFINED

int cfg_FindGroupByName	(	vector< T >	a_grpVector,
		string	a_name
	)			`[inline]`

void cmn_GC	(	pf_Component *	a_garbage,
		vector< pf_Component * > &	a_gcVec
	)

	T	A type to save reference to
	VT	Type of content of garbage collector vector.

IVD_PARSER_DECL_d ostream& operator<<	(	ostream &	a_os,
		const pf_File &	a_file
	)

ostream& operator<<	(	ostream &	a_os,
		const pf_SectionList &	a_list
	)

Parser for config files; validation

Detailed Description

Transformation of configuration file to destination variables

Transformation consists of several major stages:

How to use the parser for your own configuration file?

Classes

Defines

Typedefs

Enumerations

Functions

Variables

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation