PDG_AttributeDictionary.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_DICT_H__
#define __PDG_ATTRIBUTE_DICT_H__

#include "PDG_API.h"

#include "PDG_AttributeArray.h"

#include <UT/UT_Options.h>
#include <UT/UT_StringArray.h>
#include <UT/UT_WorkBuffer.h>

class PDG_AttributeQuery;
class PDG_AttributeMap;
class PDG_AttributePattern;

class UT_JSONValue;
class UT_JSONWriter;
class UT_WorkBuffer;

/**
 * Dictionary attribute type
 */
class PDG_API PDG_AttributeDictionary : public PDG_AttributeArray<
                                                PDG_AttributeType::eDictArray,
                                                UT_OptionsHolder,
                                                UT_Array<UT_OptionsHolder>>
{
public:
    using Base = PDG_AttributeArray<
                        PDG_AttributeType::eDictArray,
                        UT_OptionsHolder,
                        UT_Array<UT_OptionsHolder>>;
    using Base::Base;
    using Base::values;
    using Base::appendValue;
    using Base::setValue;

public:
                                ~PDG_AttributeDictionary() override;

    /// Returns the total memory usage of all data on this attribute
    int64                       getMemoryUsage(bool inclusive) const override;

    /// Constructs a new dictionary attribute that copies the data from this
    /// attribute
    PDG_AttributeData*          clone() const override;


    /// Writes the dictionary data to the json writer
    bool                        saveData(UT_JSONWriter& writer) const override;

    /// Writes the dictionary data to the json writer
    void                        saveData(
                                    const UT_StringHolder& key,
                                    UT_OptionsHolder& dict) const override;

    /// Reads the dictionary data from the json value
    bool                        loadData(const UT_JSONValue& value) override;

    /// Reads the dictionary data from the dict
    bool                        loadData(
                                    const UT_StringHolder& key,
                                    const UT_OptionsHolder& dict) override;


    /// Writes a string representation of the dictionaries to the buffer
    bool                        desc(
                                    UT_WorkBuffer& result,
                                    bool pretty_print=false) const;
    bool                        desc(
                                    UT_StringHolder& result,
                                    bool pretty_print=false) const;

    /// Writes a string representation of the dictionary at the specified
    /// index to the buffer
    bool                        desc(
                                    UT_WorkBuffer& result,
                                    int component,
                                    bool pretty_print=false) const;
    bool                        desc(
                                    UT_StringHolder& result,
                                    int component,
                                    bool pretty_print=false) const;

    /// Sets values from an array of python dictionary representations
    void                        setValue(const UT_StringArray& reprs);

    /// Sets a value from a python dictionary string representation
    void                        setValue(
                                    const UT_StringHolder& repr,
                                    int component);

    /// Merges the dictionary into a dictionary in this attribute at the
    /// specified index
    void                        mergeValue(
                                    const UT_OptionsHolder& options,
                                    int component);

    /// Removes any dictionary entries at the specified index that match
    /// the attribute pattern
    void                        removeKeys(
                                    const PDG_AttributePattern& pattern,
                                    int component);

    /// Imports the specified attributes as key/value pairs in the dictionary.
    void                        importAttributes(
                                    const PDG_AttributePattern& pattern,
                                    const PDG_AttributeMap& attributes,
                                    int component,
                                    PDG_AttributeOverwrite overwrite);

    /// Imports the specified dictionary attribute key/value pairs into
    /// this dictionary.
    void                        mergeAttributes(
                                    const PDG_AttributePattern& pattern,
                                    const PDG_AttributeMap& attributes,
                                    int component);
   
    /// Queries a floating point value from the dictionary, using the
    /// specified query string and index
    PDG_AttributeCast           query(
                                    fpreal& result,
                                    const PDG_AttributeQuery& query,
                                    exint& query_index,
                                    int component) const;
    PDG_AttributeCast           query(
                                    fpreal& result,
                                    const UT_StringHolder& str,
                                    int component) const;

    /// Queries a string value from the dictionary, using the
    /// specified query string and index
    PDG_AttributeCast           query(
                                    UT_WorkBuffer& result,
                                    const PDG_AttributeQuery& query,
                                    exint& query_index,
                                    int component) const;
    PDG_AttributeCast           query(
                                    UT_WorkBuffer& result,
                                    const UT_StringHolder& str,
                                    int component) const;

private:
    const UT_OptionEntry*       queryInternal(
                                    const PDG_AttributeQuery& query,
                                    exint& query_index) const;
};

#endif