src/tools/tString.h File Reference

#include "aa_config.h"
#include "defs.h"
#include <string>
#include <sstream>
#include <iostream>
#include <iosfwd>

Include dependency graph for tString.h:

Go to the source code of this file.

Classes
class	tString
	string class: standard string with some extras More...
struct	tColoredStringProxy
	proxy class for inserting color markings More...
class	tColoredString
	strings that know about color markings More...
Defines
#define	WRAP_MUTATING_OPERATOR(op, T)   inline THISCLASS & operator op( T t ){ static_cast< BASE & >( *this ) op t; return *this; }
	wraps a mutating operator (+=, -=, *=). op is the operator and T the argument type.
#define	WRAP_MUTATING_OPERATOR_ALLTYPES(op)   template< class T > WRAP_MUTATING_OPERATOR(op, T const &)
	wraps a mutating operator (+=, -=, *=) for all argument types. op is the operator.
#define	WRAP_OPERATOR(op, T)   inline THISCLASS operator op( T t ) const { return THISCLASS( static_cast< const BASE & >( *this ) op t ); }
	wraps a non-mutating binary operator (+, -, *). op is the operator and T the second argument.
#define	WRAP_OPERATOR_ALLTYPES(op)   template< class T > WRAP_OPERATOR(op, T const &)
	wraps a non-mutating binary operator (+, -, *) for second arguments. op is the operator.
Functions
bool	tIsInList (tString const &list, tString const &item)
	check whether item is in a comma or whitespace separated list
void	tToLower (tString &toTransform)
	converts a string to lowercase
void	tToUpper (tString &toTransform)
	converts a string to uppercase
template<class T>
tString &	operator<< (tString &s, const T &c)
	string building streaming operator
tColoredString &	operator<< (tColoredString &s, const tColoredStringProxy &colorCode)
	string building streaming operator
template<class T>
tColoredString &	operator<< (tColoredString &s, const T &c)
	string building streaming operator
std::istream &	operator>> (std::istream &s, tString &x)
	stream reading operator honoring escape sequences and quoting

---

Define Documentation

#define WRAP_MUTATING_OPERATOR	(	op,
		T		)	inline THISCLASS & operator op( T t ){ static_cast< BASE & >( *this ) op t; return *this; }

wraps a mutating operator (+=, -=, *=). op is the operator and T the argument type.

Definition at line 46 of file tString.h.

#define WRAP_MUTATING_OPERATOR_ALLTYPES

(

op

)

template< class T > WRAP_MUTATING_OPERATOR(op, T const &)

wraps a mutating operator (+=, -=, *=) for all argument types. op is the operator.

Definition at line 48 of file tString.h.

#define WRAP_OPERATOR	(	op,
		T		)	inline THISCLASS operator op( T t ) const { return THISCLASS( static_cast< const BASE & >( *this ) op t ); }

wraps a non-mutating binary operator (+, -, *). op is the operator and T the second argument.

Definition at line 51 of file tString.h.

#define WRAP_OPERATOR_ALLTYPES

(

op

)

template< class T > WRAP_OPERATOR(op, T const &)

wraps a non-mutating binary operator (+, -, *) for second arguments. op is the operator.

Definition at line 53 of file tString.h.

---

Function Documentation

template<class T>

tColoredString& operator<<	(	tColoredString &	s,
		const T &	c
	)			[inline]

string building streaming operator

Definition at line 248 of file tString.h.

References tColoredString::RemoveTrailingColor().

{
    // delegate to basic string function...
    static_cast< tString& >( s ) << c;

    // but don't allow overhanging color codes
    s.RemoveTrailingColor();

    return s;
}

Here is the call graph for this function:

tColoredString& operator<<	(	tColoredString &	s,
		const tColoredStringProxy &	colorCode
	)

string building streaming operator

Appends a color code to a colored string

Parameters:

	s	the string to append to
	colorCode	the colorcode to append

Definition at line 1694 of file tString.cpp.

References tColoredStringProxy::b_, cs, tColoredStringProxy::g_, int_to_hex(), tColoredStringProxy::r_, and RTC().

{
    if (st_colorStrings)
    {
        char cs[9];
        cs[0]='0';
        cs[1]='x';

        int RGB[3];
        RGB[0]=RTC(colorCode.r_);
        RGB[1]=RTC(colorCode.g_);
        RGB[2]=RTC(colorCode.b_);

        for(int i=0;i<3;i++){
            int lp=RGB[i]%16;
            int hp=(RGB[i]-lp)/16;
            cs[2+2*i]=int_to_hex(hp);
            cs[2+2*i+1]=int_to_hex(lp);
        }
        cs[8]=0;

        s << cs;
    }

    return s;
}

Here is the call graph for this function:

template<class T>

tString& operator<<	(	tString &	s,
		const T &	c
	)			[inline]

string building streaming operator

Definition at line 235 of file tString.h.

{
    std::ostringstream S;

    S << c;

    return s += S.str();
}

std::istream& operator>>	(	std::istream &	s,
		tString &	x
	)

stream reading operator honoring escape sequences and quoting

Todo:

write symmetric stream writing operator

Parameters:

	s	stream to read from
	x	string to read to

Returns:

reference to stream for chaining

Definition at line 111 of file tString.cpp.

References c, tString::Clear(), isblank(), and st_ReadEscapeSequence().

{
    x.Clear();

    std::ws(s);

    char c=s.get();

    // check if the string is quoted
    bool quoted = false;
    char quoteChar = c;   // if it applies, this is the quoting character
    if ( c == '"' || c == '\'' )
    {
        // yes, it is
        quoted = true;
        c = s.get();
    }

    while((quoted || !( isblank(c) || c == '\n' || c == '\r' ) ) && s.good() && !s.eof()){
        x += c;
        c=s.get();

        // read and interpret escape sequences
        if ( !st_ReadEscapeSequence( c, s) )
        {
            // interpret special characters
            if ( quoted && c == quoteChar )
            {
                // this marks the end of a quoted string; abort.
                c = s.get();
                break;
            }
        }
        else if ( isblank( c ) )
        {
            // include escaped spaces
            x += c;
            c=s.get();
        }

    }
    s.putback(c);
    return s;
}

Here is the call graph for this function:

bool tIsInList	(	tString const &	list_,
		tString const &	item
	)

check whether item is in a comma or whitespace separated list

Parameters:

	list	The string representation of the list
	item	The item to look for

Returns:

true if the list contains the item

Example: tIsInList( "ab, cd", "ab" ) -> true

Definition at line 2166 of file tString.cpp.

References isblank(), tString::Len(), pos, tString::StrPos(), and tString::SubStr().

Referenced by sn_BothHave(), and sn_GetSupportedMethods().

{
    tString list = list_;

    while( list != "" )
    {
        // find the item
        int pos = list.StrPos( item );

        // no traditional match? shoot.
        if ( pos < 0 )
        {
            return false;
        }

        // check whether the match is a true list match
        if ( 
            ( pos == 0 || list[pos-1] == ',' || isblank(list[pos-1]) )
            &&
            ( pos + item.Len() >= list.Len() || list[pos+item.Len()-1] == ',' || isblank(list[pos+item.Len()-1]) )
            )
        {
            return true;
        }
        else
        {
            // no? truncate the list and go on.
            list = list.SubStr( pos + 1 );
        }
    }
    
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tToLower

(

tString &

toTransform

)

converts a string to lowercase

Parameters:

toTransform

The string to transform

Definition at line 2209 of file tString.cpp.

References tString::Len().

Referenced by eVoter::HandleChat(), nKrawall::nMethod::nMethod(), tConfItemBase::tConfItemBase(), and uAction::uAction().

{
    for( int i = toTransform.Len()-2; i >= 0; --i )
    {
        toTransform[i] = tolower( toTransform[i] );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tToUpper

(

tString &

toTransform

)

converts a string to uppercase

Parameters:

toTransform

The string to transform

Definition at line 2226 of file tString.cpp.

References tString::Len().

Referenced by tConfItemBase::LoadLine(), and s_Veto().

{
    for( int i = toTransform.Len()-2; i >= 0; --i )
    {
        toTransform[i] = toupper( toTransform[i] );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

---