tCommandLineParser Struct Reference

command line data More...

#include <tCommandLine.h>

List of all members.

Public Member Functions
bool	GetSwitch (char const *option, char const *option_short=NULL)
bool	GetOption (tString &target, char const *option, char const *option_short=NULL)
	Tests whether the current argument is the given switch.
bool	End () const
	Tests whether the current argument is the given option and extracts the value.
const char *	Executable () const
	Tests whether the command line parsing is done.
const char *	Current () const
	Returns the full path to the executable.
void	Advance ()
	Returns the current option.
	tCommandLineParser (int argc, char **argv)
	Advances to the next option.
Private Member Functions
	tCommandLineParser ()
	constructor
Private Attributes
const int	argc
	constructor
char **	argv
	total number of arguments
int	index
	pointer array to arguments

---

Detailed Description

command line data

Definition at line 62 of file tCommandLine.h.

---

Constructor & Destructor Documentation

tCommandLineParser::tCommandLineParser	(	int	a_argc,
		char **	a_argv
	)

Advances to the next option.

Parameters:

	a_argc	number of arguments
	a_argv	arguments

Definition at line 303 of file tCommandLine.cpp.

        : argc( a_argc ), argv( a_argv ), index( 0 )
{
}

tCommandLineParser::tCommandLineParser

(

)

[private]

constructor

---

Member Function Documentation

bool tCommandLineParser::GetSwitch	(	char const *	option,
		char const *	option_short = NULL
	)

Parameters:

	option	long version of the switch
	option_short	short version of the switch

Returns:

true if the switch was detected

Definition at line 222 of file tCommandLine.cpp.

References argv, End(), index, and tASSERT.

Referenced by tCommandLineData::Analyse(), gMainCommandLineAnalyzer::DoAnalyze(), tDirectoriesCommandLineAnalyzer::DoAnalyze(), rFastForwardCommandLineAnalyzer::DoAnalyze(), and GetOption().

{
    if ( End() )
        return false;

    char * argument = argv[index];
    tASSERT( argument );
    if ( !strcmp(argument,option) || ( option_short && !strcmp(argument,option_short ) ) )
    {
        index++;
        return true;
    }

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tCommandLineParser::GetOption	(	tString &	target,
		char const *	option,
		char const *	option_short = NULL
	)

Tests whether the current argument is the given switch.

Parameters:

	target	string to store option to
	option	long version of the option
	option_short	short version of the option

Returns:

true if the option was detected

Definition at line 251 of file tCommandLine.cpp.

References argv, End(), GetSwitch(), index, QUIT, and tASSERT.

Referenced by gCommandLineJumpStartAnalyzer::DoAnalyze(), tRecordingCommandLineAnalyzer::DoAnalyze(), rFastForwardCommandLineAnalyzer::DoAnalyze(), and ReadDir().

{
    if ( End() )
        return false;

    char * argument = argv[index];
    tASSERT( argument );
    if ( GetSwitch( option, option_short ) )
    {
        if ( !End() )
        {
            target = argv[index];
            index++;
            return true;
        }
        else
        {
            index--;
            tString name_;
            QUIT( "  " << argument << " needs another argument.\n" );
        }
    }

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tCommandLineParser::End

(

void

)

const

Tests whether the current argument is the given option and extracts the value.

Returns:

true if the options have been parsed to the end

Definition at line 287 of file tCommandLine.cpp.

References argc, and index.

Referenced by Advance(), tCommandLineData::Analyse(), GetOption(), and GetSwitch().

{
    return ( index >= argc );
}

Here is the caller graph for this function:

const char * tCommandLineParser::Executable

(

void

)

const

Tests whether the command line parsing is done.

Returns:

the full path of the executable

Definition at line 333 of file tCommandLine.cpp.

References argv.

Referenced by tDirectoriesCommandLineAnalyzer::DoInitialize().

{
    return argv[ 0 ];
}

Here is the caller graph for this function:

const char * tCommandLineParser::Current

(

void

)

const

Returns the full path to the executable.

Returns:

the current command line option

Definition at line 348 of file tCommandLine.cpp.

References argv, and index.

Referenced by tCommandLineData::Analyse().

{
    return argv[ index ];
}

Here is the caller graph for this function:

void tCommandLineParser::Advance

(

void

)

Returns the current option.

Definition at line 362 of file tCommandLine.cpp.

References End(), index, and tASSERT.

Referenced by tCommandLineData::Analyse().

{
    tASSERT( !End() );
    index ++;
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

const int tCommandLineParser::argc [private]

constructor

Definition at line 78 of file tCommandLine.h.

Referenced by End().

char* * tCommandLineParser::argv [private]

total number of arguments

Definition at line 79 of file tCommandLine.h.

Referenced by Current(), Executable(), GetOption(), and GetSwitch().

int tCommandLineParser::index [private]

pointer array to arguments

Definition at line 80 of file tCommandLine.h.

Referenced by Advance(), Current(), End(), GetOption(), and GetSwitch().

---

The documentation for this struct was generated from the following files:

• src/tools/tCommandLine.h
• src/tools/tCommandLine.cpp

---