JLANG::JString Class Reference

Wrapper class around STL string class. More...

#include <JString.hh>

Inheritance diagram for JLANG::JString:

Public Member Functions
	JString ()
	Default constructor.
	JString (const std::string &buffer)
	Constructor.
	JString (const char c)
	Constructor.
	JString (const char *buffer, const std::string::size_type length)
	Constructor.
template<class T >
	JString (const T &value)
	Constructor.
template<class ... Args>
	JString (const char *format, const Args &...args)
	Constructor.
	JString (const JString &buffer, const JStringFacet &facet)
	Constructor.
JString &	compile (const JStringFacet &facet)
	Compile token with given facet.
bool	startsWith (const std::string &prefix) const
	Test if this string starts with the specified prefix.
bool	endsWith (const std::string &suffix) const
	Test if this string ends with the specified suffix.
JString &	replace (const char target, const char replacement, const std::size_t max=std::numeric_limits< std::size_t >::max())
	Replace characters.
JString &	replace (const std::string &target, const std::string &replacement, const std::size_t max=std::numeric_limits< std::size_t >::max())
	Replace character sequences.
template<class T >
JString &	replace (const std::string &target, const T &value, const std::size_t max=std::numeric_limits< std::size_t >::max())
	Replace character sequence.
JString &	trim ()
	Trim string.
JString &	trim (const char c)
	Trim string.
JString	trim (const std::string &target)
	Trim string.
JString &	toUpper ()
	Convert all character to upper case.
JString &	toLower ()
	Convert all character to lower case.
template<class T >
JString &	assign (T &output)
	Assign (part of) string to value.

Static Public Member Functions
static JString	valueOf (const int input)
	Convert enumeration type to string.
template<class T >
static JString	valueOf (const T &input)
	Convert value to string.
template<class T >
static const T &	toValue (const JString &input)
	Convert string to value.

Private Member Functions
template<class T , class ... Args>
void	__set__ (const T &value, const Args &...args)
	Recursive method for formatting string.
void	__set__ () const
	Termination method for formatting string.

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

Detailed Description

Wrapper class around STL string class.

Definition at line 27 of file JString.hh.

Constructor & Destructor Documentation

JString() [1/7]

JLANG::JString::JString ( )

inline

Default constructor.

Definition at line 39 of file JString.hh.

              :
      std::string()
    {}

JString() [2/7]

JLANG::JString::JString ( const std::string & buffer )

inlineexplicit

Constructor.

Parameters

buffer

string

Definition at line 49 of file JString.hh.

                                              :
      std::string(buffer)
    {}

JString() [3/7]

JLANG::JString::JString ( const char c )

inlineexplicit

Constructor.

Parameters

c

char

Definition at line 59 of file JString.hh.

                                  :
      std::string(1,c)
    {}

JString() [4/7]

JLANG::JString::JString ( const char * buffer, const std::string::size_type length )

inlineexplicit

Constructor.

Parameters

buffer	string
length	length

Definition at line 70 of file JString.hh.

                                                                          :
      std::string(buffer, length)
    {}

JString() [5/7]

template<class T >

JLANG::JString::JString ( const T & value )

inline

Constructor.

Parameters

value

value

Definition at line 81 of file JString.hh.

                            :
      std::string(valueOf(value))
    {}

JString() [6/7]

template<class ... Args>

JLANG::JString::JString ( const char * format, const Args &... args )

inline

Constructor.

Each '' in the format string will be replaced by the corresponding argument.

Parameters

format	format
args	values

Definition at line 94 of file JString.hh.

                                                     :
      std::string(format)
    {
      __set__(args...);
    }

JString() [7/7]

JLANG::JString::JString ( const JString & buffer, const JStringFacet & facet )

inline

Constructor.

This constructor compiles (see below) the input string.

Parameters

buffer	input string
facet	facet

Definition at line 108 of file JString.hh.

                                                              :
      std::string(buffer)
    {
      compile(facet);
    }

Member Function Documentation

compile()

JString & JLANG::JString::compile ( const JStringFacet & facet )

inline

Compile token with given facet.

This method uses the given facet to parse the input string. The result is then compatible with the definition of a token and may be empty.

Parameters

facet

facet

Returns

this string

Definition at line 123 of file JString.hh.

    {
      using namespace std;
 
      istringstream is(*this);
 
      ios_base::iostate state;
 
      facet.get(is, istreambuf_iterator<char>(), is, state, *this);
 
      return *this;
    }

startsWith()

bool JLANG::JString::startsWith ( const std::string & prefix ) const

inline

Test if this string starts with the specified prefix.

Parameters

prefix

prefix

Returns

true if this string starts with prefix; else false

Definition at line 144 of file JString.hh.

    {                                           
      return this->size() >= prefix.size() && this->substr(0, prefix.size()) == prefix;
    }

endsWith()

bool JLANG::JString::endsWith ( const std::string & suffix ) const

inline

Test if this string ends with the specified suffix.

Parameters

suffix

suffix

Returns

true if this string ends with suffix; else false

Definition at line 156 of file JString.hh.

    {                                           
      return this->size() >= suffix.size() && this->substr(this->size() - suffix.size()) == suffix;
    }

replace() [1/3]

JString & JLANG::JString::replace ( const char target, const char replacement, const std::size_t max = std::numeric_limits<std::size_t>::max() )

inline

Replace characters.

Parameters

target	target character
replacement	replacement character
max	maximum number of replacements

Returns

this string

Definition at line 170 of file JString.hh.

    {
      for (std::size_t i = this->find(target), n = max; i != std::string::npos && n != 0; i = find(target,i), --n) {
        (*this)[i] = replacement;
      }
      
      return *this;
    }

replace() [2/3]

JString & JLANG::JString::replace ( const std::string & target, const std::string & replacement, const std::size_t max = std::numeric_limits<std::size_t>::max() )

inline

Replace character sequences.

Parameters

target	target string
replacement	replacement string
max	maximum number of replacements

Returns

this string

Definition at line 190 of file JString.hh.

    {
      for (std::size_t i = this->find(target), n = max; i != std::string::npos && n != 0; i = this->find(target,i), --n) {
        replace(this->begin() + i, this->begin() + i + target.length(), replacement);
      }
      
      return *this;
    }

replace() [3/3]

template<class T >

JString & JLANG::JString::replace ( const std::string & target, const T & value, const std::size_t max = std::numeric_limits<std::size_t>::max() )

inline

Replace character sequence.

Parameters

target	target string
value	value
max	maximum number of replacements

Returns

this string

Definition at line 211 of file JString.hh.

    {
      for (std::size_t i = this->find(target), n = max; i != std::string::npos && n != 0; i = this->find(target,i), --n) {
        replace(this->begin() + i, this->begin() + i + target.length(), JString(value));
      }
      
      return *this;
    }

trim() [1/3]

JString & JLANG::JString::trim ( )

inline

Trim string.

Returns the modified string, with leading and trailing white spaces omitted.

Returns

this string

Definition at line 229 of file JString.hh.

    {
      *this = JLANG::trim(*this);
 
      return *this;
    }

trim() [2/3]

JString & JLANG::JString::trim ( const char c )

inline

Trim string.

Returns the modified string, with leading and trailing target characters omitted.

Parameters

c	strip character

Returns

this string

Definition at line 244 of file JString.hh.

    {
      *this = JLANG::trim(*this, c);
 
      return *this;
    }

trim() [3/3]

JString JLANG::JString::trim ( const std::string & target )

inline

Trim string.

Returns the modified string, with leading and trailing target characters omitted.

Parameters

target

character(s) to strip

Returns

this string

Definition at line 259 of file JString.hh.

    {
      *this = JLANG::trim(*this, target);
 
      return *this;
    }

toUpper()

JString & JLANG::JString::toUpper ( )

inline

Convert all character to upper case.

Returns

this string

Definition at line 272 of file JString.hh.

    {
      for (iterator i = begin(); i != end(); ++i) {
        *i = toupper(*i);
      }
 
      return *this;
    }

toLower()

JString & JLANG::JString::toLower ( )

inline

Convert all character to lower case.

Returns

this string

Definition at line 287 of file JString.hh.

    {
      for (iterator i = begin(); i != end(); ++i) {
        *i = tolower(*i);
      }
 
      return *this;
    }

valueOf() [1/2]

static JString JLANG::JString::valueOf ( const int input )

inlinestatic

Convert enumeration type to string.

Parameters

input

value

Returns

string

Definition at line 303 of file JString.hh.

    {
      std::ostringstream os;
 
      if (os << input)
        return JString(os.str());
      else
        THROW(JException, "JString::valueOf()");
    }

valueOf() [2/2]

template<class T >

static JString JLANG::JString::valueOf ( const T & input )

inlinestatic

Convert value to string.

Parameters

input

value

Returns

string

Definition at line 321 of file JString.hh.

    {
      std::ostringstream os;
 
      if (os << input)
        return JString(os.str());
      else
        THROW(JException, "JString::valueOf()");
    }

toValue()

template<class T >

static const T & JLANG::JString::toValue ( const JString & input )

inlinestatic

Convert string to value.

Parameters

input

string

Returns

value

Definition at line 339 of file JString.hh.

    {
      static T value;
 
      std::istringstream is(input);
 
      if (is >> value)
        return value;
      else
        THROW(JException, "JString::toValue<T>()");
    }

assign()

template<class T >

JString & JLANG::JString::assign ( T & output )

inline

Assign (part of) string to value.

Parameters

output

value

Returns

remaining string

Definition at line 359 of file JString.hh.

    {
      using namespace std;
 
      istringstream is(*this);
 
      is >> output;
 
      if (!is) {
        THROW(JException, "JString::assign()");
      }
 
      this->assign(istreambuf_iterator<char>(is),
                   istreambuf_iterator<char>());
 
      return *this;
    }

__set__() [1/2]

template<class T , class ... Args>

void JLANG::JString::__set__ ( const T & value, const Args &... args )

inlineprivate

Recursive method for formatting string.

Parameters

value	next value
args	remaining values

Definition at line 448 of file JString.hh.

    {
      using namespace std;
 
      const size_t pos = this->find('%');
 
      if (pos != string::npos) {
 
        replace(pos, 1, JString::valueOf(value));
 
        __set__(args...);
      }
    }

__set__() [2/2]

void JLANG::JString::__set__ ( ) const

inlineprivate

Termination method for formatting string.

Definition at line 466 of file JString.hh.

    {}

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JString & object )

friend

Read string from input stream.

Parameters

in	input stream
object	string

Returns

input stream

Definition at line 385 of file JString.hh.

    {
      using namespace std;
 
      istream::sentry sentry(in);   // skips white spaces
 
      if (sentry) {
 
        const locale& loc = in.getloc();
 
        if (has_facet<JStringFacet>(loc)) {
 
          ios_base::iostate state;
 
          use_facet<JStringFacet>(loc).get(in, istreambuf_iterator<char>(), in, state, object);
 
          if (state != ios_base::goodbit && state != ios_base::eofbit) {
            in.setstate(state);
          }
 
        } else {
 
          in >> static_cast<string&>(object);
        }
      }
 
      return in;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JString & object )

friend

Write string to output stream.

Parameters

out	output stream
object	string

Returns

output stream

Definition at line 422 of file JString.hh.

    {
      using namespace std;
 
      const locale& loc = out.getloc();
 
      if (has_facet<JStringFacet>(loc)) {
 
        use_facet<JStringFacet>(loc).put(out, out, out.fill(), object);
 
      } else {
 
        out << static_cast<const string&>(object);
      }
 
      return out;
    }

---

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

• JString.hh