Symbol Class Reference

Symbols are unique objects with a name stored in a hash table. More...

#include <symbol.hh>

List of all members.

Public Member Functions
ostream &	print (ostream &fout) const
	print a symbol on a stream
Private Member Functions
	Symbol (const char *str, unsigned int hsh, Symbol *nxt)
	Constructs a new symbol ready to be placed in the hash table.
	~Symbol ()
	The Destructor is never used.
bool	equiv (unsigned int hash, const char *str) const
	Check if the name of the symbol is equal to string str.
Static Private Member Functions
static unsigned int	calcHashKey (const char *str)
	Compute the 32-bits hash key of string str.
static Symbol *	get (const string &str)
	Get the symbol of name str.
static Symbol *	get (const char *str)
	Get the symbol of name str.
static Symbol *	prefix (const char *str)
	Creates a new symbol of name prefixed by str.
static bool	isnew (const char *str)
	Returns true if no symbol of name str exists.
Private Attributes
char *	fName
	Name of the symbol.
unsigned int	fHash
	Hash key computed from the name and used to determine the hash table entry.
Symbol *	fNext
	Next symbol in the hash table entry.
void *	fData
	Field to user disposal to store additional data.
Static Private Attributes
static const int	kHashTableSize = 511
	Size of the hash table (a prime number is recommended).
static Symbol *	gSymbolTable [kHashTableSize]
	Hash table used to store the symbols.
Friends
Symbol *	symbol (const char *str)
	Returns (and creates if new) the symbol of name str.
Symbol *	symbol (const string &str)
	Returns (and creates if new) the symbol of name str.
Symbol *	unique (const char *str)
	Returns a new unique symbol of name strxxx.
const char *	name (Symbol *sym)
	Returns the name of a symbol.
void *	getUserData (Symbol *sym)
	Returns user data.
void	setUserData (Symbol *sym, void *d)
	Set user data.

---

Detailed Description

Symbols are unique objects with a name stored in a hash table.

Definition at line 52 of file symbol.hh.

---

Constructor & Destructor Documentation

Symbol::Symbol	(	const char *	str,
		unsigned int	hsh,
		Symbol *	nxt
	)			[private]

Constructs a new symbol ready to be placed in the hash table.

Constructs a symbol ready to be placed in the hash table.

It makes a private copy of its name.

Parameters:

	str	the name of the symbol
	hsh	the hash key of the symbol
	nxt	a pointer to the next symbol in the hash table entry

Definition at line 151 of file symbol.cpp.

References fData, fHash, fName, and fNext.

{
    int len = strlen(str);
    
    fName = new char [len+1];
    memcpy(fName, str, len+1);
    fHash = hsh;
    fNext = nxt;
    fData = 0;
}

---

Member Function Documentation

unsigned int Symbol::calcHashKey

(

const char *

str

)

[static, private]

Compute the 32-bits hash key of string str.

Parameters:

str

the string

Returns:

a 32-bits hash key

Definition at line 133 of file symbol.cpp.

Referenced by get(), and isnew().

{
    unsigned int h = 0;

    while (*str) h = (h << 1) ^ (h >> 20) ^ (*str++);
    return h;
}

bool Symbol::equiv	(	unsigned int	hash,
		const char *	str
	)			const [private]

Check if the name of the symbol is equal to string str.

Check if the name of the symbol is equal to string str This method is used by isnew() and make() when searching the hashtable for an existing symbol.

Parameters:

	hash	the hash key of the string (used to speedup the comparison)
	str	the string to compare

Returns:

true if the name of the symbol and str are the same

Definition at line 120 of file symbol.cpp.

References fHash, and fName.

Referenced by get(), and isnew().

{
    return (fHash == hash) && (strcmp(fName,str) == 0);
}

Symbol * Symbol::get

(

const char *

str

)

[static, private]

Get the symbol of name str.

Search the hash table for the symbol of name str or returns a new one.

Parameters:

str

the name of the symbol

Returns:

a symbol of name str

Definition at line 63 of file symbol.cpp.

References calcHashKey(), equiv(), fNext, gSymbolTable, and kHashTableSize.

{
    unsigned int            hsh  = calcHashKey(str);
    int             bckt = hsh % kHashTableSize;
    Symbol*         item = gSymbolTable[bckt];

    while ( item && !item->equiv(hsh,str) ) item = item->fNext;
    Symbol* r = item ? item : gSymbolTable[bckt] = new Symbol(str, hsh, gSymbolTable[bckt]);
    return r;
}

Symbol * Symbol::get

(

const string &

str

)

[static, private]

Get the symbol of name str.

Search the hash table for the symbol of name str or returns a new one.

Parameters:

str

the name of the symbol

Returns:

a symbol of name str

Definition at line 42 of file symbol.cpp.

Referenced by symbol().

{
    char    buf[1024];
    int     i;
    int     n = str.length();
    
    if (n>1023) n = 1023;
    for (i = 0; i < n; i++) { buf[i] = str[i]; }
    buf[i] = 0;
    
    return Symbol::get(buf);
}

bool Symbol::isnew

(

const char *

str

)

[static, private]

Returns true if no symbol of name str exists.

Static method that searches the symbol table for a string.

Parameters:

str

string to search

Returns:

true if the string is NOT in the table (it is a new string)

Definition at line 81 of file symbol.cpp.

References calcHashKey(), equiv(), fNext, gSymbolTable, and kHashTableSize.

Referenced by prefix().

{
    unsigned int            hsh  = calcHashKey(str);
    int             bckt = hsh % kHashTableSize;
    Symbol*         item = gSymbolTable[bckt];
    
    while ( item && !item->equiv(hsh,str) ) item = item->fNext;
    return item == 0;
}

Symbol * Symbol::prefix

(

const char *

str

)

[static, private]

Creates a new symbol of name prefixed by str.

Creates a new symbol with a name obtained by concatenating the str prefix with a number in order to make it unique.

Parameters:

str

the prefix of the name

Returns:

a symbol of name prefix++n

Definition at line 98 of file symbol.cpp.

References isnew(), and name.

Referenced by unique().

{
    char    name[256];
    
    for (int n = 0; n<10000; n++) {
        snprintf(name, 256, "%s%d", str, n);
        if (isnew(name)) return get(name);
    }
    return get("UNIQUEOVERFLOW");
}   

ostream & Symbol::print

(

ostream &

fout

)

const

print a symbol on a stream

< print a symbol on a stream

Definition at line 164 of file symbol.cpp.

{
    return fout << fName;
}

---

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

• symbol.hh
• symbol.cpp