HGL::Common::PoptTableBuilder Class Reference
[Utility classes]

Builds a POPT table structure. More...

#include <popttablebuilder.h>

List of all members.

Public Member Functions

void addEntry (const std::string &name, struct::poptOption *opt)
 Adds an entry to the last added subtable.
void addSubtable (const std::string &desc)
 Adds a subtable (group) containing further POPT tables.
struct::poptOption & getPoptTable ()
 Builds a reference to a POPT option table to include.

Static Public Member Functions

static bool isTableEntry (const struct::poptOption &opt)
 Checks if a given POPT option is POPT_ARG_INCLUDE_TABLE and its arg is NULL.

Detailed Description

Builds a POPT table structure.

This class builds a POPT table structure for dynamic inclusion of POPT command line arguments.

Author:
Heiko Schäfer <heiko@hgl.rangun.de>
Since:
0.5.15

Member Function Documentation

void PoptTableBuilder::addEntry ( const std::string &  name,
struct::poptOption *  opt 
)

Adds an entry to the last added subtable.

Parameters:
name for the POPT option table
opt POPT option structure array
Since:
0.5.15
void PoptTableBuilder::addSubtable ( const std::string &  desc  ) 

Adds a subtable (group) containing further POPT tables.

Parameters:
desc a description for the group
Since:
0.5.15
struct::poptOption & PoptTableBuilder::getPoptTable (  ) 

Builds a reference to a POPT option table to include.

Precondition:
A table built by calls to addSubTable and addEntry
Returns:
a reference to a POPT option table to include
Since:
0.5.15
bool PoptTableBuilder::isTableEntry ( const struct::poptOption &  opt  )  [static]

Checks if a given POPT option is POPT_ARG_INCLUDE_TABLE and its arg is NULL.

Parameters:
opt a POPT option
Returns:
true if the given POPT option is POPT_ARG_INCLUDE_TABLE and its arg is NULL, false otherwise
Since:
0.5.15

Generated on 9 Apr 2014 for hgl 0.5.26~svn by  doxygen 1.6.1