4656e2ca5ac3e3cb8eca6fc543ecc4322b061379
[blender.git] / source / gameengine / Expressions / Value.h
1 /*
2  * Value.h: interface for the CValue class.
3  * $Id$
4  * Copyright (c) 1996-2000 Erwin Coumans <coockie@acm.org>
5  *
6  * Permission to use, copy, modify, distribute and sell this software
7  * and its documentation for any purpose is hereby granted without fee,
8  * provided that the above copyright notice appear in all copies and
9  * that both that copyright notice and this permission notice appear
10  * in supporting documentation.  Erwin Coumans makes no
11  * representations about the suitability of this software for any
12  * purpose.  It is provided "as is" without express or implied warranty.
13  *
14  */
15
16 #ifdef WIN32
17 #pragma warning (disable:4786)
18 #endif //WIN32
19
20 /////////////////////////////////////////////////////////////////////////////////////
21 //// Baseclass CValue
22 //// Together with CExpression, CValue and it's derived classes can be used to
23 //// parse expressions into a parsetree with error detecting/correcting capabilities
24 //// also expandible by a CFactory pluginsystem 
25 //// 
26 //// Features:
27 //// Reference Counting (AddRef() / Release())
28 //// Calculations (Calc() / CalcFinal())
29 //// Configuration (Configure())
30 //// Serialization (EdSerialize() / EdIdSerialize() / EdPtrSerialize() and macro PLUGIN_DECLARE_SERIAL
31 //// Property system (SetProperty() / GetProperty() / FindIdentifier())
32 //// Replication (GetReplica())
33 //// Flags (IsSelected() / IsModified() / SetSelected()...)
34 //// 
35 //// Some small editor-specific things added
36 //// A helperclass CompressorArchive handles the serialization
37 //// 
38 /////////////////////////////////////////////////////////////////////////////////////
39 #ifndef __VALUE_H__
40 #define __VALUE_H__
41
42 #include <map>          // array functionality for the propertylist
43 #include "STR_String.h" // STR_String class
44
45 #ifndef GEN_NO_ASSERT
46 #undef  assert
47 #define assert(exp)                     ((void)NULL)
48 #endif
49
50
51 #ifndef GEN_NO_TRACE
52 #undef  trace
53 #define trace(exp)                      ((void)NULL)
54 #endif
55
56 #ifndef GEN_NO_DEBUG
57 #undef  debug
58 #define debug(exp)                      ((void)NULL)
59 #endif
60
61 #ifndef GEN_NO_ASSERTD
62 #undef  assertd
63 #define assertd(exp)                    ((void)NULL)
64 #endif
65
66
67 #ifndef USE_PRAGMA_ONCE
68 #ifdef WIN32
69         #pragma once
70
71 #endif //WIN32
72 #endif
73
74 #define EDITOR_LEVEL_VERSION 0x06
75
76 enum VALUE_OPERATOR {
77         
78         VALUE_ADD_OPERATOR,                     // +
79         VALUE_SUB_OPERATOR,                     // -
80         VALUE_MUL_OPERATOR,                     // *
81         VALUE_DIV_OPERATOR,                     // /
82         VALUE_NEG_OPERATOR,                     // -
83         VALUE_POS_OPERATOR,                     // +
84         VALUE_AND_OPERATOR,                     // &&
85         VALUE_OR_OPERATOR,                      // ||
86         VALUE_EQL_OPERATOR,                     // ==
87         VALUE_NEQ_OPERATOR,                     // !=
88         VALUE_GRE_OPERATOR,                     // >
89         VALUE_LES_OPERATOR,                     // <
90         VALUE_GEQ_OPERATOR,                     // >=
91         VALUE_LEQ_OPERATOR,                     // <=
92         VALUE_NOT_OPERATOR,                     // !
93         VALUE_NO_OPERATOR                       // no operation at all
94 };
95
96 enum VALUE_DATA_TYPE {
97         VALUE_NO_TYPE,                          // abstract baseclass
98         VALUE_INT_TYPE,
99         VALUE_FLOAT_TYPE,
100         VALUE_STRING_TYPE,
101         VALUE_BOOL_TYPE,
102         VALUE_ERROR_TYPE,
103         VALUE_EMPTY_TYPE,
104         VALUE_SOLID_TYPE,
105         VALUE_COMBISOLID_TYPE,
106         VALUE_VECTOR_TYPE,
107         VALUE_MENU_TYPE,
108         VALUE_ACTOR_TYPE,
109         VALUE_MAX_TYPE                          //only here to provide number of types
110 };
111
112
113
114 #ifdef _DEBUG
115 //extern int gRefCountValue;            // debugonly variable to check if all CValue Refences are Dereferenced at programexit
116 #endif
117
118 struct HashableInt 
119 {
120         HashableInt(int id)                                                                                                                     : mData(id) { }
121
122         unsigned long                           Hash() const                                                                                    { return 0;} ////}gHash(&mData, sizeof(int));}
123         
124         bool                            operator==(HashableInt rhs)                                                             { return mData == rhs.mData; }
125         
126         int                                     mData;
127 };
128
129
130 //
131 // Bitfield that stores the flags for each CValue derived class
132 //
133 struct ValueFlags {
134         ValueFlags() :
135                 Modified(true),
136                 Selected(false),
137                 Affected(false),
138                 ReleaseRequested(false),
139                 Error(false),
140                 RefCountDisabled(false),
141                 HasProperties(false),
142                 HasName(false),
143                 Visible(true),
144                 CustomFlag1(false),
145                 CustomFlag2(false)
146         {
147         }
148
149         unsigned short Modified : 1;
150         unsigned short Selected : 1;
151         unsigned short Affected : 1;
152         unsigned short ReleaseRequested : 1;
153         unsigned short Error : 1;
154         unsigned short RefCountDisabled : 1;
155         unsigned short HasProperties : 1;
156         unsigned short HasName : 1;
157         unsigned short Visible : 1;
158         unsigned short CustomFlag1 : 1;
159         unsigned short CustomFlag2 : 1;
160
161         
162 };
163
164 /**
165  *      Base Class for all Actions performed on CValue's. Can be extended for undo/redo system in future.
166 */
167 class CAction
168 {
169 public:
170         CAction() {
171         };
172         virtual ~CAction(){
173         };
174         virtual void Execute() const =0;
175 };
176
177 //
178 // CValue
179 //
180 // Base class for all editor functionality, flexible object type that allows
181 // calculations and uses reference counting for memory management.
182 // 
183 //
184
185 /**
186  * These macros are helpfull when embedding Python routines. The second
187  * macro is one that also requires a documentation string
188  */
189 #define KX_PYMETHOD(class_name, method_name)                    \
190         PyObject* Py##method_name(PyObject* self, PyObject* args, PyObject* kwds); \
191         static PyObject* sPy##method_name( PyObject* self, PyObject* args, PyObject* kwds) { \
192                 return ((class_name*) self)->Py##method_name(self, args, kwds);         \
193         }; \
194
195 #define KX_PYMETHOD_DOC(class_name, method_name)                        \
196         PyObject* Py##method_name(PyObject* self, PyObject* args, PyObject* kwds); \
197         static PyObject* sPy##method_name( PyObject* self, PyObject* args, PyObject* kwds) { \
198                 return ((class_name*) self)->Py##method_name(self, args, kwds);         \
199         }; \
200     static char method_name##_doc[]; \
201
202 /* The line above should remain empty */
203 /**
204  * Method table macro (with doc)
205  */
206 #define KX_PYMETHODTABLE(class_name, method_name) \
207         {#method_name , (PyCFunction) class_name::sPy##method_name, METH_VARARGS, class_name::method_name##_doc}
208
209 /**
210  * Function implementation macro
211  */
212 #define KX_PYMETHODDEF_DOC(class_name, method_name, doc_string) \
213 char class_name::method_name##_doc[] = doc_string; \
214 PyObject* class_name::Py##method_name(PyObject* self, PyObject* args, PyObject* kwds)
215
216
217
218 #ifndef NO_EXP_PYTHON_EMBEDDING
219 #include "PyObjectPlus.h"
220 #include "object.h"
221 class CValue  : public PyObjectPlus
222 #else
223 class CValue  
224 #endif //NO_EXP_PYTHON_EMBEDDING
225
226
227 {
228 #ifndef NO_EXP_PYTHON_EMBEDDING
229 Py_Header;
230 #endif //NO_EXP_PYTHON_EMBEDDING
231 public:
232         enum AllocationTYPE {
233                 STACKVALUE              = 0,
234                 HEAPVALUE               = 1
235         };
236         
237         enum DrawTYPE {
238                 STARTFRAME              = 0,
239                 ENDFRAME                = 1,
240                 INTERFRAME              = 2
241         };
242
243
244         // Construction / Destruction
245 #ifndef NO_EXP_PYTHON_EMBEDDING
246
247         CValue(PyTypeObject *T = &Type);
248         //static PyObject*      PyMake(PyObject*,PyObject*);
249         virtual PyObject *_repr(void)
250         {
251                 return Py_BuildValue("s",(const char*)GetText());
252         }
253
254
255
256         virtual PyObject*                       _getattr(const STR_String& attr);
257
258         void    SpecialRelease()
259         {
260                 int i=0;
261                 if (ob_refcnt == 0)
262                 {
263                         _Py_NewReference(this);
264                         
265                 } else
266                 {
267                         i++;
268                 }
269                 Release();
270         }
271         static void PyDestructor(PyObject *P)                           // python wrapper
272         {
273           ((CValue*)P)->SpecialRelease();
274         };
275
276         virtual PyObject*       ConvertValueToPython() {
277                 return NULL;
278         }
279
280         virtual CValue* ConvertPythonToValue(PyObject* pyobj);
281
282
283         virtual int                             _setattr(const STR_String& attr,PyObject* value);
284         
285         KX_PYMETHOD(CValue,GetName);
286
287 #else
288         CValue();
289 #endif //NO_EXP_PYTHON_EMBEDDING
290
291         
292         
293         // Expression Calculation
294         virtual CValue*         Calc(VALUE_OPERATOR op, CValue *val) = 0;
295         virtual CValue*         CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, CValue *val) = 0;
296         virtual void            SetOwnerExpression(class CExpression* expr);
297
298         
299
300         void                            Execute(const CAction& a)
301         {
302                 a.Execute();
303         };
304
305         /// Reference Counting
306         int                                     GetRefCount()                                                                                   { return m_refcount; }
307         virtual CValue*         AddRef();                                                                                               // Add a reference to this value
308         virtual int                     Release();                                                                                              // Release a reference to this value (when reference count reaches 0, the value is removed from the heap)
309
310         /// Property Management
311         virtual void            SetProperty(const STR_String& name,CValue* ioProperty);                                         // Set property <ioProperty>, overwrites and releases a previous property with the same name if needed
312         virtual CValue*         GetProperty(const STR_String & inName);                                                 // Get pointer to a property with name <inName>, returns NULL if there is no property named <inName>
313         STR_String                      GetPropertyText(const STR_String & inName,const STR_String& deftext="");                                                // Get text description of property with name <inName>, returns an empty string if there is no property named <inName>
314         float                           GetPropertyNumber(const STR_String& inName,float defnumber);
315         virtual bool            RemoveProperty(const STR_String & inName);                                              // Remove the property named <inName>, returns true if the property was succesfully removed, false if property was not found or could not be removed
316         virtual void            ClearProperties();                                                                              // Clear all properties
317
318         virtual void            SetPropertiesModified(bool inModified);                                 // Set all properties' modified flag to <inModified>
319         virtual bool            IsAnyPropertyModified();                                                                // Check if any of the properties in this value have been modified
320
321         virtual CValue*         GetProperty(int inIndex);                                                               // Get property number <inIndex>
322         virtual int                     GetPropertyCount();                                                                             // Get the amount of properties assiocated with this value
323
324         virtual void            CloneProperties(CValue* replica);
325         virtual CValue*         FindIdentifier(const STR_String& identifiername);
326         /** Set the wireframe color of this value depending on the CSG
327          * operator type <op>
328          * @attention: not implemented */
329         virtual void            SetColorOperator(VALUE_OPERATOR op);
330
331         virtual const STR_String &      GetText() = 0;
332         virtual float           GetNumber() = 0;
333         double*                         ZeroVector() { return m_sZeroVec; };
334         virtual double*         GetVector3(bool bGetTransformedVec = false);
335
336         virtual STR_String      GetName() = 0;                                                                                  // Retrieve the name of the value
337         virtual void            SetName(STR_String name) = 0;                                                           // Set the name of the value
338         virtual void            ReplicaSetName(STR_String name) = 0;
339         /** Sets the value to this cvalue.
340          * @attention this particular function should never be called. Why not abstract? */
341         virtual void            SetValue(CValue* newval);
342         virtual CValue*         GetReplica() =0;
343         //virtual CValue*               Copy() = 0;
344         
345         
346         STR_String                              op2str(VALUE_OPERATOR op);
347                 
348         // setting / getting flags
349         inline void                     SetSelected(bool bSelected)                                                             { m_ValFlags.Selected = bSelected; }
350         virtual void            SetModified(bool bModified)                                                             { m_ValFlags.Modified = bModified; }
351         virtual void            SetAffected(bool bAffected=true)                                                { m_ValFlags.Affected = bAffected; }
352         inline void                     SetReleaseRequested(bool bReleaseRequested)                             { m_ValFlags.ReleaseRequested=bReleaseRequested; }
353         inline void                     SetError(bool err)                                                                              { m_ValFlags.Error=err; }
354         inline void                     SetVisible (bool vis)                                                                   { m_ValFlags.Visible=vis; }
355                                                                                                                                                                 
356         virtual bool            IsModified()                                                                                    { return m_ValFlags.Modified; }
357         inline bool                     IsError()                                                                                               { return m_ValFlags.Error; }
358         virtual bool            IsAffected()                                                                                    { return m_ValFlags.Affected || m_ValFlags.Modified; }
359         virtual bool            IsSelected()                                                                                    { return m_ValFlags.Selected; }
360         inline bool                     IsReleaseRequested()                                                                    { return m_ValFlags.ReleaseRequested; }
361         virtual bool            IsVisible()                                                                                             { return m_ValFlags.Visible;}
362         virtual void            SetCustomFlag1(bool bCustomFlag)                                                { m_ValFlags.CustomFlag1 = bCustomFlag;};
363         virtual bool            IsCustomFlag1()                                                                                 { return m_ValFlags.CustomFlag1;};
364
365         virtual void            SetCustomFlag2(bool bCustomFlag)                                                { m_ValFlags.CustomFlag2 = bCustomFlag;};
366         virtual bool            IsCustomFlag2()                                                                                 { return m_ValFlags.CustomFlag2;};
367                                                                                                                                                                 
368 protected:                                                                                                                                              
369         virtual void            DisableRefCount();                                                                              // Disable reference counting for this value
370         virtual void            AddDataToReplica(CValue* replica);                                              
371         virtual                         ~CValue();
372 private:                                                                                                                                                
373         // Member variables                                                                                                                     
374         std::map<STR_String,CValue*>*           m_pNamedPropertyArray;                                                                  // Properties for user/game etc
375         ValueFlags                      m_ValFlags;                                                                                             // Frequently used flags in a bitfield (low memoryusage)
376         int                                     m_refcount;                                                                                             // Reference Counter    
377         static  double m_sZeroVec[3];   
378
379 };
380
381
382
383 //
384 // Declare a CValue or CExpression or CWhatever to be serialized by the editor.
385 //
386 // This macro introduces the EdSerialize() function (which must be implemented by
387 // the client) and the EdIdSerialize() function (which is implemented by this macro).
388 //
389 // The generated Copy() function returns a pointer to <root_base_class_name> type
390 // of object. So, for *any* CValue-derived object this should be set to CValue,
391 // for *any* CExpression-derived object this should be set to CExpression.
392 //
393 #define PLUGIN_DECLARE_SERIAL(class_name, root_base_class_name)                                                                                 \
394 public:                                                                                                                                                                                                 \
395         virtual root_base_class_name *  Copy()                                  { return new class_name; }                                      \
396         virtual bool EdSerialize(CompressorArchive& arch,class CFactoryManager* facmgr,bool bIsStoring);    \
397         virtual bool EdIdSerialize(CompressorArchive& arch,class CFactoryManager* facmgr,bool bIsStoring)       \
398 {                                                                                                                                                                                                               \
399         if (bIsStoring)                                                                                                                                                                         \
400                 arch.StoreString(#class_name);                                                                                                                                  \
401                                                                                                                                                                                                                 \
402         return false;                                                                                                                                                                           \
403 }                                                                                                                                                                                                               \
404         
405
406 ////////////////////////////////////////////////////////////////////////////////
407 ////////////////////////////////////////////////////////////////////////////////
408 ////////////////////////////////////////////////////////////////////////////////
409
410 // CPropValue is a CValue derived class, that implements the identification (String name)
411 // SetName() / GetName(), 
412 // normal classes should derive from CPropValue, real lightweight classes straight from CValue
413
414
415 class CPropValue : public CValue
416 {
417 public:
418
419 #ifndef NO_EXP_PYTHON_EMBEDDING 
420         CPropValue(PyTypeObject* T=&Type) :
421           CValue(T),
422 #else
423         CPropValue() :
424 #endif //NO_EXP_PYTHON_EMBEDDING
425                 m_pstrNewName(NULL)
426
427         {
428         }
429         
430         virtual ~CPropValue()
431         {
432                 if (m_pstrNewName)
433                 {
434                         delete m_pstrNewName;
435                         m_pstrNewName = NULL;
436                 }
437         }
438         
439         virtual void                    SetName(STR_String name) {
440                 if (m_pstrNewName)
441                 {
442                         delete m_pstrNewName;
443                         m_pstrNewName = NULL;   
444                 }
445                 if (name.Length())
446                         m_pstrNewName = new STR_String(name);
447         }
448         virtual void                    ReplicaSetName(STR_String name) {
449                 m_pstrNewName=NULL;
450                 if (name.Length())
451                         m_pstrNewName = new STR_String(name);
452         }
453         
454         virtual STR_String                      GetName() {
455                 //STR_String namefromprop = GetPropertyText("Name");
456                 //if (namefromprop.Length() > 0)
457                 //      return namefromprop;
458                 
459                 if (m_pstrNewName)
460                 {
461                         return *m_pstrNewName;
462                 }
463                 return STR_String("");
464         };                                              // name of Value
465         
466 protected:
467         STR_String*                                     m_pstrNewName;                              // Identification
468 };
469
470 #endif // !defined _VALUEBASECLASS_H
471