utils_string.h File Reference

#include "utils/Buffer.h"

Include dependency graph for utils_string.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
std::string	GenerateKey (size_t length)
	Generates random key. More...
bool	IsNumber (char c)
	Checks whether character is a number. More...
bool	IsNumber (const char *str, size_t len)
	Checks whether string is a number. More...
bool	IsNumber (const std::string &str)
	Checks whether string is a number. More...
bool	IsHexNumber (char c)
	Checks whether character is a hexadecimal number. More...
bool	IsHexNumber (const char *str, size_t len)
	Checks whether string is a hexadecimal number. More...
bool	IsHexNumber (const std::string &str)
	Checks whether string is a hexadecimal number. More...
bool	IsPrintable (char c)
	Checks whether character is printable. More...
bool	IsPrintable (const char *str, size_t len)
	Checks whether string is printable. More...
bool	IsPrintable (const std::string &str)
	Checks whether string is printable. More...
const char *	itoa (int64 num)
	Convers num to string. More...
void	ListToINString (const std::vector< int32 > &ints, std::string &into, const char *if_empty="")
void	MakeUpperString (const char *source, char *target)
	toupper() for strings. More...
void	MakeLowerString (const char *source, char *target)
	tolower() for strings. More...
bool	PyDecodeEscape (const char *str, Buffer &into)
	Decodes string escapes into actual characters. More...
void	SearchReplace (std::string &subject, const std::string &search, const std::string &replace)
	Does search & replace on subject. More...
void	SplitPath (const std::string &path, std::vector< std::string > &into)
	Splits path to its components. More...

Variables
const std::string	NULL_STRING
	std::string to use where you would use NULL for const char*. More...

Function Documentation

std::string GenerateKey

(

size_t

length

)

Generates random key.

Parameters

[in]

length

Length of key to generate.

Returns

Generated key.

Definition at line 32 of file utils_string.cpp.

References key(), and MakeRandomInt().

{
    static const char CHARS[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
    static const size_t CHARS_COUNT = sizeof( CHARS ) / sizeof( char );

    std::string key;

    for(; 0 < length; --length)
        key += CHARS[ MakeRandomInt( 0, CHARS_COUNT - 1 ) ];

    return key;
}

Here is the call graph for this function:

bool IsHexNumber

(

char

c

)

Checks whether character is a hexadecimal number.

Parameters

[in]

c

The character to be checked.

Return values

true	The character is a hexadecimal number.
false	The character is not a hexadecimal number.

Definition at line 86 of file utils_string.cpp.

Referenced by Seperator::isHexNumber(), and IsHexNumber().

{
    return 0 != isxdigit( c );
}

Here is the caller graph for this function:

bool IsHexNumber	(	const char *	str,
		size_t	len
	)

Checks whether string is a hexadecimal number.

Parameters

[in]	str	The string to be checked.
[in]	len	Length of the string.

Return values

true	The string is a hexadecimal number.
false	The string is not a hexadecimal number.

Definition at line 91 of file utils_string.cpp.

References IsHexNumber().

{
    // skip sign if there is one
    if( 1 >= len )
    {
        if(    '-' == str[0]
            || '+' == str[0] )
        {
            str += 1;
            len -= 1;
        }
    }

    // skip "0x" or "0X" prefix if there is one
    if( 2 >= len )
    {
        if(    '0' == str[0]
            && (    'x' == str[1]
                 || 'X' == str[1] ) )
        {
            str += 2;
            len -= 2;
        }
    }

    if( 0 == len )
        return false;

    for(; len > 0; ++str, --len)
    {
        if( !IsHexNumber( *str ) )
            return false;
    }

    return true;
}

Here is the call graph for this function:

bool IsHexNumber

(

const std::string &

str

)

Checks whether string is a hexadecimal number.

Parameters

[in]

str

The string to be checked.

Return values

true	The string is a hexadecimal number.
false	The string is not a hexadecimal number.

Definition at line 128 of file utils_string.cpp.

References IsHexNumber().

{
    return IsHexNumber( str.c_str(), str.length() );
}

Here is the call graph for this function:

bool IsNumber

(

char

c

)

Checks whether character is a number.

Parameters

[in]

c

The character to be checked.

Return values

true	The character is a number.
false	The character is not a number.

Definition at line 45 of file utils_string.cpp.

Referenced by Command_unspawn(), Seperator::isNumber(), and IsNumber().

{
    return 0 != isdigit( c );
}

Here is the caller graph for this function:

bool IsNumber	(	const char *	str,
		size_t	len
	)

Checks whether string is a number.

Parameters

[in]	str	The string to be checked.
[in]	len	Length of the string.

Return values

true	The string is a number.
false	The string is not a number.

Definition at line 50 of file utils_string.cpp.

References IsNumber().

{
    // skip sign if there is one
    if( len >= 1 )
    {
        if(    '-' == str[0]
            || '+' == str[0] )
        {
            str += 1;
            len -= 1;
        }
    }

    if( 0 == len )
        return false;

    bool seenDec = false;
    for(; len > 0; ++str, --len)
    {
        if( !IsNumber( *str ) )
        {
            if( !seenDec && '.' == *str )
                seenDec = true;
            else
                return false;
        }
    }

    return true;
}

Here is the call graph for this function:

bool IsNumber

(

const std::string &

str

)

Checks whether string is a number.

Parameters

[in]

str

The string to be checked.

Return values

true	The string is a number.
false	The string is not a number.

Definition at line 81 of file utils_string.cpp.

References IsNumber().

{
    return IsNumber( str.c_str(), str.length() );
}

Here is the call graph for this function:

bool IsPrintable

(

char

c

)

Checks whether character is printable.

Parameters

[in]

c

The character to be checked.

Return values

true	The character is printable.
false	The character is not printable.

Definition at line 133 of file utils_string.cpp.

Referenced by IsPrintable().

{
    // They seem to expect it unsigned ...
    const unsigned char _c = c;

    return ( isgraph( _c ) || isspace( _c ) );
}

Here is the caller graph for this function:

bool IsPrintable	(	const char *	str,
		size_t	len
	)

Checks whether string is printable.

Parameters

[in]	str	String to be checked.
[in]	len	Length of string.

Return values

true	The string is printable.
false	The string is not printable.

Definition at line 141 of file utils_string.cpp.

References IsPrintable().

{
    for(; len > 0; ++str, --len)
    {
        if( !IsPrintable( *str ) )
            return false;
    }

    return true;
}

Here is the call graph for this function:

bool IsPrintable

(

const std::string &

str

)

Checks whether string is printable.

Parameters

[in]

str

String to be checked.

Return values

true	The string is printable.
false	The string is not printable.

Definition at line 152 of file utils_string.cpp.

References IsPrintable().

{
    return IsPrintable( str.c_str(), str.size() );
}

Here is the call graph for this function:

const char* itoa

(

int64

num

)

Convers num to string.

Parameters

[in]

num

The number to be converted.

Returns

Pointer to static array where result is stored.

Definition at line 159 of file utils_string.cpp.

References _ITOA_BUFLEN, and snprintf.

Referenced by APIAccountManager::_APIKeyRequest(), APICharacterManager::_CharacterSheet(), APIServerManager::_ServerStatus(), APICharacterManager::_SkillInTraining(), APICharacterManager::_SkillQueue(), PlanetSE::CreateCustomsOffice(), APICharacterDB::GetCharacterAttributes(), APICharacterDB::GetCharacterSkillQueue(), APICharacterDB::GetCharacterSkillsTrained(), Sentry::Killed(), CustomsSE::Killed(), NPC::Killed(), DroneSE::Killed(), StructureSE::Killed(), ShipSE::Killed(), Inventory::LoadContents(), DestinyManager::MoveObject(), and ModuleManager::UnloadCharge().

{
    static char buf[ _ITOA_BUFLEN ];
    memset( buf, 0, _ITOA_BUFLEN );

    snprintf( buf, _ITOA_BUFLEN, "%li", num );

    return buf;
}

Here is the caller graph for this function:

void ListToINString	(	const std::vector< int32 > &	ints,
		std::string &	into,
		const char *	if_empty = ""
	)

function to convert a vector of numbers to a string containing string representatives of those numbers.

Parameters

[in]	ints	contains the numbers that need to converted.
[in]	if_empty	is the default value added if ints is empty.
[out]	into	contains the string representatives of the numbers.

Definition at line 169 of file utils_string.cpp.

References snprintf.

Referenced by ConfigDB::GetMultiAllianceShortNamesEx(), ConfigDB::GetMultiCorpTickerNamesEx(), ConfigDB::GetMultiGraphicsEx(), ConfigDB::GetMultiInvTypesEx(), ConfigDB::GetMultiLocationsEx(), ConfigDB::GetMultiOwnersEx(), ConfigDB::GetMultiStationEx(), and MissionDB::LoadMissionBookMark().

{
    if( ints.empty() )
    {
        into = if_empty;
        return;
    }

    /*
     * Some small theory about numbers to strings
     *
     * the max size of a number converted to
     * a string is:
     * uint32 -1 results in
     * "4294967295" which is 10 characters.
     */
    size_t format_index = into.size();
    into.resize( format_index + ints.size() * ( 10 + 1 ) );

    std::vector<int32>::const_iterator cur, end;
    cur = ints.begin();
    end = ints.end();
    for(; cur != end; ++cur)
    {
        if( ( cur + 1 ) != end )
            format_index += snprintf( &into[ format_index ], 12, "%i,", *cur );
        else
            // last value to be printed
            format_index += snprintf( &into[ format_index ], 11, "%i", *cur );
    }
}

Here is the caller graph for this function:

void MakeLowerString	(	const char *	source,
		char *	target
	)

tolower() for strings.

Parameters

[in]	source	Source string.
[out]	target	Array which receives result.

Definition at line 212 of file utils_string.cpp.

{
    if( !target )
        return;

    for(; *source; ++target, ++source )
        *target = tolower( *source );

    *target = 0;
}

void MakeUpperString	(	const char *	source,
		char *	target
	)

toupper() for strings.

Parameters

[in]	source	Source string.
[out]	target	Array which receives result.

Definition at line 201 of file utils_string.cpp.

{
    if( !target )
        return;

    for(; *source; ++target, ++source )
        *target = toupper( *source );

    *target = 0;
}

bool PyDecodeEscape	(	const char *	str,
		Buffer &	into
	)

Decodes string escapes into actual characters.

Based on PyString_DecodeEscape from Python.

Parameters

[in]	str	Escaped string.
[out]	into	The result will be put here.

Return values

true	Decode ran OK.
false	Error occured during decoding.

Definition at line 223 of file utils_string.cpp.

References Buffer::Append().

Referenced by DestinyDumpLogText(), and UnmarshalLogText().

{
    const size_t len = strlen( str );
    const char* const end = str + len;

    while( str < end )
    {
        if( *str != '\\' )
        {
            into.Append< char >( *str++ );
            continue;
        }

        if( ++str == end )
            //ended with a \ char
            return false;

        int c;
        switch( *str++ )
        {
            /* XXX This assumes ASCII! */
            case '\n':                                break; /* ? */
            case '\\': into.Append< char >( '\\' );   break;
            case '\'': into.Append< char >( '\'' );   break;
            case '\"': into.Append< char >( '\"' );   break;
            case 'b':  into.Append< char >( '\b' );   break;
            case 'f':  into.Append< char >( '\014' ); break; /* FF */
            case 't':  into.Append< char >( '\t' );   break;
            case 'n':  into.Append< char >( '\n' );   break;
            case 'r':  into.Append< char >( '\r' );   break;
            case 'v':  into.Append< char >( '\013' ); break; /* VT */
            case 'a':  into.Append< char >( '\007' ); break; /* BEL, not classic C */

            case '0':
            case '1':
            case '2':
            case '3':
            case '4':
            case '5':
            case '6':
            case '7':
                c = str[-1] - '0';
                if( '0' <= *str && *str <= '7' )
                {
                    c = ( c << 3 ) + *str++ - '0';
                    if( '0' <= *str && *str <= '7' )
                        c = ( c << 3 ) + *str++ - '0';
                }
                into.Append< uint8 >( c );
                break;

        case 'x':
            if( isxdigit( str[0] ) && isxdigit( str[1] ) )
            {
                unsigned int x = 0;
                c = *str++;

                if( isdigit(c) )
                    x = c - '0';
                else if( islower(c) )
                    x = 10 + c - 'a';
                else
                    x = 10 + c - 'A';

                x = x << 4;
                c = *str++;

                if( isdigit(c) )
                    x += c - '0';
                else if( islower(c) )
                    x += 10 + c - 'a';
                else
                    x += 10 + c - 'A';

                into.Append< uint8 >( x );
                break;
            }
            //"invalid \\x escape");
            return false;

        default:
            return false;
        }
    }

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SearchReplace	(	std::string &	subject,
		const std::string &	search,
		const std::string &	replace
	)

Does search & replace on subject.

Parameters

[in,out]	subject	String to be searched.
[in]	search	String which shall be replaced.
[in]	replace	String with which to replace.

Definition at line 311 of file utils_string.cpp.

Referenced by BaseRowsetReader::iterator::GetAsString().

{
    std::string::size_type pos = 0;
    while( ( pos = subject.find( search, pos ) ) != std::string::npos )
    {
        subject.replace( pos, search.length(), replace );
        pos += replace.length();
    }
}

Here is the caller graph for this function:

void SplitPath	(	const std::string &	path,
		std::vector< std::string > &	into
	)

Splits path to its components.

Parameters

[in]	path	Path to split.
[out]	into	Vector which receives components of the path.

Definition at line 321 of file utils_string.cpp.

Referenced by StuffExtract().

{
    const char* p = path.c_str();
    const char* begin = p;
    size_t len = 0;

    for(; *p != '\0'; ++p)
    {
        if( *p == '/' || *p == '\\' )
        {
            into.push_back( std::string( begin, len ) );
            len = 0;
            begin = p + 1;
        }
        else
        {
            ++len;
        }
    }

    if( begin < p )
        into.push_back( std::string( begin, len ) );
}

Here is the caller graph for this function:

Variable Documentation

const std::string NULL_STRING

std::string to use where you would use NULL for const char*.

Definition at line 30 of file utils_string.cpp.