GU_AgentMetadata.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.
 */

#ifndef __GU_AgentMetadata__
#define __GU_AgentMetadata__

#include "GU_API.h"

#include <UT/UT_Assert.h>
#include <UT/UT_IntrusivePtr.h>
#include <UT/UT_Options.h>
#include <UT/UT_StringHolder.h>
#include <SYS/SYS_Types.h>

class UT_JSONParser;
class UT_JSONWriter;
class UT_StringArray;

class GU_AgentMetadata;
using GU_AgentMetadataPtr = UT_IntrusivePtr<GU_AgentMetadata>;
using GU_AgentMetadataConstPtr = UT_IntrusivePtr<const GU_AgentMetadata>;

/// Provides a simple way to store custom metadata (UT_Options) in the agent
/// definition.
class GU_API GU_AgentMetadata : public UT_IntrusiveRefCounter<GU_AgentMetadata>
{
public:
    /// Use the static addMetadata() method to create new metadata items.
    /// This is only public for use with UTmakeIntrusive().
    GU_AgentMetadata(
            const UT_StringHolder &filename,
            const UT_OptionsHolder &dict)
        : myFileName(filename), myDict(dict)
    {
    }

    ~GU_AgentMetadata();

    /// Create new empty metadata.
    static GU_AgentMetadataPtr addMetadata();
    /// Load the metadata from a file.
    static GU_AgentMetadataPtr addMetadataFromFile(
            const UT_StringHolder &filename,
            UT_StringArray &errors);
    /// Creates a copy of the metadata. The copy will not be marked as an
    /// external reference.
    static GU_AgentMetadataPtr addMetadataCopy(const GU_AgentMetadata &src);

    /// The amount of memory used by this item.
    int64 getMemoryUsage(bool inclusive) const;

    /// Return whether the metadata was loaded from disk.
    bool isFile() const { return myFileName.isstring(); }
    /// Clear the flag marking that the metadata references a file on disk.
    void clearIsFile();
    /// Returns the name of the file referenced on disk.
    const UT_StringHolder &fileName() const
    {
        UT_ASSERT(isFile());
        return myFileName;
    }

    /// Save the metadata.
    bool save(UT_JSONWriter &w) const;
    /// Load the metadata.
    bool load(UT_JSONParser &p, UT_StringArray &errors);

    /// Returns the metadata dictionary.
    const UT_OptionsHolder &dict() const { return myDict; }

    /// Updates the metadata dictionary.
    void setDict(const UT_OptionsHolder &dict) { myDict = dict; }

private:
    UT_StringHolder myFileName;
    UT_OptionsHolder myDict;
};

#endif