Cleanup: GPencil Clarify comment
[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 #ifndef __BPY_EXTERN_H__
22 #define __BPY_EXTERN_H__
23
24 struct ChannelDriver; /* DNA_anim_types.h */
25 struct ID;            /* DNA_ID.h */
26 struct ListBase;      /* DNA_listBase.h */
27 struct Object;        /* DNA_object_types.h */
28 struct PathResolvedRNA;
29 struct ReportList;
30 struct Text;              /* defined in DNA_text_types.h */
31 struct bConstraint;       /* DNA_constraint_types.h */
32 struct bConstraintOb;     /* DNA_constraint_types.h */
33 struct bConstraintTarget; /* DNA_constraint_types.h*/
34 struct bContext;
35 struct bContextDataResult;
36 struct bPythonConstraint; /* DNA_constraint_types.h */
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 void BPY_pyconstraint_exec(struct bPythonConstraint *con,
43                            struct bConstraintOb *cob,
44                            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 /* global interpreter lock */
56
57 typedef void *BPy_ThreadStatePtr;
58
59 BPy_ThreadStatePtr BPY_thread_save(void);
60 void BPY_thread_restore(BPy_ThreadStatePtr tstate);
61
62 /* our own wrappers to Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS */
63 #define BPy_BEGIN_ALLOW_THREADS \
64   { \
65     BPy_ThreadStatePtr _bpy_saved_tstate = BPY_thread_save(); \
66     (void)0
67 #define BPy_END_ALLOW_THREADS \
68   BPY_thread_restore(_bpy_saved_tstate); \
69   } \
70   (void)0
71
72 bool BPY_execute_filepath(struct bContext *C, const char *filepath, struct ReportList *reports);
73 bool BPY_execute_text(struct bContext *C,
74                       struct Text *text,
75                       struct ReportList *reports,
76                       const bool do_jump);
77
78 bool BPY_execute_string_as_number(struct bContext *C,
79                                   const char *imports[],
80                                   const char *expr,
81                                   const bool verbose,
82                                   double *r_value);
83 bool BPY_execute_string_as_intptr(struct bContext *C,
84                                   const char *imports[],
85                                   const char *expr,
86                                   const bool verbose,
87                                   intptr_t *r_value);
88 bool BPY_execute_string_as_string(struct bContext *C,
89                                   const char *imports[],
90                                   const char *expr,
91                                   const bool verbose,
92                                   char **r_value);
93
94 bool BPY_execute_string_ex(struct bContext *C,
95                            const char *imports[],
96                            const char *expr,
97                            bool use_eval);
98 bool BPY_execute_string(struct bContext *C, const char *imports[], const char *expr);
99
100 void BPY_text_free_code(struct Text *text);
101 void BPY_modules_update(
102     struct bContext *C);  // XXX - annoying, need this for pointers that get out of date
103 void BPY_modules_load_user(struct bContext *C);
104
105 void BPY_app_handlers_reset(const short do_all);
106
107 void BPY_driver_reset(void);
108 float BPY_driver_exec(struct PathResolvedRNA *anim_rna,
109                       struct ChannelDriver *driver,
110                       struct ChannelDriver *driver_orig,
111                       const float evaltime);
112
113 void BPY_DECREF(void *pyob_ptr); /* Py_DECREF() */
114 void BPY_DECREF_RNA_INVALIDATE(void *pyob_ptr);
115 int BPY_context_member_get(struct bContext *C,
116                            const char *member,
117                            struct bContextDataResult *result);
118 void BPY_context_set(struct bContext *C);
119 void BPY_context_update(struct bContext *C);
120
121 void BPY_id_release(struct ID *id);
122
123 bool BPY_string_is_keyword(const char *str);
124
125 /* I18n for addons */
126 #ifdef WITH_INTERNATIONAL
127 const char *BPY_app_translations_py_pgettext(const char *msgctxt, const char *msgid);
128 #endif
129
130 #ifdef __cplusplus
131 } /* extern "C" */
132 #endif
133
134 #endif /* __BPY_EXTERN_H__ */