Cleanup: use doxy section for itasc_plugin
[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 #pragma once
22
23 struct ARegionType;
24 struct AnimationEvalContext;
25 struct ChannelDriver; /* DNA_anim_types.h */
26 struct ID;            /* DNA_ID.h */
27 struct ListBase;      /* DNA_listBase.h */
28 struct Object;        /* DNA_object_types.h */
29 struct PathResolvedRNA;
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 struct wmWindowManager;
38
39 #include "BLI_utildefines.h"
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 void BPY_pyconstraint_exec(struct bPythonConstraint *con,
46                            struct bConstraintOb *cob,
47                            struct ListBase *targets);
48 //  void BPY_pyconstraint_settings(void *arg1, void *arg2);
49 void BPY_pyconstraint_target(struct bPythonConstraint *con, struct bConstraintTarget *ct);
50 void BPY_pyconstraint_update(struct Object *owner, struct bConstraint *con);
51 int BPY_is_pyconstraint(struct Text *text);
52 //  void BPY_free_pyconstraint_links(struct Text *text);
53
54 /* global interpreter lock */
55
56 typedef void *BPy_ThreadStatePtr;
57
58 /**
59  * Analogue of #PyEval_SaveThread()
60  */
61 BPy_ThreadStatePtr BPY_thread_save(void);
62 /**
63  * Analogue of #PyEval_RestoreThread()
64  */
65 void BPY_thread_restore(BPy_ThreadStatePtr tstate);
66
67 /* our own wrappers to Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS */
68 #define BPy_BEGIN_ALLOW_THREADS \
69   { \
70     BPy_ThreadStatePtr _bpy_saved_tstate = BPY_thread_save(); \
71     (void)0
72 #define BPy_END_ALLOW_THREADS \
73   BPY_thread_restore(_bpy_saved_tstate); \
74   } \
75   (void)0
76
77 void BPY_text_free_code(struct Text *text);
78 void BPY_modules_update(void);
79 void BPY_modules_load_user(struct bContext *C);
80
81 void BPY_app_handlers_reset(const short do_all);
82
83 /**
84  * Update function, it gets rid of py-drivers global dictionary, forcing
85  * BPY_driver_exec to recreate it. This function is used to force
86  * reloading the Blender text module "pydrivers.py", if available, so
87  * updates in it reach py-driver evaluation.
88  */
89 void BPY_driver_reset(void);
90
91 /**
92  * This evaluates Python driver expressions, `driver_orig->expression`
93  * is a Python expression that should evaluate to a float number, which is returned.
94  */
95 float BPY_driver_exec(struct PathResolvedRNA *anim_rna,
96                       struct ChannelDriver *driver,
97                       struct ChannelDriver *driver_orig,
98                       const struct AnimationEvalContext *anim_eval_context);
99
100 void BPY_DECREF(void *pyob_ptr); /* Py_DECREF() */
101 void BPY_DECREF_RNA_INVALIDATE(void *pyob_ptr);
102 int BPY_context_member_get(struct bContext *C,
103                            const char *member,
104                            struct bContextDataResult *result);
105 void BPY_context_set(struct bContext *C);
106 void BPY_context_update(struct bContext *C);
107
108 #define BPY_context_dict_clear_members(C, ...) \
109   BPY_context_dict_clear_members_array(&((C)->data.py_context), \
110                                        (C)->data.py_context_orig, \
111                                        ((const char *[]){__VA_ARGS__}), \
112                                        VA_NARGS_COUNT(__VA_ARGS__))
113 /**
114  * Use for `CTX_*_set(..)` functions need to set values which are later read back as expected.
115  * In this case we don't want the Python context to override the values as it causes problems
116  * see T66256.
117  *
118  * \param dict_p: A pointer to #bContext.data.py_context so we can assign a new value.
119  * \param dict_orig: The value of #bContext.data.py_context_orig to check if we need to copy.
120  *
121  * \note Typically accessed via #BPY_context_dict_clear_members macro.
122  */
123 void BPY_context_dict_clear_members_array(void **dict_p,
124                                           void *dict_orig,
125                                           const char *context_members[],
126                                           uint context_members_len);
127
128 void BPY_id_release(struct ID *id);
129
130 bool BPY_string_is_keyword(const char *str);
131
132 /* bpy_rna_callback.c */
133 void BPY_callback_screen_free(struct ARegionType *art);
134 void BPY_callback_wm_free(struct wmWindowManager *wm);
135
136 /* I18n for addons */
137 #ifdef WITH_INTERNATIONAL
138 const char *BPY_app_translations_py_pgettext(const char *msgctxt, const char *msgid);
139 #endif
140
141 #ifdef __cplusplus
142 } /* extern "C" */
143 #endif