PDG_AttributeOwner.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.
 *
 * COMMENTS:
 */

#ifndef __PDG_ATTRIBUTE_OWNER_H__
#define __PDG_ATTRIBUTE_OWNER_H__

#include "PDG_API.h"
#include "PDG_AttributeMap.h"
#include "PDG_AttributeTypes.h"

#include <UT/UT_RWLock.h>
#include <UT/UT_StringHolder.h>

#include <iosfwd>

class PDG_EvaluationContext;
class UT_IStream;

/*
 * Interface for other classes that own attribute data
 */
class PDG_API PDG_AttributeOwner
{
public:
                            PDG_AttributeOwner(bool has_runtime)
                                : myAttributes(this, has_runtime) {}
    virtual                 ~PDG_AttributeOwner() {}

    PDG_AttributeMap&       attributes()
                                { return myAttributes; }
    const PDG_AttributeMap& attributes() const
                                { return myAttributes; }

    bool                    attribSaveJSON(std::ostream& os, bool binary) const;
    bool                    attribSaveJSON(
                                const UT_StringHolder& file_path) const;

    bool                    attribLoadJSON(
                                UT_IStream& istream,
                                PDG_AttributeCollision strategy);
    bool                    attribLoadJSON(
                                const UT_StringHolder& file_path,
                                PDG_AttributeCollision strategy);

    bool                    hasAttributes() const;

    virtual bool            isAttribFlagValid(
                                PDG_AttributeFlag flag) const;
    virtual bool            areAttribFlagsValid(
                                uint16 flags) const;

    virtual UT_RWLock*      attribGlobalLock() const
                                { return nullptr; }
    virtual bool            attribCanWrite(
                                const PDG_EvaluationContext* context) const
                                { return true; }

    virtual void            attribUnlock(bool modified) const {}
    virtual void            attribModify(
                                PDG_AttributeType attrib_type,
                                const UT_StringHolder& attrib_name) const {}
    virtual void            attribWarn(const UT_StringHolder& msg) const {}

    virtual UT_StringHolder attribOwnerName() const
                                { return ""; }

protected:
    PDG_AttributeMap        myAttributes;
};

#endif