c1bc70b711
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/
79 lines
2.3 KiB
C
79 lines
2.3 KiB
C
/* SPDX-FileCopyrightText: 2023 Blender Foundation
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/**
|
|
* \file
|
|
* \ingroup pygen
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "BLI_sys_types.h"
|
|
|
|
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);
|