Bastien Montagne
9da7dfa158
This will allow much finer controll over how we copy data-blocks, from full copy in Main database, to "lighter" ones (out of Main, inside an already allocated datablock, etc.). This commit also transfers a llot of what was previously handled by per-ID-type custom code to generic ID handling code in BKE_library. Hopefully will avoid in future inconsistencies and missing bits we had all over the codebase in the past. It also adds missing copying handling for a few types, most notably Scene (which where using a fully customized handling previously). Note that the type of allocation used during copying (regular in Main, allocated but outside of Main, or not allocated by ID handling code at all) is stored in ID's, which allows to handle them correctly when freeing. This needs to be taken care of with caution when doing 'weird' unusual things with ID copying and/or allocation! As a final note, while rather noisy, this commit will hopefully not break too much existing branches, old 'API' has been kept for the main part, as a wrapper around new code. Cleaning it up will happen later. Design task : T51804 Phab Diff: D2714
154 lines
6.5 KiB
C++
154 lines
6.5 KiB
C++
/*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* 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,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* Contributor(s): Joseph Eagar
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
|
|
#ifndef __BKE_IDPROP_H__
|
|
#define __BKE_IDPROP_H__
|
|
|
|
/** \file BKE_idprop.h
|
|
* \ingroup bke
|
|
* \author Joseph Eagar
|
|
*/
|
|
|
|
#include "DNA_ID.h"
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
struct IDProperty;
|
|
struct ID;
|
|
|
|
typedef union IDPropertyTemplate {
|
|
int i;
|
|
float f;
|
|
double d;
|
|
struct {
|
|
const char *str;
|
|
int len;
|
|
char subtype;
|
|
} string;
|
|
struct ID *id;
|
|
struct {
|
|
int len;
|
|
char type;
|
|
} array;
|
|
struct {
|
|
int matvec_size;
|
|
const float *example;
|
|
} matrix_or_vector;
|
|
} IDPropertyTemplate;
|
|
|
|
/* ----------- Property Array Type ---------- */
|
|
|
|
IDProperty *IDP_NewIDPArray(const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
IDProperty *IDP_CopyIDPArray(const IDProperty *array, const int flag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
|
|
/* shallow copies item */
|
|
void IDP_SetIndexArray(struct IDProperty *prop, int index, struct IDProperty *item) ATTR_NONNULL();
|
|
struct IDProperty *IDP_GetIndexArray(struct IDProperty *prop, int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
void IDP_AppendArray(struct IDProperty *prop, struct IDProperty *item);
|
|
void IDP_ResizeIDPArray(struct IDProperty *prop, int len);
|
|
|
|
/* ----------- Numeric Array Type ----------- */
|
|
/*this function works for strings too!*/
|
|
void IDP_ResizeArray(struct IDProperty *prop, int newlen);
|
|
void IDP_FreeArray(struct IDProperty *prop);
|
|
|
|
/* ---------- String Type ------------ */
|
|
IDProperty *IDP_NewString(const char *st, const char *name, int maxlen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2 /* 'name 'arg */); /* maxlen excludes '\0' */
|
|
void IDP_AssignString(struct IDProperty *prop, const char *st, int maxlen) ATTR_NONNULL(); /* maxlen excludes '\0' */
|
|
void IDP_ConcatStringC(struct IDProperty *prop, const char *st) ATTR_NONNULL();
|
|
void IDP_ConcatString(struct IDProperty *str1, struct IDProperty *append) ATTR_NONNULL();
|
|
void IDP_FreeString(struct IDProperty *prop) ATTR_NONNULL();
|
|
|
|
/*-------- ID Type -------*/
|
|
|
|
typedef void(*IDPWalkFunc)(void *userData, IDProperty *idp);
|
|
|
|
/*-------- Group Functions -------*/
|
|
|
|
/** Sync values from one group to another, only where they match */
|
|
void IDP_SyncGroupValues(struct IDProperty *dest, const struct IDProperty *src) ATTR_NONNULL();
|
|
void IDP_SyncGroupTypes(struct IDProperty *dest, const struct IDProperty *src, const bool do_arraylen) ATTR_NONNULL();
|
|
void IDP_ReplaceGroupInGroup(struct IDProperty *dest, const struct IDProperty *src) ATTR_NONNULL();
|
|
void IDP_ReplaceInGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
|
|
void IDP_ReplaceInGroup_ex(struct IDProperty *group, struct IDProperty *prop, struct IDProperty *prop_exist);
|
|
void IDP_MergeGroup(IDProperty *dest, const IDProperty *src, const bool do_overwrite) ATTR_NONNULL();
|
|
bool IDP_AddToGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
|
|
bool IDP_InsertToGroup(struct IDProperty *group, struct IDProperty *previous,
|
|
struct IDProperty *pnew) ATTR_NONNULL(1 /* group */, 3 /* pnew */);
|
|
void IDP_RemoveFromGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
|
|
void IDP_FreeFromGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
|
|
|
|
IDProperty *IDP_GetPropertyFromGroup(struct IDProperty *prop, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
IDProperty *IDP_GetPropertyTypeFromGroup(struct IDProperty *prop, const char *name, const char type) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
|
|
/*-------- Main Functions --------*/
|
|
struct IDProperty *IDP_GetProperties(struct ID *id, const bool create_if_needed) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
struct IDProperty *IDP_CopyProperty(const struct IDProperty *prop) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
struct IDProperty *IDP_CopyProperty_ex(const struct IDProperty *prop, const int flag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
|
|
bool IDP_EqualsProperties_ex(IDProperty *prop1, IDProperty *prop2, const bool is_strict) ATTR_WARN_UNUSED_RESULT;
|
|
|
|
bool IDP_EqualsProperties(struct IDProperty *prop1, struct IDProperty *prop2) ATTR_WARN_UNUSED_RESULT;
|
|
|
|
struct IDProperty *IDP_New(const char type, const IDPropertyTemplate *val, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
|
|
void IDP_FreeProperty_ex(struct IDProperty *prop, const bool do_id_user);
|
|
void IDP_FreeProperty(struct IDProperty *prop);
|
|
|
|
void IDP_ClearProperty(IDProperty *prop);
|
|
|
|
void IDP_RelinkProperty(struct IDProperty *prop);
|
|
|
|
#define IDP_Int(prop) ((prop)->data.val)
|
|
#define IDP_Array(prop) ((prop)->data.pointer)
|
|
/* C11 const correctness for casts */
|
|
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
|
|
# define IDP_Float(prop) _Generic((prop), \
|
|
IDProperty *: (*(float *)&(prop)->data.val), \
|
|
const IDProperty *: (*(const float *)&(prop)->data.val))
|
|
# define IDP_Double(prop) _Generic((prop), \
|
|
IDProperty *: (*(double *)&(prop)->data.val), \
|
|
const IDProperty *: (*(const double *)&(prop)->data.val))
|
|
# define IDP_String(prop) _Generic((prop), \
|
|
IDProperty *: ((char *) (prop)->data.pointer), \
|
|
const IDProperty *: ((const char *) (prop)->data.pointer))
|
|
# define IDP_IDPArray(prop) _Generic((prop), \
|
|
IDProperty *: ((IDProperty *) (prop)->data.pointer), \
|
|
const IDProperty *: ((const IDProperty *) (prop)->data.pointer))
|
|
# define IDP_Id(prop) _Generic((prop), \
|
|
IDProperty *: ((ID *) (prop)->data.pointer), \
|
|
const IDProperty *: ((const ID *) (prop)->data.pointer))
|
|
#else
|
|
# define IDP_Float(prop) (*(float *)&(prop)->data.val)
|
|
# define IDP_Double(prop) (*(double *)&(prop)->data.val)
|
|
# define IDP_String(prop) ((char *) (prop)->data.pointer)
|
|
# define IDP_IDPArray(prop) ((IDProperty *) (prop)->data.pointer)
|
|
# define IDP_Id(prop) ((ID *) (prop)->data.pointer)
|
|
#endif
|
|
|
|
#ifndef NDEBUG
|
|
/* for printout only */
|
|
void IDP_spit(IDProperty *prop);
|
|
#endif
|
|
|
|
#endif /* __BKE_IDPROP_H__ */
|