UT/UT_SortedSymbolTable.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.
 *
 * Produced by:
 *      Chris AtLee
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        UT_SortedSymbolTable.h
 *
 * COMMENTS:
 *      This type of symbol table allows for quick iteration through it
 *      because it also stores its data in an array.  As a consequence,
 *      deleting from the table is O(n).
 *
 *      Elements in the array are stored in the order they were inserted.
 */

#ifndef __UT_SortedSymbolTable_h__
#define __UT_SortedSymbolTable_h__

#include "UT_API.h"
#include "UT_String.h"
#include "UT_SymbolTable.h"
#include "UT_RefArray.h"
#include "UT_Pair.h"

class UT_API UT_SortedSymbolTable
{
public:
    explicit UT_SortedSymbolTable();
    virtual ~UT_SortedSymbolTable();

    // Empty the table
    void        clear();

    // Add a symbol to the table
    void        addSymbol(const char* symbol, UT_Thing data);

    // Lookup a symbol
    // Returns 1 on success, 0 on failure
    int         findSymbol(const char* symbol, UT_Thing* datap) const;

    // Returns the symbol name of the given index
    const char* getSymbol(uint i) const;
    const char *getStringReference(const char *string);

    // Delete a symbol, this is O(n)
    int         deleteSymbol(const char* symbol);

    // Find a symbol
    UT_Thing    &operator[](const char* symbol);

    // Index into the array.
    UT_Thing    &operator[](uint i) const;
    UT_Thing    &operator()(uint i) const
                 {
                    return *(myThings(i).mySecond);
                 }

    // How many entries there are
    uint        entries() const;
    // Is the table empty?
    bool        empty() const;

    // Sort the thing array by the symbol name
    void        sortThingsBySymbol()
                {
                    myThings.sort(comparePair);
                }

protected:
    typedef UT_Pair<const char*, UT_Thing*> myPair;

    static int  comparePair(const myPair *p1, const myPair *p2)
        {
            return UT_String::compareNumberedString(p1->myFirst, p2->myFirst);
        }
    UT_SymbolTable              myTable;
    UT_RefArray<myPair>         myThings;
};

#endif

---