Py-Driver: add 'self' option
[blender.git] / source / blender / python / BPY_extern.h
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): Michel Selten,
19  *                 Willian P. Germano,
20  *                 Chris Keith,
21  *                 Campbell Barton
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file BPY_extern.h
27  *  \ingroup python
28  */
29
30
31
32 #ifndef __BPY_EXTERN_H__
33 #define __BPY_EXTERN_H__
34
35 struct PathResolvedRNA;
36 struct Text; /* defined in DNA_text_types.h */
37 struct ID; /* DNA_ID.h */
38 struct Object; /* DNA_object_types.h */
39 struct ChannelDriver; /* DNA_anim_types.h */
40 struct ListBase; /* DNA_listBase.h */
41 struct bConstraint; /* DNA_constraint_types.h */
42 struct bPythonConstraint; /* DNA_constraint_types.h */
43 struct bConstraintOb; /* DNA_constraint_types.h */
44 struct bConstraintTarget; /* DNA_constraint_types.h*/
45 struct bContext;
46 struct bContextDataResult;
47 struct ReportList;
48
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52
53 void BPY_pyconstraint_exec(struct bPythonConstraint *con, struct bConstraintOb *cob, struct ListBase *targets);
54 //      void BPY_pyconstraint_settings(void *arg1, void *arg2);
55 void BPY_pyconstraint_target(struct bPythonConstraint *con, struct bConstraintTarget *ct);
56 void BPY_pyconstraint_update(struct Object *owner, struct bConstraint *con);
57 int BPY_is_pyconstraint(struct Text *text);
58 //      void BPY_free_pyconstraint_links(struct Text *text);
59
60 void BPY_python_start(int argc, const char **argv);
61 void BPY_python_end(void);
62 void BPY_python_reset(struct bContext *C);
63
64
65 /* global interpreter lock */
66
67 typedef void *BPy_ThreadStatePtr;
68
69 BPy_ThreadStatePtr BPY_thread_save(void);
70 void BPY_thread_restore(BPy_ThreadStatePtr tstate);
71
72 /* our own wrappers to Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS */
73 #define BPy_BEGIN_ALLOW_THREADS { BPy_ThreadStatePtr _bpy_saved_tstate = BPY_thread_save(); (void)0
74 #define BPy_END_ALLOW_THREADS BPY_thread_restore(_bpy_saved_tstate); } (void)0
75
76 bool    BPY_execute_filepath(struct bContext *C, const char *filepath, struct ReportList *reports);
77 bool    BPY_execute_text(struct bContext *C, struct Text *text, struct ReportList *reports, const bool do_jump);
78 bool    BPY_execute_string_as_number(struct bContext *C, const char *expr, double *value, const bool verbose);
79 bool    BPY_execute_string_ex(struct bContext *C, const char *expr, bool use_eval);
80 bool    BPY_execute_string(struct bContext *C, const char *expr);
81
82 void    BPY_text_free_code(struct Text *text);
83 void    BPY_modules_update(struct bContext *C); // XXX - annoying, need this for pointers that get out of date
84 void    BPY_modules_load_user(struct bContext *C);
85
86 void    BPY_app_handlers_reset(const short do_all);
87
88 void    BPY_driver_reset(void);
89 float   BPY_driver_exec(struct PathResolvedRNA *anim_rna, struct ChannelDriver *driver, const float evaltime);
90
91 void    BPY_DECREF(void *pyob_ptr);     /* Py_DECREF() */
92 void    BPY_DECREF_RNA_INVALIDATE(void *pyob_ptr);
93 int             BPY_context_member_get(struct bContext *C, const char *member, struct bContextDataResult *result);
94 void    BPY_context_set(struct bContext *C);
95 void    BPY_context_update(struct bContext *C);
96
97 void    BPY_id_release(struct ID *id);
98
99 bool    BPY_string_is_keyword(const char *str);
100
101 /* I18n for addons */
102 #ifdef WITH_INTERNATIONAL
103 const char *BPY_app_translations_py_pgettext(const char *msgctxt, const char *msgid);
104 #endif
105
106 #ifdef __cplusplus
107 }                               /* extern "C" */
108 #endif
109
110 #endif  /* __BPY_EXTERN_H__ */