get_argument_list.h File Reference

#include <list>
#include "PString.h"

Include dependency graph for get_argument_list.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
std::list< PString >	phoenix_getArgumentList (int argc, char **argv)
	Convert the list of given arguments to the program into a list of string. More...
PString	phoenix_getProgramCall (const std::list< PString > &listArg)
	Get the program call. More...
bool	phoenix_isOptionExist (const std::list< PString > &listArg, const PString &arg1)
	Check if one of the two passed arguments are in the list of arguments. More...
bool	phoenix_isOptionExist (const std::list< PString > &listArg, const PString &arg1, const PString &arg2)
	Check if one of the two passed arguments are in the list of arguments. More...
bool	phoenix_isOptionExist (const std::list< PString > &listArg, const std::list< PString > &argCheckList)
	Check if one of the two passed arguments are in the list of arguments. More...
PString	phoenix_listArgToString (const std::list< PString > &listArg)
	Convert the given list of arguement into a string. More...
void	phoenix_rmProgramCall (std::list< PString > &listArg)
	Remove the program call from the list of argument. More...

Function Documentation

phoenix_getArgumentList()

std::list<PString> phoenix_getArgumentList	(	int	argc,
		char **	argv
	)

Convert the list of given arguments to the program into a list of string.

Parameters

argc	: number of arguments passed to the program
argv	: table of arguments passed to the program

Returns

corresponding list of string

Definition at line 15 of file get_argument_list.cpp.

                                                               {
        std::list<PString> argList;
        for(int i(0); i < argc; ++i){
                argList.push_back(PString(argv[i]));
        }
        return argList;
}

Referenced by main().

Here is the caller graph for this function:

phoenix_getProgramCall()

PString phoenix_getProgramCall

(

const std::list< PString > &

listArg

)

Get the program call.

Parameters

listArg

: list of argument passed to the program

Returns

program call, or empty string if list of argument is empty

Definition at line 82 of file get_argument_list.cpp.

                                                                {
        if(listArg.size() != 0lu){return listArg.front();}
        else{return "";}
}

Referenced by main().

Here is the caller graph for this function:

phoenix_isOptionExist() [1/3]

bool phoenix_isOptionExist	(	const std::list< PString > &	listArg,
		const PString &	arg1
	)

Check if one of the two passed arguments are in the list of arguments.

Parameters

listArg	: list of arguments given to the program
arg1	: argument to be searched

Returns

true if arg1 or arg2 is in listArg, false otherwise

Definition at line 47 of file get_argument_list.cpp.

                                                                                  {
        std::list<PString> argCheckList;
        argCheckList.push_back(arg1);
        return phoenix_isOptionExist(listArg, argCheckList);
}

References phoenix_isOptionExist().

Here is the call graph for this function:

phoenix_isOptionExist() [2/3]

bool phoenix_isOptionExist	(	const std::list< PString > &	listArg,
		const PString &	arg1,
		const PString &	arg2
	)

Check if one of the two passed arguments are in the list of arguments.

Parameters

listArg	: list of arguments given to the program
arg1	: argument to be searched
arg2	: argument to be searched

Returns

true if arg1 or arg2 is in listArg, false otherwise

Definition at line 59 of file get_argument_list.cpp.

                                                                                                        {
        std::list<PString> argCheckList;
        argCheckList.push_back(arg1);
        argCheckList.push_back(arg2);
        return phoenix_isOptionExist(listArg, argCheckList);
}

References phoenix_isOptionExist().

Here is the call graph for this function:

phoenix_isOptionExist() [3/3]

bool phoenix_isOptionExist	(	const std::list< PString > &	listArg,
		const std::list< PString > &	argCheckList
	)

Check if one of the two passed arguments are in the list of arguments.

Parameters

listArg	: list of arguments given to the program
argCheckList	: list of argument to be searched

Returns

true if one element of argCheckList has been found in listArg, false otherwise

Definition at line 28 of file get_argument_list.cpp.

                                                                                                   {
        bool isSearch(true);
        std::list<PString>::const_iterator itArg(listArg.begin());
        while(itArg != listArg.end() && isSearch){
                std::list<PString>::const_iterator itCheck(argCheckList.begin());
                while(itCheck != argCheckList.end() && isSearch){
                        isSearch = *itArg != *itCheck;
                        ++itCheck;
                }
                ++itArg;
        }
        return !isSearch;
}

Referenced by main(), and phoenix_isOptionExist().

Here is the caller graph for this function:

phoenix_listArgToString()

PString phoenix_listArgToString

(

const std::list< PString > &

listArg

)

Convert the given list of arguement into a string.

Parameters

listArg

: list of argument to be converted into a string

Returns

corresponding string

Definition at line 70 of file get_argument_list.cpp.

                                                                 {
        PString body("");
        for(std::list<PString>::const_iterator itArg(listArg.begin()); itArg != listArg.end(); ++itArg){
                body += itArg->escapeStr(" '\"", "\\") + " ";
        }
        return body;
}

References PString::escapeStr().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_rmProgramCall()

void phoenix_rmProgramCall

(

std::list< PString > &

listArg

)

Remove the program call from the list of argument.

Parameters

[out]

listArg

: list or argument to be modified

Definition at line 90 of file get_argument_list.cpp.

                                                      {
        if(listArg.size() != 0lu){
                listArg.pop_front();
        }
}

Referenced by main().

Here is the caller graph for this function: