options Namespace Reference

Namespaces
	escapedIO
	internal
	template specialisation for options that are std::chrono::time_point<std::chrono::system_clock>

Classes
class	base
	base class for options More...
class	container
	template for container-based options. More...
class	ForeignApplicationOptions
	class to hold a list of options that are to be handled by a foreign option parser More...
class	ForeignOption
	special type of option that is not really parsed but used to feed an additional option parser More...
class	fundamental_wrapper
	wrapper class for fundamental types More...
class	map
	template for map-based options. More...
class	OptionsForTApplication
	specific class to give the options for a TApplication as ForeignApplicationOptions to the option parser More...
class	originalStringKeeper
	interface class that is used for options where the original string rather than the streamed value is to be written into config files. More...
class	parser
	class that contains the parser, i.e. does that option handling More...
class	positional
class	postFixedNumber
class	single
	generic option class with any type that can be used with std::istream and std::ostream More...
class	single< bool >
	class specialisation for options of type bool More...
class	single< std::chrono::duration< Rep, Period > >
	template specialisation for options that are std::chrono::durations More...
class	single< std::chrono::system_clock::time_point >
class	single< std::regex >
class	valuePrinter
	template interface class for options that provide a value printer More...
class	withAction

Functions
std::ostream &	operator<< (std::ostream &aStream, const internal::sourceItem &aItem)
	operator to write sourceItems to a stream More...
template<typename T >
std::ostream &	operator<< (std::ostream &aStream, const postFixedNumber< T > &aNumber)
template<typename T >
std::istream &	operator>> (std::istream &aStream, postFixedNumber< T > &aNumber)
template<typename T >
std::ostream &	operator<< (std::ostream &aStream, const fundamental_wrapper< T > &aWrapper)
template<typename T >
std::istream &	operator>> (std::istream &aStream, fundamental_wrapper< T > &aWrapper)

Detailed Description

all of the option parser stuff is contained in the namespace options.

Function Documentation

operator<<() [1/3]

template<typename T >

std::ostream& options::operator<<	(	std::ostream &	aStream,
		const fundamental_wrapper< T > &	aWrapper
	)

Definition at line 155 of file Options.h.

                                                                                                              {
        const T& oerks = aWrapper;
        aStream << oerks;
        return aStream;
    };

operator<<() [2/3]

std::ostream & options::operator<<	(	std::ostream &	aStream,
		const internal::sourceItem &	aItem
	)

operator to write sourceItems to a stream

Definition at line 57 of file Options.cpp.

                                                                                  {
        aStream << aItem.fGetFile()->fGetName() << ":" << aItem.fGetLineNumber();
        return aStream;
    }

References options::internal::sourceItem::fGetFile(), and options::internal::sourceItem::fGetLineNumber().

Here is the call graph for this function:

operator<<() [3/3]

template<typename T >

std::ostream& options::operator<<	(	std::ostream &	aStream,
		const postFixedNumber< T > &	aNumber
	)

Definition at line 121 of file Options.h.

                                                                                                         {
        T n = aNumber;
        int m = 0;
        // as long as no better solution pops up for the shell scrip parser
        // always write just normally
        //while (n != 0 && (n & ((static_cast<T>(1) << 10) - 1)) == 0) {
        //  n = n >> 10;
        //  m++;
        //}
        aStream << n;
        if (m > 0) {
            static std::string gMultipliers("kMGTPEZY");
            aStream << gMultipliers.at(m - 1);
        }
        return aStream;
    }

operator>>() [1/2]

template<typename T >

std::istream& options::operator>>	(	std::istream &	aStream,
		fundamental_wrapper< T > &	aWrapper
	)

Definition at line 160 of file Options.h.

                                                                                                        {
        T& oerks = aWrapper;
        using escapedIO::operator>>;
        aStream >> oerks;
        return aStream;
    };

operator>>() [2/2]

template<typename T >

std::istream& options::operator>>	(	std::istream &	aStream,
		postFixedNumber< T > &	aNumber
	)

Definition at line 137 of file Options.h.

                                                                                                   {
        T n;
        aStream >> n;
        if (!aStream.eof()) {
            auto c = aStream.peek();
            static std::string gMultipliers("kMGTPEZY");
            auto m = gMultipliers.find(c);
            if (m != std::string::npos) {
                aStream.get();
                n = n << ((m + 1) * 10);
            }
        }
        aNumber = n;
        return aStream;
    };