archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity
This repository has been archived on 2023-10-09. You can view files and clone it, but cannot push or open issues or pull requests.
Files
ce64cfd6edc2a0ec0aabfd4daaa5f655763cc74b
blender-archive/source/blender/python/intern/bpy_capi_utils.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

54 lines
1.8 KiB
C++
Raw Normal View History

doxygen: prevent GPL license block from being parsed as doxygen comment.
2011-02-23 10:52:22 +00:00
/*
PyOperator invoke function now receives the wmEvent and default properties as 2 python dictionary args. the Python invoke function can then edit the properties based on the event, once its finished the properties are copied back to the operator. python exec and invoke functions can now return RUNNING_MODAL, CANCELLED, FINISHED, PASS_THROUGH flags Still need to look into how python operators can make use of invoke/exec for a practical case. (Need to bring back the popup menu's)
2008-12-28 08:41:49 +00:00
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
correct fsf address
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
PyOperator invoke function now receives the wmEvent and default properties as 2 python dictionary args. the Python invoke function can then edit the properties based on the event, once its finished the properties are copied back to the operator. python exec and invoke functions can now return RUNNING_MODAL, CANCELLED, FINISHED, PASS_THROUGH flags Still need to look into how python operators can make use of invoke/exec for a practical case. (Need to bring back the popup menu's)
2008-12-28 08:41:49 +00:00
*/
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it.
2019-02-18 08:08:12 +11:00
/** \file
* \ingroup pythonintern
doxygen: blender/python tagged.
2011-02-27 20:10:08 +00:00
*/
Cleanup: style
2017-12-04 16:37:31 +11:00
#pragma once
get rid of warnings, fix for a refcount error
2009-03-21 16:03:26 +00:00
PyAPI: remove Python 3.7x compatibility code This removes Python version checks needed to build with 3.8+ and 3.7x. Ref D10381
2021-02-12 08:08:15 +11:00
#if PY_VERSION_HEX < 0x03090000
# error "Python 3.9 or greater is required, you'll need to update your Python."
default to Python3.3 on Linux for SCons and CMake, warn when building with python 3.2x or older. also remove casts to keep Python3.2 warning quiet.
2012-11-05 13:48:42 +00:00
#endif
Cleanup: correct usage of extern-C blocks in various places This removes extern-C blocks around other includes and adds such blocks for some headers that need them.
2020-07-28 16:32:30 +02:00
#ifdef __cplusplus
extern "C" {
#endif
Python Panels WIP - Register python panels - Added a generic class checking function BPY_class_validate() for panels/operators. - No button drawing yet Brecht, Added RNA_enum_value_from_id() and RNA_enum_id_from_value() to rna_access.c to do lookups between identifiers and values of EnumPropertyItem's, Not sure if these should go here.
2009-04-01 12:43:07 +00:00
struct EnumPropertyItem;
RNA: Generic Type Registration The Python API to define Panels and Operators is based on subclassing, this makes that system more generic, and based on RNA. Hopefully that will make it easy to make various parts of Blender more extensible. * The system simply uses RNA properties and functions and marks them with REGISTER to make them part of the type registration process. Additionally, the struct must provide a register/unregister callback to create/free the PanelType or similar. * From the python side there were some small changes, mainly that registration now goes trough bpy.types.register instead of bpy.ui.addPanel. * Only Panels have been wrapped this way now. Check rna_ui.c to see how this code works. There's still some rough edges and possibilities to make it cleaner, though it works without any manual python code. * Started some docs here: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/RNATypeRegistration * Also changed some RNA_property and RNA_struct functions to not require a PointerRNA anymore, where they were not required (which is actually the cause of most changed files).
2009-04-19 13:37:59 +00:00
struct ReportList;
2.5 Makes older python's compile.
2009-03-20 10:51:58 +00:00
Cleanup: Use const for RNA EnumPropertyItem args Practically all access to enum data is read-only.
2017-10-18 15:07:26 +11:00
char *BPy_enum_as_string(const struct EnumPropertyItem *item);
Python Panels WIP - Register python panels - Added a generic class checking function BPY_class_validate() for panels/operators. - No button drawing yet Brecht, Added RNA_enum_value_from_id() and RNA_enum_id_from_value() to rna_access.c to do lookups between identifiers and values of EnumPropertyItem's, Not sure if these should go here.
2009-04-01 12:43:07 +00:00
RNA: Generic Type Registration The Python API to define Panels and Operators is based on subclassing, this makes that system more generic, and based on RNA. Hopefully that will make it easy to make various parts of Blender more extensible. * The system simply uses RNA properties and functions and marks them with REGISTER to make them part of the type registration process. Additionally, the struct must provide a register/unregister callback to create/free the PanelType or similar. * From the python side there were some small changes, mainly that registration now goes trough bpy.types.register instead of bpy.ui.addPanel. * Only Panels have been wrapped this way now. Check rna_ui.c to see how this code works. There's still some rough edges and possibilities to make it cleaner, though it works without any manual python code. * Started some docs here: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/RNATypeRegistration * Also changed some RNA_property and RNA_struct functions to not require a PointerRNA anymore, where they were not required (which is actually the cause of most changed files).
2009-04-19 13:37:59 +00:00
/* error reporting */
code cleanup: warnings and use stdbool for bpy* funcs.
2013-01-07 05:26:12 +00:00
short BPy_reports_to_error(struct ReportList *reports, PyObject *exception, const bool clear);
PyAPI: utility function to print reports
2019-03-27 14:01:25 +11:00
void BPy_reports_write_stdout(const struct ReportList *reports, const char *header);
UI: errors in buttons now show in info report Mistakes in button expressions were previously only printed to the console.
2015-05-18 09:12:26 +10:00
bool BPy_errors_to_report_ex(struct ReportList *reports,
UI: improve errors when evaluating a number button fails Showing the Python error without any explanation is often not enough information and doesn't hint that the error was in the user input. The error report from a invalid expression such as '..1' used to be: ('invalid syntax', ('<string>', 1, 1, '..1')) Now reads: Error evaluating number, see Info editor for details: invalid syntax Address issue raised by T78913.
2020-07-27 13:46:58 +10:00
const char *error_prefix,
UI: errors in buttons now show in info report Mistakes in button expressions were previously only printed to the console.
2015-05-18 09:12:26 +10:00
const bool use_full,
const bool use_location);
UI: improve errors when evaluating a number button fails Showing the Python error without any explanation is often not enough information and doesn't hint that the error was in the user input. The error report from a invalid expression such as '..1' used to be: ('invalid syntax', ('<string>', 1, 1, '..1')) Now reads: Error evaluating number, see Info editor for details: invalid syntax Address issue raised by T78913.
2020-07-27 13:46:58 +10:00
bool BPy_errors_to_report_brief_with_prefix(struct ReportList *reports, const char *error_prefix);
UI: errors in buttons now show in info report Mistakes in button expressions were previously only printed to the console.
2015-05-18 09:12:26 +10:00
bool BPy_errors_to_report(struct ReportList *reports);
RNA: Generic Type Registration The Python API to define Panels and Operators is based on subclassing, this makes that system more generic, and based on RNA. Hopefully that will make it easy to make various parts of Blender more extensible. * The system simply uses RNA properties and functions and marks them with REGISTER to make them part of the type registration process. Additionally, the struct must provide a register/unregister callback to create/free the PanelType or similar. * From the python side there were some small changes, mainly that registration now goes trough bpy.types.register instead of bpy.ui.addPanel. * Only Panels have been wrapped this way now. Check rna_ui.c to see how this code works. There's still some rough edges and possibilities to make it cleaner, though it works without any manual python code. * Started some docs here: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/RNATypeRegistration * Also changed some RNA_property and RNA_struct functions to not require a PointerRNA anymore, where they were not required (which is actually the cause of most changed files).
2009-04-19 13:37:59 +00:00
Cleanup: remove duplicate context variable (__py_context) The context was stored both in __py_context & bpy_context_module. This avoids duplicate functions to update them too.
2020-10-15 18:12:03 +11:00
struct bContext *BPY_context_get(void);
Store the context for python in a static variable with assessor functions - BPy_GetContext/BPy_SetContext, Still not happy with this in the long term but its less problematic then storing the context in pythons namespace which couldn't be set before importing modules. This might fix a crash quite a few people have reported (but I cant reproduce).
2009-05-25 13:48:44 +00:00
bpy_context_set and bpy_context_clear to replace a number of functions (some were not always called causing bugs). fix for a leak when trying to run a text with a syntax error too.
2009-08-07 16:20:19 +00:00
extern void bpy_context_set(struct bContext *C, PyGILState_STATE *gilstate);
Clang Tidy: enable readability-non-const-parameter warning Clang Tidy reported a couple of false positives. I disabled those `NOLINTNEXTLINE`. Differential Revision: https://developer.blender.org/D8199
2020-07-13 11:27:09 +02:00
extern void bpy_context_clear(struct bContext *C, const PyGILState_STATE *gilstate);
hopefully fixes building on msvc, also some minor header edits
2012-11-05 14:58:12 +00:00
Cleanup: correct usage of extern-C blocks in various places This removes extern-C blocks around other includes and adds such blocks for some headers that need them.
2020-07-28 16:32:30 +02:00
#ifdef __cplusplus
}
#endif
Copy Permalink