Datablock ID Properties
[blender.git] / source / blender / blenkernel / BKE_idprop.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Joseph Eagar
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22  
23 #ifndef __BKE_IDPROP_H__
24 #define __BKE_IDPROP_H__
25
26 /** \file BKE_idprop.h
27  *  \ingroup bke
28  *  \author Joseph Eagar
29  */
30
31 #include "DNA_ID.h"
32
33 #include "BLI_compiler_attrs.h"
34
35 struct IDProperty;
36 struct ID;
37
38 typedef union IDPropertyTemplate {
39         int i;
40         float f;
41         double d;
42         struct {
43                 const char *str;
44                 int len;
45                 char subtype;
46         } string;
47         struct ID *id;
48         struct {
49                 int len;
50                 char type;
51         } array;
52         struct {
53                 int matvec_size;
54                 const float *example;
55         } matrix_or_vector;
56 } IDPropertyTemplate;
57
58 /* ----------- Property Array Type ---------- */
59
60 IDProperty *IDP_NewIDPArray(const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
61 IDProperty *IDP_CopyIDPArray(const IDProperty *array) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
62
63 /* shallow copies item */
64 void IDP_SetIndexArray(struct IDProperty *prop, int index, struct IDProperty *item) ATTR_NONNULL();
65 struct IDProperty *IDP_GetIndexArray(struct IDProperty *prop, int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
66 void IDP_AppendArray(struct IDProperty *prop, struct IDProperty *item);
67 void IDP_ResizeIDPArray(struct IDProperty *prop, int len);
68
69 /* ----------- Numeric Array Type ----------- */
70 /*this function works for strings too!*/
71 void IDP_ResizeArray(struct IDProperty *prop, int newlen);
72 void IDP_FreeArray(struct IDProperty *prop);
73
74 /* ---------- String Type ------------ */
75 IDProperty *IDP_NewString(const char *st, const char *name, int maxlen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2 /* 'name 'arg */); /* maxlen excludes '\0' */
76 void IDP_AssignString(struct IDProperty *prop, const char *st, int maxlen) ATTR_NONNULL(); /* maxlen excludes '\0' */
77 void IDP_ConcatStringC(struct IDProperty *prop, const char *st) ATTR_NONNULL();
78 void IDP_ConcatString(struct IDProperty *str1, struct IDProperty *append) ATTR_NONNULL();
79 void IDP_FreeString(struct IDProperty *prop) ATTR_NONNULL();
80
81 /*-------- ID Type -------*/
82
83 typedef void(*IDPWalkFunc)(void *userData, IDProperty *idp);
84
85 /*-------- Group Functions -------*/
86
87 /** Sync values from one group to another, only where they match */
88 void IDP_SyncGroupValues(struct IDProperty *dest, const struct IDProperty *src) ATTR_NONNULL();
89 void IDP_SyncGroupTypes(struct IDProperty *dest, const struct IDProperty *src, const bool do_arraylen) ATTR_NONNULL();
90 void IDP_ReplaceGroupInGroup(struct IDProperty *dest, const struct IDProperty *src) ATTR_NONNULL();
91 void IDP_ReplaceInGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
92 void IDP_ReplaceInGroup_ex(struct IDProperty *group, struct IDProperty *prop, struct IDProperty *prop_exist);
93 void IDP_MergeGroup(IDProperty *dest, const IDProperty *src, const bool do_overwrite) ATTR_NONNULL();
94 bool IDP_AddToGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
95 bool IDP_InsertToGroup(struct IDProperty *group, struct IDProperty *previous,
96                       struct IDProperty *pnew) ATTR_NONNULL(1 /* group */, 3 /* pnew */);
97 void IDP_RemoveFromGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
98 void IDP_FreeFromGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
99
100 IDProperty *IDP_GetPropertyFromGroup(struct IDProperty *prop, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
101 IDProperty *IDP_GetPropertyTypeFromGroup(struct IDProperty *prop, const char *name, const char type) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
102
103 /*-------- Main Functions --------*/
104 struct IDProperty *IDP_GetProperties(struct ID *id, const bool create_if_needed) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
105 struct IDProperty *IDP_CopyProperty(const struct IDProperty *prop) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
106
107 bool IDP_EqualsProperties_ex(IDProperty *prop1, IDProperty *prop2, const bool is_strict) ATTR_WARN_UNUSED_RESULT;
108
109 bool IDP_EqualsProperties(struct IDProperty *prop1, struct IDProperty *prop2) ATTR_WARN_UNUSED_RESULT;
110
111 struct IDProperty *IDP_New(const char type, const IDPropertyTemplate *val, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
112
113 void IDP_FreeProperty_ex(struct IDProperty *prop, const bool do_id_user);
114 void IDP_FreeProperty(struct IDProperty *prop);
115
116 void IDP_ClearProperty(IDProperty *prop);
117
118 void IDP_RelinkProperty(struct IDProperty *prop);
119
120 #define IDP_Int(prop)                     ((prop)->data.val)
121 #define IDP_Array(prop)                   ((prop)->data.pointer)
122 /* C11 const correctness for casts */
123 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
124 #  define IDP_Float(prop)  _Generic((prop), \
125         IDProperty *:             (*(float *)&(prop)->data.val), \
126         const IDProperty *: (*(const float *)&(prop)->data.val))
127 #  define IDP_Double(prop)  _Generic((prop), \
128         IDProperty *:             (*(double *)&(prop)->data.val), \
129         const IDProperty *: (*(const double *)&(prop)->data.val))
130 #  define IDP_String(prop)  _Generic((prop), \
131         IDProperty *:             ((char *) (prop)->data.pointer), \
132         const IDProperty *: ((const char *) (prop)->data.pointer))
133 #  define IDP_IDPArray(prop)  _Generic((prop), \
134         IDProperty *:             ((IDProperty *) (prop)->data.pointer), \
135         const IDProperty *: ((const IDProperty *) (prop)->data.pointer))
136 #  define IDP_Id(prop)  _Generic((prop), \
137         IDProperty *:             ((ID *) (prop)->data.pointer), \
138         const IDProperty *: ((const ID *) (prop)->data.pointer))
139 #else
140 #  define IDP_Float(prop)        (*(float *)&(prop)->data.val)
141 #  define IDP_Double(prop)      (*(double *)&(prop)->data.val)
142 #  define IDP_String(prop)         ((char *) (prop)->data.pointer)
143 #  define IDP_IDPArray(prop) ((IDProperty *) (prop)->data.pointer)
144 #  define IDP_Id(prop)               ((ID *) (prop)->data.pointer)
145 #endif
146
147 #ifndef NDEBUG
148 /* for printout only */
149 void IDP_spit(IDProperty *prop);
150 #endif
151
152 #endif /* __BKE_IDPROP_H__ */