JLANG::JEquation Class Reference

General purpose equation class. More...

#include <JEquation.hh>

Inheritance diagram for JLANG::JEquation:

Classes
struct	equation_type
	Auxiliary data structure for equation. More...

Public Member Functions
	JEquation ()
	Default constructor.
	JEquation (const std::string &key, const std::string &value)
	Constructor.
	JEquation (const std::string &buffer, const JEquationFacet &facet)
	Constructor.
const std::string &	getKey () const
	Get key.
const char	getSeparator () const
	Get separator.
const std::string &	getValue () const
	Get value.
JEquation &	setEquation (const std::string &buffer, const JEquationFacet &facet)
	Set equation.
JEquation &	setEquation (const JEquationFacet &facet)
	Set this equation to its value.
std::string	toString () const
	Convert equation to string.

Static Public Member Functions
template<class T >
static equation_type< T >	make_equation (const std::string &key, const T &value)
	Auxiliary method to create equation type.
static JEquation	valueOf (const std::string &buffer, const JEquationFacet &facet)
	Extract equation.

Protected Attributes
JString	key
char	sep
JString	value

Friends
std::istream &	operator>> (std::istream &in, JEquation &equation)
	Read equation from input stream.
std::ostream &	operator<< (std::ostream &out, const JEquation &equation)
	Write equation to output stream.

Detailed Description

General purpose equation class.

An equation could have the following formats:

      <skip line>  "comment"  <end of line>
      <skip line>  "comment"  <end of line>
      <key> <separator> <value> <comment> "comment" <end of line>
      <key> <separator> <left bracket> <value> <value> <right bracket> <end of line>
      <key><division><key> <separator> <value> <end of line>

In this:

• lines starting with one of the skip line characters are ignored;
• key is the key of the equation;
• value is the value of the equation;
• comment marks the start of an inline comment (which is not part of the value); and
• ' ' could be any of the specified white space characters. In case of a division of the key, the value of the equation will include the following key up to the end of line. The special characters are defined in the JEquationParameters class. The use of this class for I/O is handled via the JEquationFacet class.

Definition at line 47 of file JEquation.hh.

Constructor & Destructor Documentation

JEquation() [1/3]

JLANG::JEquation::JEquation ( )

inline

Default constructor.

Definition at line 126 of file JEquation.hh.

                :
      key  (),
      sep  ('\0'),
      value()
    {}

JEquation() [2/3]

JLANG::JEquation::JEquation ( const std::string & key, const std::string & value )

inline

Constructor.

Parameters

key	key
value	value

Definition at line 139 of file JEquation.hh.

                                                            :
      key  (key),
      sep  ('\0'),
      value(value)
    {}

JEquation() [3/3]

JLANG::JEquation::JEquation ( const std::string & buffer, const JEquationFacet & facet )

inline

Constructor.

Parameters

buffer	input
facet	facet

Definition at line 152 of file JEquation.hh.

    {
      setEquation(buffer, facet);
    }

Member Function Documentation

make_equation()

template<class T >

static equation_type< T > JLANG::JEquation::make_equation ( const std::string & key, const T & value )

inlinestatic

Auxiliary method to create equation type.

Parameters

key	key
value	value

Definition at line 117 of file JEquation.hh.

    {
      return equation_type<T>(key, value);
    }

getKey()

const std::string & JLANG::JEquation::getKey ( ) const

inline

Get key.

Returns

key

Definition at line 163 of file JEquation.hh.

    {
      return key;
    }

getSeparator()

const char JLANG::JEquation::getSeparator ( ) const

inline

Get separator.

Returns

separator

Definition at line 174 of file JEquation.hh.

    {
      return sep;
    }

getValue()

const std::string & JLANG::JEquation::getValue ( ) const

inline

Get value.

Returns

value

Definition at line 185 of file JEquation.hh.

    {
      return value;
    }

setEquation() [1/2]

JEquation & JLANG::JEquation::setEquation ( const std::string & buffer, const JEquationFacet & facet )

inline

Set equation.

Parameters

buffer	input
facet	facet

Returns

this equation

Definition at line 320 of file JEquation.hh.

    {
      using namespace std;
 
      istringstream in(buffer);
 
      in.imbue(locale(in.getloc(), facet.clone()));
 
      in >> *this;
 
      return *this;
    }

setEquation() [2/2]

JEquation & JLANG::JEquation::setEquation ( const JEquationFacet & facet )

inline

Set this equation to its value.

Parameters

facet

facet

Returns

this equation

Definition at line 340 of file JEquation.hh.

    {
      setEquation(getValue(), facet);
 
      return *this;
    }

valueOf()

static JEquation JLANG::JEquation::valueOf ( const std::string & buffer, const JEquationFacet & facet )

inlinestatic

Extract equation.

Parameters

buffer	input
facet	facet

Returns

equation

Definition at line 355 of file JEquation.hh.

    {
      return JEquation(buffer, facet);
    }

toString()

std::string JLANG::JEquation::toString ( ) const

inline

Convert equation to string.

Returns

string

Definition at line 366 of file JEquation.hh.

    {
      std::string buffer;
 
      buffer += getKey();
      buffer += getSeparator();
      buffer += getValue();
 
      return buffer;
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JEquation & equation )

friend

Read equation from input stream.

Parameters

in	input stream
equation	equation

Returns

input stream

Definition at line 198 of file JEquation.hh.

    {
      using namespace std;
 
      istream::sentry sentry(in, false);
 
      if (sentry) {
 
        equation = JEquation();
 
        const locale& loc = in.getloc();
 
        if (has_facet<JEquationFacet>(loc)) {
 
          const JEquationFacet& facet = use_facet<JEquationFacet>(loc);
 
          ios_base::iostate state = in.rdstate();
 
 
          for (int c; (c = in.peek()) != EOF && facet.isSkipLine((char) c); ) {
            facet.ignore(in);
          }
 
 
          if (state == ios_base::goodbit) facet.get(in, istreambuf_iterator<char>(), in, state, equation.key);
          if (state == ios_base::goodbit) facet.get(in, istreambuf_iterator<char>(), in, state, equation.sep);
          if (state == ios_base::goodbit) facet.getline(in, equation.value);
 
 
          // remove white spaces and brackets before evaluation
 
          if (facet.isSeparator(equation.sep)) {
 
            JString::const_iterator         p = equation.value. begin();
            JString::const_reverse_iterator q = equation.value.rbegin();
 
            for ( ; ; ++p, ++q) {
 
              for ( ; p != equation.value. end() && facet.isWhiteSpace(*p); ++p) {}
              for ( ; q != equation.value.rend() && facet.isWhiteSpace(*q); ++q) {}
            
              if (p == equation.value. end() || *p != facet.getLeftBracket() ||
                  q == equation.value.rend() || *q != facet.getRightBracket()) {
                break;
              }
            }
 
            if (p != equation.value.begin() || q != equation.value.rbegin()) {
              equation.value = string(p, q.base());
            }
          }
 
          if (state != ios_base::goodbit && state != ios_base::eofbit) {
            in.setstate(state);
          }
 
          if (!(state & ios_base::eofbit)) {
            if (!facet.isDivision (equation.sep) &&
                !facet.isSeparator(equation.sep)) {
              in.setstate(ios_base::badbit);
            }
          }
 
        } else {
 
          in.setstate(ios_base::failbit);
        }
      }
 
      return in;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JEquation & equation )

friend

Write equation to output stream.

Parameters

out	output stream
equation	equation

Returns

output stream

Definition at line 278 of file JEquation.hh.

    {
      using namespace std;
 
      ostream::sentry sentry(out);
 
      if (sentry) {
 
        const locale& loc = out.getloc();
 
        if (has_facet<JEquationFacet>(loc)) {
 
          const JEquationFacet& facet = use_facet<JEquationFacet>(loc);
 
          // conform with as many as possible equation parsers.
 
          out << equation.key;
          out << facet.getDefaultSeparator();
          out << facet.getDefaultWhiteSpace();
          out << equation.value;
          out << facet.getDefaultEndOfLine();
 
        } else {
 
          out << equation.key;
          out << equation.sep;
          out << equation.value;
          out << endl;
        }
      }
 
      return out;
    }

Member Data Documentation

key

JString JLANG::JEquation::key

protected

Definition at line 378 of file JEquation.hh.

sep

char JLANG::JEquation::sep

protected

Definition at line 379 of file JEquation.hh.

value

JString JLANG::JEquation::value

protected

Definition at line 380 of file JEquation.hh.

---

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

• JEquation.hh