BPY_extern_run.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_sys_types.h"
 
#include "BLI_compiler_attrs.h"
 
struct ReportList;
struct Text;
struct bContext;
 
/* `bpy_interface_run.cc` */
 
/* -------------------------------------------------------------------- */
bool BPY_run_filepath(bContext *C, const char *filepath, ReportList *reports) ATTR_NONNULL(1, 2);
bool BPY_run_text(bContext *C, Text *text, ReportList *reports, bool do_jump) ATTR_NONNULL(1, 2);
 
/* -------------------------------------------------------------------- */
bool BPY_run_string_exec(bContext *C, const char *imports[], const char *expr);
bool BPY_run_string_eval(bContext *C, const char *imports[], const char *expr);
 
/* -------------------------------------------------------------------- */
struct BPy_RunErrInfo {
  bool use_single_line_error;
 
  ReportList *reports;
  const char *report_prefix;
 
  char **r_string;
};
 
bool BPY_run_string_as_number(bContext *C,
                              const char *imports[],
                              const char *expr,
                              BPy_RunErrInfo *err_info,
                              double *r_value) ATTR_NONNULL(1, 3, 5);
bool BPY_run_string_as_intptr(bContext *C,
                              const char *imports[],
                              const char *expr,
                              BPy_RunErrInfo *err_info,
                              intptr_t *r_value) ATTR_NONNULL(1, 3, 5);
bool BPY_run_string_as_string_and_len(bContext *C,
                                      const char *imports[],
                                      const char *expr,
                                      BPy_RunErrInfo *err_info,
                                      char **r_value,
                                      size_t *r_value_len) ATTR_NONNULL(1, 3, 5, 6);
 
bool BPY_run_string_as_string(bContext *C,
                              const char *imports[],
                              const char *expr,
                              BPy_RunErrInfo *err_info,
                              char **r_value) ATTR_NONNULL(1, 3, 5);
 
bool BPY_run_string_as_string_and_len_or_none(bContext *C,
                                              const char *imports[],
                                              const char *expr,
                                              BPy_RunErrInfo *err_info,
                                              char **r_value,
                                              size_t *r_value_len) ATTR_NONNULL(1, 3, 5, 6);
 
bool BPY_run_string_as_string_or_none(bContext *C,
                                      const char *imports[],
                                      const char *expr,
                                      BPy_RunErrInfo *err_info,
                                      char **r_value) ATTR_NONNULL(1, 3, 5);