104027c099767f1d71ebf525d716fa24a5203c2e
[blender.git] / source / blender / python / intern / bpy_props.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include "bpy_props.h"
26 #include "bpy_rna.h"
27 #include "bpy_util.h"
28
29 #include "BKE_utildefines.h"
30
31 #include "RNA_define.h" /* for defining our own rna */
32 #include "RNA_enum_types.h"
33
34 #include "MEM_guardedalloc.h"
35
36 #include "../generic/py_capi_utils.h"
37
38 EnumPropertyItem property_flag_items[] = {
39         {PROP_HIDDEN, "HIDDEN", 0, "Hidden", ""},
40         {PROP_ANIMATABLE, "ANIMATABLE", 0, "Animateable", ""},
41         {0, NULL, 0, NULL, NULL}};
42
43 /* subtypes */
44 EnumPropertyItem property_subtype_string_items[] = {
45         {PROP_FILEPATH, "FILE_PATH", 0, "File Path", ""},
46         {PROP_DIRPATH, "DIR_PATH", 0, "Directory Path", ""},
47         {PROP_FILENAME, "FILENAME", 0, "Filename", ""},
48
49         {PROP_NONE, "NONE", 0, "None", ""},
50         {0, NULL, 0, NULL, NULL}};
51
52 EnumPropertyItem property_subtype_number_items[] = {
53         {PROP_UNSIGNED, "UNSIGNED", 0, "Unsigned", ""},
54         {PROP_PERCENTAGE, "PERCENTAGE", 0, "Percentage", ""},
55         {PROP_FACTOR, "FACTOR", 0, "Factor", ""},
56         {PROP_ANGLE, "ANGLE", 0, "Angle", ""},
57         {PROP_TIME, "TIME", 0, "Time", ""},
58         {PROP_DISTANCE, "DISTANCE", 0, "Distance", ""},
59
60         {PROP_NONE, "NONE", 0, "None", ""},
61         {0, NULL, 0, NULL, NULL}};
62
63 EnumPropertyItem property_subtype_array_items[] = {
64         {PROP_COLOR, "COLOR", 0, "Color", ""},
65         {PROP_TRANSLATION, "TRANSLATION", 0, "Translation", ""},
66         {PROP_DIRECTION, "DIRECTION", 0, "Direction", ""},
67         {PROP_VELOCITY, "VELOCITY", 0, "Velocity", ""},
68         {PROP_ACCELERATION, "ACCELERATION", 0, "Acceleration", ""},
69         {PROP_MATRIX, "MATRIX", 0, "Matrix", ""},
70         {PROP_EULER, "EULER", 0, "Euler", ""},
71         {PROP_QUATERNION, "QUATERNION", 0, "Quaternion", ""},
72         {PROP_AXISANGLE, "AXISANGLE", 0, "Axis Angle", ""},
73         {PROP_XYZ, "XYZ", 0, "XYZ", ""},
74         {PROP_COLOR_GAMMA, "COLOR_GAMMA", 0, "Color Gamma", ""},
75         {PROP_LAYER, "LAYER", 0, "Layer", ""},
76
77         {PROP_NONE, "NONE", 0, "None", ""},
78         {0, NULL, 0, NULL, NULL}};
79
80 /* PyObject's */
81 static PyObject *pymeth_BoolProperty = NULL;
82 static PyObject *pymeth_BoolVectorProperty = NULL;
83 static PyObject *pymeth_IntProperty = NULL;
84 static PyObject *pymeth_IntVectorProperty = NULL;
85 static PyObject *pymeth_FloatProperty = NULL;
86 static PyObject *pymeth_FloatVectorProperty = NULL;
87 static PyObject *pymeth_StringProperty = NULL;
88 static PyObject *pymeth_EnumProperty = NULL;
89 static PyObject *pymeth_PointerProperty = NULL;
90 static PyObject *pymeth_CollectionProperty = NULL;
91 static PyObject *pymeth_RemoveProperty = NULL;
92
93
94 /* operators and classes use this so it can store the args given but defer
95  * running it until the operator runs where these values are used to setup
96  * the default args for that operator instance */
97 static PyObject *bpy_prop_deferred_return(PyObject *func, PyObject *kw)
98 {
99         PyObject *ret = PyTuple_New(2);
100         PyTuple_SET_ITEM(ret, 0, func);
101         Py_INCREF(func);
102
103         if(kw==NULL)
104                 kw= PyDict_New();
105         else
106                 Py_INCREF(kw);
107
108         PyTuple_SET_ITEM(ret, 1, kw);
109
110         return ret;
111 }
112
113 /* this define runs at the start of each function and deals with 
114  * returning a deferred property (to be registed later) */
115 #define BPY_PROPDEF_HEAD(_func) \
116         if (PyTuple_GET_SIZE(args) == 1) { \
117                 PyObject *ret; \
118                 self= PyTuple_GET_ITEM(args, 0); \
119                 args= PyTuple_New(0); \
120                 ret= BPy_##_func(self, args, kw); \
121                 Py_DECREF(args); \
122                 return ret; \
123         } \
124         else if (PyTuple_GET_SIZE(args) > 1) { \
125                  PyErr_SetString(PyExc_ValueError, "all args must be keywords"); \
126                 return NULL; \
127         } \
128         srna= srna_from_self(self, #_func"(...):"); \
129         if(srna==NULL) { \
130                 if(PyErr_Occurred()) \
131                         return NULL; \
132                 return bpy_prop_deferred_return((void *)pymeth_##_func, kw); \
133         } \
134
135
136 #if 0
137 static int bpy_struct_id_used(StructRNA *srna, char *identifier)
138 {
139         PointerRNA ptr;
140         RNA_pointer_create(NULL, srna, NULL, &ptr);
141         return (RNA_struct_find_property(&ptr, identifier) != NULL);
142 }
143 #endif
144
145
146 /* Function that sets RNA, NOTE - self is NULL when called from python, but being abused from C so we can pass the srna allong
147  * This isnt incorrect since its a python object - but be careful */
148 static char BPy_BoolProperty_doc[] =
149 ".. function:: BoolProperty(name=\"\", description=\"\", default=False, options={'ANIMATABLE'}, subtype='NONE')\n"
150 "\n"
151 "   Returns a new boolean property definition.\n"
152 "\n"
153 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
154 "   :type options: set\n"
155 "   :arg subtype: Enumerator in ['UNSIGNED', 'PERCENTAGE', 'FACTOR', 'ANGLE', 'TIME', 'DISTANCE', 'NONE'].\n"
156 "   :type subtype: string";
157
158 static PyObject *BPy_BoolProperty(PyObject *self, PyObject *args, PyObject *kw)
159 {
160         StructRNA *srna;
161
162         BPY_PROPDEF_HEAD(BoolProperty)
163
164         if(srna) {
165                 static char *kwlist[] = {"attr", "name", "description", "default", "options", "subtype", NULL};
166                 char *id=NULL, *name="", *description="";
167                 int def=0;
168                 PropertyRNA *prop;
169                 PyObject *pyopts= NULL;
170                 int opts=0;
171                 char *pysubtype= NULL;
172                 int subtype= PROP_NONE;
173
174                 if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ssiO!s:BoolProperty", (char **)kwlist, &id, &name, &description, &def, &PySet_Type, &pyopts, &pysubtype))
175                         return NULL;
176
177                 if(RNA_def_property_free_identifier(srna, id) == -1) {
178                         PyErr_Format(PyExc_TypeError, "BoolProperty(): '%s' is defined as a non-dynamic type.", id);
179                         return NULL;
180                 }
181
182                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "BoolProperty(options={...}):"))
183                         return NULL;
184
185                 if(pysubtype && RNA_enum_value_from_id(property_subtype_number_items, pysubtype, &subtype)==0) {
186                         PyErr_Format(PyExc_TypeError, "BoolProperty(subtype='%s'): invalid subtype.", pysubtype);
187                         return NULL;
188                 }
189
190                 // prop= RNA_def_boolean(srna, id, def, name, description);
191                 prop= RNA_def_property(srna, id, PROP_BOOLEAN, subtype);
192                 RNA_def_property_boolean_default(prop, def);
193                 RNA_def_property_ui_text(prop, name, description);
194
195                 if(pyopts) {
196                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
197                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
198                 }
199                 RNA_def_property_duplicate_pointers(srna, prop);
200         }
201
202         Py_RETURN_NONE;
203 }
204
205 static char BPy_BoolVectorProperty_doc[] =
206 ".. function:: BoolVectorProperty(name=\"\", description=\"\", default=(False, False, False), options={'ANIMATABLE'}, subtype='NONE', size=3)\n"
207 "\n"
208 "   Returns a new vector boolean property definition.\n"
209 "\n"
210 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
211 "   :type options: set\n"
212 "   :arg subtype: Enumerator in ['COLOR', 'TRANSLATION', 'DIRECTION', 'VELOCITY', 'ACCELERATION', 'MATRIX', 'EULER', 'QUATERNION', 'AXISANGLE', 'XYZ', 'COLOR_GAMMA', 'LAYER', 'NONE'].\n"
213 "   :type subtype: string";
214 static PyObject *BPy_BoolVectorProperty(PyObject *self, PyObject *args, PyObject *kw)
215 {
216         StructRNA *srna;
217
218         BPY_PROPDEF_HEAD(BoolVectorProperty)
219
220         if(srna) {
221                 static const char *kwlist[] = {"attr", "name", "description", "default", "options", "subtype", "size", NULL};
222                 char *id=NULL, *name="", *description="";
223                 int def[PYRNA_STACK_ARRAY]={0};
224                 int size=3;
225                 PropertyRNA *prop;
226                 PyObject *pydef= NULL;
227                 PyObject *pyopts= NULL;
228                 int opts=0;
229                 char *pysubtype= NULL;
230                 int subtype= PROP_NONE;
231
232                 if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ssOO!si:BoolVectorProperty", (char **)kwlist, &id, &name, &description, &pydef, &PySet_Type, &pyopts, &pysubtype, &size))
233                         return NULL;
234
235                 if(RNA_def_property_free_identifier(srna, id) == -1) {
236                         PyErr_Format(PyExc_TypeError, "BoolVectorProperty(): '%s' is defined as a non-dynamic type.", id);
237                         return NULL;
238                 }
239
240                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "BoolVectorProperty(options={...}):"))
241                         return NULL;
242
243                 if(pysubtype && RNA_enum_value_from_id(property_subtype_array_items, pysubtype, &subtype)==0) {
244                         PyErr_Format(PyExc_TypeError, "BoolVectorProperty(subtype='%s'): invalid subtype.", pysubtype);
245                         return NULL;
246                 }
247
248                 if(size < 1 || size > PYRNA_STACK_ARRAY) {
249                         PyErr_Format(PyExc_TypeError, "BoolVectorProperty(size=%d): size must be between 0 and %d.", size, PYRNA_STACK_ARRAY);
250                         return NULL;
251                 }
252
253                 if(pydef && PyC_AsArray(def, pydef, size, &PyBool_Type, "BoolVectorProperty(default=sequence)") < 0)
254                         return NULL;
255
256                 // prop= RNA_def_boolean_array(srna, id, size, pydef ? def:NULL, name, description);
257                 prop= RNA_def_property(srna, id, PROP_BOOLEAN, subtype);
258                 RNA_def_property_array(prop, size);
259                 if(pydef) RNA_def_property_boolean_array_default(prop, def);
260                 RNA_def_property_ui_text(prop, name, description);
261
262                 if(pyopts) {
263                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
264                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
265                 }
266                 RNA_def_property_duplicate_pointers(srna, prop);
267         }
268         
269         Py_RETURN_NONE;
270 }
271
272 static char BPy_IntProperty_doc[] =
273 ".. function:: IntProperty(name=\"\", description=\"\", default=0, min=-sys.maxint, max=sys.maxint, soft_min=-sys.maxint, soft_max=sys.maxint, step=1, options={'ANIMATABLE'}, subtype='NONE')\n"
274 "\n"
275 "   Returns a new int property definition.\n"
276 "\n"
277 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
278 "   :type options: set\n"
279 "   :arg subtype: Enumerator in ['UNSIGNED', 'PERCENTAGE', 'FACTOR', 'ANGLE', 'TIME', 'DISTANCE', 'NONE'].\n"
280 "   :type subtype: string";
281 static PyObject *BPy_IntProperty(PyObject *self, PyObject *args, PyObject *kw)
282 {
283         StructRNA *srna;
284
285         BPY_PROPDEF_HEAD(IntProperty)
286
287         if(srna) {
288                 static const char *kwlist[] = {"attr", "name", "description", "default", "min", "max", "soft_min", "soft_max", "step", "options", "subtype", NULL};
289                 char *id=NULL, *name="", *description="";
290                 int min=INT_MIN, max=INT_MAX, soft_min=INT_MIN, soft_max=INT_MAX, step=1, def=0;
291                 PropertyRNA *prop;
292                 PyObject *pyopts= NULL;
293                 int opts=0;
294                 char *pysubtype= NULL;
295                 int subtype= PROP_NONE;
296
297                 if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ssiiiiiiO!s:IntProperty", (char **)kwlist, &id, &name, &description, &def, &min, &max, &soft_min, &soft_max, &step, &PySet_Type, &pyopts, &pysubtype))
298                         return NULL;
299
300                 if(RNA_def_property_free_identifier(srna, id) == -1) {
301                         PyErr_Format(PyExc_TypeError, "IntProperty(): '%s' is defined as a non-dynamic type.", id);
302                         return NULL;
303                 }
304
305                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "IntProperty(options={...}):"))
306                         return NULL;
307
308                 if(pysubtype && RNA_enum_value_from_id(property_subtype_number_items, pysubtype, &subtype)==0) {
309                         PyErr_Format(PyExc_TypeError, "IntProperty(subtype='%s'): invalid subtype.", pysubtype);
310                         return NULL;
311                 }
312
313                 prop= RNA_def_property(srna, id, PROP_INT, subtype);
314                 RNA_def_property_int_default(prop, def);
315                 RNA_def_property_range(prop, min, max);
316                 RNA_def_property_ui_text(prop, name, description);
317                 RNA_def_property_ui_range(prop, MAX2(soft_min, min), MIN2(soft_max, max), step, 3);
318
319                 if(pyopts) {
320                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
321                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
322                 }
323                 RNA_def_property_duplicate_pointers(srna, prop);
324         }
325         Py_RETURN_NONE;
326 }
327
328 static char BPy_IntVectorProperty_doc[] =
329 ".. function:: IntVectorProperty(name=\"\", description=\"\", default=(0, 0, 0), min=-sys.maxint, max=sys.maxint, soft_min=-sys.maxint, soft_max=sys.maxint, options={'ANIMATABLE'}, subtype='NONE', size=3)\n"
330 "\n"
331 "   Returns a new vector int property definition.\n"
332 "\n"
333 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
334 "   :type options: set\n"
335 "   :arg subtype: Enumerator in ['COLOR', 'TRANSLATION', 'DIRECTION', 'VELOCITY', 'ACCELERATION', 'MATRIX', 'EULER', 'QUATERNION', 'AXISANGLE', 'XYZ', 'COLOR_GAMMA', 'LAYER', 'NONE'].\n"
336 "   :type subtype: string";
337 static PyObject *BPy_IntVectorProperty(PyObject *self, PyObject *args, PyObject *kw)
338 {
339         StructRNA *srna;
340
341         BPY_PROPDEF_HEAD(IntVectorProperty)
342
343         if(srna) {
344                 static const char *kwlist[] = {"attr", "name", "description", "default", "min", "max", "soft_min", "soft_max", "step", "options", "subtype", "size", NULL};
345                 char *id=NULL, *name="", *description="";
346                 int min=INT_MIN, max=INT_MAX, soft_min=INT_MIN, soft_max=INT_MAX, step=1, def[PYRNA_STACK_ARRAY]={0};
347                 int size=3;
348                 PropertyRNA *prop;
349                 PyObject *pydef= NULL;
350                 PyObject *pyopts= NULL;
351                 int opts=0;
352                 char *pysubtype= NULL;
353                 int subtype= PROP_NONE;
354
355                 if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ssOiiiiiO!si:IntVectorProperty", (char **)kwlist, &id, &name, &description, &pydef, &min, &max, &soft_min, &soft_max, &step, &PySet_Type, &pyopts, &pysubtype, &size))
356                         return NULL;
357
358                 if(RNA_def_property_free_identifier(srna, id) == -1) {
359                         PyErr_Format(PyExc_TypeError, "IntVectorProperty(): '%s' is defined as a non-dynamic type.", id);
360                         return NULL;
361                 }
362
363                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "IntVectorProperty(options={...}):"))
364                         return NULL;
365
366                 if(pysubtype && RNA_enum_value_from_id(property_subtype_array_items, pysubtype, &subtype)==0) {
367                         PyErr_Format(PyExc_TypeError, "IntVectorProperty(subtype='%s'): invalid subtype.", pysubtype);
368                         return NULL;
369                 }
370
371                 if(size < 1 || size > PYRNA_STACK_ARRAY) {
372                         PyErr_Format(PyExc_TypeError, "IntVectorProperty(size=%d): size must be between 0 and %d.", size, PYRNA_STACK_ARRAY);
373                         return NULL;
374                 }
375
376                 if(pydef && PyC_AsArray(def, pydef, size, &PyLong_Type, "IntVectorProperty(default=sequence)") < 0)
377                         return NULL;
378
379                 prop= RNA_def_property(srna, id, PROP_INT, subtype);
380                 RNA_def_property_array(prop, size);
381                 if(pydef) RNA_def_property_int_array_default(prop, def);
382                 RNA_def_property_range(prop, min, max);
383                 RNA_def_property_ui_text(prop, name, description);
384                 RNA_def_property_ui_range(prop, MAX2(soft_min, min), MIN2(soft_max, max), step, 3);
385
386                 if(pyopts) {
387                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
388                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
389                 }
390                 RNA_def_property_duplicate_pointers(srna, prop);
391         }
392         Py_RETURN_NONE;
393 }
394
395
396 static char BPy_FloatProperty_doc[] =
397 ".. function:: FloatProperty(name=\"\", description=\"\", default=0.0, min=sys.float_info.min, max=sys.float_info.max, soft_min=sys.float_info.min, soft_max=sys.float_info.max, step=3, precision=2, options={'ANIMATABLE'}, subtype='NONE', unit='NONE')\n"
398 "\n"
399 "   Returns a new float property definition.\n"
400 "\n"
401 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
402 "   :type options: set\n"
403 "   :arg subtype: Enumerator in ['UNSIGNED', 'PERCENTAGE', 'FACTOR', 'ANGLE', 'TIME', 'DISTANCE', 'NONE'].\n"
404 "   :type subtype: string\n"
405 "   :arg unit: Enumerator in ['NONE', 'LENGTH', 'AREA', 'VOLUME', 'ROTATION', 'TIME', 'VELOCITY', 'ACCELERATION'].\n"
406 "   :type unit: string\n";
407 static PyObject *BPy_FloatProperty(PyObject *self, PyObject *args, PyObject *kw)
408 {
409         StructRNA *srna;
410
411         BPY_PROPDEF_HEAD(FloatProperty)
412
413         if(srna) {
414                 static const char *kwlist[] = {"attr", "name", "description", "default", "min", "max", "soft_min", "soft_max", "step", "precision", "options", "subtype", "unit", NULL};
415                 char *id=NULL, *name="", *description="";
416                 float min=-FLT_MAX, max=FLT_MAX, soft_min=-FLT_MAX, soft_max=FLT_MAX, step=3, def=0.0f;
417                 int precision= 2;
418                 PropertyRNA *prop;
419                 PyObject *pyopts= NULL;
420                 int opts=0;
421                 char *pysubtype= NULL;
422                 int subtype= PROP_NONE;
423                 char *pyunit= NULL;
424                 int unit= PROP_UNIT_NONE;
425
426                 if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ssffffffiO!ss:FloatProperty", (char **)kwlist, &id, &name, &description, &def, &min, &max, &soft_min, &soft_max, &step, &precision, &PySet_Type, &pyopts, &pysubtype, &pyunit))
427                         return NULL;
428
429                 if(RNA_def_property_free_identifier(srna, id) == -1) {
430                         PyErr_Format(PyExc_TypeError, "FloatProperty(): '%s' is defined as a non-dynamic type.", id);
431                         return NULL;
432                 }
433
434                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "FloatProperty(options={...}):"))
435                         return NULL;
436
437                 if(pysubtype && RNA_enum_value_from_id(property_subtype_number_items, pysubtype, &subtype)==0) {
438                         PyErr_Format(PyExc_TypeError, "FloatProperty(subtype='%s'): invalid subtype.", pysubtype);
439                         return NULL;
440                 }
441
442                 if(pyunit && RNA_enum_value_from_id(property_unit_items, pyunit, &unit)==0) {
443                         PyErr_Format(PyExc_TypeError, "FloatProperty(unit='%s'): invalid unit.");
444                         return NULL;
445                 }
446
447                 prop= RNA_def_property(srna, id, PROP_FLOAT, subtype | unit);
448                 RNA_def_property_float_default(prop, def);
449                 RNA_def_property_range(prop, min, max);
450                 RNA_def_property_ui_text(prop, name, description);
451                 RNA_def_property_ui_range(prop, MAX2(soft_min, min), MIN2(soft_max, max), step, precision);
452
453                 if(pyopts) {
454                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
455                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
456                 }
457                 RNA_def_property_duplicate_pointers(srna, prop);
458         }
459         Py_RETURN_NONE;
460 }
461
462 static char BPy_FloatVectorProperty_doc[] =
463 ".. function:: FloatVectorProperty(name=\"\", description=\"\", default=(0.0, 0.0, 0.0), min=sys.float_info.min, max=sys.float_info.max, soft_min=sys.float_info.min, soft_max=sys.float_info.max, step=3, precision=2, options={'ANIMATABLE'}, subtype='NONE', size=3)\n"
464 "\n"
465 "   Returns a new vector float property definition.\n"
466 "\n"
467 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
468 "   :type options: set\n"
469 "   :arg subtype: Enumerator in ['COLOR', 'TRANSLATION', 'DIRECTION', 'VELOCITY', 'ACCELERATION', 'MATRIX', 'EULER', 'QUATERNION', 'AXISANGLE', 'XYZ', 'COLOR_GAMMA', 'LAYER', 'NONE'].\n"
470 "   :type subtype: string";
471 static PyObject *BPy_FloatVectorProperty(PyObject *self, PyObject *args, PyObject *kw)
472 {
473         StructRNA *srna;
474
475         BPY_PROPDEF_HEAD(FloatVectorProperty)
476
477         if(srna) {
478                 static const char *kwlist[] = {"attr", "name", "description", "default", "min", "max", "soft_min", "soft_max", "step", "precision", "options", "subtype", "size", NULL};
479                 char *id=NULL, *name="", *description="";
480                 float min=-FLT_MAX, max=FLT_MAX, soft_min=-FLT_MAX, soft_max=FLT_MAX, step=3, def[PYRNA_STACK_ARRAY]={0.0f};
481                 int precision= 2, size=3;
482                 PropertyRNA *prop;
483                 PyObject *pydef= NULL;
484                 PyObject *pyopts= NULL;
485                 int opts=0;
486                 char *pysubtype= NULL;
487                 int subtype= PROP_NONE;
488
489                 if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ssOfffffiO!si:FloatVectorProperty", (char **)kwlist, &id, &name, &description, &pydef, &min, &max, &soft_min, &soft_max, &step, &precision, &PySet_Type, &pyopts, &pysubtype, &size))
490                         return NULL;
491
492                 if(RNA_def_property_free_identifier(srna, id) == -1) {
493                         PyErr_Format(PyExc_TypeError, "FloatVectorProperty(): '%s' is defined as a non-dynamic type.", id);
494                         return NULL;
495                 }
496
497                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "FloatVectorProperty(options={...}):"))
498                         return NULL;
499
500                 if(pysubtype && RNA_enum_value_from_id(property_subtype_array_items, pysubtype, &subtype)==0) {
501                         PyErr_Format(PyExc_TypeError, "FloatVectorProperty(subtype='%s'): invalid subtype.", pysubtype);
502                         return NULL;
503                 }
504
505                 if(size < 1 || size > PYRNA_STACK_ARRAY) {
506                         PyErr_Format(PyExc_TypeError, "FloatVectorProperty(size=%d): size must be between 0 and %d.", size, PYRNA_STACK_ARRAY);
507                         return NULL;
508                 }
509
510                 if(pydef && PyC_AsArray(def, pydef, size, &PyFloat_Type, "FloatVectorProperty(default=sequence)") < 0)
511                         return NULL;
512
513                 prop= RNA_def_property(srna, id, PROP_FLOAT, subtype);
514                 RNA_def_property_array(prop, size);
515                 if(pydef) RNA_def_property_float_array_default(prop, def);
516                 RNA_def_property_range(prop, min, max);
517                 RNA_def_property_ui_text(prop, name, description);
518                 RNA_def_property_ui_range(prop, MAX2(soft_min, min), MIN2(soft_max, max), step, precision);
519
520                 if(pyopts) {
521                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
522                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
523                 }
524                 RNA_def_property_duplicate_pointers(srna, prop);
525         }
526         Py_RETURN_NONE;
527 }
528
529 static char BPy_StringProperty_doc[] =
530 ".. function:: StringProperty(name=\"\", description=\"\", default=\"\", maxlen=0, options={'ANIMATABLE'}, subtype='NONE')\n"
531 "\n"
532 "   Returns a new string property definition.\n"
533 "\n"
534 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
535 "   :type options: set\n"
536 "   :arg subtype: Enumerator in ['FILE_PATH', 'DIR_PATH', 'FILENAME', 'NONE'].\n"
537 "   :type subtype: string";
538 static PyObject *BPy_StringProperty(PyObject *self, PyObject *args, PyObject *kw)
539 {
540         StructRNA *srna;
541
542         BPY_PROPDEF_HEAD(StringProperty)
543
544         if(srna) {
545                 static const char *kwlist[] = {"attr", "name", "description", "default", "maxlen", "options", "subtype", NULL};
546                 char *id=NULL, *name="", *description="", *def="";
547                 int maxlen=0;
548                 PropertyRNA *prop;
549                 PyObject *pyopts= NULL;
550                 int opts=0;
551                 char *pysubtype= NULL;
552                 int subtype= PROP_NONE;
553
554                 if (!PyArg_ParseTupleAndKeywords(args, kw, "s|sssiO!s:StringProperty", (char **)kwlist, &id, &name, &description, &def, &maxlen, &PySet_Type, &pyopts, &pysubtype))
555                         return NULL;
556
557                 if(RNA_def_property_free_identifier(srna, id) == -1) {
558                         PyErr_Format(PyExc_TypeError, "StringProperty(): '%s' is defined as a non-dynamic type.", id);
559                         return NULL;
560                 }
561
562                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "StringProperty(options={...}):"))
563                         return NULL;
564
565                 if(pysubtype && RNA_enum_value_from_id(property_subtype_string_items, pysubtype, &subtype)==0) {
566                         PyErr_Format(PyExc_TypeError, "StringProperty(subtype='%s'): invalid subtype.", pysubtype);
567                         return NULL;
568                 }
569
570                 prop= RNA_def_property(srna, id, PROP_STRING, subtype);
571                 if(maxlen != 0) RNA_def_property_string_maxlength(prop, maxlen + 1); /* +1 since it includes null terminator */
572                 if(def) RNA_def_property_string_default(prop, def);
573                 RNA_def_property_ui_text(prop, name, description);
574
575                 if(pyopts) {
576                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
577                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
578                 }
579                 RNA_def_property_duplicate_pointers(srna, prop);
580         }
581         Py_RETURN_NONE;
582 }
583
584 static EnumPropertyItem *enum_items_from_py(PyObject *value, const char *def, int *defvalue)
585 {
586         EnumPropertyItem *items= NULL;
587         PyObject *item;
588         int seq_len, i, totitem= 0;
589
590         if(!PySequence_Check(value)) {
591                 PyErr_SetString(PyExc_TypeError, "expected a sequence of tuples for the enum items");
592                 return NULL;
593         }
594
595         seq_len = PySequence_Length(value);
596         for(i=0; i<seq_len; i++) {
597                 EnumPropertyItem tmp= {0, "", 0, "", ""};
598
599                 item= PySequence_GetItem(value, i);
600                 if(item==NULL || PyTuple_Check(item)==0) {
601                         PyErr_SetString(PyExc_TypeError, "expected a sequence of tuples for the enum items");
602                         if(items) MEM_freeN(items);
603                         Py_XDECREF(item);
604                         return NULL;
605                 }
606
607                 if(!PyArg_ParseTuple(item, "sss", &tmp.identifier, &tmp.name, &tmp.description)) {
608                         PyErr_SetString(PyExc_TypeError, "expected an identifier, name and description in the tuple");
609                         Py_DECREF(item);
610                         return NULL;
611                 }
612
613                 tmp.value= i;
614                 RNA_enum_item_add(&items, &totitem, &tmp);
615
616                 if(def[0] && strcmp(def, tmp.identifier) == 0)
617                         *defvalue= tmp.value;
618
619                 Py_DECREF(item);
620         }
621
622         if(!def[0])
623                 *defvalue= 0;
624
625         RNA_enum_item_end(&items, &totitem);
626
627         return items;
628 }
629
630 static char BPy_EnumProperty_doc[] =
631 ".. function:: EnumProperty(items, name=\"\", description=\"\", default=\"\", options={'ANIMATABLE'})\n"
632 "\n"
633 "   Returns a new enumerator property definition.\n"
634 "\n"
635 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
636 "   :type options: set\n"
637 "   :arg items: The items that make up this enumerator.\n"
638 "   :type items: sequence of string triplets";
639 static PyObject *BPy_EnumProperty(PyObject *self, PyObject *args, PyObject *kw)
640 {
641         StructRNA *srna;
642
643         BPY_PROPDEF_HEAD(EnumProperty)
644         
645         if(srna) {
646                 static const char *kwlist[] = {"attr", "items", "name", "description", "default", "options", NULL};
647                 char *id=NULL, *name="", *description="", *def="";
648                 int defvalue=0;
649                 PyObject *items= Py_None;
650                 EnumPropertyItem *eitems;
651                 PropertyRNA *prop;
652                 PyObject *pyopts= NULL;
653                 int opts=0;
654
655                 if (!PyArg_ParseTupleAndKeywords(args, kw, "sO|sssO!:EnumProperty", (char **)kwlist, &id, &items, &name, &description, &def, &PySet_Type, &pyopts))
656                         return NULL;
657
658                 if(RNA_def_property_free_identifier(srna, id) == -1) {
659                         PyErr_Format(PyExc_TypeError, "EnumProperty(): '%s' is defined as a non-dynamic type.", id);
660                         return NULL;
661                 }
662
663                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "EnumProperty(options={...}):"))
664                         return NULL;
665
666                 eitems= enum_items_from_py(items, def, &defvalue);
667                 if(!eitems)
668                         return NULL;
669
670                 prop= RNA_def_enum(srna, id, eitems, defvalue, name, description);
671                 if(pyopts) {
672                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
673                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
674                 }
675                 RNA_def_property_duplicate_pointers(srna, prop);
676                 MEM_freeN(eitems);
677         }
678         Py_RETURN_NONE;
679 }
680
681 static StructRNA *pointer_type_from_py(PyObject *value, const char *error_prefix)
682 {
683         StructRNA *srna;
684
685         srna= srna_from_self(value, "BoolProperty(...):");
686         if(!srna) {
687
688                 PyObject *msg= PyC_ExceptionBuffer();
689                 char *msg_char= _PyUnicode_AsString(msg);
690                 PyErr_Format(PyExc_TypeError, "%.200s expected an RNA type derived from IDPropertyGroup, failed with: %s", error_prefix, msg_char);
691                 Py_DECREF(msg);
692                 return NULL;
693         }
694
695         if(!RNA_struct_is_a(srna, &RNA_IDPropertyGroup)) {
696                  PyErr_Format(PyExc_SystemError, "%.200s expected an RNA type derived from IDPropertyGroup", error_prefix);
697                 return NULL;
698         }
699
700         return srna;
701 }
702
703 static char BPy_PointerProperty_doc[] =
704 ".. function:: PointerProperty(items, type=\"\", description=\"\", default=\"\", options={'ANIMATABLE'})\n"
705 "\n"
706 "   Returns a new pointer property definition.\n"
707 "\n"
708 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
709 "   :type options: set\n"
710 "   :arg type: Dynamic type from :mod:`bpy.types`.\n"
711 "   :type type: class";
712 static PyObject *BPy_PointerProperty(PyObject *self, PyObject *args, PyObject *kw)
713 {
714         StructRNA *srna;
715
716         BPY_PROPDEF_HEAD(PointerProperty)
717
718         if(srna) {
719                 static const char *kwlist[] = {"attr", "type", "name", "description", "options", NULL};
720                 char *id=NULL, *name="", *description="";
721                 PropertyRNA *prop;
722                 StructRNA *ptype;
723                 PyObject *type= Py_None;
724                 PyObject *pyopts= NULL;
725                 int opts=0;
726
727                 if (!PyArg_ParseTupleAndKeywords(args, kw, "sO|ssO!:PointerProperty", (char **)kwlist, &id, &type, &name, &description, &PySet_Type, &pyopts))
728                         return NULL;
729
730                 if(RNA_def_property_free_identifier(srna, id) == -1) {
731                         PyErr_Format(PyExc_TypeError, "PointerProperty(): '%s' is defined as a non-dynamic type.", id);
732                         return NULL;
733                 }
734
735                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "PointerProperty(options={...}):"))
736                         return NULL;
737
738                 ptype= pointer_type_from_py(type, "PointerProperty(...):");
739                 if(!ptype)
740                         return NULL;
741
742                 prop= RNA_def_pointer_runtime(srna, id, ptype, name, description);
743                 if(pyopts) {
744                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
745                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
746                 }
747                 RNA_def_property_duplicate_pointers(srna, prop);
748         }
749         Py_RETURN_NONE;
750 }
751
752 static char BPy_CollectionProperty_doc[] =
753 ".. function:: CollectionProperty(items, type=\"\", description=\"\", default=\"\", options={'ANIMATABLE'})\n"
754 "\n"
755 "   Returns a new collection property definition.\n"
756 "\n"
757 "   :arg options: Enumerator in ['HIDDEN', 'ANIMATABLE'].\n"
758 "   :type options: set\n"
759 "   :arg type: Dynamic type from :mod:`bpy.types`.\n"
760 "   :type type: class";
761 static PyObject *BPy_CollectionProperty(PyObject *self, PyObject *args, PyObject *kw)
762 {
763         StructRNA *srna;
764
765         BPY_PROPDEF_HEAD(CollectionProperty)
766
767         if(srna) {
768                 static const char *kwlist[] = {"attr", "type", "name", "description", "options", NULL};
769                 char *id=NULL, *name="", *description="";
770                 PropertyRNA *prop;
771                 StructRNA *ptype;
772                 PyObject *type= Py_None;
773                 PyObject *pyopts= NULL;
774                 int opts=0;
775
776                 if (!PyArg_ParseTupleAndKeywords(args, kw, "sO|ssO!:CollectionProperty", (char **)kwlist, &id, &type, &name, &description, &PySet_Type, &pyopts))
777                         return NULL;
778
779                 if(RNA_def_property_free_identifier(srna, id) == -1) {
780                         PyErr_Format(PyExc_TypeError, "CollectionProperty(): '%s' is defined as a non-dynamic type.", id);
781                         return NULL;
782                 }
783
784                 if(pyopts && pyrna_set_to_enum_bitfield(property_flag_items, pyopts, &opts, "CollectionProperty(options={...}):"))
785                         return NULL;
786
787                 ptype= pointer_type_from_py(type, "CollectionProperty(...):");
788                 if(!ptype)
789                         return NULL;
790
791                 prop= RNA_def_collection_runtime(srna, id, ptype, name, description);
792                 if(pyopts) {
793                         if(opts & PROP_HIDDEN) RNA_def_property_flag(prop, PROP_HIDDEN);
794                         if((opts & PROP_ANIMATABLE)==0) RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
795                 }
796                 RNA_def_property_duplicate_pointers(srna, prop);
797         }
798         Py_RETURN_NONE;
799 }
800
801 static char BPy_RemoveProperty_doc[] =
802 ".. function:: RemoveProperty(attr)\n"
803 "\n"
804 "   Removes a dynamically defined property.\n"
805 "\n"
806 "   :arg attr: Property name.\n"
807 "   :type attr: string";
808 static PyObject *BPy_RemoveProperty(PyObject *self, PyObject *args, PyObject *kw)
809 {
810         StructRNA *srna;
811
812         if(PyTuple_GET_SIZE(args) == 1) {
813                 PyObject *ret;
814                 self= PyTuple_GET_ITEM(args, 0);
815                 args= PyTuple_New(0);
816                 ret= BPy_RemoveProperty(self, args, kw);
817                 Py_DECREF(args);
818                 return ret;     
819         }
820         else if (PyTuple_GET_SIZE(args) > 1) {
821                  PyErr_SetString(PyExc_ValueError, "all args must be keywords"); \
822                 return NULL;
823         }
824
825         srna= srna_from_self(self, "RemoveProperty(...):");
826         if(srna==NULL && PyErr_Occurred()) {
827                 return NULL; /* self's type was compatible but error getting the srna */
828         }
829         else if(srna==NULL) {
830                 PyErr_SetString(PyExc_TypeError, "RemoveProperty(): struct rna not available for this type.");
831                 return NULL;
832         }
833         else {
834                 static const char *kwlist[] = {"attr", NULL};
835                 
836                 char *id=NULL;
837
838                 if (!PyArg_ParseTupleAndKeywords(args, kw, "s:RemoveProperty", (char **)kwlist, &id))
839                         return NULL;
840
841                 if(RNA_def_property_free_identifier(srna, id) != 1) {
842                         PyErr_Format(PyExc_TypeError, "RemoveProperty(): '%s' not a defined dynamic property.", id);
843                         return NULL;
844                 }
845         }
846         Py_RETURN_NONE;
847 }
848
849 static struct PyMethodDef props_methods[] = {
850         {"BoolProperty", (PyCFunction)BPy_BoolProperty, METH_VARARGS|METH_KEYWORDS, BPy_BoolProperty_doc},
851         {"BoolVectorProperty", (PyCFunction)BPy_BoolVectorProperty, METH_VARARGS|METH_KEYWORDS, BPy_BoolVectorProperty_doc},
852         {"IntProperty", (PyCFunction)BPy_IntProperty, METH_VARARGS|METH_KEYWORDS, BPy_IntProperty_doc},
853         {"IntVectorProperty", (PyCFunction)BPy_IntVectorProperty, METH_VARARGS|METH_KEYWORDS, BPy_IntVectorProperty_doc},
854         {"FloatProperty", (PyCFunction)BPy_FloatProperty, METH_VARARGS|METH_KEYWORDS, BPy_FloatProperty_doc},
855         {"FloatVectorProperty", (PyCFunction)BPy_FloatVectorProperty, METH_VARARGS|METH_KEYWORDS, BPy_FloatVectorProperty_doc},
856         {"StringProperty", (PyCFunction)BPy_StringProperty, METH_VARARGS|METH_KEYWORDS, BPy_StringProperty_doc},
857         {"EnumProperty", (PyCFunction)BPy_EnumProperty, METH_VARARGS|METH_KEYWORDS, BPy_EnumProperty_doc},
858         {"PointerProperty", (PyCFunction)BPy_PointerProperty, METH_VARARGS|METH_KEYWORDS, BPy_PointerProperty_doc},
859         {"CollectionProperty", (PyCFunction)BPy_CollectionProperty, METH_VARARGS|METH_KEYWORDS, BPy_CollectionProperty_doc},
860
861         {"RemoveProperty", (PyCFunction)BPy_RemoveProperty, METH_VARARGS|METH_KEYWORDS, BPy_RemoveProperty_doc},
862         {NULL, NULL, 0, NULL}
863 };
864
865 static struct PyModuleDef props_module = {
866         PyModuleDef_HEAD_INIT,
867         "bpy.props",
868         "This module defines properties to extend blenders internal data, the result of these functions"
869         " is used to assign properties to classes registered with blender and can't be used directly.",
870         -1,/* multiple "initialization" just copies the module dict. */
871         props_methods,
872         NULL, NULL, NULL, NULL
873 };
874
875 PyObject *BPY_rna_props( void )
876 {
877         PyObject *submodule;
878         PyObject *submodule_dict;
879         
880         submodule= PyModule_Create(&props_module);
881         PyDict_SetItemString(PyImport_GetModuleDict(), props_module.m_name, submodule);
882
883         /* INCREF since its its assumed that all these functions return the
884          * module with a new ref like PyDict_New, since they are passed to
885           * PyModule_AddObject which steals a ref */
886         Py_INCREF(submodule);
887         
888         /* api needs the PyObjects internally */
889         submodule_dict= PyModule_GetDict(submodule);
890
891 #define ASSIGN_STATIC(_name) pymeth_##_name = PyDict_GetItemString(submodule_dict, #_name)
892
893         ASSIGN_STATIC(BoolProperty);
894         ASSIGN_STATIC(BoolVectorProperty);
895         ASSIGN_STATIC(IntProperty);
896         ASSIGN_STATIC(IntVectorProperty);
897         ASSIGN_STATIC(FloatProperty);
898         ASSIGN_STATIC(FloatVectorProperty);
899         ASSIGN_STATIC(StringProperty);
900         ASSIGN_STATIC(EnumProperty);
901         ASSIGN_STATIC(PointerProperty);
902         ASSIGN_STATIC(CollectionProperty);
903         ASSIGN_STATIC(RemoveProperty);
904         
905         return submodule;
906 }