Class DArguments

Inherits from:

Object

Declared in:

DArguments.h

Class Hierarchy

    Object
      |
      +---DArguments

Class Description

The DArguments class implements methods for parsing the arguments of a program. After adding the definition of the arguments, the arguments are parsed. The results are stored in boolean objects, parsable objects and a list of texts.
Some notes:

• Default options: -?/--help (show the help text) --version (show the version) -- (stop parsing)
• The target object for switches (options without parameter) must be the class DBool (or inherite from DBool). The target objects for parameter options must comply to the protocol DParsable.
• The help format looks like the help text from the gnu tools (with column width=80)
• The parameter for an option is required; optional parameters are not supported.

  Last modified:

  12-Nov-2005 (DArguments.h)

  Instance Variables

  private DList *_options

  the options

  private int _longColumn

  the lenght of column with long options

  Method Index

  • Constructors
    

    - (DArguments *) init

    Initialise an empty argument parser

    Returns:

    the object

  • Copy related methods
    

    - deepen

    Deepen a copy of the parser (not implemented)

    Returns:

    the object

  • Destructor
    

    - free

    Free the parser

    Returns:

    the object

  • Option definition methods
    

    - (DArguments *) option :(const char *) longOption :(char) shortOption :(const char *) description :(id) target

    Add an option

    Parameters:

    longOption - the long option description (date or date=DATE)
    shortOption - the short option description (d)
    description - the help text for the option
    

    Returns:

    the object

    - (DArguments *) options :(const DArgOption *) options :(int) number

    Add an array of options

    Parameters:

    options - the array with options
    number - the number of elements in options
    

    Returns:

    the object

  • Main method
    

    - (DList *) parse :(const char *) name :(const char *) usage :(const char *) version :(const char *) tail :(char **) argv :(int) argc

    Parse the program arguments, leave the result in the target objects and the non-option list

    Parameters:

    name - the program name
    usage - the usage text (or NULL)
    version - the version text (or NULL)
    tail - the tail text (or NULL)
    argv - the arguments array
    argc - the number of elements in argv
    

    Returns:

    the (new) list with all the non-option arguments (or nil if not found)

  • Help methods
    

    - (DArguments *) printHelp :(const char *) usage :(const char *) tail

    Print the standard help on stdout

    Parameters:

    usage - the usage text
    tail - the tail text
    

    Returns:

    the object

    - (void) printOptionHelp :(char) shortOption :(int) longColumn :(const char *) longOption :(const char *) description

    Print the option help on stdout

    Parameters:

    shortOption - the short option (or EOS)
    longColumn - the length of the long column
    longOption - the long option (or NULL)
    description - the description (or NULL)
    

    Returns:

    none

    - (DArguments *) printVersion :(const char *) version

    Print the version on stdout

    Parameters:

    version - the version text
    

    Returns:

    the object

  ---

  generated 08-Jan-2006 by ObjcDoc 3.0.0