UT_SharedString.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_SharedString.h ( UT Library, C++)
 *
 * COMMENTS:    Container class for a shared string database.  This can be used
 *              when you need to allocate many strings where there are
 *              potentially a lot of duplicate string values.
 */

#ifndef __UT_SharedString__
#define __UT_SharedString__

#include "UT_API.h"
#include <iosfwd>
#include "UT_SymbolTable.h"
#include "UT_IndexedHashMapT.h"

class UT_API UT_SharedString {
public:
     UT_SharedString();
    
    const UT_StringHolder       &get(const UT_StringRef &str)
                 {
                     if (!str.isstring())
                         return UT_StringHolder::theEmptyString;;

                     UT_IndexedHashMapStringItem *ptr;
                     ptr = myMap.add(UT_StringHolder(str));
                     return ptr->getKey();
                 }

    void         free(const UT_StringRef &str)
                 {
                     if (str.isstring())
                         myMap.remove(UTmakeUnsafeRef(str));
                 }
    void         outputStats();
    void         dumpTable(std::ostream &os);

    // Old-school
    const UT_StringHolder       &allocString(const UT_StringRef &str)
                                        { return get(str); }
    void                         freeString(const UT_StringRef &str)
                                        { return free(str); }
private:
    UT_IndexedStringMap          myMap;
};

#endif