e955c94ed3
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.
87 lines
2.4 KiB
C
87 lines
2.4 KiB
C
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/**
|
|
* \file
|
|
* \ingroup pygen
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "BLI_sys_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct EnumPropertyItem;
|
|
|
|
/**
|
|
* Convert all items into a single comma separated string.
|
|
* Use for creating useful error messages.
|
|
*/
|
|
char *pyrna_enum_repr(const struct EnumPropertyItem *item);
|
|
|
|
/**
|
|
* Same as #RNA_enum_value_from_id, but raises an exception.
|
|
*/
|
|
int pyrna_enum_value_from_id(const struct EnumPropertyItem *item,
|
|
const char *identifier,
|
|
int *value,
|
|
const char *error_prefix);
|
|
|
|
/**
|
|
* Takes a set of strings and map it to and array of booleans.
|
|
*
|
|
* Useful when the values aren't flags.
|
|
*
|
|
* \param type_convert_sign: Maps signed to unsigned range,
|
|
* needed when we want to use the full range of a signed short/char.
|
|
*/
|
|
unsigned int *pyrna_enum_bitmap_from_set(const struct EnumPropertyItem *items,
|
|
PyObject *value,
|
|
int type_size,
|
|
bool type_convert_sign,
|
|
int bitmap_size,
|
|
const char *error_prefix);
|
|
|
|
/**
|
|
* 'value' _must_ be a set type, error check before calling.
|
|
*/
|
|
int pyrna_enum_bitfield_from_set(const struct EnumPropertyItem *items,
|
|
PyObject *value,
|
|
int *r_value,
|
|
const char *error_prefix);
|
|
|
|
PyObject *pyrna_enum_bitfield_as_set(const struct EnumPropertyItem *items, int value);
|
|
|
|
/**
|
|
* Data for #pyrna_enum_value_parse_string & #pyrna_enum_bitfield_parse_set parsing utilities.
|
|
* Use with #PyArg_ParseTuple's `O&` formatting.
|
|
*/
|
|
struct BPy_EnumProperty_Parse {
|
|
const struct EnumPropertyItem *items;
|
|
/**
|
|
* Set when the value was successfully parsed.
|
|
* Useful if the input ever needs to be included in an error message.
|
|
* (if the value is not supported under certain conditions).
|
|
*/
|
|
PyObject *value_orig;
|
|
|
|
int value;
|
|
bool is_set;
|
|
};
|
|
/**
|
|
* Use with #PyArg_ParseTuple's `O&` formatting.
|
|
*/
|
|
int pyrna_enum_value_parse_string(PyObject *o, void *p);
|
|
/**
|
|
* Use with #PyArg_ParseTuple's `O&` formatting.
|
|
*/
|
|
int pyrna_enum_bitfield_parse_set(PyObject *o, void *p);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|