CWE-ou-minkata/Sources/Plasma/FeatureLib/pfPython/plPythonSDLModifier.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
#ifndef plPythonSDLModifier_h_inc
#define plPythonSDLModifier_h_inc

class plPythonFileMod;
class plStateDataRecord;
class plSimpleStateVariable;

#include "hsStlUtils.h"
#include "plModifier/plSDLModifier.h"

#include <Python.h>
#include "pyGlueHelpers.h"


// hack for plNetClientVNodeMgr single-player mode SDLHook stuff.
plStateDataRecord * GetAgeSDL();

class pyKey;
//
// The fields of a SDL record in Python format.
// If the Python code changes a value an update is sent automatically
//
class plPythonSDLModifier : public plSDLModifier
{
protected:
    class SDLObj
    {
    public:
        PyObject* obj;
        int size;       // 0 for resizable
        bool sendToClients;
        bool skipLocalCheck;
        bool sendImmediate;
        std::string hintString;
        SDLObj() : obj(nil), size(-1), sendToClients(false) {}
        SDLObj(PyObject* obj, int size, bool sendToClients) : obj(obj), size(size), sendToClients(sendToClients) {}
    };
    typedef std::map<std::string, SDLObj> SDLMap;
    SDLMap fMap;
    plPythonFileMod* fOwner;

    plPythonSDLModifier() {}

    PyObject* ISDLVarToPython(plSimpleStateVariable* var);
    PyObject* ISDLVarIdxToPython(plSimpleStateVariable* var, int type, int idx);

    void IPythonVarToSDL(plStateDataRecord* state, const char* name);
    bool IPythonVarIdxToSDL(plSimpleStateVariable* var, int varIdx, int type, PyObject* pyVar, const char* hintstring);

    void ISetItem(const char* key, PyObject* value);
    void IDirtySynchState(const char* name, hsBool sendImmediate = false);

    void IPutCurrentStateIn(plStateDataRecord* dstState);
    void ISetCurrentStateFrom(const plStateDataRecord* srcState);
public:
    plPythonSDLModifier(plPythonFileMod* owner);
    ~plPythonSDLModifier();

    CLASSNAME_REGISTER(plPythonSDLModifier);
    GETINTERFACE_ANY(plPythonSDLModifier, plSDLModifier);

    virtual const char* GetSDLName() const;
    virtual void SetItemFromSDLVar(plSimpleStateVariable* var);

    static bool HasSDL(const char* pythonFile);
    // find the Age global SDL guy... if there is one
    static const plPythonSDLModifier* FindAgeSDL();
    static plKey FindAgeSDLTarget();

    void SetDefault(const char* key, PyObject* value);
    void SendToClients(const char* key);
    void SetNotify(pyKey& selfkey, const char* key, float tolerance);

    PyObject* GetItem(const char* key);
    void SetItem(const char* key, PyObject* value);
    void SetItemIdx(const char* key, int idx, PyObject* value, hsBool sendImmediate = false);
    void SetFlags(const char* name, bool sendImmediate, bool skipOwnershipCheck);
    void SetTagString(const char* name, const char* tag);
};

// A wrapper for plPythonSDLModifier that Python uses
class pySDLModifier
{
protected:
    plPythonSDLModifier* fRecord;

    pySDLModifier(plPythonSDLModifier* sdlMod);
    pySDLModifier() {}
public:
    // required functions for PyObject interoperability
    PYTHON_CLASS_NEW_FRIEND(ptSDL);
    PYTHON_CLASS_NEW_DEFINITION;
    static PyObject *New(plPythonSDLModifier *sdlMod);
    PYTHON_CLASS_CHECK_DEFINITION; // returns true if the PyObject is a pySDLModifier object
    PYTHON_CLASS_CONVERT_FROM_DEFINITION(pySDLModifier); // converts a PyObject to a pySDLModifier (throws error if not correct type)

    static void AddPlasmaClasses(PyObject *m);
    static void AddPlasmaMethods(std::vector<PyMethodDef> &methods);

    // global function to get the GrandMaster Age SDL object
    static PyObject* GetAgeSDL();

    static void SetDefault(pySDLModifier& self, std::string key, PyObject* value);
    static void SendToClients(pySDLModifier& self, std::string key);
    static void SetNotify(pySDLModifier& self, pyKey& selfkey, std::string key, float tolerance);
    
    static PyObject* GetItem(pySDLModifier& self, std::string key);
    static void SetItem(pySDLModifier& self, std::string key, PyObject* value);
    static void SetItemIdx(pySDLModifier& self, std::string key, int idx, PyObject* value);
    static void SetItemIdxImmediate(pySDLModifier& self, std::string key, int idx, PyObject* value);
    static void SetFlags(pySDLModifier& self, const char* name, bool sendImmediate, bool skipOwnershipCheck);
    static void SetTagString(pySDLModifier& self, const char* name, const char* tag);
    
};

#endif // plPythonSDLModifier_h_inc