test2/source/blender/python/intern/bpy_rna_callback.hh

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

#pragma once

/** \file
 * \ingroup pythonintern
 */

#include <Python.h>

struct BPy_StructRNA;

#if 0
PyObject *pyrna_callback_add(BPy_StructRNA *self, PyObject *args);
PyObject *pyrna_callback_remove(BPy_StructRNA *self, PyObject *args);
#endif

PyObject *pyrna_callback_classmethod_add(PyObject *self, PyObject *args);
PyObject *pyrna_callback_classmethod_remove(PyObject *self, PyObject *args);
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 */`
python support for defining region drawing callbacks, while not directly related to operators, this means python can now make operators that draw in the 3D viewport interactively. nicer then 2.4x space handelers because you can register draw handelers to draw pre/post 3d space or in pixel space. 2010-02-27 13:27:06 +00:00
correct include guards and add checks in check_style_c.py for them. 2013-09-19 23:17:52 +00:00			`#pragma once`

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			`*/`

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>`

python support for defining region drawing callbacks, while not directly related to operators, this means python can now make operators that draw in the 3D viewport interactively. nicer then 2.4x space handelers because you can register draw handelers to draw pre/post 3d space or in pixel space. 2010-02-27 13:27:06 +00:00			`struct BPy_StructRNA;`

Change region drawing callbacks to work much closer to how blender manages them internally. - yes, this does break scripts, but the api is marked experimental. ED_region_draw_cb_activate() adds a callback to a region type whereas the api made it look like the callback was being added to the region instance. Use a class method on bpy.types.Space to manage region drawing, eg. was: self._handle = context.region.callback_add(draw_callback_px, args, 'POST_PIXEL') is now: self._handle = bpy.types.SpaceView3D.draw_handler_add(draw_callback_px, args, 'WINDOW', 'POST_PIXEL') 2012-12-20 13:29:58 +00:00			`#if 0`
fix for warnings from Sparse static source code checker, mostly BKE/BLI and python functions. - use NULL rather then 0 where possible (makes code & function calls more readable IMHO). - set static variables and functions (exposed some unused vars/funcs). - use func(void) rather then func() for definitions. 2011-02-13 10:52:18 +00:00			`PyObject pyrna_callback_add(BPy_StructRNA self, PyObject *args);`
			`PyObject pyrna_callback_remove(BPy_StructRNA self, PyObject *args);`
Change region drawing callbacks to work much closer to how blender manages them internally. - yes, this does break scripts, but the api is marked experimental. ED_region_draw_cb_activate() adds a callback to a region type whereas the api made it look like the callback was being added to the region instance. Use a class method on bpy.types.Space to manage region drawing, eg. was: self._handle = context.region.callback_add(draw_callback_px, args, 'POST_PIXEL') is now: self._handle = bpy.types.SpaceView3D.draw_handler_add(draw_callback_px, args, 'WINDOW', 'POST_PIXEL') 2012-12-20 13:29:58 +00:00			`#endif`

Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes 2020-09-04 20:59:13 +02:00			`PyObject pyrna_callback_classmethod_add(PyObject self, PyObject *args);`
			`PyObject pyrna_callback_classmethod_remove(PyObject self, PyObject *args);`