JEEP::JProperties Class Reference

Utility class to parse parameter values. More...

#include <JProperties.hh>

Inheritance diagram for JEEP::JProperties:

Classes
class	JFileReader
	Auxiliary class to handle input from file. More...

Public Types
typedef std::map< std::string, JPropertiesElement >	JMap_t

Public Member Functions
	JProperties (const int debug=0)
	Constructor. More...
	JProperties (const JEquationParameters &parameters, const int debug=0)
	Constructor. More...
template<class T >
void	put (const std::string &key, T &object)
	Put object at given key. More...
JProperties &	join (const JProperties &properties)
	Join properties objects. More...
bool	read (const JEquation &equation)
	Read equation. More...
bool	read (const std::string &buffer)
	Read from input string. More...
std::istream &	read (std::istream &in)
	Read from input stream. More...
std::istream &	read (std::istream &in, const std::string &format)
	Read from input stream according given format. More...
template<class T >
std::istream &	read (std::istream &in, T __begin, T __end)
	Read from input stream according given format. More...
std::ostream &	write (std::ostream &out) const
	Write the current parameter values. More...
std::ostream &	write (std::ostream &out, const std::string &format)
	Write to output stream according given format. More...
template<class T >
std::ostream &	write (std::ostream &out, T __begin, T __end)
	Write to output stream according given format. More...
std::string	sed (const std::string &format, const std::string &prefix="", const std::string &postfix="")
	Stream editing of input format. More...
template<class T >
const T &	getValue (const std::string &key) const
	Get value. More...
template<class T >
T &	getValue (const std::string &key)
	Get value. More...
template<class T >
void	setValue (const std::string &key, const T &value)
	Set value. More...
std::string	getString (const std::string &key) const
	Get string value. More...
std::ostream &	print (std::ostream &out) const
	Print the current parameter values. More...
const JEquationParameters &	getEquationParameters () const
	Get equation parameters. More...
void	setEquationParameters (const JEquationParameters &buffer)
	Set equation parameters. More...
const char	getDefaultSeparator () const
	Get default separator character. More...
const std::string &	getSeparator () const
	Get separator characters. More...
void	setSeparator (const std::string &sep)
	Set separator character(s). More...
const char	getDefaultEndOfLine () const
	Get default end of line character. More...
const char	getPreferredEndOfLine (const unsigned int index) const
	Get preferred end of line character. More...
const std::string &	getEndOfLine () const
	Get end of line characters. More...
void	setEndOfLine (const std::string &eol)
	Set end of line characters. More...
const char	getDefaultDivision () const
	Get default division character. More...
const std::string &	getDivision () const
	Get division characters. More...
void	setDivision (const std::string &div)
	Set division characters. More...
const char	getDefaultSkipLine () const
	Get default skip line character. More...
const std::string &	getSkipLine () const
	Get skip line characters. More...
void	setSkipLine (const std::string &skip)
	Set skip line characters. More...
void	setBrackets (const char left, const char right)
	Set brackets. More...
char	getLeftBracket () const
	Get left bracket. More...
char	getRightBracket () const
	Get right bracket. More...
const char	getDefaultWhiteSpace () const
	Get default white space character. More...
const std::string &	getWhiteSpace () const
	Get white space characters. More...
void	setWhiteSpace (const std::string &ws)
	Set white space characters. More...
JEquationParameters &	join (const JEquationParameters &value)
	Join equation parameters. More...
bool	isSeparator (const char c) const
	Test for separator character. More...
bool	isEndOfLine (const char c) const
	Test for end of line character. More...
bool	isDivision (const char c) const
	Test for division character. More...
bool	isSkipLine (const char c) const
	Test for skip line character. More...
bool	isLeftBracket (const char c) const
	Test for left bracket character. More...
bool	isRightBracket (const char c) const
	Test for right bracket character. More...
bool	isWhiteSpace (const char c) const
	Test for white space character. More...

Static Public Member Functions
static std::string	getKey (const std::string &buffer, const std::string &sep)
	Utility method to strip off all leading characters from a string until specified character(s). More...

Static Public Attributes
static int	debug

Protected Attributes
std::string	sep
std::string	eol
std::string	div
std::string	skip
char	left
char	right
std::string	ws

Friends
std::istream &	operator>> (std::istream &in, JProperties &properties)
	Stream input. More...
std::ostream &	operator<< (std::ostream &out, const JProperties &properties)
	Stream output. More...

Detailed Description

Utility class to parse parameter values.

The mapping between a parameter (of any type) and a value has to be defined in the user's program, e.g.

#include "Jeep/JProperties.hh"

ifstream in(filename.c_str());
 
JProperties zap;

int    integer_value;
double double_value;
string string_value;

zap.insert(make_property(integer_value));   // key == parameter name
zap.insert(make_property(double_value));    // key == parameter name

zap["mies"] = string_value;

zap.read(in);
zap.write(cout);

Definition at line 496 of file JProperties.hh.

Member Typedef Documentation

typedef std::map<std::string, JPropertiesElement> JEEP::JProperties::JMap_t

Definition at line 503 of file JProperties.hh.

Constructor & Destructor Documentation

JEEP::JProperties::JProperties ( const int  debug = 0 )

inline

Constructor.

Parameters

debug

debug level

Definition at line 620 of file JProperties.hh.

                                     :
      JMap_t(),
      JEquationParameters()
    {
      this->debug = debug;
    }

JEEP::JProperties::JProperties ( const JEquationParameters &  parameters, const int  debug = 0  )

inline

Constructor.

Parameters

parameters	equation parameters
debug	debug level

Definition at line 634 of file JProperties.hh.

                                     :
      JMap_t(),
      JEquationParameters(parameters)
    {
      this->debug = debug;
    }

Member Function Documentation

static std::string JEEP::JProperties::getKey ( const std::string &  buffer, const std::string &  sep  )

inlinestatic

Utility method to strip off all leading characters from a string until specified character(s).

Parameters

buffer	input string
sep	last character(s) to strip

Returns

modified string

Definition at line 515 of file JProperties.hh.

    {
      using namespace std;

      const size_type pos = buffer.find_last_of(sep);

      if (pos != string::npos)
        return buffer.substr(pos + 1);
      else
        return buffer;
    }

template<class T >

void JEEP::JProperties::put ( const std::string &  key, T &  object  )

inline

Put object at given key.

Parameters

key	key
object	object

Definition at line 650 of file JProperties.hh.

    {
      this->insert(value_type(key, JPropertiesElement(object)));
    }

JProperties& JEEP::JProperties::join ( const JProperties &  properties )

inline

Join properties objects.

Parameters

properties

properties

Definition at line 661 of file JProperties.hh.

    { 
      JEquationParameters::join(properties);

      insert(properties.begin(), properties.end());

      return *this;
    }

bool JEEP::JProperties::read ( const JEquation &  equation )

inline

Read equation.

Parameters

equation

equation

Returns

status

Definition at line 677 of file JProperties.hh.

    {
      using namespace std;

      iterator p = find(equation.getKey());
          
      DEBUG("Processing key: " << equation.getKey() << ' ' << (p != end()) << endl);
      
      if (p != end()) {
          
        istringstream is(equation.getValue());

        if        (isDivision(equation.getSeparator())) {
            
          if (p->second->is_properties()) {

            p->second->read(is);
              
          } else {
            
            ERROR("JProperties::read(): no properties object after division <" << equation.getKey() << ">" << endl);
          }
          
        } else if (isSeparator(equation.getSeparator())) {
          
          try {
            p->second->read(is);     
          }
          catch(const exception& error) {
            ERROR("JProperties::read(): read error at key <" << equation.getKey() << "> " << error.what() << endl);
          }
          
        } else {
          
          ERROR("JProperties::read(): illegal character following key <" << equation.getKey() << "> " << equation.getSeparator() << endl);
        }
        
        if (p->second.getEndMarker()) {
          return false;
        }
        
        if (fail(is)) {
          
          ERROR("JProperties::read(): error reading data for key <" << equation.getKey() << "> " << equation.getValue() << endl);
        }
        
      } else {
        
        WARNING("JProperties::read(): unknown key <" << equation.getKey() << ">" << endl);
      }

      return true;
    }

bool JEEP::JProperties::read ( const std::string &  buffer )

inline

Read from input string.

Parameters

buffer

input string

Returns

read status

Definition at line 738 of file JProperties.hh.

    { 
      std::istringstream in(buffer); 

      return !fail(read(in));
    }

std::istream& JEEP::JProperties::read ( std::istream &  in )

inline

Read from input stream.

The input format is:

   [<key><sub>]<key><sep><value><eol>
   [<key><sub>]<key><sep><value><eol>

In this, white spaces are ignored. The reading of key and value pairs is controlled by the JLANG::JEquationFacet class.

Parameters

in	input stream

Returns

input stream

Definition at line 760 of file JProperties.hh.

    {
      using namespace std;

      in.imbue(locale(in.getloc(), new JEquationFacet(*this)));

      for (JEquation equation; in >> equation && read(equation); ) {}

      return in;
    }

std::istream& JEEP::JProperties::read ( std::istream &  in, const std::string &  format  )

inline

Read from input stream according given format.

For each key in the format specification, a corresponding value will be read from the input stream.

Parameters

in	input stream
format	format

Returns

input stream

Definition at line 782 of file JProperties.hh.

    {
      using namespace std;
      
      istringstream is(format);

      vector<string> buffer;

      for (string key; is >> key; ) {
        buffer.push_back(key);
      }

      return read(in, buffer.begin(), buffer.end());
    }

template<class T >

std::istream& JEEP::JProperties::read ( std::istream &  in, T  __begin, T  __end  )

inline

Read from input stream according given format.

For each key in the format specification, a corresponding value will be read from the input stream.

Parameters

in	input stream
__begin	begin of format
__end	end of format

Returns

input stream

Definition at line 810 of file JProperties.hh.

    {
      using namespace std;
      
      for (T i = __begin; i != __end; ++i) {

        iterator p = find(*i);
          
        if (p != end()) {

          p->second->read(in);
          
        } else {
        
          WARNING("JProperties::read(): unknown key <" << *i << ">" << endl);
        }
      }

      return in;
    }

std::ostream& JEEP::JProperties::write ( std::ostream &  out ) const

inline

Write the current parameter values.

The output format is

[<key><sub>]<key><sep><value><eol> [<key><sub>]<key><sep><value><eol>

in this, white spaces are omitted.

Parameters

out	output stream

Returns

output stream

Definition at line 845 of file JProperties.hh.

    {
      using namespace std;

      for (const_iterator i = begin(); i != end(); ++i) {

        char c = ' ';

        if (i->second->is_properties()) {
          c = getDefaultDivision ();
        } else {
          c = getDefaultSeparator();
        }

        i->second->write(out, (i->first + c).c_str(), getDefaultEndOfLine());
      }

      out << flush;

      return out;
    }

std::ostream& JEEP::JProperties::write ( std::ostream &  out, const std::string &  format  )

inline

Write to output stream according given format.

For each key in the format specification, a corresponding value will be written to the output stream.

Parameters

out	output stream
format	format

Returns

output stream

Definition at line 878 of file JProperties.hh.

    {
      using namespace std;
      
      istringstream is(format);

      vector<string> buffer;

      for (string key; is >> key; ) {
        buffer.push_back(key);
      }

      return write(out, buffer.begin(), buffer.end());
    }

template<class T >

std::ostream& JEEP::JProperties::write ( std::ostream &  out, T  __begin, T  __end  )

inline

Write to output stream according given format.

For each key in the format specification, a corresponding value will be written to the output stream.

Parameters

out	output stream
__begin	begin of format
__end	end of format

Returns

output stream

Definition at line 906 of file JProperties.hh.

    {
      using namespace std;
      
      for (T i = __begin; i != __end; ++i) {

        iterator p = find(*i);
          
        if (p != end()) {

          out << getDefaultWhiteSpace();

          p->second->write(out);
          
        } else {
        
          WARNING("JProperties::write(): unknown key <" << *i << ">" << endl);
        }
      }

      return out;
    }

std::string JEEP::JProperties::sed ( const std::string &  format, const std::string &  prefix = "", const std::string &  postfix = ""  )

inline

Stream editing of input format.

For each key in the format specification, a corresponding value will be written to the output stream.

Parameters

format	format
prefix	prefix key word
postfix	postfix key word

Returns

output stream

Definition at line 941 of file JProperties.hh.

    {
      using namespace std;
      
      string buffer = format;
      
      for (iterator i = begin(); i != end(); ++i) {

        string::size_type ipos = 0;
        
        while ((ipos = buffer.find(prefix + i->first + postfix, ipos)) != string::npos) {

          ostringstream out;

          i->second->write(out);

          buffer.replace(ipos, prefix.length() + i->first.length() + postfix.length(), out.str());
        }
      }
      
      return buffer;
    }

template<class T >

const T& JEEP::JProperties::getValue ( const std::string &  key ) const

inline

Get value.

Parameters

key

key

Returns

value of this JPropertiesElement

Definition at line 974 of file JProperties.hh.

    {
      const_iterator i = find(key);

      if (i != end())
        return i->second.getValue<T>();
      else
        THROW(JPropertiesException, "Key <" << key << "> not found at JPropertiesElement::getValue()");
    }

template<class T >

T& JEEP::JProperties::getValue ( const std::string &  key )

inline

Get value.

Parameters

key

key

Returns

value of this JPropertiesElement

Definition at line 992 of file JProperties.hh.

    {
      iterator i = find(key);

      if (i != end())
        return i->second.getValue<T>();
      else
        THROW(JPropertiesException, "Key <" << key << "> not found at JPropertiesElement::getValue()");
    }

template<class T >

void JEEP::JProperties::setValue ( const std::string &  key, const T &  value  )

inline

Set value.

Parameters

key	key
value	value

Definition at line 1010 of file JProperties.hh.

    {
      iterator i = find(key);

      if (i != end())
        return i->second.setValue<T>(value);
      else
        THROW(JPropertiesException, "Key <" << key << "> not found at JPropertiesElement::setValue()");
    }

std::string JEEP::JProperties::getString ( const std::string &  key ) const

inline

Get string value.

Parameters

key

key

Returns

value

Definition at line 1027 of file JProperties.hh.

    {
      const_iterator i = find(key);

      if (i != end())
        return i->second.toString();
      else
        THROW(JPropertiesException, "Key <" << key << "> not found at JPropertiesElement::getString()");
    }

std::ostream& JEEP::JProperties::print ( std::ostream &  out ) const

inline

Print the current parameter values.

Parameters

out	output stream

Returns

output stream

Definition at line 1044 of file JProperties.hh.

    {
      write(out);

      return out;
    }

const JEquationParameters& JLANG::JEquationParameters::getEquationParameters ( ) const

inlineinherited

Get equation parameters.

Returns

equation parameters

Definition at line 71 of file JEquationParameters.hh.

    {
      return *this;
    }

void JLANG::JEquationParameters::setEquationParameters ( const JEquationParameters &  buffer )

inlineinherited

Set equation parameters.

Parameters

buffer

equation parameters

Definition at line 82 of file JEquationParameters.hh.

    {
      static_cast<JEquationParameters&>(*this) = buffer;
    }

const char JLANG::JEquationParameters::getDefaultSeparator ( ) const

inlineinherited

Get default separator character.

Returns

separator between parameter and its value

Definition at line 93 of file JEquationParameters.hh.

    { 
      if (sep.empty())
        return '=';
      else
        return sep[0];
    }

const std::string& JLANG::JEquationParameters::getSeparator ( ) const

inlineinherited

Get separator characters.

Returns

separator between parameter and its value

Definition at line 107 of file JEquationParameters.hh.

    { 
      return sep;
    }

void JLANG::JEquationParameters::setSeparator ( const std::string &  sep )

inlineinherited

Set separator character(s).

Parameters

sep	separator between parameter and its value

Definition at line 118 of file JEquationParameters.hh.

    { 
      this->sep = sep; 
    }

const char JLANG::JEquationParameters::getDefaultEndOfLine ( ) const

inlineinherited

Get default end of line character.

Returns

end of line character

Definition at line 129 of file JEquationParameters.hh.

    { 
      if (eol.empty())
        return '\n';
      else
        return eol[0];
    }

const char JLANG::JEquationParameters::getPreferredEndOfLine ( const unsigned int  index ) const

inlineinherited

Get preferred end of line character.

Parameters

index

index

Returns

end of line character

Definition at line 144 of file JEquationParameters.hh.

    { 
      if      (eol.empty())
        return '\n';
      else if (index < eol.size())
        return eol[index];
      else
        return eol[0];
    }

const std::string& JLANG::JEquationParameters::getEndOfLine ( ) const

inlineinherited

Get end of line characters.

Returns

end of line characters

Definition at line 160 of file JEquationParameters.hh.

    { 
      return eol;
    }

void JLANG::JEquationParameters::setEndOfLine ( const std::string &  eol )

inlineinherited

Set end of line characters.

Parameters

eol	end of line character

Definition at line 171 of file JEquationParameters.hh.

    { 
      this->eol = eol;
    }

const char JLANG::JEquationParameters::getDefaultDivision ( ) const

inlineinherited

Get default division character.

Returns

division character

Definition at line 182 of file JEquationParameters.hh.

    { 
      if (div.empty())
        return '.';
      else
        return div[0];
    }

const std::string& JLANG::JEquationParameters::getDivision ( ) const

inlineinherited

Get division characters.

Returns

division characters

Definition at line 196 of file JEquationParameters.hh.

    { 
      return div;
    }

void JLANG::JEquationParameters::setDivision ( const std::string &  div )

inlineinherited

Set division characters.

Parameters

div	division characters

Definition at line 207 of file JEquationParameters.hh.

    { 
      this->div = div;
    }

const char JLANG::JEquationParameters::getDefaultSkipLine ( ) const

inlineinherited

Get default skip line character.

Returns

skip line character

Definition at line 218 of file JEquationParameters.hh.

    { 
      if (skip.empty())
        return '#';
      else
        return skip[0];
    }

const std::string& JLANG::JEquationParameters::getSkipLine ( ) const

inlineinherited

Get skip line characters.

Returns

skip line characters

Definition at line 232 of file JEquationParameters.hh.

    { 
      return skip;
    }

void JLANG::JEquationParameters::setSkipLine ( const std::string &  skip )

inlineinherited

Set skip line characters.

Parameters

skip	skip line characters

Definition at line 243 of file JEquationParameters.hh.

    { 
      this->skip = skip;
    }

void JLANG::JEquationParameters::setBrackets ( const char  left, const char  right  )

inlineinherited

Set brackets.

Parameters

left	left bracket
right	right bracket

Definition at line 255 of file JEquationParameters.hh.

    {
      this->left  = left;
      this->right = right;
    }

char JLANG::JEquationParameters::getLeftBracket ( ) const

inlineinherited

Get left bracket.

Returns

left bracket

Definition at line 267 of file JEquationParameters.hh.

    {
      return left;
    }

char JLANG::JEquationParameters::getRightBracket ( ) const

inlineinherited

Get right bracket.

Returns

right bracket

Definition at line 278 of file JEquationParameters.hh.

    {
      return right;
    }

const char JLANG::JEquationParameters::getDefaultWhiteSpace ( ) const

inlineinherited

Get default white space character.

Returns

white space character

Definition at line 289 of file JEquationParameters.hh.

    { 
      if (ws.empty())
        return ' ';
      else
        return ws[0];
    }

const std::string& JLANG::JEquationParameters::getWhiteSpace ( ) const

inlineinherited

Get white space characters.

Returns

white space characters

Definition at line 303 of file JEquationParameters.hh.

    { 
      return ws;
    }

void JLANG::JEquationParameters::setWhiteSpace ( const std::string &  ws )

inlineinherited

Set white space characters.

Parameters

ws	white space characters

Definition at line 314 of file JEquationParameters.hh.

    { 
      this->ws = ws;
    }

JEquationParameters& JLANG::JEquationParameters::join ( const JEquationParameters &  value )

inlineinherited

Join equation parameters.

Parameters

value

equation parameters

Definition at line 325 of file JEquationParameters.hh.

    { 
      using namespace std;

      for (string::const_iterator i = value.sep.begin(); i != value.sep.end(); ++i) {
        if (!isSeparator(*i)) {
          sep += *i;
        }
      }

      for (string::const_iterator i = value.eol.begin(); i != value.eol.end(); ++i) {
        if (!isEndOfLine(*i)) {
          eol += *i;
        }
      }

      for (string::const_iterator i = value.div.begin(); i != value.div.end(); ++i) {
        if (!isDivision(*i)) {
          div += *i;
        }
      }

      for (string::const_iterator i = value.skip.begin(); i != value.skip.end(); ++i) {
        if (!isSkipLine(*i)) {
          skip += *i;
        }
      }

      for (string::const_iterator i = value.ws.begin(); i != value.ws.end(); ++i) {
        if (!isWhiteSpace(*i)) {
          ws += *i;
        }
      }

      return *this;
    }

bool JLANG::JEquationParameters::isSeparator ( const char  c ) const

inlineinherited

Test for separator character.

Parameters

c

character

Returns

true if separator; else false

Definition at line 369 of file JEquationParameters.hh.

    { 
      return sep .find(c) != std::string::npos;
    }

bool JLANG::JEquationParameters::isEndOfLine ( const char  c ) const

inlineinherited

Test for end of line character.

Parameters

c

character

Returns

true if end of line; else false

Definition at line 381 of file JEquationParameters.hh.

{ return eol .find(c) != std::string::npos; }

bool JLANG::JEquationParameters::isDivision ( const char  c ) const

inlineinherited

Test for division character.

Parameters

c

character

Returns

true if division; else false

Definition at line 390 of file JEquationParameters.hh.

    { 
      return div .find(c) != std::string::npos;
    }

bool JLANG::JEquationParameters::isSkipLine ( const char  c ) const

inlineinherited

Test for skip line character.

Parameters

c

character

Returns

true if skip line; else false

Definition at line 402 of file JEquationParameters.hh.

    { 
      return skip.find(c) != std::string::npos;
    }

bool JLANG::JEquationParameters::isLeftBracket ( const char  c ) const

inlineinherited

Test for left bracket character.

Parameters

c

character

Returns

true if left bracket; else false

Definition at line 414 of file JEquationParameters.hh.

    { 
      return c == left;
    }

bool JLANG::JEquationParameters::isRightBracket ( const char  c ) const

inlineinherited

Test for right bracket character.

Parameters

c

character

Returns

true if right bracket; else false

Definition at line 426 of file JEquationParameters.hh.

    { 
      return c == right;
    }

bool JLANG::JEquationParameters::isWhiteSpace ( const char  c ) const

inlineinherited

Test for white space character.

Parameters

c

character

Returns

true if white space; else false

Definition at line 438 of file JEquationParameters.hh.

    { 
      return ws  .find(c) != std::string::npos;
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JProperties &  properties  )

friend

Stream input.

Parameters

in	input stream
properties	properties

Returns

input stream

Definition at line 1059 of file JProperties.hh.

    {
      return properties.read(in); 
    }

std::ostream& operator<< ( std::ostream &  out, const JProperties &  properties  )

friend

Stream output.

Parameters

out	output stream
properties	properties

Returns

output stream

Definition at line 1072 of file JProperties.hh.

    { 
      return properties.write(out); 
    }

Member Data Documentation

std::string JLANG::JEquationParameters::sep

protectedinherited

Definition at line 444 of file JEquationParameters.hh.

std::string JLANG::JEquationParameters::eol

protectedinherited

Definition at line 445 of file JEquationParameters.hh.

std::string JLANG::JEquationParameters::div

protectedinherited

Definition at line 446 of file JEquationParameters.hh.

std::string JLANG::JEquationParameters::skip

protectedinherited

Definition at line 447 of file JEquationParameters.hh.

char JLANG::JEquationParameters::left

protectedinherited

Definition at line 448 of file JEquationParameters.hh.

char JLANG::JEquationParameters::right

protectedinherited

Definition at line 449 of file JEquationParameters.hh.

std::string JLANG::JEquationParameters::ws

protectedinherited

Definition at line 450 of file JEquationParameters.hh.

int JEEP::JMessage< JProperties >::debug

staticinherited

debug level (default is off).

Definition at line 45 of file JMessage.hh.

---

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

• JProperties.hh