symbol.hh

Go to the documentation of this file.

/************************************************************************
 ************************************************************************
    FAUST compiler
    Copyright (C) 2003-2004 GRAME, Centre National de Creation Musicale
    ---------------------------------------------------------------------
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 ************************************************************************
 ************************************************************************/
 
#ifndef     __SYMBOL__
#define     __SYMBOL__

#include <string>
#include <map>

using namespace std;

//--------------------------------SYMBOL-------------------------------------

class Symbol
{
    
 private:
         
    static const int    kHashTableSize = 511;                   
    static Symbol*      gSymbolTable[kHashTableSize];           
    
    
 // Fields
    char*           fName;                                      
    unsigned int            fHash;                                      
    Symbol*         fNext;                                      
    void*           fData;                                      
    
 // Constructors & destructors
    Symbol (const char* str, unsigned int hsh, Symbol* nxt);    
   ~Symbol ();                                                  
    
 // Others
    bool            equiv (unsigned int hash, const char* str) const ;  
    static unsigned int     calcHashKey (const char* str);              

 // Static methods
    static Symbol*      get (const string& str);                
    static Symbol*      get (const char* str);                  
    static Symbol*      prefix (const char* str);               
    static bool         isnew (const char* str);                
    
 public:
    ostream&                print (ostream& fout) const;                                

    friend Symbol*          symbol (const char* str);
    friend Symbol*          symbol (const string& str);
    friend Symbol*          unique (const char* str);
    friend const char*  name (Symbol* sym);
    
    friend void*            getUserData (Symbol* sym);
    friend void             setUserData (Symbol* sym, void* d);
        
};

inline Symbol*          symbol (const char* str)    { return Symbol::get(str); }    
inline Symbol*          symbol (const string& str)  { return Symbol::get(str); }    
inline Symbol*          unique (const char* str)    { return Symbol::prefix(str);}  
inline const char*  name (Symbol* sym)          { return sym->fName; }          
    
inline void*            getUserData (Symbol* sym)           { return sym->fData; }      
inline void             setUserData (Symbol* sym, void* d)  { sym->fData=d; }           

inline ostream& operator << (ostream& s, const Symbol& n) { return n.print(s); }


typedef Symbol* Sym;

#endif