CMD/CMD_SymbolList.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:
 *      Mark Elendt
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        CMD_SymbolList.h ( CMD Library, C++)
 *
 * COMMENTS:    Used by aliases and variables.  The symbol list contains a
 *              symbol and a value
 */

#ifndef __CMD_SymbolList__
#define __CMD_SymbolList__

#include "CMD_API.h"
#include <UT/UT_Lock.h>
#include <UT/UT_String.h>
#include <UT/UT_LinkList.h>
#include <UT/UT_StringArray.h>

class UT_SymbolTable;
class CMD_Alias;
class CMD_Manager;

class CMD_API CMD_SymbolEntry : public UT_LinkNode
{
public:
             CMD_SymbolEntry(const char *name, const char *value,
                             bool export_var);
    virtual ~CMD_SymbolEntry();

    virtual void        setValue(const char *value) = 0;

    UT_String   myName;
    UT_String   myValue;
};

class CMD_API CMD_SymbolList : protected UT_LinkList
{
public:
             CMD_SymbolList();
    virtual ~CMD_SymbolList();

    bool                 hasValue(const char *name) const;

    bool                 getValue(const char *name, UT_String &value);
    bool                 getValue(const char *name, float &value);
    bool                 getValue(const char *name, int &value);

    void                 setValue(const char *name, const char *value,
                                  bool export_var);

    virtual int          destroySymbol(const char *name);

    int                  getSymbolNames(UT_StringArray &nameList);

protected:
    virtual int          isValidSymbolName(const char *name) const;

    virtual CMD_SymbolEntry *
                         createEntry(const char *name,
                                     const char *value,
                                     bool export_var) = 0;

    static void          sortNames(UT_StringArray &names);

    UT_Lock &            getLock() const
                            { return myLock; }

private:
    const UT_String     *getRawValue(const char *name) const;
    CMD_SymbolEntry     *getSymbolPtr(const char *name) const;

private:
    UT_SymbolTable      *myTable;
    mutable UT_Lock      myLock;
};

#endif

---