Arguments Class Reference

#include <Arguments.h>

Inheritance diagram for Arguments:

Public Member Functions
String	help () const
String	shortUsage () const
String	tryUsage () const
String	argRequired (const String &_option) const
String	usage () const
String	version () const
Public Member Functions inherited from Object
virtual String	toString () const
virtual void	destroy ()
String	className () const
bool	isInstanceOf (const std::type_info &typeinfo) const
virtual const std::type_info &	typeInfo () const

Protected Member Functions
virtual void	onOption (int _key, const String &_arg) __DCL_THROWS1(Exception *)
virtual String	onValidate ()
Protected Member Functions inherited from Object
virtual	~Object ()
	Object ()

Detailed Description

Definition at line 16 of file Arguments.h.

Member Function Documentation

argRequired()

String Arguments::argRequired

(

const String &

_option

)

const

Definition at line 142 of file Arguments.cpp.

{
    StringBuilder sb = __value0;
    sb += L": option '";
    sb += _option;
    sb += L"' requires an argument";
    return sb;
}

help()

String Arguments::help

(

)

const

Definition at line 100 of file Arguments.cpp.

{
    StringBuilder sb = shortUsage();
    if (__doc) {
        sb += L'\n';
        sb += __doc;
    }
    sb += L'\n';
 
    __add_help(sb, __options);
    sb += L'\n';
    __add_help(sb, __options__);
 
    if (__program_bug_address) {
        sb += L"\n\n";
        sb += L"Report bugs to ";
        sb += __program_bug_address;
    }
    return sb;
}

onOption()

void Arguments::onOption ( int _key, const String & _arg )

protectedvirtual

Reimplemented in MainArguments, and MainArguments.

Definition at line 43 of file Arguments.cpp.

{
}

onValidate()

String Arguments::onValidate ( )

protectedvirtual

Reimplemented in MainArguments, and MainArguments.

Definition at line 48 of file Arguments.cpp.

{
    return String();
}

shortUsage()

String Arguments::shortUsage

(

)

const

Definition at line 121 of file Arguments.cpp.

{
    StringBuilder sb = L"Usage: ";
    sb += __value0;
    sb += L" [OPTION...] ";
    if (__arg_doc) {
        sb += __arg_doc;
    }
    return sb;
}

tryUsage()

String Arguments::tryUsage

(

)

const

Definition at line 132 of file Arguments.cpp.

{
    StringBuilder sb = L"Try `";
    sb += __value0;
    sb += L" --help' or `";
    sb += __value0;
    sb += L" --usage' for more information.";
    return sb;
}

usage()

String Arguments::usage

(

)

const

Definition at line 214 of file Arguments.cpp.

{
    StringArray a;
    {
        String s = __key_options(__options)
            + __key_options(__options__)
            ;
        if (!s.isEmpty()) {
            a.add(L"-" + s);
        }
    }
    __add_key_arg_options(a, __options);
    __add_name_arg_options(a, __options);
    __add_name_options(a, __options);
    __add_name_options(a, __options__);
 
    StringBuilder sb = L"Usage: ";
    sb += __value0;
    String padding(L' ', 10);
    size_t n = sb.length();
    for (size_t i = 0; i < a.size(); i++) {
        const String& s = a[i];
        if ((n + s.length() + 3) > 80) {
            sb += L"\n";
            sb += padding;
            n = padding.length();
        }
        n += s.length() + 3;
        sb += L" [";
        sb += s;
        sb += L"]";
    }
 
    if (__arg_doc) {
        if (n + String::length(__arg_doc) + 1 > 80) {
            sb += L"\n";
            sb += padding;
        }
        sb += L" ";
        sb += __arg_doc;
    }
 
    return sb;
}

version()

String Arguments::version

(

)

const

Definition at line 259 of file Arguments.cpp.

{
    StringBuilder sb; // = L"Version: ";
    if (__program_version) {
        sb += __program_version;
    }
 
    return sb;
}

---

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

• Arguments.h
• Arguments.cpp