Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/group__Args.html below:

NCBI C++ ToolKit: Command-Line Argument Processing

Bitwise OR of "EArgValueFlags".

Definition at line 330 of file ncbiargs.hpp.

Some values types can contain several value lists.

Example: CGIs pass list selections by repeating the same name

Definition at line 308 of file ncbiargs.hpp.

Type of the container that contains the allowed string values.

See also

m_Strings

Definition at line 1720 of file ncbiargs.hpp.

Processing of positional arguments.

In strict mode any value starting with '-' is treated as a key/flag unless any positional arguments have already been found (e.g. after '–' argument). In loose mode any argument is treated as positional if it can not be processed as a valid key or flag.

Strict mode (default)

Loose mode.

Definition at line 599 of file ncbiargs.hpp.

Type of CArgDescriptions For a CGI application positional arguments and flags does not make sense (this syntax cannot be expressed by CGI protocol)

Regular application.

CGI application.

Definition at line 582 of file ncbiargs.hpp.

Whether the argument:

See also

GetDefault()

Has default value.

Not provided in command line.

Definition at line 326 of file ncbiargs.hpp.

Nonempty command is required.

Command is not necessary.

On PrintUsage, keep commands unsorted.

On PrintUsage, keep command groups unsorted.

Definition at line 1416 of file ncbiargs.hpp.

Hide command in Usage.

Definition at line 1441 of file ncbiargs.hpp.

Flag to invert constraint logically.

Logical NOT.

Constraint is not inverted (taken as is)

Definition at line 954 of file ncbiargs.hpp.

Dependencies between arguments.

One argument requires another.

One argument excludes another.

Definition at line 987 of file ncbiargs.hpp.

Error types for improperly formatted arguments.

These error conditions are checked for and caught when processing arguments.

Invalid argument.

Expecting an argument value.

The value is excluded by another argument.

Incorrect cast for an argument.

Conversion problem.

Expecting a file.

Argument value outside constraints.

Wrong argument type.

No argument.

Synopsis error.

Definition at line 126 of file ncbiargs.hpp.

Error type for help exception.

Error code for short help message.

Error code for detailed help message.

Error code for detailed help message which includes hidden arguments.

Error code for XML formatted help message.

Show short help message and return error.

Definition at line 161 of file ncbiargs.hpp.

Open file in binary mode.

Open file in text mode.

Open file in append mode.

Open file in truncate mode.

Open existing file, never create it.

If needed, create directory where the file is located.

Definition at line 262 of file ncbiargs.hpp.

Additional flags, the first group is file related flags.

Must match the argument type, or an exception will be thrown. ( File related are for eInputFile and eOutputFiler argument types.)

Open file right away; for eInputFile, eOutputFile, eIOFile.

Open as binary file; for eInputFile, eOutputFile, eIOFile.

Append to end-of-file; for eOutputFile or eIOFile.

Delete contents of an existing file; for eOutputFile or eIOFile.

If the file does not exist, do not create it; for eOutputFile or eIOFile.

If needed, create directory where the file is located.

Mask for all file-related flags.

Repeated key arguments are legal (use with AddKey)

Ignore invalid argument values.

If not set, exceptions will be thrown on invalid values.

Post warning when an invalid value is ignored (no effect if fIgnoreInvalidValue is not set).

Allow to ignore separator between the argument's name and value.

Usual ' ' or '=' separators can still be used with the argument. The following restrictions apply to a no-separator argument:

• the argument must be a key (including optional or default);
• the argument's name must be a single char;
• no other argument's name can start with the same char, unless fOptionalSeparatorAllowConflict is also specified.

For arguments with fOptionalSeparator flag, allow other arguments which names begin with the same char.

Require '=' separator.

Hide it in Usage.

Confidential argument Such arguments can be read from command line, from file, or from console.

On command line, they can appear in one of the following forms: -key – read value from console, with automatically generated prompt -key-file fname – read value from file 'fname', if 'fname' equals '-', read value from standard input (stdin) without any prompt -key-verbatim value – read value from the command line, as is

Mark standard/special flag. For internal use only.

Definition at line 637 of file ncbiargs.hpp.

Which standard flag's descriptions should not be displayed in the usage message.

Do not display descriptions of the standard flags such as the -h, -logfile, -conffile, -version flags in the usage message. Note that you still can pass them in the command line.

Hide log file description.

Hide configuration file description.

Hide version description.

Hide full version description.

Hide dryrun description.

Hide help description.

Hide full help description.

Hide XML help description.

Hide all standard argument descriptions.

Definition at line 1095 of file ncbiargs.hpp.

Miscellaneous flags.

Do not print USAGE on argument error.

Force printing USAGE (and then exit) if no command line args are present.

Sort args when printing USAGE.

Print arg error to both log and cerr.

Definition at line 1059 of file ncbiargs.hpp.

Symbol class for defining sets of characters.

Symbol character classes patterned after those defined in <ctype.h>.

Alphanumeric characters.

Alphabet characters.

Control characters.

Digit characters.

Graphical characters.

Lowercase characters.

Printable characters.

Punctuation characters.

Space characters.

Uppercase characters.

Hexadecimal characters.

User defined characters using constructor with string&.

Definition at line 1572 of file ncbiargs.hpp.

Available argument types.

An arbitrary string.

{'true', 't', 'false', 'f'}, case-insensitive

Convertible into an integer number (Int8 only)

Convertible into an integer number (int or Int8)

Convertible to TIntId (int or Int8 depending on NCBI_INT8_GI)

Convertible into a floating point number (double)

Name of file (must exist and be readable)

Name of file (must be writable)

Name of file (must be writable)

Name of file directory.

Integer number with possible "software" qualifiers (KB, KiB, et al)

DateTime string, formats: "M/D/Y h:m:s", "Y-M-DTh:m:g", "Y/M/D h:m:g", "Y-M-D h:m:g".

Time string can have trailing 'Z' symbol, specifying that it represent time in the UTC format.

For internal use only.

Definition at line 611 of file ncbiargs.hpp.

Make another dependency group a member of this dependency group.

Attention

The "dep_group" will be added by reference, and its lifetime will be managed according to the usual CObject/CRef rules.

Parameters

instant_set "eInstantSet" means that if the added group ("dep_group") is set, then the SetMinMembers() condition doesn't apply anymore.

Returns

"*this"

Definition at line 4973 of file ncbiargs.cpp.

References CArgDependencyGroup::m_Groups.

Add new argument name and value.

Throw an exception if the "name" is not an empty string, and if there is an argument with this name already and "update" parameter is not set.

HINT: Use empty "name" to add extra (unnamed) args, and they will be automagically assigned with the virtual names: "#1", "#2", "#3", etc.

Parameters

arg argument value added to the collection update when TRUE and argument already exists it will be replaced when FALSE throws an exception add_value when TRUE and argument already exists the value is added to the string list (multiple argument)

Definition at line 1937 of file ncbiargs.cpp.

References _ASSERT, CArgValue::AsString(), set< Key, Compare >::end(), CArgValue::GetName(), set< Key, Compare >::insert(), CArgs::m_Args, CArgValue::m_Name, CArgs::m_nExtra, NCBI_THROW, CArgs::Remove(), s_ComposeNameExtra(), CArgValue::SetOrdinalPosition(), CArgValue::SetStringList(), set< Key, Compare >::size(), CArgDescriptions::VerifyName(), and CArgs::x_Find().

Referenced by CArgDescriptions::x_PostCheck().

Make a regular argument a member of this dependency group.

An argument with this name will need to be added separately using CArgDescriptions::AddXXX().

Parameters

arg_name Name of the argument, as specified in CArgDescriptions::AddXXX() instant_set "eInstantSet" means that if the added argument ("arg_name") is set, then the SetMinMembers() condition doesn't apply anymore.

Returns

"*this"

Definition at line 4967 of file ncbiargs.cpp.

References CArgDependencyGroup::m_Arguments.

Add command argument descriptions.

Parameters

cmd Command string description Argument description alias Alternative name of the command flags Optional flags

Definition at line 4056 of file ncbiargs.cpp.

References cmd, command, CArgDescriptions::Delete(), CCommandArgDescriptions::eHidden, map_checker< Container >::erase(), CArgDescriptions::Exist(), flags, kEmptyStr, CCommandArgDescriptions::m_Aliases, CArgDescriptions::m_AutoHelp, CCommandArgDescriptions::m_Commands, CCommandArgDescriptions::m_CurrentCmdGroup, CCommandArgDescriptions::m_Description, CCommandArgDescriptions::m_Groups, CArgDescriptions::m_HasHidden, NCBI_THROW, s_AutoHelp, s_AutoHelpFull, s_AutoHelpShowAll, s_AutoHelpXml, CCommandArgDescriptions::SetCurrentCommandGroup(), and NStr::TruncateSpaces().

Add description for optional key with default value.

Optional key with default value has the following syntax:

arg_key_dflt := [-<key>

]

Will throw exception CArgException if:

• description with name "name" already exists
• "name" contains symbols other than {alnum, '-', '_'}
• "name" starts with more than one '-'
• "synopsis" contains symbols other than {alnum, '_'}
• "flags" are inconsistent with "type"

Any argument can be later referenced using its unique name "name".

Parameters

name Name of argument key synopsis Synopsis for argument comment Argument description type Argument type default_value Default value flags Optional flags env_var Optional name of environment variable that contains default value display_value Default value shown in Usage

Definition at line 2467 of file ncbiargs.cpp.

References flags, and CArgDescriptions::x_AddDesc().

Referenced by CFlatFileConfig::AddArgumentDescriptions(), CArgDescriptions::AddDefaultFileArguments(), CWinMaskConfig::AddWinMaskArgs(), CSdbapiTest::Init(), CAVApp::Init(), CId2FetchApp::Init(), CSdbapiSimpleApp::Init(), CDbapiTestSpeedApp::InitSample(), s_InitPsgOptions(), CPsgClientApp::s_InitRequest(), CStdCmdLineArgs::SetArgumentDescriptions(), CTaskCmdLineArgs::SetArgumentDescriptions(), COffDiagonalRangeArg::SetArgumentDescriptions(), CRMBlastNArg::SetArgumentDescriptions(), CGenericSearchArgs::SetArgumentDescriptions(), CFilteringArgs::SetArgumentDescriptions(), CCompositionBasedStatsArgs::SetArgumentDescriptions(), CLargestIntronSizeArgs::SetArgumentDescriptions(), CGeneticCodeArgs::SetArgumentDescriptions(), CGapTriggerArgs::SetArgumentDescriptions(), CPssmEngineArgs::SetArgumentDescriptions(), CPsiBlastArgs::SetArgumentDescriptions(), CKBlastpArgs::SetArgumentDescriptions(), CDeltaBlastArgs::SetArgumentDescriptions(), CMappingArgs::SetArgumentDescriptions(), CQueryOptionsArgs::SetArgumentDescriptions(), CMapperQueryOptionsArgs::SetArgumentDescriptions(), CIgBlastArgs::SetArgumentDescriptions(), CFormattingArgs::SetArgumentDescriptions(), CMapperFormattingArgs::SetArgumentDescriptions(), CMTArgs::SetArgumentDescriptions(), CMbIndexArgs::SetArgumentDescriptions(), CSRASearchModeArgs::SetArgumentDescriptions(), CMapperGenericSearchArgs::SetArgumentDescriptions(), CMapperNuclArgs::SetArgumentDescriptions(), CMapperLargestIntronSizeArgs::SetArgumentDescriptions(), CInputStreamSource::SetStandardInputArgs(), CAdvancedAlignCleanup::SetupArgDescriptions(), CSplignArgUtil::SetupArgDescriptions(), CAlignCollapser::SetupArgDescriptions(), CGnomonAnnotatorArgUtil::SetupArgDescriptions(), CChainerArgUtil::SetupArgDescriptions(), CMultAlign::SetupArgDescriptions(), CCompartOptions::SetupArgDescriptions(), CProSplignOptions_Base::SetupArgDescriptions(), CProSplignScoring::SetupArgDescriptions(), CProSplignOutputOptions::SetupArgDescriptions(), CDBLBClientApp::x_InitLookup(), CDBLBClientApp::x_InitWhereIs(), and CTbl2AsnApp::x_SetAlnArgs().

Add description for optional positional argument with default value.

Optional positional argument with default value has the following syntax:

arg_pos_dflt := [

]

Will throw exception CArgException if:

• description with name "name" already exists
• "name" contains symbols other than {alnum, '-', '_'}
• "name" starts with more than one '-'
• "flags" are inconsistent with "type"

See also

NOTE for AddPositional()

Parameters

name Name of argument comment Argument description type Argument type default_value Default value flags Optional flags env_var Optional name of environment variable that contains default value display_value Default value shown in Usage

Definition at line 2537 of file ncbiargs.cpp.

References flags, and CArgDescriptions::x_AddDesc().

Add a dependency group.

The argument constraints specified by the dependency group(s) will be processed only after all regular dependencies for arguments and dependency groups have been processed.

Attention

The "dep_group" will be added by reference, and its lifetime will then be managed according to the usual CObject/CRef rules.

See also

SetDependency()

Definition at line 2611 of file ncbiargs.cpp.

References set< Key, Compare >::insert(), and CArgDescriptions::m_DependencyGroups.

Definition at line 3773 of file ncbiargs.cpp.

References arr, NStr::fWrap_Hyphenate, i, kEmptyStr, kMax_UInt, s_IsFlag(), s_IsOptional(), s_PrintCommentBody(), string, NStr::UIntToString(), and NStr::Wrap().

Referenced by CArgDescriptions::PrintUsage(), and CCommandArgDescriptions::PrintUsage().

Add description for flag argument.

Flag argument has the following syntax:

arg_flag := -<flag>, <flag> := "name"

If argument "set_value" is eFlagHasValueIfSet (TRUE), then:

• if the flag is provided (in the command-line), then the resultant CArgValue::HasValue() will be TRUE;
• else it will be FALSE.

Setting argument "set_value" to FALSE will reverse the above meaning.

NOTE: If CArgValue::HasValue() is TRUE, then AsBoolean() is always TRUE.

Parameters

name Name of argument comment Argument description flags Optional flags

Definition at line 2485 of file ncbiargs.cpp.

References CArgDescriptions::eFlagHasValueIfSet, flags, and CArgDescriptions::x_AddDesc().

Referenced by CFlatFileConfig::AddArgumentDescriptions(), CLocalTaxon::AddArguments(), CArgDescriptions::AddStdArguments(), CWinMaskConfig::AddWinMaskArgs(), COMSSA::AppInit(), CArgDescriptions::CArgDescriptions(), CAVApp::Init(), SUApp::Init(), Cn3DNoWin::Init(), CId2FetchApp::Init(), CNcbiTestApplication::Init(), s_AddLatencyOptions(), s_CommandlessInit(), s_InitDataFlags(), s_InitDataOnly(), s_InitPsgOptions(), CPsgClientApp::s_InitRequest(), CStdCmdLineArgs::SetArgumentDescriptions(), CRMBlastNArg::SetArgumentDescriptions(), CNuclArgs::SetArgumentDescriptions(), CCompositionBasedStatsArgs::SetArgumentDescriptions(), CGappedArgs::SetArgumentDescriptions(), CPsiBlastArgs::SetArgumentDescriptions(), CDeltaBlastArgs::SetArgumentDescriptions(), CQueryOptionsArgs::SetArgumentDescriptions(), CMapperQueryOptionsArgs::SetArgumentDescriptions(), CBlastDatabaseArgs::SetArgumentDescriptions(), CIgBlastArgs::SetArgumentDescriptions(), CFormattingArgs::SetArgumentDescriptions(), CMapperFormattingArgs::SetArgumentDescriptions(), CRemoteArgs::SetArgumentDescriptions(), CDebugArgs::SetArgumentDescriptions(), CHspFilteringArgs::SetArgumentDescriptions(), CSRASearchModeArgs::SetArgumentDescriptions(), CMapperGenericSearchArgs::SetArgumentDescriptions(), CAdvancedAlignCleanup::SetupArgDescriptions(), CAlignCollapser::SetupArgDescriptions(), CGnomonAnnotatorArgUtil::SetupArgDescriptions(), CChainerArgUtil::SetupArgDescriptions(), CGridWorkerApp::SetupArgDescriptions(), CProSplignOptions_Base::SetupArgDescriptions(), CProSplignOutputOptions::SetupArgDescriptions(), CDBLBClientApp::x_InitLookup(), and CDBLBClientApp::x_InitWhereIs().

Add description for mandatory key.

Mandatory key has the syntax:

arg_key := -<key>

Will throw exception CArgException if:

• description with name "name" already exists
• "name" contains symbols other than {alnum, '-', '_'}
• "name" starts with more than one '-'
• "synopsis" contains symbols other than {alnum, '_'}
• "flags" are inconsistent with "type"

Any argument can be later referenced using its unique name "name".

Parameters

name Name of argument key synopsis Synopsis for argument comment Argument description type Argument type flags Optional flags

Definition at line 2437 of file ncbiargs.cpp.

References flags, and CArgDescriptions::x_AddDesc().

Referenced by CWinMaskConfig::AddWinMaskArgs(), CAVApp::Init(), SUApp::Init(), Cn3DNoWin::Init(), CPsgClientApp::s_InitRequest(), CTaskCmdLineArgs::SetArgumentDescriptions(), CBlastDatabaseArgs::SetArgumentDescriptions(), CInputStreamSource::SetStandardInputArgs(), CGnomonAnnotatorArgUtil::SetupArgDescriptions(), CChainerArgUtil::SetupArgDescriptions(), and CDBLBClientApp::x_InitLookup().

Add description of mandatory opening positional argument.

Mandatory opening argument has the following syntax: arg_pos :=

NOTE: In command line, mandatory opening arguments must go first, before any other arguments; their order is defined by the order in which they were described and added into CArgDescriptions.

Will throw exception CArgException if:

• description with name "name" already exists
• "name" contains symbols other than {alnum, '-', '_'}
• "name" starts with more than one '-'
• "flags" are inconsistent with "type"

Any argument can be later referenced using its unique name "name".

Parameters

name Name of argument comment Argument description type Argument type flags Optional flags

Definition at line 2510 of file ncbiargs.cpp.

References flags, and CArgDescriptions::x_AddDesc().

Referenced by s_InitCreate(), and s_InitPost().

Add description for optional key without default value.

Optional key without default value has the following syntax:

arg_key_opt := [-<key>

]

Will throw exception CArgException if:

• description with name "name" already exists
• "name" contains symbols other than {alnum, '-', '_'}
• "name" starts with more than one '-'
• "synopsis" contains symbols other than {alnum, '_'}
• "flags" are inconsistent with "type"

Any argument can be later referenced using its unique name "name".

Parameters

name Name of argument key synopsis Synopsis for argument comment Argument description type Argument type flags Optional flags

Definition at line 2452 of file ncbiargs.cpp.

References flags, and CArgDescriptions::x_AddDesc().

Referenced by CFlatFileConfig::AddArgumentDescriptions(), CGenomicCollectionsService::AddArguments(), CLocalTaxon::AddArguments(), CArgDescriptions::AddDefaultFileArguments(), CArgDescriptions::AddStdArguments(), CWinMaskConfig::AddWinMaskArgs(), SUApp::Init(), Cn3DNoWin::Init(), CId2FetchApp::Init(), CNcbiTestApplication::Init(), CDbapiTestSpeedApp::InitSample(), CLangQueryApp::InitSample(), s_InitDataOnly(), s_InitPost(), s_InitPsgOptions(), CPsgClientApp::s_InitRequest(), CStdCmdLineArgs::SetArgumentDescriptions(), CWindowSizeArg::SetArgumentDescriptions(), CWordThresholdArg::SetArgumentDescriptions(), CMatrixNameArg::SetArgumentDescriptions(), CGenericSearchArgs::SetArgumentDescriptions(), CFilteringArgs::SetArgumentDescriptions(), CNuclArgs::SetArgumentDescriptions(), CDiscontiguousMegablastArgs::SetArgumentDescriptions(), CGappedArgs::SetArgumentDescriptions(), CFrameShiftArgs::SetArgumentDescriptions(), CSearchStrategyArgs::SetArgumentDescriptions(), CPsiBlastArgs::SetArgumentDescriptions(), CPhiBlastArgs::SetArgumentDescriptions(), CMappingArgs::SetArgumentDescriptions(), CQueryOptionsArgs::SetArgumentDescriptions(), CMapperQueryOptionsArgs::SetArgumentDescriptions(), CBlastDatabaseArgs::SetArgumentDescriptions(), CIgBlastArgs::SetArgumentDescriptions(), CFormattingArgs::SetArgumentDescriptions(), CMapperFormattingArgs::SetArgumentDescriptions(), CHspFilteringArgs::SetArgumentDescriptions(), CMbIndexArgs::SetArgumentDescriptions(), CMapperStdCmdLineArgs::SetArgumentDescriptions(), CInputStreamSource::SetStandardInputArgs(), CAdvancedAlignCleanup::SetupArgDescriptions(), CSplignArgUtil::SetupArgDescriptions(), CChainerArgUtil::SetupArgDescriptions(), CGridWorkerApp::SetupArgDescriptions(), CRemoteCgiApp::SetupArgDescriptions(), CDBLBClientApp::x_InitLookup(), and CTbl2AsnApp::x_SetAlnArgs().

Add description for optional positional argument without default value.

Optional positional argument, without default value has the following syntax:

arg_pos_opt := [

]

Will throw exception CArgException if:

• description with name "name" already exists
• "name" contains symbols other than {alnum, '-', '_'}
• "name" starts with more than one '-'
• "flags" are inconsistent with "type"

Any argument can be later referenced using its unique name "name".

See also

NOTE for AddPositional()

Parameters

name Name of argument comment Argument descr. type Argument type flags Optional flags

Definition at line 2523 of file ncbiargs.cpp.

References flags, and CArgDescriptions::x_AddDesc().

Referenced by s_InitQuery(), and CPsgClientApp::s_InitRequest().

Add description for mandatory positional argument.

Mandatory positional argument has the following syntax:

arg_pos :=

NOTE: For all types of positional arguments:

• The order is important! That is, the N-th positional argument passed in the cmd.-line will be matched against (and processed according to) the N-th added named positional argument description.
• Mandatory positional args always go first.

Will throw exception CArgException if:

• description with name "name" already exists
• "name" contains symbols other than {alnum, '-', '_'}
• "name" starts with more than one '-'
• "flags" are inconsistent with "type"

Any argument can be later referenced using its unique name "name".

Parameters

name Name of argument comment Argument description type Argument type flags Optional flags

Definition at line 2497 of file ncbiargs.cpp.

References flags, and CArgDescriptions::x_AddDesc().

Referenced by CAVApp::Init(), CSdbapiSimpleApp::Init(), s_CommandlessInit(), s_InitPost(), CPsgClientApp::s_InitRequest(), CDBLBClientApp::x_InitWhatIs(), and CDBLBClientApp::x_InitWhereIs().

Add standard arguments.

Reimplemented in CCommandArgDescriptions.

Definition at line 2274 of file ncbiargs.cpp.

References CArgDescriptions::AddFlag(), CArgDescriptions::AddOptionalKey(), CArgDescriptions::Delete(), CArgDescriptions::eFlagHasValueIfSet, CArgDescriptions::eInputFile, CArgDescriptions::eOutputFile, CArgDescriptions::Exist(), CArgDescriptions::fHideConffile, CArgDescriptions::fHideDryRun, CArgDescriptions::fHideFullHelp, CArgDescriptions::fHideFullVersion, CArgDescriptions::fHideHelp, CArgDescriptions::fHideLogfile, CArgDescriptions::fHideVersion, CArgDescriptions::fHideXmlHelp, CArgDescriptions::fStandard, CArgDescriptions::m_AutoHelp, CArgDescriptions::m_HasHidden, mask, s_ArgCfgFile, s_ArgDryRun, s_ArgFullVersion, s_ArgFullVersionJson, s_ArgFullVersionXml, s_ArgLogFile, s_ArgVersion, s_AutoHelp, s_AutoHelpFull, s_AutoHelpShowAll, and s_AutoHelpXml.

Referenced by CCommandArgDescriptions::AddStdArguments().

Add allowed string values.

Parameters

value String to add to the set of allowed string values

Definition at line 4639 of file ncbiargs.cpp.

References set< Key, Compare >::insert(), CArgAllow_Strings::m_Strings, and rapidjson::value.

Referenced by CWinMaskConfig::AddWinMaskArgs(), CArgAllow_Strings::AllowValue(), CAppHitFilter::Init(), CAppNWA::Init(), CSplignApp::Init(), CPrimeCacheApplication::Init(), CConvert2BlastMaskApplication::Init(), CDustMaskApplication::Init(), SegMaskerApplication::Init(), CHttpSessionApp::Init(), NCBITEST_INIT_CMDLINE(), and CSplignArgUtil::SetupArgDescriptions().

Get the argument's boolean value.

If you request a wrong value type, such as a call to "AsBoolean()" for a "integer" argument, an exception is thrown.

NOTE: Do not confuse HasValue(), operator bool() and AsBoolean(). The former two methods check if the argument has any value, they do not return its actual value.

See also

HasValue(), AsString(), AsInt8(), AsInteger, AsDouble()

Implemented in CArg_Boolean, CArg_String, CArg_ExcludedValue, and CArg_NoValue.

Get the argument's value as an integer id (TIntId).

The actual value is Int4 or Int8 depending on the NCBI_INT8_GI definition.

If you request a wrong value type, such as a call to "AsIntId()" for a "boolean", an exception is thrown. Calling AsIntId() on an integer argument is always allowed. For an Int8 argument it will throw an exception if NCBI_INT8_GI is not defined.

See also

AsInteger(), AsInt8()

Implemented in CArg_IntId, CArg_Integer, CArg_Int8, CArg_String, CArg_ExcludedValue, and CArg_NoValue.

Get the argument's string value.

If it is a value of a flag argument, then return either "true" or "false".

See also

AsInteger(), AsInt8(), AsDouble(), AsBoolean()

Implemented in CArg_String, CArg_ExcludedValue, and CArg_NoValue.

Referenced by CArgs::Add(), ArgToSeq_id(), CCodeGenerator::GetOpt(), CProjBulderApp::ParseArguments(), CArgs::Print(), CAsn2Asn::RunAsn2Asn(), CMakeBlastDBApp::x_ProcessMaskData(), and CSplignApp::x_ReadFastaSetId().

Definition at line 1547 of file ncbiargs.hpp.

Constructor specifying range of allowed integer values.

Definition at line 4814 of file ncbiargs.cpp.

Constructor specifying an allowed integer value.

Definition at line 4809 of file ncbiargs.cpp.

Constructor for user defined eUser class.

Definition at line 4562 of file ncbiargs.cpp.

Constructor.

Parameters

values Strings to add to the set of allowed string values use_case If to ignore the case of the characters

Definition at line 4633 of file ncbiargs.cpp.

Constructor.

If "auto_help" is passed TRUE, then a special flag "-h" will be added to the list of accepted arguments. Passing "-h" in the command line will printout USAGE and ignore all other passed arguments. Error handler is used to process errors when parsing arguments. If not set the default handler is used.

Definition at line 2209 of file ncbiargs.cpp.

References CArgDescriptions::AddFlag(), kEmptyStr, CArgDescriptions::m_ArgGroups, CArgDescriptions::m_AutoHelp, CArgDescriptions::m_ErrorHandler, CRef< C, Locker >::Reset(), s_AutoHelp, s_AutoHelpFull, s_AutoHelpShowAll, s_AutoHelpXml, and CArgDescriptions::SetUsageContext().

Creating copy of this object usually makes no sense if it is really required, please use Assign method.

Definition at line 1780 of file ncbiargs.cpp.

References CArgs::Assign().

Constructor.

If "auto_help" is passed TRUE, then a special flag "-h" will be added to the list of accepted arguments. Passing "-h" in the command line will printout USAGE and ignore all other passed arguments. Error handler is used to process errors when parsing arguments. If not set the default handler is used.

Definition at line 4020 of file ncbiargs.cpp.

template<class T >

Definition at line 3596 of file ncbiargs.cpp.

References _ASSERT, set< Key, Compare >::begin(), set< Key, Compare >::end(), CArgDescriptions::fHidden, CArgDescriptions::fUsageSortArgs, CArgDesc::GetName(), CArgDescriptions::IsSetMiscFlag(), kEmptyStr, CArgDescriptions::m_Args, CArgDescriptions::CPrintUsage::m_args, CArgDescriptions::m_AutoHelp, CArgDescriptions::m_HasHidden, CArgDescriptions::m_KeyFlagArgs, CArgDescriptions::m_OpeningArgs, CArgDescriptions::m_PosArgs, s_AutoHelp, s_AutoHelpFull, s_AutoHelpShowAll, util::strcmp(), and CArgDescriptions::x_Find().

Parse command-line arguments 'argv'.

Reimplemented from CArgDescriptions.

Definition at line 4133 of file ncbiargs.cpp.

References command, CArgDescriptions::CreateArgs(), map_checker< Container >::empty(), ctll::empty(), map_checker< Container >::end(), map_checker< Container >::find(), kEmptyStr, CCommandArgDescriptions::m_Command, CCommandArgDescriptions::m_Description, NCBI_THROW, CArgs::SetCommand(), CNcbiArguments::Shift(), CNcbiArguments::Size(), CArgDescriptions::x_CheckAutoHelp(), CCommandArgDescriptions::x_IdentifyCommand(), and CCommandArgDescriptions::x_IsCommandMandatory().

template<class TSize , class TArray >

Create parsed arguments in CArgs object.

Parse command-line arguments, and create "CArgs" args object from the passed command-line arguments "argc" and "argv".

Throw

• CArgException on error
• CArgHelpException if USAGE printout was requested ("-h" flag)

Note

Deallocate the resulting "CArgs" object using 'delete'.

Attention

This function is not suitable for parsing URL-encoded _CGI_ arg outside of the CCgiApplication framework.

Definition at line 1311 of file ncbiargs.hpp.

References CArgDescriptions::eCgiArgs, CArgDescriptions::eCreateArgs, CArgDescriptions::GetArgsType(), i, kEmptyStr, kMax_UInt, CArgDescriptions::x_CheckAutoHelp(), CArgDescriptions::x_CreateArg(), CArgDescriptions::x_PostCheck(), and CArgDescriptions::x_PreCheck().

Referenced by CArgDescriptions::CreateArgs(), CCommandArgDescriptions::CreateArgs(), CBlastArgs::s_CreateBlastOptions(), and CNcbiApplicationAPI::SetupArgDescriptions().

Delete description of argument with name "name".

Extra arguments get deleted by the name passed as "".

Throw the CArgException (eSynopsis error code) exception if the specified name cannot be found.

Definition at line 2685 of file ncbiargs.cpp.

References _ASSERT, set< Key, Compare >::end(), set< Key, Compare >::erase(), CArgDescriptions::m_Args, CArgDescriptions::m_AutoHelp, CArgDescriptions::m_KeyFlagArgs, CArgDescriptions::m_nExtra, CArgDescriptions::m_nExtraOpt, CArgDescriptions::m_PosArgs, NCBI_THROW, s_AutoHelp, and CArgDescriptions::x_Find().

Referenced by CCommandArgDescriptions::AddCommand(), and CArgDescriptions::AddStdArguments().

Check existence of argument description.

Return TRUE if arg "name" was described in the parent CArgDescriptions.

NOTE: Do not confuse this method with CArgValue::HasValue() which checks if the argument not just exists, but was assigned a value (possibly the default one).

Definition at line 1833 of file ncbiargs.cpp.

References set< Key, Compare >::end(), CArgs::m_Args, and CArgs::x_Find().

Referenced by BuildAlgorithmParametersString(), CGenomicCollectionsService::CGenomicCollectionsService(), CBlastDBAliasApp::ConvertGiFile(), CBlastDBAliasApp::CreateAliasFile(), CWinMaskConfig::CWinMaskConfig(), CMapperMTArgs::ExtractAlgorithmOptions(), CMapperQueryOptionsArgs::ExtractAlgorithmOptions(), CMapperFormattingArgs::ExtractAlgorithmOptions(), CBlastDatabaseArgs::ExtractAlgorithmOptions(), CFormattingArgs::ExtractAlgorithmOptions(), CMbIndexArgs::ExtractAlgorithmOptions(), CStdCmdLineArgs::ExtractAlgorithmOptions(), CGenericSearchArgs::ExtractAlgorithmOptions(), CFilteringArgs::ExtractAlgorithmOptions(), CNuclArgs::ExtractAlgorithmOptions(), CCompositionBasedStatsArgs::ExtractAlgorithmOptions(), CPssmEngineArgs::ExtractAlgorithmOptions(), CPsiBlastArgs::ExtractAlgorithmOptions(), CPhiBlastArgs::ExtractAlgorithmOptions(), CKBlastpArgs::ExtractAlgorithmOptions(), CDeltaBlastArgs::ExtractAlgorithmOptions(), CMappingArgs::ExtractAlgorithmOptions(), CQueryOptionsArgs::ExtractAlgorithmOptions(), CIgBlastArgs::ExtractAlgorithmOptions(), CRemoteArgs::ExtractAlgorithmOptions(), NParamsBuilder::SOneRequest::GetDataOnlyEnabled(), NParamsBuilder::SOneRequest::GetDataOnlyOutputFormat(), CSearchStrategyArgs::GetExportStream(), CSearchStrategyArgs::GetImportStream(), GetSubjectFile(), CBlastDatabaseArgs::HasBeenSet(), CMbIndexArgs::HasBeenSet(), RecoverSearchStrategy(), CBlastnApp::Run(), CBlastpApp::Run(), CBlastxApp::Run(), CSeedTopApp::Run(), CTblastnApp::Run(), CIgBlastnApp::Run(), CNcbiApplogApp::Run(), CTbl2AsnApp::Run(), BlastdbCopyApplication::Run(), CVDBBlastnApp::Run(), CVDBTblastnApp::Run(), CClientGenomicCollectionsSvcApplication::Run(), CSampleBasicApplication::Run(), CBlastAppArgs::SetOptions(), CBlastnAppArgs::x_CreateOptionsHandle(), CBlastpAppArgs::x_CreateOptionsHandle(), CBlastxAppArgs::x_CreateOptionsHandle(), CPsiBlastAppArgs::x_CreateOptionsHandle(), CTblastnAppArgs::x_CreateOptionsHandle(), CTblastnVdbAppArgs::x_CreateOptionsHandle(), CArgDependencyGroup::x_Evaluate(), CMTArgs::x_ExtractAlgorithmOptions(), CArgDescriptions::x_PostCheck(), CDataLoadersUtil::x_SetupASNCacheDataLoader(), CDataLoadersUtil::x_SetupBlastDataLoader(), CDataLoadersUtil::x_SetupGenbankDataLoader(), CDataLoadersUtil::x_SetupLDS2DataLoader(), CDataLoadersUtil::x_SetupSRADataLoader(), and CDataLoadersUtil::x_SetupVDBDataLoader().

Get default value of the argument.

Parameters

flags Indicate whether the argument has default value, and if the arg's value was set from the command line or from the default value.

Returns

Default value, if specified for this argument. If the argument doesn't have a default value: empty string. If the argument is a flag: "false" or "true".

Definition at line 173 of file ncbiargs.cpp.

References CArgValue::m_Default, and CArgValue::m_Flags.

Translate from the error code value to its string representation.

Reimplemented from CCoreException.

Reimplemented in CArgHelpException.

Definition at line 5167 of file ncbiargs.cpp.

References CArgException::eArgType, CArgException::eConstraint, CArgException::eConvert, CArgException::eExcludedValue, CArgException::eInvalidArg, CArgException::eNoArg, CArgException::eNoFile, CArgException::eNoValue, CArgException::eSynopsis, CArgException::eWrongCast, CCoreException::GetErrCode(), and CException::GetErrCodeString().

Get argument flags.

Definition at line 1920 of file ncbiargs.hpp.

References CArgDesc::m_Flags.

Referenced by CArgDesc::GetUsageConstraint(), CArgDesc_Key::GetUsageSynopsis(), CArgDesc_KeyOpt::GetUsageSynopsis(), CArgDesc_KeyDef::GetUsageSynopsis(), CArgErrorHandler::HandleError(), CArgDesc::PrintXml(), CArgDescMandatory::ProcessArgument(), CArgDescriptions::x_AddDesc(), CArgDescriptions::x_IsMultiArg(), CArgDescriptions::x_PreCheck(), and CArgDescriptions::x_PrintComment().

Get argument name.

Definition at line 187 of file ncbiargs.hpp.

References CArgValue::m_Name.

Referenced by CArgs::Add(), CArg_String::AsBoolean(), CArg_String::AsDateTime(), CArg_String::AsDirectory(), CArg_String::AsDouble(), CArg_String::AsInputFile(), CArg_String::AsInt8(), CArg_String::AsInteger(), CArg_IntId::AsInteger(), CArg_String::AsIntId(), CArg_Int8::AsIntId(), CArg_String::AsIOFile(), CArg_String::AsOutputFile(), CArg_Boolean::CArg_Boolean(), CArg_DataSize::CArg_DataSize(), CArg_DateTime::CArg_DateTime(), CArg_Double::CArg_Double(), CArg_Int8::CArg_Int8(), CArg_Integer::CArg_Integer(), CArg_IntId::CArg_IntId(), CArg_String::CloseFile(), CArg_Ios::CloseFile(), operator<(), and CArg_Ios::x_Open().

Get argument name.

Definition at line 1869 of file ncbiargs.hpp.

References CArgDesc::m_Name.

Referenced by CArgDescMandatory::CArgDescMandatory(), CArgDescriptions::CPrintUsage::CPrintUsage(), CArgDesc_Flag::GetUsageSynopsis(), CArgDesc_Pos::GetUsageSynopsis(), CArgDesc_Opening::GetUsageSynopsis(), CArgDesc_Key::GetUsageSynopsis(), CArgDesc_KeyOpt::GetUsageSynopsis(), CArgDesc_KeyDef::GetUsageSynopsis(), CArgErrorHandler::HandleError(), operator<(), CArgDesc::PrintXml(), CArgDescMandatory::ProcessArgument(), CArgDesc_Flag::ProcessArgument(), CArgDesc_Alias::ProcessArgument(), CArgDescMandatory::ProcessDefault(), CArgDescOptional::ProcessDefault(), CArgDesc_Flag::ProcessDefault(), CArgDesc_Alias::ProcessDefault(), CArgDesc::SetConstraint(), CArgDescriptions::x_AddDesc(), CArgDescriptions::x_PostCheck(), CArgDescriptions::x_PreCheck(), CArgDescriptions::x_PrintAliasesAsXml(), and CArgDescriptions::x_PrintComment().

Get the number of unnamed positional (a.k.a. extra) args.

Definition at line 445 of file ncbiargs.hpp.

References CArgs::m_nExtra.

Referenced by CIdMapperApp::GetSourceIds(), COMSSAMerge::Run(), CDemoSeqQaApp::Run(), CCpGDemoApp::Run(), CAgpValidateApplication::Run(), CAgpconvertApplication::Run(), CMultipatternApp::Run(), CPsgPerfApplication::Run(), CRunTestApplication::Run(), CTestApplication::Run(), CSampleBasicApplication::Run(), CGapStatsApplication::RunNoCatch(), and CAgpValidateApplication::x_ValidateUsingFiles().

Get ordinal position of the value.

NOTE: this is not the position in command line, rather this reflects the order in which values were added to the list.

Definition at line 319 of file ncbiargs.hpp.

References CArgValue::m_Ordinal.

Get usage information.

Implements CArgAllow.

Reimplemented in CArgAllow_Integers.

Definition at line 4739 of file ncbiargs.cpp.

References set< Key, Compare >::begin(), NStr::Int8ToString(), ITERATE, kEmptyStr, kMax_I8, kMin_I8, CArgAllow_Int8s::m_MinMax, pi, set< Key, Compare >::size(), string, and usage.

Referenced by CArgAllow_Integers::GetUsage().

Get usage information.

Reimplemented from CArgAllow_Int8s.

Definition at line 4819 of file ncbiargs.cpp.

References set< Key, Compare >::begin(), CArgAllow_Int8s::GetUsage(), NStr::Int8ToString(), kEmptyStr, kMax_Int, kMin_Int, CArgAllow_Int8s::m_MinMax, set< Key, Compare >::size(), and string.

Get usage information.

Implements CArgAllow.

Definition at line 4874 of file ncbiargs.cpp.

References set< Key, Compare >::begin(), NStr::DoubleToString(), ITERATE, kEmptyStr, kMax_Double, kMin_Double, CArgAllow_Doubles::m_MinMax, pi, set< Key, Compare >::size(), string, and usage.

Get usage information.

Implemented in CArgAllowGeneticCodeInteger, CArgAllow_Regexp, CArgAllow_Doubles, CArgAllow_Integers, CArgAllow_Int8s, CArgAllow_Strings, CArgAllow_String, CArgAllow_Symbols, CArgAllowStringSet, CArgAllowIntegerSet, CArgAllowValuesBetween, CArgAllowValuesLessThanOrEqual, CArgAllowValuesGreaterThanOrEqual, and CArgAllowMaximumFileNameLength.

Referenced by CArgDesc::GetUsageConstraint(), CArgDescMandatory::ProcessArgument(), and CArgDesc::SetConstraint().

Creating copy of this object usually makes no sense if it is really required, please use Assign method.

Definition at line 1785 of file ncbiargs.cpp.

References CArgs::Assign().

Print (append) all arguments to the string "str" and return "str".

Definition at line 1896 of file ncbiargs.cpp.

References CArgValue::AsString(), set< Key, Compare >::begin(), set< Key, Compare >::end(), CArgValue::GetStringList(), NStr::Join(), CArgs::m_Args, str(), and tmp.

Referenced by CXcompareAnnotsApplication::Run(), CReadBlastApp::Run(), and CSampleBasicApplication::Run().

Definition at line 3911 of file ncbiargs.cpp.

References a, CArgDescriptions::eExcludes, multimap_checker< Container >::empty(), CArgDescriptions::ePositionalMode_Loose, CArgDescriptions::eRequires, CArgDescriptions::GetPositionalMode(), i, ITERATE, CArgDescriptions::m_Args, CArgDescriptions::m_Dependencies, CArgDescriptions::m_nExtra, CArgDescriptions::m_nExtraOpt, CArgDescriptions::m_OpeningArgs, CArgDescriptions::m_PosArgs, s_IsFlag(), s_IsKey(), s_IsPositional(), s_WriteXmlLine(), tag, NStr::UIntToString(), and CArgDescriptions::x_PrintAliasesAsXml().

Referenced by CArgDescriptions::PrintUsageXml(), and CCommandArgDescriptions::PrintUsageXml().

Definition at line 5055 of file ncbiargs.cpp.

References arr, map_checker< Container >::begin(), count, CArgDependencyGroup::eInstantSet, map_checker< Container >::end(), first(), i, NStr::Join(), kEmptyStr, CArgDependencyGroup::m_Arguments, CArgDependencyGroup::m_Description, CArgDependencyGroup::m_Groups, CArgDependencyGroup::m_MaxMembers, CArgDependencyGroup::m_MinMembers, CArgDependencyGroup::m_Name, msg(), NStr::NumericToString(), offset, and map_checker< Container >::size().

Print usage message to end of specified string.

Printout USAGE and append to the string "str" using provided argument descriptions and usage context.

Returns

Appended "str"

Reimplemented in CArgDesc_agp_validate, CDiscRepArgDescriptions, and CCommandArgDescriptions.

Definition at line 3856 of file ncbiargs.cpp.

References CArgDescriptions::CPrintUsage::AddDescription(), CArgDescriptions::CPrintUsage::AddDetails(), CArgDescriptions::CPrintUsage::AddSynopsis(), arr, NStr::Join(), kEmptyStr, CArgDescriptions::m_UsageName, and str().

Referenced by CCgiRequestProcessor::OnException(), CDiscRepArgDescriptions::PrintUsage(), CMakeScoreMethodApp::Run(), and CBlastArgs::s_CreateBlastOptions().

Print usage message to end of specified string.

Printout USAGE and append to the string "str" using provided argument descriptions and usage context.

Returns

Appended "str"

Reimplemented from CArgDescriptions.

Definition at line 4175 of file ncbiargs.cpp.

References a, CArgDescriptions::CPrintUsage::AddCommandDescription(), CArgDescriptions::CPrintUsage::AddDescription(), CArgDescriptions::CPrintUsage::AddDetails(), CArgDescriptions::CPrintUsage::AddSynopsis(), arr, map_checker< Container >::begin(), cmd, map_checker< Container >::empty(), map_checker< Container >::end(), CCommandArgDescriptions::eNoSortCommands, CCommandArgDescriptions::eNoSortGroups, map_checker< Container >::find(), CNcbiApplicationAPI::GetArguments(), CNcbiApplication::Instance(), ITERATE, NStr::Join(), kEmptyStr, map_checker< Container >::lower_bound(), CCommandArgDescriptions::m_Aliases, CArgDescriptions::m_AutoHelp, CCommandArgDescriptions::m_Cmd_req, CCommandArgDescriptions::m_CmdGroups, CCommandArgDescriptions::m_Command, CCommandArgDescriptions::m_Commands, CCommandArgDescriptions::m_Description, CCommandArgDescriptions::m_Groups, CArgDescriptions::m_HasHidden, CArgDescriptions::m_UsageName, max(), NULL, map_checker< Container >::size(), CNcbiArguments::Size(), str(), t, CCommandArgDescriptions::x_GetCommandGroupIndex(), CCommandArgDescriptions::x_IdentifyCommand(), and CCommandArgDescriptions::x_IsCommandMandatory().

Print argument description in XML format.

Parameters

out Print into this output stream

Reimplemented from CArgDescriptions.

Definition at line 4326 of file ncbiargs.cpp.

References map_checker< Container >::begin(), map_checker< Container >::end(), map_checker< Container >::find(), g(), CCommandArgDescriptions::m_Aliases, CCommandArgDescriptions::m_CmdGroups, CCommandArgDescriptions::m_Commands, CCommandArgDescriptions::m_Description, CCommandArgDescriptions::m_Groups, out(), CArgDescriptions::CPrintUsageXml::PrintArguments(), s_WriteXmlLine(), CCommandArgDescriptions::x_GetCommandGroupIndex(), and CCommandArgDescriptions::x_IsCommandMandatory().

Definition at line 5133 of file ncbiargs.cpp.

References map_checker< Container >::begin(), CArgDependencyGroup::eInstantSet, map_checker< Container >::end(), i, CArgDependencyGroup::m_Arguments, CArgDependencyGroup::m_Description, CArgDependencyGroup::m_Groups, CArgDependencyGroup::m_MaxMembers, CArgDependencyGroup::m_MinMembers, CArgDependencyGroup::m_Name, and out().

Print description in XML format.

Definition at line 1001 of file ncbiargs.cpp.

References CUtf8::AsUTF8(), eEncoding_Unknown, CArgDescriptions::fAllowMultiple, CArgDescriptions::fAppend, CArgDescriptions::fBinary, CArgDescriptions::fConfidential, CArgDescriptions::fCreatePath, CArgDescriptions::fHidden, CArgDescriptions::fIgnoreInvalidValue, flags, CArgDescriptions::fMandatorySeparator, CArgDescriptions::fNoCreate, CArgDescriptions::fOptionalSeparator, CArgDescriptions::fOptionalSeparatorAllowConflict, CArgDescriptions::fPreOpen, CArgDescriptions::fStandard, CArgDescriptions::fTruncate, CArgDescriptions::fWarnOnInvalidValue, CArgDesc::GetComment(), CArgDesc::GetConstraint(), CArgDescDefault::GetDisplayValue(), CArgDesc::GetFlags(), CArgDesc::GetGroup(), CArgDesc::GetName(), CArgDesc_Flag::GetSetValue(), CArgDescSynopsis::GetSynopsis(), CArgDescMandatory::GetType(), CArgDescriptions::GetTypeName(), CArgDesc::GetUsageConstraint(), CArgDesc::IsConstraintInverted(), out(), CArgAllow::PrintUsageXml(), s_IsFlag(), s_IsKey(), s_IsOpening(), s_IsOptional(), s_IsPositional(), s_WriteEscapedStr(), s_WriteXmlLine(), and NStr::SizetToString().

Set additional user defined constraint on argument value.

Constraint is defined by CArgAllow and its derived classes. The constraint object must be allocated by "new", and it must NOT be freed by "delete" after it has been passed to CArgDescriptions!

Parameters

name Name of the parameter(flag) to check constraint The constraint object. NOTE: A CRef will always be taken on the object, and its lifetime will be controlled by the CObject's smart-pointer mechanism. negate Flag indicates if this is inverted(NOT) constaint

See also

See "CArgAllow_***" classes for some pre-defined constraints

Definition at line 2616 of file ncbiargs.cpp.

References CArgDescriptions::eConstraint, set< Key, Compare >::end(), CArgDescriptions::m_Args, NCBI_THROW, and CArgDescriptions::x_Find().

Referenced by CFlatFileConfig::AddArgumentDescriptions(), CWinMaskConfig::AddWinMaskArgs(), CAVApp::Init(), SUApp::Init(), Cn3DNoWin::Init(), CId2FetchApp::Init(), CDbapiTestSpeedApp::InitSample(), s_InitDataOnly(), CPsgClientApp::s_InitRequest(), CStdCmdLineArgs::SetArgumentDescriptions(), CTaskCmdLineArgs::SetArgumentDescriptions(), CWindowSizeArg::SetArgumentDescriptions(), COffDiagonalRangeArg::SetArgumentDescriptions(), CWordThresholdArg::SetArgumentDescriptions(), CRMBlastNArg::SetArgumentDescriptions(), CGenericSearchArgs::SetArgumentDescriptions(), CNuclArgs::SetArgumentDescriptions(), CDiscontiguousMegablastArgs::SetArgumentDescriptions(), CLargestIntronSizeArgs::SetArgumentDescriptions(), CFrameShiftArgs::SetArgumentDescriptions(), CGeneticCodeArgs::SetArgumentDescriptions(), CPsiBlastArgs::SetArgumentDescriptions(), CMappingArgs::SetArgumentDescriptions(), CQueryOptionsArgs::SetArgumentDescriptions(), CMapperQueryOptionsArgs::SetArgumentDescriptions(), CBlastDatabaseArgs::SetArgumentDescriptions(), CIgBlastArgs::SetArgumentDescriptions(), CFormattingArgs::SetArgumentDescriptions(), CMapperFormattingArgs::SetArgumentDescriptions(), CMTArgs::SetArgumentDescriptions(), CHspFilteringArgs::SetArgumentDescriptions(), CMapperGenericSearchArgs::SetArgumentDescriptions(), CMapperNuclArgs::SetArgumentDescriptions(), CMapperLargestIntronSizeArgs::SetArgumentDescriptions(), CArgDescriptions::SetConstraint(), CSplignArgUtil::SetupArgDescriptions(), CCompartOptions::SetupArgDescriptions(), CProSplignOutputOptions::SetupArgDescriptions(), CDBLBClientApp::x_InitLookup(), CDBLBClientApp::x_InitWhereIs(), and CTbl2AsnApp::x_SetAlnArgs().

Set current arguments group name.

When printing descriptions for optional arguments (on -help command), they will be arranged by group name. Empty group name resets the group. Arguments without group are listed first immediately after mandatory arguments.

Definition at line 2657 of file ncbiargs.cpp.

References CArgDescriptions::m_ArgGroups, CArgDescriptions::m_CurrentGroup, and CArgDescriptions::x_GetGroupIndex().

Referenced by CFlatFileConfig::AddArgumentDescriptions(), CGenomicCollectionsService::AddArguments(), CWinMaskConfig::AddWinMaskArgs(), CArgDescriptions::CreateArgs(), CStdCmdLineArgs::SetArgumentDescriptions(), CTaskCmdLineArgs::SetArgumentDescriptions(), CWindowSizeArg::SetArgumentDescriptions(), COffDiagonalRangeArg::SetArgumentDescriptions(), CWordThresholdArg::SetArgumentDescriptions(), CRMBlastNArg::SetArgumentDescriptions(), CMatrixNameArg::SetArgumentDescriptions(), CGenericSearchArgs::SetArgumentDescriptions(), CFilteringArgs::SetArgumentDescriptions(), CNuclArgs::SetArgumentDescriptions(), CDiscontiguousMegablastArgs::SetArgumentDescriptions(), CCompositionBasedStatsArgs::SetArgumentDescriptions(), CGappedArgs::SetArgumentDescriptions(), CLargestIntronSizeArgs::SetArgumentDescriptions(), CFrameShiftArgs::SetArgumentDescriptions(), CGeneticCodeArgs::SetArgumentDescriptions(), CGapTriggerArgs::SetArgumentDescriptions(), CPssmEngineArgs::SetArgumentDescriptions(), CSearchStrategyArgs::SetArgumentDescriptions(), CPsiBlastArgs::SetArgumentDescriptions(), CPhiBlastArgs::SetArgumentDescriptions(), CKBlastpArgs::SetArgumentDescriptions(), CDeltaBlastArgs::SetArgumentDescriptions(), CMappingArgs::SetArgumentDescriptions(), CQueryOptionsArgs::SetArgumentDescriptions(), CMapperQueryOptionsArgs::SetArgumentDescriptions(), CBlastDatabaseArgs::SetArgumentDescriptions(), CIgBlastArgs::SetArgumentDescriptions(), CFormattingArgs::SetArgumentDescriptions(), CMapperFormattingArgs::SetArgumentDescriptions(), CMTArgs::SetArgumentDescriptions(), CRemoteArgs::SetArgumentDescriptions(), CDebugArgs::SetArgumentDescriptions(), CHspFilteringArgs::SetArgumentDescriptions(), CMbIndexArgs::SetArgumentDescriptions(), CSRASearchModeArgs::SetArgumentDescriptions(), CMapperStdCmdLineArgs::SetArgumentDescriptions(), CMapperGenericSearchArgs::SetArgumentDescriptions(), CMapperNuclArgs::SetArgumentDescriptions(), CMapperLargestIntronSizeArgs::SetArgumentDescriptions(), CInputStreamSource::SetStandardInputArgs(), CAdvancedAlignCleanup::SetupArgDescriptions(), CSplignArgUtil::SetupArgDescriptions(), CAlignCollapser::SetupArgDescriptions(), CGnomonAnnotatorArgUtil::SetupArgDescriptions(), and CChainerArgUtil::SetupArgDescriptions().

Define a dependency.

If arg1 was specified and requires arg2, arg2 is treated as a mandatory one even if was defined as optional. If arg1 excludes arg2, arg2 must not be set even if it's mandatory. This allows to create a set of arguments exactly one of which must be set.

Definition at line 2643 of file ncbiargs.cpp.

References CArgDescriptions::eExcludes, multimap_checker< Container >::insert(), and CArgDescriptions::m_Dependencies.

Referenced by CFlatFileConfig::AddArgumentDescriptions(), CLocalTaxon::AddArguments(), s_AddLatencyOptions(), s_InitDataFlags(), s_InitDataOnly(), CPsgClientApp::s_InitRequest(), CStdCmdLineArgs::SetArgumentDescriptions(), CFilteringArgs::SetArgumentDescriptions(), CDiscontiguousMegablastArgs::SetArgumentDescriptions(), CFrameShiftArgs::SetArgumentDescriptions(), CSearchStrategyArgs::SetArgumentDescriptions(), CPsiBlastArgs::SetArgumentDescriptions(), CPhiBlastArgs::SetArgumentDescriptions(), CDeltaBlastArgs::SetArgumentDescriptions(), CMapperQueryOptionsArgs::SetArgumentDescriptions(), CBlastDatabaseArgs::SetArgumentDescriptions(), CFormattingArgs::SetArgumentDescriptions(), CMapperFormattingArgs::SetArgumentDescriptions(), CMTArgs::SetArgumentDescriptions(), CHspFilteringArgs::SetArgumentDescriptions(), CMapperStdCmdLineArgs::SetArgumentDescriptions(), CMapperGenericSearchArgs::SetArgumentDescriptions(), CInputStreamSource::SetStandardInputArgs(), CAdvancedAlignCleanup::SetupArgDescriptions(), CCompartOptions::SetupArgDescriptions(), CDBLBClientApp::x_InitLookup(), and CTbl2AsnApp::x_SetAlnArgs().

Set detailed usage description.

In short help message, program will print short description defined in SetUsageContext method. In detailed help message, program will use detailed description defined here.

Parameters

usage_description Detailed usage description

See also

SetUsageContext

Definition at line 3374 of file ncbiargs.cpp.

References CArgDescriptions::m_DetailedDescription.

Parameters

max_members No more than "max_members" of members (args or immediate groups listed in this group) are allowed to be in the "set" state. If this condition is not met, then this group will be marked as "not set".

Returns

"*this"

Definition at line 4961 of file ncbiargs.cpp.

References CArgDependencyGroup::m_MaxMembers.

Set extra info to be used by PrintUsage().

If "usage_name" is empty, it will be initialized using CNcbiApplicationAPI::GetProgramDisplayName

See also

SetDetailedDescription Format width

Parameters

usage_name Program name usage_description Usage descr. usage_sort_args Sort args.

Definition at line 3344 of file ncbiargs.cpp.

References NStr::eNocase, ERR_POST_X, CArgDescriptions::fUsageSortArgs, CNcbiApplicationAPI::GetProgramDisplayName(), CNcbiApplicationAPI::Instance(), CArgDescriptions::m_UsageDescription, CArgDescriptions::m_UsageName, CArgDescriptions::m_UsageWidth, CArgDescriptions::ResetMiscFlags(), CArgDescriptions::SetMiscFlags(), NStr::TrimSuffixInPlace(), and Warning().

Referenced by COMSSA::AppInit(), CArgDescriptions::CArgDescriptions(), CSdbapiTest::Init(), CAVApp::Init(), Cn3DNoWin::Init(), CId2FetchApp::Init(), CNcbiTestApplication::Init(), CSdbapiSimpleApp::Init(), CProgramDescriptionArgs::SetArgumentDescriptions(), CIgBlastProgramDescriptionArgs::SetArgumentDescriptions(), CMapperProgramDescriptionArgs::SetArgumentDescriptions(), CDBLBClientApp::x_InitLookup(), CDBLBClientApp::x_InitWhatIs(), and CDBLBClientApp::x_InitWhereIs().

Verify if specified value is allowed.

Implemented in CArgAllowGeneticCodeInteger, CArgAllow_Regexp, CArgAllow_Doubles, CArgAllow_Int8s, CArgAllow_Strings, CArgAllow_String, CArgAllow_Symbols, CArgAllowStringSet, CArgAllowIntegerSet, CArgAllowValuesBetween, CArgAllowValuesLessThanOrEqual, CArgAllowValuesGreaterThanOrEqual, and CArgAllowMaximumFileNameLength.

Referenced by CArgDescMandatory::ProcessArgument().

Helper method for adding description.

Definition at line 3409 of file ncbiargs.cpp.

References _ASSERT, CArgDescriptions::Exist(), CArgDescriptions::fHidden, CArgDescriptions::fOptionalSeparator, CArgDesc::GetFlags(), CArgDesc::GetName(), CRef< C, Locker >::GetPointerOrNull(), set< Key, Compare >::insert(), CArgDescriptions::m_Args, CArgDescriptions::m_CurrentGroup, CArgDescriptions::m_ErrorHandler, CArgDescriptions::m_HasHidden, CArgDescriptions::m_KeyFlagArgs, CArgDescriptions::m_NoSeparator, CArgDescriptions::m_OpeningArgs, CArgDescriptions::m_PosArgs, NCBI_THROW, s_IsAlias(), s_IsFlag(), s_IsKey(), s_IsOpening(), s_IsOptional(), CArgDesc::SetErrorHandler(), CArgDesc::SetGroup(), and CArgDescriptions::x_Find().

Referenced by CArgDescriptions::AddAlias(), CArgDescriptions::AddDefaultKey(), CArgDescriptions::AddDefaultPositional(), CArgDescriptions::AddExtra(), CArgDescriptions::AddFlag(), CArgDescriptions::AddKey(), CArgDescriptions::AddNegatedFlagAlias(), CArgDescriptions::AddOpening(), CArgDescriptions::AddOptionalKey(), CArgDescriptions::AddOptionalPositional(), and CArgDescriptions::AddPositional().

Process arguments.

Helper method to process arguments and build a CArgs object that is passed as the args parameter.

Returns

TRUE if specified "arg2" was used.

Parameters

arg1 Argument to process have_arg2 Is there an arg. that follows? arg2 Following argument n_plain Indicates number of args args Contains processed args

Definition at line 2898 of file ncbiargs.cpp.

References set< Key, Compare >::end(), CArgDescriptions::ePositionalMode_Loose, eq(), CArgs::GetAll(), kEmptyStr, kMax_UInt, CArgDescriptions::m_Args, CArgDescriptions::m_nExtra, CArgDescriptions::m_nExtraOpt, CArgDescriptions::m_OpeningArgs, CArgDescriptions::m_PosArgs, CArgDescriptions::m_PositionalMode, NCBI_THROW, NPOS, s_ArgDelimiter, NStr::UIntToString(), CArgDescriptions::VerifyName(), and CArgDescriptions::x_Find().

Referenced by CArgDescriptions::ConvertKeys(), and CArgDescriptions::CreateArgs().

Returns

TRUE if specified "arg2" was used.

Definition at line 4985 of file ncbiargs.cpp.

References map_checker< Container >::begin(), set< Key, Compare >::begin(), CArgDependencyGroup::eInstantSet, map_checker< Container >::end(), CArgs::Exist(), i, set< Key, Compare >::insert(), NStr::Join(), CArgDependencyGroup::m_Arguments, CArgDependencyGroup::m_Groups, CArgDependencyGroup::m_MaxMembers, CArgDependencyGroup::m_MinMembers, msg(), NCBI_THROW, result, map_checker< Container >::size(), and set< Key, Compare >::size().

Referenced by CArgDependencyGroup::Evaluate().

Helper method to find named parameter.

'negative' (if provided) will indicate if the name referred to a negative alias.

Definition at line 2761 of file ncbiargs.cpp.

References set< Key, Compare >::end(), set< Key, Compare >::find(), CArgDesc_Alias::GetAliasedName(), CArgDesc_Alias::GetNegativeFlag(), CArgDescriptions::m_Args, and negative().

Referenced by CArgDescriptions::AddNegatedFlagAlias(), CArgDescriptions::CPrintUsage::CPrintUsage(), CArgDescriptions::Delete(), CArgDescriptions::Exist(), CArgDescriptions::SetConstraint(), CArgDescriptions::SetErrorHandler(), CArgDescriptions::x_AddDesc(), CArgDescriptions::x_CreateArg(), CArgDescriptions::x_Find(), CArgDescriptions::x_IsMultiArg(), CArgDescriptions::x_PostCheck(), and CArgDescriptions::x_PreCheck().

Definition at line 4106 of file ncbiargs.cpp.

References a, map_checker< Container >::begin(), cmd, command, map_checker< Container >::end(), map_checker< Container >::find(), kEmptyStr, CCommandArgDescriptions::m_Aliases, CCommandArgDescriptions::m_Description, and NStr::StartsWith().

Referenced by CCommandArgDescriptions::CreateArgs(), and CCommandArgDescriptions::PrintUsage().

Helper method for doing post-processing consistency checks.

Definition at line 3203 of file ncbiargs.cpp.

References CArgs::Add(), set< Key, Compare >::begin(), CArgDescriptions::eCgiArgs, CArgDescriptions::eConstraint, CArgDescriptions::eConvertKeys, CArgDescriptions::eExcludes, map_checker< Container >::end(), set< Key, Compare >::end(), CArgDescriptions::eRequires, CArgs::Exist(), map_checker< Container >::find(), set< Key, Compare >::find(), CArgDescriptions::fUsageIfNoArgs, CArgDescriptions::GetArgsType(), CArgDesc::GetName(), i, map_checker< Container >::insert(), set< Key, Compare >::insert(), CArgs::IsEmpty(), CArgDescriptions::IsSetMiscFlag(), ITERATE, kEmptyStr, CArgDescriptions::m_Dependencies, CArgDescriptions::m_DependencyGroups, CArgDescriptions::m_KeyFlagArgs, CArgDescriptions::m_nExtra, CArgDescriptions::m_OpeningArgs, CArgDescriptions::m_PosArgs, max(), NCBI_THROW, NStr::NumericToString(), CArgDesc::ProcessDefault(), s_ArgExptMsg(), NStr::StringToUInt(), NStr::UIntToString(), and CArgDescriptions::x_Find().

Referenced by CArgDescriptions::ConvertKeys(), and CArgDescriptions::CreateArgs().

Helper method for doing pre-processing consistency checks.

Definition at line 2794 of file ncbiargs.cpp.

References _ASSERT, a, set< Key, Compare >::begin(), CArgDescriptions::eConstraint, set< Key, Compare >::end(), ERR_POST_X, Error(), CArgDescriptions::fOptionalSeparator, CArgDescriptions::fOptionalSeparatorAllowConflict, CArgDescriptions::fStandard, CArgDesc::GetFlags(), CArgDesc::GetName(), i, CArgDescriptions::m_Args, CArgDescriptions::m_nExtra, CArgDescriptions::m_NoSeparator, CArgDescriptions::m_PosArgs, n, NCBI_RETHROW, NCBI_THROW, NPOS, s_IsAlias(), CArgDesc::VerifyDefault(), CException::what(), and CArgDescriptions::x_Find().

Referenced by CArgDescriptions::ConvertKeys(), and CArgDescriptions::CreateArgs().

Definition at line 3469 of file ncbiargs.cpp.

References arr, CArgDescriptions::eExcludes, CArgDescriptions::eInputFile, multimap_checker< Container >::equal_range(), CArgDescriptions::eRequires, CArgDescriptions::fConfidential, CArgDescriptions::fMandatorySeparator, NStr::fWrap_Hyphenate, CArgDesc_Alias::GetAliasedName(), CArgDesc::GetComment(), CArgDescDefault::GetDisplayValue(), CArgDesc::GetFlags(), CArgDesc::GetName(), CArgDesc_Alias::GetNegativeFlag(), CArgDesc_Flag::GetSetValue(), CArgDescriptions::GetTypeName(), CArgDesc::GetUsageCommentAttr(), CArgDesc::GetUsageSynopsis(), indent(), ITERATE, kEmptyStr, CArgDescriptions::m_Args, CArgDescriptions::m_Dependencies, NPOS, s_IsFlag(), s_IsPositional(), s_PrintCommentBody(), t, and NStr::Wrap().

Definition at line 4383 of file ncbiargs.cpp.

Definition at line 54 of file arg_regexp.cpp.

Definition at line 4951 of file ncbiargs.cpp.

Definition at line 161 of file ncbiargs.cpp.

Definition at line 3697 of file ncbiargs.cpp.

Definition at line 3906 of file ncbiargs.cpp.

Assoc.map of arguments' name/descr.

Definition at line 1166 of file ncbiargs.hpp.

Referenced by CArgDescriptions::AddNegatedFlagAlias(), CArgDescriptions::CPrintUsage::CPrintUsage(), CArgDescriptions::Delete(), CArgDescriptions::Exist(), CArgDescriptions::CPrintUsageXml::PrintArguments(), CArgDescriptions::SetConstraint(), CArgDescriptions::SetErrorHandler(), CArgDescriptions::x_AddDesc(), CArgDescriptions::x_CreateArg(), CArgDescriptions::x_Find(), CArgDescriptions::x_IsMultiArg(), CArgDescriptions::x_PreCheck(), CArgDescriptions::x_PrintAliasesAsXml(), and CArgDescriptions::x_PrintComment().

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4