test/source/blender/python/intern/bpy_operator_wrap.hh

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

/** \file
 * \ingroup pythonintern
 */

#pragma once

#include <Python.h>

struct wmOperatorType;

/**
 * These are used for operator methods, used by `bpy_operator.cc`.
 *
 * Accessed via sub-classes of `bpy.types.Macro` using the `define` method.
 */
PyObject *PYOP_wrap_macro_define(PyObject *self, PyObject *args);

/* Exposed to RNA/WM API. */

/**
 * Generic function used by all Python defined operators
 * it's passed as an argument to #WM_operatortype_append_ptr in for operator registration.
 */
void BPY_RNA_operator_wrapper(wmOperatorType *ot, void *userdata);
/**
 * Generic function used by all Python defined macro-operators
 * it's passed as an argument to #WM_operatortype_append_ptr in for operator registration.
 */
void BPY_RNA_operator_macro_wrapper(wmOperatorType *ot, void *userdata);
License Headers: Set copyright to "Blender Authors", add AUTHORS Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783. 2023-08-16 00:20:26 +10:00			`/* SPDX-FileCopyrightText: 2023 Blender Authors`
Cleanup: Add a copyright notice to files and use SPDX format A lot of files were missing copyright field in the header and the Blender Foundation contributed to them in a sense of bug fixing and general maintenance. This change makes it explicit that those files are at least partially copyrighted by the Blender Foundation. Note that this does not make it so the Blender Foundation is the only holder of the copyright in those files, and developers who do not have a signed contract with the foundation still hold the copyright as well. Another aspect of this change is using SPDX format for the header. We already used it for the license specification, and now we state it for the copyright as well, following the FAQ: https://reuse.software/faq/ 2023-05-31 16:19:06 +02:00			`*`
			`* SPDX-License-Identifier: GPL-2.0-or-later */`
doxygen: blender/python tagged. 2011-02-27 20:10:08 +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			`*/`

unify include guard defines, __$FILENAME__ without the underscores these clogged up the namespace for autocompleation which was annoying. 2012-02-17 18:59:41 +00:00			`#pragma once`
python operators (in bpy_opwrapper.) This means you can define an operator in python that is called from C or Python - like any other operator. Python functions for invoke and exec can be registered with an operator name. keywords are read from the python exec() function, then used to create operator properties. The default python values are used to set the property type and defaults. def exec(size=2.0, text="blah"): ... is equivalent to... prop = RNA_def_property(ot->srna, "size", PROP_FLOAT, PROP_NONE); RNA_def_property_float_default(prop, 2.0f); prop = RNA_def_property(ot->srna, "size", PROP_STRING, PROP_NONE); RNA_def_property_string_default(prop, "blah"); TODO - make use of events * return OPERATOR_CANCELLED/OPERATOR_FINISHED.. etc * add support for array args * more testing 2008-12-27 14:52:49 +00:00
Refactor: Make header files more clangd and clang-tidy friendly When using clangd or running clang-tidy on headers there are currently many errors. These are noisy in IDEs, make auto fixes impossible, and break features like code completion, refactoring and navigation. This makes source/blender headers work by themselves, which is generally the goal anyway. But #includes and forward declarations were often incomplete. * Add #includes and forward declarations * Add IWYU pragma: export in a few places * Remove some unused #includes (but there are many more) * Tweak ShaderCreateInfo macros to work better with clangd Some types of headers still have errors, these could be fixed or worked around with more investigation. Mostly preprocessor template headers like NOD_static_types.h. Note that that disabling WITH_UNITY_BUILD is required for clangd to work properly, otherwise compile_commands.json does not contain the information for the relevant source files. For more details see the developer docs: https://developer.blender.org/docs/handbook/tooling/clangd/ Pull Request: https://projects.blender.org/blender/blender/pulls/132608 2025-01-07 12:39:13 +01:00			`#include <Python.h>`

fix warnings. 2011-02-15 03:20:12 +00:00			`struct wmOperatorType;`

PyAPI: fixes for defining operator macros - Support passing in operator ID's using Python dot syntax. - Support define operators that haven't yet been registered matching Blender's own behavior. Also add doc-string for bpy.types.Macro.define. 2024-06-01 16:17:02 +10:00			`/**`
			* These are used for operator methods, used by `bpy_operator.cc`.
			`*`
			* Accessed via sub-classes of `bpy.types.Macro` using the `define` method.
			`*/`
Support for the C Macro system in Python. Basic definition works like a python operator but you derive from "bpy.types.Macro" instead. Operators are added to the macro after it has been added with "bpy.ops.add_macro" through the class method "define" which takes an operator id and returns an OperatorMacroType (new RNA type) for which properties can then be defined to be passed to the operator when run. Example: http://blenderartists.org/~theeth/bf/macro.py Using this system, it should be easy to add an operator to the console that converts selected lines into a macro or even a more generic record macro system. 2009-12-05 19:27:26 +00:00			`PyObject PYOP_wrap_macro_define(PyObject self, PyObject *args);`
fix warnings. 2011-02-15 03:20:12 +00:00
Cleanup: spelling in comments 2022-11-02 10:14:37 +11:00			`/* Exposed to RNA/WM API. */`

Cleanup: move public doc-strings into headers for 'python' 2021-12-02 17:24:04 +11:00			`/**`
			`* Generic function used by all Python defined operators`
			`* it's passed as an argument to #WM_operatortype_append_ptr in for operator registration.`
			`*/`
Refactor: Move BPY `intern` remaining headers to proper C++ ones. 2024-09-24 12:23:25 +02:00			`void BPY_RNA_operator_wrapper(wmOperatorType ot, void userdata);`
Cleanup: move public doc-strings into headers for 'python' 2021-12-02 17:24:04 +11:00			`/**`
			`* Generic function used by all Python defined macro-operators`
			`* it's passed as an argument to #WM_operatortype_append_ptr in for operator registration.`
			`*/`
Refactor: Move BPY `intern` remaining headers to proper C++ ones. 2024-09-24 12:23:25 +02:00			`void BPY_RNA_operator_macro_wrapper(wmOperatorType ot, void userdata);`