BGE Py API using python3 c/api calls. include bpy_compat.h to support py2.x
[blender.git] / source / gameengine / Expressions / ListValue.cpp
1 // ListValue.cpp: implementation of the CListValue class.
2 //
3 //////////////////////////////////////////////////////////////////////
4 /*
5  * Copyright (c) 1996-2000 Erwin Coumans <coockie@acm.org>
6  *
7  * Permission to use, copy, modify, distribute and sell this software
8  * and its documentation for any purpose is hereby granted without fee,
9  * provided that the above copyright notice appear in all copies and
10  * that both that copyright notice and this permission notice appear
11  * in supporting documentation.  Erwin Coumans makes no
12  * representations about the suitability of this software for any
13  * purpose.  It is provided "as is" without express or implied warranty.
14  *
15  */
16
17 #include "ListValue.h"
18 #include "StringValue.h"
19 #include "VoidValue.h"
20 #include <algorithm>
21 #include "BoolValue.h"
22
23 #include "BLO_sys_types.h" /* for intptr_t support */
24
25 #ifdef HAVE_CONFIG_H
26 #include <config.h>
27 #endif
28
29 #if  ((PY_MAJOR_VERSION == 2) &&(PY_MINOR_VERSION < 5))
30 #define Py_ssize_t int
31 #endif
32
33 Py_ssize_t listvalue_bufferlen(PyObject* self)
34 {
35         CListValue *list= static_cast<CListValue *>(BGE_PROXY_REF(self));
36         if (list==NULL)
37                 return 0;
38         
39         return (Py_ssize_t)list->GetCount();
40 }
41
42 PyObject* listvalue_buffer_item(PyObject* self, Py_ssize_t index)
43 {
44         CListValue *list= static_cast<CListValue *>(BGE_PROXY_REF(self));
45         CValue *cval;
46         
47         if (list==NULL) {
48                 PyErr_SetString(PyExc_SystemError, "val = CList[i], "BGE_PROXY_ERROR_MSG);
49                 return NULL;
50         }
51         
52         int count = list->GetCount();
53         
54         if (index < 0)
55                 index = count+index;
56         
57         if (index < 0 || index >= count) {
58                 PyErr_SetString(PyExc_IndexError, "CList[i]: Python ListIndex out of range in CValueList");
59                 return NULL;
60         }
61         
62         cval= list->GetValue(index);
63         
64         PyObject* pyobj = cval->ConvertValueToPython();
65         if (pyobj)
66                 return pyobj;
67         else
68                 return cval->GetProxy();
69 }
70
71 PyObject* listvalue_mapping_subscript(PyObject* self, PyObject* pyindex)
72 {
73         CListValue *list= static_cast<CListValue *>(BGE_PROXY_REF(self));
74         if (list==NULL) {
75                 PyErr_SetString(PyExc_SystemError, "value = CList[i], "BGE_PROXY_ERROR_MSG);
76                 return NULL;
77         }
78         
79         if (PyUnicode_Check(pyindex))
80         {
81                 CValue *item = ((CListValue*) list)->FindValue(_PyUnicode_AsString(pyindex));
82                 if (item) {
83                         PyObject* pyobj = item->ConvertValueToPython();
84                         if(pyobj)
85                                 return pyobj;
86                         else
87                                 return item->GetProxy();
88                 }
89         }
90         else if (PyLong_Check(pyindex))
91         {
92                 int index = PyLong_AsSsize_t(pyindex);
93                 return listvalue_buffer_item(self, index); /* wont add a ref */
94         }
95         
96         PyObject *pyindex_str = PyObject_Repr(pyindex); /* new ref */
97         PyErr_Format(PyExc_KeyError, "CList[key]: '%s' key not in list", _PyUnicode_AsString(pyindex_str));
98         Py_DECREF(pyindex_str);
99         return NULL;
100 }
101
102
103 /* just slice it into a python list... */
104 PyObject* listvalue_buffer_slice(PyObject* self,Py_ssize_t ilow, Py_ssize_t ihigh)
105 {
106         CListValue *list= static_cast<CListValue *>(BGE_PROXY_REF(self));
107         if (list==NULL) {
108                 PyErr_SetString(PyExc_SystemError, "val = CList[i:j], "BGE_PROXY_ERROR_MSG);
109                 return NULL;
110         }
111         
112         int i, j;
113         PyObject *newlist;
114
115         if (ilow < 0) ilow = 0;
116
117         int n = ((CListValue*) list)->GetCount();
118
119         if (ihigh >= n)
120                 ihigh = n;
121     if (ihigh < ilow)
122         ihigh = ilow;
123
124         newlist = PyList_New(ihigh - ilow);
125         if (!newlist)
126                 return NULL;
127
128         for (i = ilow, j = 0; i < ihigh; i++, j++)
129         {
130                 PyObject* pyobj = list->GetValue(i)->ConvertValueToPython();
131                 if (!pyobj)
132                         pyobj = list->GetValue(i)->GetProxy();
133                 PyList_SET_ITEM(newlist, i, pyobj);
134         }       
135         return newlist;
136 }
137
138
139 /* clist + list, return a list that python owns */
140 static PyObject *listvalue_buffer_concat(PyObject * self, PyObject * other)
141 {
142         CListValue *listval= static_cast<CListValue *>(BGE_PROXY_REF(self));
143         int i, numitems, numitems_orig;
144         
145         if (listval==NULL) {
146                 PyErr_SetString(PyExc_SystemError, "CList+other, "BGE_PROXY_ERROR_MSG);
147                 return NULL;
148         }
149         
150         numitems_orig= listval->GetCount();
151         
152         // for now, we support CListValue concatenated with items
153         // and CListValue concatenated to Python Lists
154         // and CListValue concatenated with another CListValue
155         
156         /* Shallow copy, dont use listval->GetReplica(), it will screw up with KX_GameObjects */
157         CListValue* listval_new = new CListValue();
158         
159         if (PyList_Check(other))
160         {
161                 CValue* listitemval;
162                 bool error = false;
163                 
164                 numitems = PyList_Size(other);
165                 
166                 /* copy the first part of the list */
167                 listval_new->Resize(numitems_orig + numitems);
168                 for (i=0;i<numitems_orig;i++)
169                         listval_new->SetValue(i, listval->GetValue(i)->AddRef());
170                 
171                 for (i=0;i<numitems;i++)
172                 {
173                         listitemval = listval->ConvertPythonToValue(PyList_GetItem(other,i), "cList + pyList: CListValue, ");
174                         
175                         if (listitemval) {
176                                 listval_new->SetValue(i+numitems_orig, listitemval);
177                         } else {
178                                 error= true;
179                                 break;
180                         }
181                 }
182                 
183                 if (error) {
184                         listval_new->Resize(numitems_orig+i); /* resize so we dont try release NULL pointers */
185                         listval_new->Release();
186                         return NULL; /* ConvertPythonToValue above sets the error */ 
187                 }
188         
189         }
190         else if (PyObject_TypeCheck(other, &CListValue::Type)) {
191                 // add items from otherlist to this list
192                 CListValue* otherval = static_cast<CListValue *>(BGE_PROXY_REF(other));
193                 if(otherval==NULL) {
194                         listval_new->Release();
195                         PyErr_SetString(PyExc_SystemError, "CList+other, "BGE_PROXY_ERROR_MSG);
196                         return NULL;
197                 }
198                 
199                 numitems = otherval->GetCount();
200                 
201                 /* copy the first part of the list */
202                 listval_new->Resize(numitems_orig + numitems); /* resize so we dont try release NULL pointers */
203                 for (i=0;i<numitems_orig;i++)
204                         listval_new->SetValue(i, listval->GetValue(i)->AddRef());
205                 
206                 /* now copy the other part of the list */
207                 for (i=0;i<numitems;i++)
208                         listval_new->SetValue(i+numitems_orig, otherval->GetValue(i)->AddRef());
209                 
210         }
211         return listval_new->NewProxy(true); /* python owns this list */
212 }
213
214 static int listvalue_buffer_contains(PyObject *self_v, PyObject *value)
215 {
216         CListValue *self= static_cast<CListValue *>(BGE_PROXY_REF(self_v));
217         
218         if (self==NULL) {
219                 PyErr_SetString(PyExc_SystemError, "val in CList, "BGE_PROXY_ERROR_MSG);
220                 return -1;
221         }
222         
223         if (PyUnicode_Check(value)) {
224                 if (self->FindValue((const char *)_PyUnicode_AsString(value))) {
225                         return 1;
226                 }
227         }
228         else if (BGE_PROXY_CHECK_TYPE(value)) { /* not dict like at all but this worked before __contains__ was used */
229                 CValue *item= static_cast<CValue *>(BGE_PROXY_REF(value));
230                 for (int i=0; i < self->GetCount(); i++)
231                         if (self->GetValue(i) == item) // Com
232                                 return 1;
233                 
234         } // not using CheckEqual
235         
236         return 0;
237 }
238
239
240 static  PySequenceMethods listvalue_as_sequence = {
241         listvalue_bufferlen,//(inquiry)buffer_length, /*sq_length*/
242         listvalue_buffer_concat, /*sq_concat*/
243         NULL, /*sq_repeat*/
244         listvalue_buffer_item, /*sq_item*/
245 #if (PY_VERSION_HEX >= 0x03000000) // TODO, slicing in py3?
246         NULL,
247         NULL,
248         NULL,
249 #else
250         listvalue_buffer_slice, /*sq_slice*/
251         NULL, /*sq_ass_item*/
252         NULL, /*sq_ass_slice*/
253 #endif
254         (objobjproc)listvalue_buffer_contains,  /* sq_contains */
255 };
256
257
258
259 /* Is this one used ? */
260 static  PyMappingMethods instance_as_mapping = {
261         listvalue_bufferlen, /*mp_length*/
262         listvalue_mapping_subscript, /*mp_subscript*/
263         NULL /*mp_ass_subscript*/
264 };
265
266
267
268 PyTypeObject CListValue::Type = {
269 #if (PY_VERSION_HEX >= 0x02060000)
270         PyVarObject_HEAD_INIT(NULL, 0)
271 #else
272         /* python 2.5 and below */
273         PyObject_HEAD_INIT( NULL )  /* required py macro */
274         0,                              /*ob_size*/
275 #endif
276         "CListValue",                   /*tp_name*/
277         sizeof(PyObjectPlus_Proxy), /*tp_basicsize*/
278         0,                              /*tp_itemsize*/
279         /* methods */
280         py_base_dealloc,                        /*tp_dealloc*/
281         0,                              /*tp_print*/
282         0,                      /*tp_getattr*/
283         0,                      /*tp_setattr*/
284         0,                              /*tp_compare*/
285         py_base_repr,                           /*tp_repr*/
286         0,                              /*tp_as_number*/
287         &listvalue_as_sequence, /*tp_as_sequence*/
288         &instance_as_mapping,           /*tp_as_mapping*/
289         0,                              /*tp_hash*/
290         0,                              /*tp_call */
291         0,
292         NULL, //py_base_getattro,
293         NULL, //py_base_setattro,
294         0,
295         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
296         0,0,0,0,0,0,0,
297         Methods,
298         0,
299         0,
300         &CValue::Type
301 };
302
303 PyMethodDef CListValue::Methods[] = {
304         /* List style access */
305         {"append", (PyCFunction)CListValue::sPyappend,METH_O},
306         {"reverse", (PyCFunction)CListValue::sPyreverse,METH_NOARGS},
307         {"index", (PyCFunction)CListValue::sPyindex,METH_O},
308         {"count", (PyCFunction)CListValue::sPycount,METH_O},
309         
310         /* Dict style access */
311         {"get", (PyCFunction)CListValue::sPyget,METH_VARARGS},
312         {"has_key", (PyCFunction)CListValue::sPyhas_key,METH_O},
313         
314         /* Own cvalue funcs */
315         {"from_id", (PyCFunction)CListValue::sPyfrom_id,METH_O},
316         
317         {NULL,NULL} //Sentinel
318 };
319
320 PyAttributeDef CListValue::Attributes[] = {
321         { NULL }        //Sentinel
322 };
323
324 //////////////////////////////////////////////////////////////////////
325 // Construction/Destruction
326 //////////////////////////////////////////////////////////////////////
327
328 CListValue::CListValue()
329 : CPropValue()
330 {
331         m_bReleaseContents=true;        
332 }
333
334
335
336 CListValue::~CListValue()
337 {
338
339         if (m_bReleaseContents) {
340                 for (unsigned int i=0;i<m_pValueArray.size();i++) {
341                         m_pValueArray[i]->Release();
342                 }
343         }
344 }
345
346
347 static STR_String gstrListRep=STR_String("List");
348
349 const STR_String & CListValue::GetText()
350 {
351         gstrListRep = "[";
352         STR_String commastr = "";
353
354         for (int i=0;i<GetCount();i++)
355         {
356                 gstrListRep += commastr;
357                 gstrListRep += GetValue(i)->GetText();
358                 commastr = ",";
359         }
360         gstrListRep += "]";
361
362         return gstrListRep;
363 }
364
365
366
367 CValue* CListValue::GetReplica() { 
368         CListValue* replica = new CListValue(*this);
369
370         replica->ProcessReplica();
371
372         replica->m_bReleaseContents=true; // for copy, complete array is copied for now...
373         // copy all values
374         int numelements = m_pValueArray.size();
375         unsigned int i=0;
376         replica->m_pValueArray.resize(numelements);
377         for (i=0;i<m_pValueArray.size();i++)
378                 replica->m_pValueArray[i] = m_pValueArray[i]->GetReplica();
379
380
381         return replica;
382 };
383
384
385
386 void CListValue::SetValue(int i, CValue *val)
387 {
388         assertd(i < m_pValueArray.size());
389         m_pValueArray[i]=val;
390 }
391
392
393
394 void CListValue::Resize(int num)
395 {
396         m_pValueArray.resize(num);
397 }
398
399
400
401 void CListValue::Remove(int i)
402 {
403         assertd(i<m_pValueArray.size());
404         m_pValueArray.erase(m_pValueArray.begin()+i);
405 }
406
407
408
409 void CListValue::ReleaseAndRemoveAll()
410 {
411         for (unsigned int i=0;i<m_pValueArray.size();i++)
412                 m_pValueArray[i]->Release();
413         m_pValueArray.clear();//.Clear();
414 }
415
416
417
418 CValue* CListValue::FindValue(const STR_String & name)
419 {
420         for (int i=0; i < GetCount(); i++)
421                 if (GetValue(i)->GetName() == name)
422                         return GetValue(i);
423         
424         return NULL;
425 }
426
427 CValue* CListValue::FindValue(const char * name)
428 {
429         for (int i=0; i < GetCount(); i++)
430                 if (GetValue(i)->GetName() == name)
431                         return GetValue(i);
432         
433         return NULL;
434 }
435
436 bool CListValue::SearchValue(CValue *val)
437 {
438         for (int i=0;i<GetCount();i++)
439                 if (val == GetValue(i))
440                         return true;
441         return false;
442 }
443
444
445
446 void CListValue::SetReleaseOnDestruct(bool bReleaseContents)
447 {
448         m_bReleaseContents = bReleaseContents;
449 }
450
451
452
453 bool CListValue::RemoveValue(CValue *val)
454 {
455         bool result=false;
456
457         for (int i=GetCount()-1;i>=0;i--)
458                 if (val == GetValue(i))
459                 {
460                         Remove(i);
461                         result=true;
462                 }
463         return result;
464 }
465
466
467
468 void CListValue::MergeList(CListValue *otherlist)
469 {
470
471         int numelements = this->GetCount();
472         int numotherelements = otherlist->GetCount();
473
474
475         Resize(numelements+numotherelements);
476
477         for (int i=0;i<numotherelements;i++)
478         {
479                 SetValue(i+numelements,otherlist->GetValue(i)->AddRef());
480         }
481 }
482
483
484 PyObject* CListValue::Pyappend(PyObject* value)
485 {
486         CValue* objval = ConvertPythonToValue(value, "CList.append(i): CValueList, ");
487
488         if (!objval) /* ConvertPythonToValue sets the error */
489                 return NULL;
490         
491         if (!BGE_PROXY_PYOWNS(m_proxy)) {
492                 PyErr_SetString(PyExc_TypeError, "CList.append(i): this CValueList is used internally for the game engine and can't be modified");
493                 return NULL;
494         }
495         
496         Add(objval);
497         
498         Py_RETURN_NONE;
499 }
500
501
502
503 PyObject* CListValue::Pyreverse()
504 {
505         std::reverse(m_pValueArray.begin(),m_pValueArray.end());
506         Py_RETURN_NONE;
507 }
508
509
510
511 bool CListValue::CheckEqual(CValue* first,CValue* second)
512 {
513         bool result = false;
514         
515         CValue* eqval =  ((CValue*)first)->Calc(VALUE_EQL_OPERATOR,(CValue*)second);
516         
517         if (eqval==NULL)
518                 return false;
519         const STR_String& text = eqval->GetText();
520         if (&text==&CBoolValue::sTrueString)
521         {
522                 result = true;
523         }
524         eqval->Release();
525         return result;
526
527 }
528
529
530
531 PyObject* CListValue::Pyindex(PyObject *value)
532 {
533         PyObject* result = NULL;
534
535         CValue* checkobj = ConvertPythonToValue(value, "val = cList[i]: CValueList, ");
536         if (checkobj==NULL)
537                 return NULL; /* ConvertPythonToValue sets the error */
538
539         int numelem = GetCount();
540         for (int i=0;i<numelem;i++)
541         {
542                 CValue* elem =                  GetValue(i);
543                 if (checkobj==elem || CheckEqual(checkobj,elem))
544                 {
545                         result = PyLong_FromSsize_t(i);
546                         break;
547                 }
548         }
549         checkobj->Release();
550
551         if (result==NULL) {
552                 PyErr_SetString(PyExc_ValueError, "CList.index(x): x not in CListValue");
553         }
554         return result;
555         
556 }
557
558
559
560 PyObject* CListValue::Pycount(PyObject* value)
561 {
562         int numfound = 0;
563
564         CValue* checkobj = ConvertPythonToValue(value, ""); /* error ignored */
565         
566         if (checkobj==NULL) { /* in this case just return that there are no items in the list */
567                 PyErr_Clear();
568                 return PyLong_FromSsize_t(0);
569         }
570
571         int numelem = GetCount();
572         for (int i=0;i<numelem;i++)
573         {
574                 CValue* elem =                  GetValue(i);
575                 if (checkobj==elem || CheckEqual(checkobj,elem))
576                 {
577                         numfound ++;
578                 }
579         }
580         checkobj->Release();
581
582         return PyLong_FromSsize_t(numfound);
583 }
584
585 /* Matches python dict.get(key, [default]) */
586 PyObject* CListValue::Pyget(PyObject *args)
587 {
588         char *key;
589         PyObject* def = Py_None;
590
591         if (!PyArg_ParseTuple(args, "s|O:get", &key, &def))
592                 return NULL;
593         
594         CValue *item = FindValue((const char *)key);
595         if (item) {     
596                 PyObject* pyobj = item->ConvertValueToPython();
597                 if (pyobj)
598                         return pyobj;
599                 else
600                         return item->GetProxy();
601         }
602         Py_INCREF(def);
603         return def;
604 }
605
606 /* Matches python dict.has_key() */
607 PyObject* CListValue::Pyhas_key(PyObject* value)
608 {
609         if (PyUnicode_Check(value) && FindValue((const char *)_PyUnicode_AsString(value)))
610                 Py_RETURN_TRUE;
611         
612         Py_RETURN_FALSE;
613 }
614
615 PyObject* CListValue::Pyfrom_id(PyObject* value)
616 {
617         uintptr_t id= (uintptr_t)PyLong_AsVoidPtr(value);
618         
619         if (PyErr_Occurred())
620                 return NULL;
621
622         int numelem = GetCount();
623         for (int i=0;i<numelem;i++)
624         {
625                 if (reinterpret_cast<uintptr_t>(m_pValueArray[i]->m_proxy) == id)
626                         return GetValue(i)->GetProxy();
627         }
628         PyErr_SetString(PyExc_IndexError, "from_id(#): id not found in CValueList");
629         return NULL;    
630
631 }
632
633
634 /* --------------------------------------------------------------------- 
635  * Some stuff taken from the header
636  * --------------------------------------------------------------------- */
637 CValue* CListValue::Calc(VALUE_OPERATOR op,CValue *val) 
638 {
639         //assert(false); // todo: implement me!
640         static int error_printed =  0;
641         if (error_printed==0) {
642                 fprintf(stderr, "CValueList::Calc not yet implimented\n");
643                 error_printed = 1;
644         }
645         return NULL;
646 }
647
648 CValue* CListValue::CalcFinal(VALUE_DATA_TYPE dtype,
649                                                           VALUE_OPERATOR op, 
650                                                           CValue* val) 
651 {
652         //assert(false); // todo: implement me!
653         static int error_printed =  0;
654         if (error_printed==0) {
655                 fprintf(stderr, "CValueList::CalcFinal not yet implimented\n");
656                 error_printed = 1;
657         }
658         return NULL;
659 }
660
661
662
663 void CListValue::Add(CValue* value)
664 {
665         m_pValueArray.push_back(value);
666 }
667
668
669
670 double CListValue::GetNumber()
671 {
672         return -1;
673 }
674
675
676
677 void CListValue::SetModified(bool bModified)
678 {       
679         CValue::SetModified(bModified);
680         int numels = GetCount();
681
682         for (int i=0;i<numels;i++)
683                 GetValue(i)->SetModified(bModified);
684 }
685
686
687
688 bool CListValue::IsModified()
689 {
690         bool bmod = CValue::IsModified(); //normal own flag
691         int numels = GetCount();
692
693         for (int i=0;i<numels;i++)
694                 bmod = bmod || GetValue(i)->IsModified();
695
696         return bmod;
697 }