PY_Kwargs.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 PY_Kwargs_H
#define PY_Kwargs_H

#include "PY_API.h"
#include "PY_Result.h"

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

class PY_PyObject;

class PY_API PY_Kwargs
{
    public:
    using PyObjectMap = UT_StringMap</*key*/ PY_PyObject*>;

    // Keyword argument builder
    // ------------------------
    // The builder is used for adding entries to a json dictionary. It 
    // then generates a string representation of the dictionary usable 
    // in a python script.
    struct PY_API Expr
    {
        Expr() = default;

        Expr(UT_StringRef const& val) : myStr(val)
        {           
        }

        const char* c_str() const
        {
            return myStr.c_str();
        }

        UT_StringHolder myStr;
    };

    PY_Kwargs( UT_StringRef const & fmt = "{'args':{%s}}");
    ~PY_Kwargs() = default;

    PY_Kwargs(PY_Kwargs && other);
    PY_Kwargs(PY_Kwargs const& other) = default;

    void add(char const * key, PY_Kwargs const & value);
        
    // Add a string entry to the dictionary. 
    // Note: single quote is specified by default to format the 
    // value. Fouble quotes are used for enclosing strings 
    // containing single quotes.
    // 
    // yes: add('key', "'single_quote_string'", true);
    // out: "{'key' : "'single_quote_string'"}
    //
    // no: add('key', "'single_quote_string'", false);
    // out: "{'key' : ''single_quote_string''}
    // this string will cause a syntax error in python 
    void add(char const * key, char const * value, bool use_double_quote=false);
    void addUIEvent(char const * key, int64 value);
    void add(char const * key, Expr const & value);
    void add(char const * key, UT_Vector3 const & value);
    void add(char const * key, UT_Vector3D const & value);
    void add(char const * key, UT_Vector4 const & value);
    void add(char const * key, UT_Vector4D const & value);
    void add(char const * key, int value);
    void add(char const * key, int64 value);
    void add(char const * key, float value);
    void add(char const * key, fpreal64 value);
    void addBool(char const * key, int value);

    // Add a formatted expression entry that takes an int64 value as argument.
    // e.g. "hou.GeometryDrawable(%s)". 
    // addExpr doesn't do any validation on the value argument.
    void addExpr(char const * key, char const * expr, int64 value);

    // adds a hou.GeometrySelection entry. sinfo_address is a 
    // pointer to a OP3D_ScriptSelectStateInfoPtr instance
    void addGeometrySelection(char const * key, int64 sinfo_address);

    // adds a hou.ui.nodes() entry. nodelist_address is a pointer 
    // to a OP_NodeList instance.
    void addNodeList(char const * key, int64 nodelist_address);

    // Adds HOM dynamic objects entry. sinfo_address is a pointer 
    // to a OP3D_ScriptSelectStateInfoPtr instance
    void addDynDetails(char const * key, int64 sinfo_address);
    void addDynPoints(char const * key, int64 sinfo_address);
    void addDynPolygons(char const * key, int64 sinfo_address); 

    void addPYObject(const char* key, void* value);
    void addPYObject(const char* key, PY_PyObject const* value);

    // append the content of an existing PY_Kwargs to this one
    void append(PY_Kwargs const & other);

    // Evaluate a specific dictionary entry
    PY_Result evaluate(const char* key, PY_Result::Type desired_result_type) const;

    PyObjectMap const & pyObjectMap() const;
    PyObjectMap & pyObjectMap();

    operator UT_StringHolder () const
    {
        return value();
    }

    UT_StringHolder value() const
    {
        UT_WorkBuffer value;
        value.sprintf( myOutputFormat.c_str(), myStr.c_str() );

        return UT_StringHolder(std::move(value));
    }

    void setOutputFormat(UT_StringRef const & out_format);

    // Reset the Kwargs content with a kwargs value string 
    // representation.
    void reset(UT_StringHolder const& kwargs_value);

    protected:
    UT_StringHolder format(char const * value_fmt);
    UT_StringHolder make(char const * fmt, char const * key, char const * val);

    UT_StringHolder myStr;
    UT_StringHolder myOutputFormat;
    size_t          myCount;
    PyObjectMap     myPyObjectMap;
};

#endif // PY_Kwargs_H