MarshalStringTable Class Reference

a singleton data container for communication string lookup. More...

#include "EVEMarshalStringTable.h"

Inheritance diagram for MarshalStringTable:

Collaboration diagram for MarshalStringTable:

Public Member Functions
	MarshalStringTable ()
uint8	LookupIndex (const std::string &str)
	lookup a index nr using a string More...
uint8	LookupIndex (const char *str)
	lookup a index nr using a string More...
const char *	LookupString (uint8 index)
	lookup a string using a index More...
Public Member Functions inherited from Singleton< MarshalStringTable >
	Singleton ()
	Primary constructor. More...

Private Types
typedef std::unordered_map < uint32, uint8 >	StringTableMap
typedef StringTableMap::iterator	StringTableMapItr
typedef StringTableMap::const_iterator	StringTableMapConstItr

Private Member Functions
uint32	hash (const char *str)
	djb2 algorithm taken from http://www.cse.yorku.ca/~oz/hash.html slightly modified More...

Private Attributes
StringTableMap	mStringTableMap

Static Private Attributes
static const char *const	s_mStringTable []
static const size_t	s_mStringTableSize = sizeof( MarshalStringTable::s_mStringTable ) / sizeof( const char* )

Additional Inherited Members
Static Public Member Functions inherited from Singleton< MarshalStringTable >
static MarshalStringTable &	get ()
Static Protected Attributes inherited from Singleton< MarshalStringTable >
static std::shared_ptr < MarshalStringTable >	mInstance

Detailed Description

a singleton data container for communication string lookup.

this class is a data container for communication string lookup. eventually this class should be available to every thread the unmarshal's. so only until we have solved the entire mess.. this is a singleton with mutex locks.

Todo:

when the object puzzle is solved this class should be available to every thread. it doesn't take much mem. So it means the mutexes can be removed when every thread has its own resource.

Author

Captnoord

Date

December 2008

Definition at line 47 of file EVEMarshalStringTable.h.

Member Typedef Documentation

typedef std::unordered_map<uint32, uint8> MarshalStringTable::StringTableMap

private

Definition at line 99 of file EVEMarshalStringTable.h.

typedef StringTableMap::const_iterator MarshalStringTable::StringTableMapConstItr

private

Definition at line 101 of file EVEMarshalStringTable.h.

typedef StringTableMap::iterator MarshalStringTable::StringTableMapItr

private

Definition at line 100 of file EVEMarshalStringTable.h.

Constructor & Destructor Documentation

MarshalStringTable::MarshalStringTable

(

)

Definition at line 290 of file EVEMarshalStringTable.cpp.

References hash(), LookupString(), mStringTableMap, and s_mStringTableSize.

{
    for( uint8 i = 1; i <= s_mStringTableSize; i++ )
        mStringTableMap.insert( std::make_pair( hash( LookupString( i ) ), i ) );
}

Here is the call graph for this function:

Member Function Documentation

uint32 MarshalStringTable::hash ( const char *  str )

inlineprivate

djb2 algorithm taken from http://www.cse.yorku.ca/~oz/hash.html slightly modified

Parameters

[in]

oStr

string that needs to be hashed.

Returns

djb2 has of the string.

Definition at line 88 of file EVEMarshalStringTable.h.

Referenced by LookupIndex(), and MarshalStringTable().

    {
        uint32 hash = 5381;
        int c;

        while( ( c = *str++ ) )
            hash = ( ( hash << 5 ) + hash ) + c; /* hash * 33 + c */

        return hash;
    }

Here is the caller graph for this function:

uint8 MarshalStringTable::LookupIndex

(

const std::string &

str

)

lookup a index nr using a string

Parameters

[in]

string

that needs a lookup for a index nr.

Returns

the index number of the string that was given; STRING_TABLE_ERROR if string is not found.

Definition at line 297 of file EVEMarshalStringTable.cpp.

{
    return LookupIndex( str.c_str() );
}

uint8 MarshalStringTable::LookupIndex

(

const char *

str

)

lookup a index nr using a string

Parameters

[in]

string

that needs a lookup for a index nr.

Returns

the index number of the string that was given; STRING_TABLE_ERROR if string is not found.

Definition at line 303 of file EVEMarshalStringTable.cpp.

References hash(), mStringTableMap, and STRING_TABLE_ERROR.

{
    StringTableMapConstItr res = mStringTableMap.find( hash( str ) );
    if( mStringTableMap.end() == res )
        return STRING_TABLE_ERROR;

    return res->second;
}

Here is the call graph for this function:

const char * MarshalStringTable::LookupString

(

uint8

index

)

lookup a string using a index

Parameters

[in]

index

is the index of the string that needs to be looked up.

Returns

if succeeds returns pointer to static string; if fails returns NULL.

Definition at line 312 of file EVEMarshalStringTable.cpp.

References s_mStringTable, and s_mStringTableSize.

Referenced by MarshalStringTable().

{
    if( --index < s_mStringTableSize )
        return s_mStringTable[ index ];
    else
        return nullptr;
}

Here is the caller graph for this function:

Member Data Documentation

StringTableMap MarshalStringTable::mStringTableMap

private

Definition at line 103 of file EVEMarshalStringTable.h.

Referenced by LookupIndex(), and MarshalStringTable().

const char *const MarshalStringTable::s_mStringTable

staticprivate

Note

this list should only be updated by running the following script within client context (thanks comet0)

---

import blue values = sorted(blue.marshal.stringTable, key=blue.marshal.stringTable.get) for i in values:

print ' "%s", ' % (i)

Definition at line 106 of file EVEMarshalStringTable.h.

Referenced by LookupString().

const size_t MarshalStringTable::s_mStringTableSize = sizeof( MarshalStringTable::s_mStringTable ) / sizeof( const char* )

staticprivate

Definition at line 109 of file EVEMarshalStringTable.h.

Referenced by LookupString(), and MarshalStringTable().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-common/marshal/EVEMarshalStringTable.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-common/marshal/EVEMarshalStringTable.cpp