documentation - brief descriptions for bpy api files.
[blender.git] / source / blender / python / intern / bpy_operator_wrap.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/python/intern/bpy_operator_wrap.c
24  *  \ingroup pythonintern
25  *
26  * This file is so python can define operators that C can call into.
27  * The generic callback functions for python operators are defines in
28  * 'rna_wm.c', some calling into functions here to do python specific
29  * functionality.
30  */
31
32
33 #include <Python.h>
34
35 #include "bpy_operator_wrap.h"
36 #include "WM_api.h"
37 #include "WM_types.h"
38
39 #include "BLI_utildefines.h"
40
41 #include "RNA_access.h"
42 #include "RNA_define.h"
43
44 #include "bpy_rna.h"
45
46 static void operator_properties_init(wmOperatorType *ot)
47 {
48         PyObject *py_class= ot->ext.data;
49         RNA_struct_blender_type_set(ot->ext.srna, ot);
50
51         /* only call this so pyrna_deferred_register_class gives a useful error
52          * WM_operatortype_append_ptr will call RNA_def_struct_identifier
53          * later */
54         RNA_def_struct_identifier(ot->srna, ot->idname);
55
56         if (pyrna_deferred_register_class(ot->srna, py_class) != 0) {
57                 PyErr_Print(); /* failed to register operator props */
58                 PyErr_Clear();
59         }
60 }
61
62 void operator_wrapper(wmOperatorType *ot, void *userdata)
63 {
64         /* take care not to overwrite anything set in
65          * WM_operatortype_append_ptr before opfunc() is called */
66         StructRNA *srna= ot->srna;
67         *ot= *((wmOperatorType *)userdata);
68         ot->srna= srna; /* restore */
69
70         operator_properties_init(ot);
71
72         {       /* XXX - not nice, set the first enum as searchable, should have a way for python to set */
73                 PointerRNA ptr;
74                 PropertyRNA *prop;
75
76                 RNA_pointer_create(NULL, ot->srna, NULL, &ptr);
77                 prop= RNA_struct_find_property(&ptr, "type");
78                 if (prop) {
79                         ot->prop= prop;
80                 }
81         }
82 }
83
84 void macro_wrapper(wmOperatorType *ot, void *userdata)
85 {
86         wmOperatorType *data= (wmOperatorType *)userdata;
87
88         /* only copy a couple of things, the rest is set by the macro registration */
89         ot->name= data->name;
90         ot->idname= data->idname;
91         ot->description= data->description;
92         ot->flag |= data->flag; /* append flags to the one set by registration */
93         ot->pyop_poll= data->pyop_poll;
94         ot->ui= data->ui;
95         ot->ext= data->ext;
96
97         operator_properties_init(ot);
98 }
99
100 PyObject *PYOP_wrap_macro_define(PyObject *UNUSED(self), PyObject *args)
101 {
102         wmOperatorType *ot;
103         wmOperatorTypeMacro *otmacro;
104         PyObject *macro;
105         PointerRNA ptr_otmacro;
106         StructRNA *srna;
107
108         char *opname;
109         const char *macroname;
110
111         if (!PyArg_ParseTuple(args, "Os:_bpy.ops.macro_define", &macro, &opname))
112                 return NULL;
113
114         if (WM_operatortype_find(opname, TRUE) == NULL) {
115                 PyErr_Format(PyExc_ValueError, "Macro Define: '%s' is not a valid operator id", opname);
116                 return NULL;
117         }
118
119         /* identifiers */
120         srna= srna_from_self(macro, "Macro Define:");
121         macroname= RNA_struct_identifier(srna);
122
123         ot= WM_operatortype_find(macroname, TRUE);
124
125         if (!ot) {
126                 PyErr_Format(PyExc_ValueError, "Macro Define: '%s' is not a valid macro or hasn't been registered yet", macroname);
127                 return NULL;
128         }
129
130         otmacro= WM_operatortype_macro_define(ot, opname);
131
132         RNA_pointer_create(NULL, &RNA_OperatorMacro, otmacro, &ptr_otmacro);
133
134         return pyrna_struct_CreatePyObject(&ptr_otmacro);
135 }
136