BPY_extern.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <optional>
#include <string>
 
#include "BLI_sys_types.h"
 
#ifdef WITH_INTERNATIONAL
 
#  include "BLI_string_ref.hh"
 
#endif
 
struct ARegionType;
struct AnimationEvalContext;
struct ChannelDriver; /* DNA_anim_types.h */
struct ID;            /* DNA_ID.h */
struct ListBase;      /* DNA_listBase.h */
struct Object;        /* DNA_object_types.h */
struct PathResolvedRNA;
struct Text;              /* defined in DNA_text_types.h */
struct bConstraint;       /* DNA_constraint_types.h */
struct bConstraintOb;     /* DNA_constraint_types.h */
struct bConstraintTarget; /* DNA_constraint_types.h */
struct bContext;
struct bContextDataResult;
struct StructRNA;
struct wmWindowManager;
 
/* global interpreter lock */
 
using BPy_ThreadStatePtr = void *;

[[nodiscard]] BPy_ThreadStatePtr BPY_thread_save();
void BPY_thread_restore(BPy_ThreadStatePtr tstate);

#define BPy_BEGIN_ALLOW_THREADS \
  { \
    BPy_ThreadStatePtr _bpy_saved_tstate = BPY_thread_save(); \
    (void)0
#define BPy_END_ALLOW_THREADS \
  BPY_thread_restore(_bpy_saved_tstate); \
  } \
  (void)0

void BPY_thread_backtrace_print();
 
void BPY_text_free_code(Text *text);
void BPY_modules_update();
void BPY_modules_load_user(bContext *C);
 
void BPY_app_handlers_reset(bool do_all);

void BPY_driver_exit();

void BPY_driver_reset();

[[nodiscard]] float BPY_driver_exec(PathResolvedRNA *anim_rna,
                                    ChannelDriver *driver,
                                    ChannelDriver *driver_orig,
                                    const AnimationEvalContext *anim_eval_context);

void BPY_DECREF(void *pyob_ptr);
 
void BPY_DECREF_RNA_INVALIDATE(void *pyob_ptr);
[[nodiscard]] bool BPY_context_member_get(bContext *C,
                                          const char *member,
                                          bContextDataResult *result);
void BPY_context_set(bContext *C);
void BPY_context_update(bContext *C);

void BPY_context_dict_clear_members_array(void **dict_p,
                                          void *dict_orig,
                                          const char *context_members[],
                                          uint context_members_len);
 
void BPY_id_release(ID *id);

void BPY_free_srna_pytype(StructRNA *srna);

[[nodiscard]] bool BPY_string_is_keyword(const char *str);

[[nodiscard]] std::optional<std::string> BPY_python_current_file_and_line(void);
 
/* `bpy_rna_callback.cc` */
 
void BPY_callback_screen_free(ARegionType *art);
void BPY_callback_wm_free(wmWindowManager *wm);
 
/* I18n for addons */
#ifdef WITH_INTERNATIONAL
[[nodiscard]] std::optional<blender::StringRefNull> BPY_app_translations_py_pgettext(
    blender::StringRef msgctxt, blender::StringRef msgid);
#endif