Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / BKE_idprop.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BKE_IDPROP_H__
18 #define __BKE_IDPROP_H__
19
20 /** \file \ingroup bke
21  */
22
23 #include "DNA_ID.h"
24
25 #include "BLI_compiler_attrs.h"
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 struct ID;
32 struct IDProperty;
33
34 typedef union IDPropertyTemplate {
35         int i;
36         float f;
37         double d;
38         struct {
39                 const char *str;
40                 int len;
41                 char subtype;
42         } string;
43         struct ID *id;
44         struct {
45                 int len;
46                 char type;
47         } array;
48         struct {
49                 int matvec_size;
50                 const float *example;
51         } matrix_or_vector;
52 } IDPropertyTemplate;
53
54 /* ----------- Property Array Type ---------- */
55
56 IDProperty *IDP_NewIDPArray(const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
57 IDProperty *IDP_CopyIDPArray(const IDProperty *array, const int flag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
58
59 /* shallow copies item */
60 void IDP_SetIndexArray(struct IDProperty *prop, int index, struct IDProperty *item) ATTR_NONNULL();
61 struct IDProperty *IDP_GetIndexArray(struct IDProperty *prop, int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
62 void IDP_AppendArray(struct IDProperty *prop, struct IDProperty *item);
63 void IDP_ResizeIDPArray(struct IDProperty *prop, int len);
64
65 /* ----------- Numeric Array Type ----------- */
66 /*this function works for strings too!*/
67 void IDP_ResizeArray(struct IDProperty *prop, int newlen);
68 void IDP_FreeArray(struct IDProperty *prop);
69
70 /* ---------- String Type ------------ */
71 IDProperty *IDP_NewString(const char *st, const char *name, int maxlen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2 /* 'name 'arg */); /* maxlen excludes '\0' */
72 void IDP_AssignString(struct IDProperty *prop, const char *st, int maxlen) ATTR_NONNULL(); /* maxlen excludes '\0' */
73 void IDP_ConcatStringC(struct IDProperty *prop, const char *st) ATTR_NONNULL();
74 void IDP_ConcatString(struct IDProperty *str1, struct IDProperty *append) ATTR_NONNULL();
75 void IDP_FreeString(struct IDProperty *prop) ATTR_NONNULL();
76
77 /*-------- ID Type -------*/
78
79 typedef void(*IDPWalkFunc)(void *userData, IDProperty *idp);
80
81 /*-------- Group Functions -------*/
82
83 /** Sync values from one group to another, only where they match */
84 void IDP_SyncGroupValues(struct IDProperty *dest, const struct IDProperty *src) ATTR_NONNULL();
85 void IDP_SyncGroupTypes(struct IDProperty *dest, const struct IDProperty *src, const bool do_arraylen) ATTR_NONNULL();
86 void IDP_ReplaceGroupInGroup(struct IDProperty *dest, const struct IDProperty *src) ATTR_NONNULL();
87 void IDP_ReplaceInGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
88 void IDP_ReplaceInGroup_ex(struct IDProperty *group, struct IDProperty *prop, struct IDProperty *prop_exist);
89 void IDP_MergeGroup(IDProperty *dest, const IDProperty *src, const bool do_overwrite) ATTR_NONNULL();
90 void IDP_MergeGroup_ex(IDProperty *dest, const IDProperty *src, const bool do_overwrite, const int flag) ATTR_NONNULL();
91 bool IDP_AddToGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
92 bool IDP_InsertToGroup(struct IDProperty *group, struct IDProperty *previous,
93                       struct IDProperty *pnew) ATTR_NONNULL(1 /* group */, 3 /* pnew */);
94 void IDP_RemoveFromGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
95 void IDP_FreeFromGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
96
97 IDProperty *IDP_GetPropertyFromGroup(struct IDProperty *prop, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
98 IDProperty *IDP_GetPropertyTypeFromGroup(struct IDProperty *prop, const char *name, const char type) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
99
100 /*-------- Main Functions --------*/
101 struct IDProperty *IDP_GetProperties(struct ID *id, const bool create_if_needed) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
102 struct IDProperty *IDP_CopyProperty(const struct IDProperty *prop) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
103 struct IDProperty *IDP_CopyProperty_ex(const struct IDProperty *prop, const int flag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
104
105 bool IDP_EqualsProperties_ex(IDProperty *prop1, IDProperty *prop2, const bool is_strict) ATTR_WARN_UNUSED_RESULT;
106
107 bool IDP_EqualsProperties(struct IDProperty *prop1, struct IDProperty *prop2) ATTR_WARN_UNUSED_RESULT;
108
109 struct IDProperty *IDP_New(const char type, const IDPropertyTemplate *val, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
110
111 void IDP_FreeProperty_ex(struct IDProperty *prop, const bool do_id_user);
112 void IDP_FreeProperty(struct IDProperty *prop);
113
114 void IDP_ClearProperty(IDProperty *prop);
115
116 void IDP_RelinkProperty(struct IDProperty *prop);
117
118 void IDP_Reset(IDProperty *prop, const IDProperty *reference);
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 /* Format IDProperty as strings */
148 char *IDP_reprN(
149         const struct IDProperty *prop, uint *r_len);
150 void IDP_repr_fn(
151         const IDProperty *prop,
152         void (*str_append_fn)(void *user_data, const char *str, uint str_len),
153         void *user_data);
154 void  IDP_print(const struct IDProperty *prop);
155
156 #ifdef __cplusplus
157 }
158 #endif
159
160 #endif /* __BKE_IDPROP_H__ */