Physically based defaults for Eevee Bloom and Shutter
[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 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct IDProperty;
40 struct ID;
41
42 typedef union IDPropertyTemplate {
43         int i;
44         float f;
45         double d;
46         struct {
47                 const char *str;
48                 int len;
49                 char subtype;
50         } string;
51         struct ID *id;
52         struct {
53                 int len;
54                 char type;
55         } array;
56         struct {
57                 int matvec_size;
58                 const float *example;
59         } matrix_or_vector;
60 } IDPropertyTemplate;
61
62 /* ----------- Property Array Type ---------- */
63
64 IDProperty *IDP_NewIDPArray(const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
65 IDProperty *IDP_CopyIDPArray(const IDProperty *array, const int flag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
66
67 /* shallow copies item */
68 void IDP_SetIndexArray(struct IDProperty *prop, int index, struct IDProperty *item) ATTR_NONNULL();
69 struct IDProperty *IDP_GetIndexArray(struct IDProperty *prop, int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
70 void IDP_AppendArray(struct IDProperty *prop, struct IDProperty *item);
71 void IDP_ResizeIDPArray(struct IDProperty *prop, int len);
72
73 /* ----------- Numeric Array Type ----------- */
74 /*this function works for strings too!*/
75 void IDP_ResizeArray(struct IDProperty *prop, int newlen);
76 void IDP_FreeArray(struct IDProperty *prop);
77
78 /* ---------- String Type ------------ */
79 IDProperty *IDP_NewString(const char *st, const char *name, int maxlen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2 /* 'name 'arg */); /* maxlen excludes '\0' */
80 void IDP_AssignString(struct IDProperty *prop, const char *st, int maxlen) ATTR_NONNULL(); /* maxlen excludes '\0' */
81 void IDP_ConcatStringC(struct IDProperty *prop, const char *st) ATTR_NONNULL();
82 void IDP_ConcatString(struct IDProperty *str1, struct IDProperty *append) ATTR_NONNULL();
83 void IDP_FreeString(struct IDProperty *prop) ATTR_NONNULL();
84
85 /*-------- ID Type -------*/
86
87 typedef void(*IDPWalkFunc)(void *userData, IDProperty *idp);
88
89 /*-------- Group Functions -------*/
90
91 /** Sync values from one group to another, only where they match */
92 void IDP_SyncGroupValues(struct IDProperty *dest, const struct IDProperty *src) ATTR_NONNULL();
93 void IDP_SyncGroupTypes(struct IDProperty *dest, const struct IDProperty *src, const bool do_arraylen) ATTR_NONNULL();
94 void IDP_ReplaceGroupInGroup(struct IDProperty *dest, const struct IDProperty *src) ATTR_NONNULL();
95 void IDP_ReplaceInGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
96 void IDP_ReplaceInGroup_ex(struct IDProperty *group, struct IDProperty *prop, struct IDProperty *prop_exist);
97 void IDP_MergeGroup(IDProperty *dest, const IDProperty *src, const bool do_overwrite) ATTR_NONNULL();
98 void IDP_MergeGroup_ex(IDProperty *dest, const IDProperty *src, const bool do_overwrite, const int flag) ATTR_NONNULL();
99 bool IDP_AddToGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
100 bool IDP_InsertToGroup(struct IDProperty *group, struct IDProperty *previous,
101                       struct IDProperty *pnew) ATTR_NONNULL(1 /* group */, 3 /* pnew */);
102 void IDP_RemoveFromGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
103 void IDP_FreeFromGroup(struct IDProperty *group, struct IDProperty *prop) ATTR_NONNULL();
104
105 IDProperty *IDP_GetPropertyFromGroup(struct IDProperty *prop, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
106 IDProperty *IDP_GetPropertyTypeFromGroup(struct IDProperty *prop, const char *name, const char type) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
107
108 /*-------- Main Functions --------*/
109 struct IDProperty *IDP_GetProperties(struct ID *id, const bool create_if_needed) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
110 struct IDProperty *IDP_CopyProperty(const struct IDProperty *prop) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
111 struct IDProperty *IDP_CopyProperty_ex(const struct IDProperty *prop, const int flag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
112
113 bool IDP_EqualsProperties_ex(IDProperty *prop1, IDProperty *prop2, const bool is_strict) ATTR_WARN_UNUSED_RESULT;
114
115 bool IDP_EqualsProperties(struct IDProperty *prop1, struct IDProperty *prop2) ATTR_WARN_UNUSED_RESULT;
116
117 struct IDProperty *IDP_New(const char type, const IDPropertyTemplate *val, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
118
119 void IDP_FreeProperty_ex(struct IDProperty *prop, const bool do_id_user);
120 void IDP_FreeProperty(struct IDProperty *prop);
121
122 void IDP_ClearProperty(IDProperty *prop);
123
124 void IDP_RelinkProperty(struct IDProperty *prop);
125
126 void IDP_Reset(IDProperty *prop, const IDProperty *reference);
127
128 #define IDP_Int(prop)                     ((prop)->data.val)
129 #define IDP_Array(prop)                   ((prop)->data.pointer)
130 /* C11 const correctness for casts */
131 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
132 #  define IDP_Float(prop)  _Generic((prop), \
133         IDProperty *:             (*(float *)&(prop)->data.val), \
134         const IDProperty *: (*(const float *)&(prop)->data.val))
135 #  define IDP_Double(prop)  _Generic((prop), \
136         IDProperty *:             (*(double *)&(prop)->data.val), \
137         const IDProperty *: (*(const double *)&(prop)->data.val))
138 #  define IDP_String(prop)  _Generic((prop), \
139         IDProperty *:             ((char *) (prop)->data.pointer), \
140         const IDProperty *: ((const char *) (prop)->data.pointer))
141 #  define IDP_IDPArray(prop)  _Generic((prop), \
142         IDProperty *:             ((IDProperty *) (prop)->data.pointer), \
143         const IDProperty *: ((const IDProperty *) (prop)->data.pointer))
144 #  define IDP_Id(prop)  _Generic((prop), \
145         IDProperty *:             ((ID *) (prop)->data.pointer), \
146         const IDProperty *: ((const ID *) (prop)->data.pointer))
147 #else
148 #  define IDP_Float(prop)        (*(float *)&(prop)->data.val)
149 #  define IDP_Double(prop)      (*(double *)&(prop)->data.val)
150 #  define IDP_String(prop)         ((char *) (prop)->data.pointer)
151 #  define IDP_IDPArray(prop) ((IDProperty *) (prop)->data.pointer)
152 #  define IDP_Id(prop)               ((ID *) (prop)->data.pointer)
153 #endif
154
155 /* Format IDProperty as strings */
156 char *IDP_reprN(
157         const struct IDProperty *prop, uint *r_len);
158 void IDP_repr_fn(
159         const IDProperty *prop,
160         void (*str_append_fn)(void *user_data, const char *str, uint str_len),
161         void *user_data);
162 void  IDP_print(const struct IDProperty *prop);
163
164 #ifdef __cplusplus
165 }
166 #endif
167
168 #endif /* __BKE_IDPROP_H__ */