PRM/PRM_Name.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:
 *      ramin
 *      Side Effects Software Inc.
 *      20 Maud St.
 *      Toronto, Ontario,  M5V 2M5
 *      Canada
 *      416-366-4607
 *
 * NAME:        PRM_Name.h (Parameter Library)
 *
 * COMMENTS:
 *              This class is used to store names of things which may have
 *              a nice "label" name, and a "token" (more parsable) name.
 */

#ifndef __PRM_Label__
#define __PRM_Label__

#include "PRM_API.h"
#include <UT/UT_IntArray.h>
#include <UT/UT_String.h>

class PRM_API PRM_Name
{
public:

    ///  If thelabel is set to 0, then the thetoken is used as 
    ///  the label. Currently the flags parameter is only used for
    ///  the parm expression flag. Set theflags to 1 to make the parm
    ///  default to expression mode.
                 PRM_Name(const char *thetoken = 0,
                          const char *thelabel = 0,
                          int         theflags = 0);
    virtual     ~PRM_Name();

    const char  *getToken() const               { return myToken; }
    const char  *getLabel() const
                 {
                    return ((const char *)myLabel) ? myLabel : myToken;
                 }
    int          getExpressionFlag() const      { return myFlags; }
    unsigned     getHash() const                { return myTokenHash; }

    void         setToken(const char *s);       
    void         setLabel(const char *s);
    void         harden();

    void         instance(const int *instance, int num);
    void         instance(const UT_IntArray &instance_num);

    bool         isValidChoice() const
                 {
                    // First, test that we don't have a null ptr for the token.
                    if (!(const char *)myToken)
                        return false;
                    return myToken.isstring() || myLabel.isstring();
                 }

    static const char  *mySeparator;

    static unsigned theSentinelHash;

private:
    void         calculateTokenHash();

    UT_String    myToken;
    UT_String    myLabel;
    unsigned     myTokenHash;
    short        myFlags;
};
#endif

---