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