svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r20937:21899
[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_MOD_OPERATOR,                     // %
79         VALUE_ADD_OPERATOR,                     // +
80         VALUE_SUB_OPERATOR,                     // -
81         VALUE_MUL_OPERATOR,                     // *
82         VALUE_DIV_OPERATOR,                     // /
83         VALUE_NEG_OPERATOR,                     // -
84         VALUE_POS_OPERATOR,                     // +
85         VALUE_AND_OPERATOR,                     // &&
86         VALUE_OR_OPERATOR,                      // ||
87         VALUE_EQL_OPERATOR,                     // ==
88         VALUE_NEQ_OPERATOR,                     // !=
89         VALUE_GRE_OPERATOR,                     // >
90         VALUE_LES_OPERATOR,                     // <
91         VALUE_GEQ_OPERATOR,                     // >=
92         VALUE_LEQ_OPERATOR,                     // <=
93         VALUE_NOT_OPERATOR,                     // !
94         VALUE_NO_OPERATOR                       // no operation at all
95 };
96
97 enum VALUE_DATA_TYPE {
98         VALUE_NO_TYPE,                          // abstract baseclass
99         VALUE_INT_TYPE,
100         VALUE_FLOAT_TYPE,
101         VALUE_STRING_TYPE,
102         VALUE_BOOL_TYPE,
103         VALUE_ERROR_TYPE,
104         VALUE_EMPTY_TYPE,
105         VALUE_SOLID_TYPE,
106         VALUE_COMBISOLID_TYPE,
107         VALUE_VECTOR_TYPE,
108         VALUE_MENU_TYPE,
109         VALUE_ACTOR_TYPE,
110         VALUE_MAX_TYPE                          //only here to provide number of types
111 };
112
113
114
115 #ifdef _DEBUG
116 //extern int gRefCountValue;            // debugonly variable to check if all CValue Refences are Dereferenced at programexit
117 #endif
118
119 struct HashableInt 
120 {
121         HashableInt(int id)                                                                                                                     : mData(id) { }
122
123         unsigned long                           Hash() const                                                                                    { return 0;} ////}gHash(&mData, sizeof(int));}
124         
125         bool                            operator==(HashableInt rhs)                                                             { return mData == rhs.mData; }
126         
127         int                                     mData;
128 };
129
130
131 //
132 // Bitfield that stores the flags for each CValue derived class
133 //
134 struct ValueFlags {
135         ValueFlags() :
136                 Modified(true),
137                 Selected(false),
138                 Affected(false),
139                 ReleaseRequested(false),
140                 Error(false),
141                 RefCountDisabled(false),
142                 HasProperties(false),
143                 HasName(false),
144                 Visible(true),
145                 CustomFlag1(false),
146                 CustomFlag2(false)
147         {
148         }
149
150         unsigned short Modified : 1;
151         unsigned short Selected : 1;
152         unsigned short Affected : 1;
153         unsigned short ReleaseRequested : 1;
154         unsigned short Error : 1;
155         unsigned short RefCountDisabled : 1;
156         unsigned short HasProperties : 1;
157         unsigned short HasName : 1;
158         unsigned short Visible : 1;
159         unsigned short CustomFlag1 : 1;
160         unsigned short CustomFlag2 : 1;
161
162         
163 };
164
165 /**
166  *      Base Class for all Actions performed on CValue's. Can be extended for undo/redo system in future.
167 */
168 class CAction
169 {
170 public:
171         CAction() {
172         };
173         virtual ~CAction(){
174         };
175         virtual void Execute() const =0;
176 };
177
178 //
179 // CValue
180 //
181 // Base class for all editor functionality, flexible object type that allows
182 // calculations and uses reference counting for memory management.
183 // 
184 //
185
186
187
188
189 #ifndef NO_EXP_PYTHON_EMBEDDING
190 #include "PyObjectPlus.h"
191 #include "object.h"
192 class CValue  : public PyObjectPlus
193 #else
194 class CValue  
195 #endif //NO_EXP_PYTHON_EMBEDDING
196
197
198 {
199 #ifndef NO_EXP_PYTHON_EMBEDDING
200 Py_Header;
201 #endif //NO_EXP_PYTHON_EMBEDDING
202 public:
203         enum AllocationTYPE {
204                 STACKVALUE              = 0,
205                 HEAPVALUE               = 1
206         };
207         
208         enum DrawTYPE {
209                 STARTFRAME              = 0,
210                 ENDFRAME                = 1,
211                 INTERFRAME              = 2
212         };
213
214
215         // Construction / Destruction
216 #ifndef NO_EXP_PYTHON_EMBEDDING
217
218         CValue();
219         //static PyObject*      PyMake(PyObject*,PyObject*);
220         virtual PyObject *py_repr(void)
221         {
222                 return PyUnicode_FromString((const char*)GetText());
223         }
224
225         virtual PyObject*       ConvertValueToPython() {
226                 return NULL;
227         }
228
229         virtual CValue* ConvertPythonToValue(PyObject* pyobj, const char *error_prefix);
230         
231         static PyObject * pyattr_get_name(void * self, const KX_PYATTRIBUTE_DEF * attrdef);
232         
233         virtual PyObject* ConvertKeysToPython( void );
234         
235         KX_PYMETHOD_NOARGS(CValue,GetName);
236
237 #else
238         CValue();
239 #endif //NO_EXP_PYTHON_EMBEDDING
240
241         
242         
243         // Expression Calculation
244         virtual CValue*         Calc(VALUE_OPERATOR op, CValue *val) = 0;
245         virtual CValue*         CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, CValue *val) = 0;
246         virtual void            SetOwnerExpression(class CExpression* expr);
247
248         
249
250         void                            Execute(const CAction& a)
251         {
252                 a.Execute();
253         };
254
255         /// Reference Counting
256         int                                     GetRefCount()                                                                                   
257         { 
258                 return m_refcount; 
259         }
260
261         // Add a reference to this value
262         CValue*                         AddRef()                                                                                                
263         {
264                 // Increase global reference count, used to see at the end of the program
265                 // if all CValue-derived classes have been dereferenced to 0
266                 //debug(gRefCountValue++);
267         #ifdef _DEBUG
268                 //gRefCountValue++;
269         #endif
270                 m_refcount++; 
271                 return this;
272         }
273
274         // Release a reference to this value (when reference count reaches 0, the value is removed from the heap)
275         int                     Release()                                                               
276         {
277                 // Decrease global reference count, used to see at the end of the program
278                 // if all CValue-derived classes have been dereferenced to 0
279                 //debug(gRefCountValue--);
280         #ifdef _DEBUG
281                 //gRefCountValue--;
282         #endif
283                 // Decrease local reference count, if it reaches 0 the object should be freed
284                 if (--m_refcount > 0)
285                 {
286                         // Reference count normal, return new reference count
287                         return m_refcount;
288                 }
289                 else
290                 {
291                         // Reference count reached 0, delete ourselves and return 0
292         //              MT_assert(m_refcount==0, "Reference count reached sub-zero, object released too much");
293                         
294                         delete this;
295                         return 0;
296                 }
297         }
298
299
300         /// Property Management
301         virtual void            SetProperty(const STR_String& name,CValue* ioProperty);                                         // Set property <ioProperty>, overwrites and releases a previous property with the same name if needed
302         virtual void            SetProperty(const char* name,CValue* ioProperty);
303         virtual CValue*         GetProperty(const char* inName);                                                        // Get pointer to a property with name <inName>, returns NULL if there is no property named <inName>
304         virtual CValue*         GetProperty(const STR_String & inName);
305         const STR_String&       GetPropertyText(const STR_String & inName);                                             // Get text description of property with name <inName>, returns an empty string if there is no property named <inName>
306         float                           GetPropertyNumber(const STR_String& inName,float defnumber);
307         virtual bool            RemoveProperty(const char *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
308         virtual vector<STR_String>      GetPropertyNames();
309         virtual void            ClearProperties();                                                                              // Clear all properties
310
311         virtual void            SetPropertiesModified(bool inModified);                                 // Set all properties' modified flag to <inModified>
312         virtual bool            IsAnyPropertyModified();                                                                // Check if any of the properties in this value have been modified
313
314         virtual CValue*         GetProperty(int inIndex);                                                               // Get property number <inIndex>
315         virtual int                     GetPropertyCount();                                                                             // Get the amount of properties assiocated with this value
316
317         virtual CValue*         FindIdentifier(const STR_String& identifiername);
318         /** Set the wireframe color of this value depending on the CSG
319          * operator type <op>
320          * @attention: not implemented */
321         virtual void            SetColorOperator(VALUE_OPERATOR op);
322
323         virtual const STR_String &      GetText() = 0;
324         virtual double          GetNumber() = 0;
325         double*                         ZeroVector() { return m_sZeroVec; };
326         virtual double*         GetVector3(bool bGetTransformedVec = false);
327
328         virtual STR_String&     GetName() = 0;                                                                                  // Retrieve the name of the value
329         virtual void            SetName(const char *name) = 0;                                                          // Set the name of the value
330         /** Sets the value to this cvalue.
331          * @attention this particular function should never be called. Why not abstract? */
332         virtual void            SetValue(CValue* newval);
333         virtual CValue*         GetReplica() =0;
334         virtual void                    ProcessReplica();
335         //virtual CValue*               Copy() = 0;
336         
337         
338         STR_String                              op2str(VALUE_OPERATOR op);
339                 
340         // setting / getting flags
341         inline void                     SetSelected(bool bSelected)                                                             { m_ValFlags.Selected = bSelected; }
342         virtual void            SetModified(bool bModified)                                                             { m_ValFlags.Modified = bModified; }
343         virtual void            SetAffected(bool bAffected=true)                                                { m_ValFlags.Affected = bAffected; }
344         inline void                     SetReleaseRequested(bool bReleaseRequested)                             { m_ValFlags.ReleaseRequested=bReleaseRequested; }
345         inline void                     SetError(bool err)                                                                              { m_ValFlags.Error=err; }
346         inline void                     SetVisible (bool vis)                                                                   { m_ValFlags.Visible=vis; }
347                                                                                                                                                                 
348         virtual bool            IsModified()                                                                                    { return m_ValFlags.Modified; }
349         inline bool                     IsError()                                                                                               { return m_ValFlags.Error; }
350         virtual bool            IsAffected()                                                                                    { return m_ValFlags.Affected || m_ValFlags.Modified; }
351         virtual bool            IsSelected()                                                                                    { return m_ValFlags.Selected; }
352         inline bool                     IsReleaseRequested()                                                                    { return m_ValFlags.ReleaseRequested; }
353         virtual bool            IsVisible()                                                                                             { return m_ValFlags.Visible;}
354         virtual void            SetCustomFlag1(bool bCustomFlag)                                                { m_ValFlags.CustomFlag1 = bCustomFlag;};
355         virtual bool            IsCustomFlag1()                                                                                 { return m_ValFlags.CustomFlag1;};
356
357         virtual void            SetCustomFlag2(bool bCustomFlag)                                                { m_ValFlags.CustomFlag2 = bCustomFlag;};
358         virtual bool            IsCustomFlag2()                                                                                 { return m_ValFlags.CustomFlag2;};
359
360 protected:                                                                                                                                              
361         virtual void            DisableRefCount();                                                                              // Disable reference counting for this value
362         //virtual void          AddDataToReplica(CValue* replica);                                              
363         virtual                         ~CValue();
364 private:
365         // Member variables                                                                                                                     
366         std::map<STR_String,CValue*>*           m_pNamedPropertyArray;                                                                  // Properties for user/game etc
367         ValueFlags                      m_ValFlags;                                                                                             // Frequently used flags in a bitfield (low memoryusage)
368         int                                     m_refcount;                                                                                             // Reference Counter    
369         static  double m_sZeroVec[3];   
370
371 };
372
373
374
375 //
376 // Declare a CValue or CExpression or CWhatever to be serialized by the editor.
377 //
378 // This macro introduces the EdSerialize() function (which must be implemented by
379 // the client) and the EdIdSerialize() function (which is implemented by this macro).
380 //
381 // The generated Copy() function returns a pointer to <root_base_class_name> type
382 // of object. So, for *any* CValue-derived object this should be set to CValue,
383 // for *any* CExpression-derived object this should be set to CExpression.
384 //
385 #define PLUGIN_DECLARE_SERIAL(class_name, root_base_class_name)                                                                                 \
386 public:                                                                                                                                                                                                 \
387         virtual root_base_class_name *  Copy()                                  { return new class_name; }                                      \
388         virtual bool EdSerialize(CompressorArchive& arch,class CFactoryManager* facmgr,bool bIsStoring);    \
389         virtual bool EdIdSerialize(CompressorArchive& arch,class CFactoryManager* facmgr,bool bIsStoring)       \
390 {                                                                                                                                                                                                               \
391         if (bIsStoring)                                                                                                                                                                         \
392                 arch.StoreString(#class_name);                                                                                                                                  \
393                                                                                                                                                                                                                 \
394         return false;                                                                                                                                                                           \
395 }                                                                                                                                                                                                               \
396         
397
398 ////////////////////////////////////////////////////////////////////////////////
399 ////////////////////////////////////////////////////////////////////////////////
400 ////////////////////////////////////////////////////////////////////////////////
401
402 // CPropValue is a CValue derived class, that implements the identification (String name)
403 // SetName() / GetName(), 
404 // normal classes should derive from CPropValue, real lightweight classes straight from CValue
405
406
407 class CPropValue : public CValue
408 {
409 public:
410
411 #ifndef NO_EXP_PYTHON_EMBEDDING 
412         CPropValue() :
413           CValue(),
414 #else
415         CPropValue() :
416 #endif //NO_EXP_PYTHON_EMBEDDING
417                 m_strNewName()
418
419         {
420         }
421         
422         virtual ~CPropValue()
423         {
424         }
425         
426         virtual void                    SetName(const char *name) {
427                 m_strNewName = name;
428         }
429         
430         virtual STR_String&                     GetName() {
431                 //STR_String namefromprop = GetPropertyText("Name");
432                 //if (namefromprop.Length() > 0)
433                 //      return namefromprop;
434                 return m_strNewName;
435         };                                              // name of Value
436         
437 protected:
438         STR_String                                      m_strNewName;                               // Identification
439 };
440
441 #endif // !defined _VALUEBASECLASS_H
442