Bevel mod: cleanup flags and extra data.
[blender.git] / source / blender / python / intern / bpy_operator_wrap.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup pythonintern
19  *
20  * This file is so python can define operators that C can call into.
21  * The generic callback functions for python operators are defines in
22  * 'rna_wm.c', some calling into functions here to do python specific
23  * functionality.
24  */
25
26 #include <Python.h>
27
28 #include "BLI_utildefines.h"
29
30 #include "WM_api.h"
31 #include "WM_types.h"
32
33 #include "RNA_access.h"
34 #include "RNA_define.h"
35
36 #include "bpy_rna.h"
37 #include "bpy_intern_string.h"
38 #include "bpy_operator_wrap.h"  /* own include */
39
40 static void operator_properties_init(wmOperatorType *ot)
41 {
42         PyTypeObject *py_class = ot->ext.data;
43         RNA_struct_blender_type_set(ot->ext.srna, ot);
44
45         /* Only call this so pyrna_deferred_register_class gives a useful error
46          * WM_operatortype_append_ptr will call RNA_def_struct_identifier later.
47          *
48          * Note the 'no_struct_map' function is used since the actual struct name is already used by the operator.
49          */
50         RNA_def_struct_identifier_no_struct_map(ot->srna, ot->idname);
51
52         if (pyrna_deferred_register_class(ot->srna, py_class) != 0) {
53                 PyErr_Print(); /* failed to register operator props */
54                 PyErr_Clear();
55         }
56
57         /* set the default property: ot->prop */
58         {
59                 /* picky developers will notice that 'bl_property' won't work with inheritance
60                  * get direct from the dict to avoid raising a load of attribute errors (yes this isnt ideal) - campbell */
61                 PyObject *py_class_dict = py_class->tp_dict;
62                 PyObject *bl_property = PyDict_GetItem(py_class_dict, bpy_intern_str_bl_property);
63                 const char *prop_id;
64                 bool prop_raise_error;
65
66                 if (bl_property) {
67                         if (PyUnicode_Check(bl_property)) {
68                                 /* since the property is explicitly given, raise an error if its not found */
69                                 prop_id = _PyUnicode_AsString(bl_property);
70                                 prop_raise_error = true;
71                         }
72                         else {
73                                 PyErr_Format(PyExc_ValueError,
74                                              "%.200s.bl_property should be a string, not %.200s",
75                                              ot->idname, Py_TYPE(bl_property)->tp_name);
76
77                                 /* this could be done cleaner, for now its OK */
78                                 PyErr_Print();
79                                 PyErr_Clear();
80
81                                 prop_id = NULL;
82                                 prop_raise_error = false;
83                         }
84                 }
85                 else {
86                         /* fallback to hard-coded string (pre 2.66, could be deprecated) */
87                         prop_id = "type";
88                         prop_raise_error = false;
89                 }
90
91                 if (prop_id) {
92                         PointerRNA ptr;
93                         PropertyRNA *prop;
94
95                         RNA_pointer_create(NULL, ot->srna, NULL, &ptr);
96                         prop = RNA_struct_find_property(&ptr, prop_id);
97                         if (prop) {
98                                 ot->prop = prop;
99                         }
100                         else {
101                                 if (prop_raise_error) {
102                                         PyErr_Format(PyExc_ValueError,
103                                                      "%.200s.bl_property '%.200s' not found",
104                                                      ot->idname, prop_id);
105
106                                         /* this could be done cleaner, for now its OK */
107                                         PyErr_Print();
108                                         PyErr_Clear();
109                                 }
110                         }
111                 }
112         }
113         /* end 'ot->prop' assignment */
114
115 }
116
117 void BPY_RNA_operator_wrapper(wmOperatorType *ot, void *userdata)
118 {
119         /* take care not to overwrite anything set in
120          * WM_operatortype_append_ptr before opfunc() is called */
121         StructRNA *srna = ot->srna;
122         *ot = *((wmOperatorType *)userdata);
123         ot->srna = srna; /* restore */
124
125         /* Use i18n context from ext.srna if possible (py operators). */
126         if (ot->ext.srna) {
127                 RNA_def_struct_translation_context(ot->srna, RNA_struct_translation_context(ot->ext.srna));
128         }
129
130         operator_properties_init(ot);
131 }
132
133 void BPY_RNA_operator_macro_wrapper(wmOperatorType *ot, void *userdata)
134 {
135         wmOperatorType *data = (wmOperatorType *)userdata;
136
137         /* only copy a couple of things, the rest is set by the macro registration */
138         ot->name = data->name;
139         ot->idname = data->idname;
140         ot->description = data->description;
141         ot->flag |= data->flag; /* append flags to the one set by registration */
142         ot->pyop_poll = data->pyop_poll;
143         ot->ui = data->ui;
144         ot->ext = data->ext;
145
146         /* Use i18n context from ext.srna if possible (py operators). */
147         if (ot->ext.srna) {
148                 RNA_def_struct_translation_context(ot->srna, RNA_struct_translation_context(ot->ext.srna));
149         }
150
151         operator_properties_init(ot);
152 }
153
154 PyObject *PYOP_wrap_macro_define(PyObject *UNUSED(self), PyObject *args)
155 {
156         wmOperatorType *ot;
157         wmOperatorTypeMacro *otmacro;
158         PyObject *macro;
159         PointerRNA ptr_otmacro;
160         StructRNA *srna;
161
162         const char *opname;
163         const char *macroname;
164
165         if (!PyArg_ParseTuple(args, "Os:_bpy.ops.macro_define", &macro, &opname))
166                 return NULL;
167
168         if (WM_operatortype_find(opname, true) == NULL) {
169                 PyErr_Format(PyExc_ValueError,
170                              "Macro Define: '%s' is not a valid operator id",
171                              opname);
172                 return NULL;
173         }
174
175         /* identifiers */
176         srna = pyrna_struct_as_srna((PyObject *)macro, false, "Macro Define:");
177         if (srna == NULL) {
178                 return NULL;
179         }
180
181         macroname = RNA_struct_identifier(srna);
182         ot = WM_operatortype_find(macroname, true);
183
184         if (!ot) {
185                 PyErr_Format(PyExc_ValueError,
186                              "Macro Define: '%s' is not a valid macro",
187                              macroname);
188                 return NULL;
189         }
190
191         otmacro = WM_operatortype_macro_define(ot, opname);
192
193         RNA_pointer_create(NULL, &RNA_OperatorMacro, otmacro, &ptr_otmacro);
194
195         return pyrna_struct_CreatePyObject(&ptr_otmacro);
196 }