Correction for own recent commit -- didn't know it's unsupported in
[blender.git] / source / blender / blenkernel / BKE_idprop.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Joseph Eagar
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27  
28 #ifndef _BKE_IDPROP_H
29 #define _BKE_IDPROP_H
30
31 /** \file BKE_idprop.h
32  *  \ingroup bke
33  *  \author Joseph Eagar
34  */
35
36 #include "DNA_ID.h"
37
38 struct IDProperty;
39 struct ID;
40
41 typedef union IDPropertyTemplate {
42         int i;
43         float f;
44         double d;
45         char *str;
46         struct ID *id;
47         struct {
48                 short type;
49                 short len;
50         } array;
51         struct {
52                 int matvec_size;
53                 float *example;
54         } matrix_or_vector;
55 } IDPropertyTemplate;
56
57 /* ----------- Property Array Type ---------- */
58
59 /*note: as a start to move away from the stupid IDP_New function, this type
60   has it's own allocation function.*/
61 IDProperty *IDP_NewIDPArray(const char *name);
62 IDProperty *IDP_CopyIDPArray(IDProperty *array);
63
64 void IDP_FreeIDPArray(IDProperty *prop);
65
66 /* shallow copies item */
67 void IDP_SetIndexArray(struct IDProperty *prop, int index, struct IDProperty *item);
68 struct IDProperty *IDP_GetIndexArray(struct IDProperty *prop, int index);
69 struct IDProperty *IDP_AppendArray(struct IDProperty *prop, struct IDProperty *item);
70 void IDP_ResizeIDPArray(struct IDProperty *prop, int len);
71
72 /* ----------- Numeric Array Type ----------- */
73 /*this function works for strings too!*/
74 void IDP_ResizeArray(struct IDProperty *prop, int newlen);
75 void IDP_FreeArray(struct IDProperty *prop);
76 void IDP_UnlinkArray(struct IDProperty *prop);
77
78 /* ---------- String Type ------------ */
79 IDProperty *IDP_NewString(const char *st, const char *name, int maxlen);/* maxlen excludes '\0' */
80 void IDP_AssignString(struct IDProperty *prop, const char *st, int maxlen);     /* maxlen excludes '\0' */
81 void IDP_ConcatStringC(struct IDProperty *prop, const char *st);
82 void IDP_ConcatString(struct IDProperty *str1, struct IDProperty *append);
83 void IDP_FreeString(struct IDProperty *prop);
84
85 /*-------- ID Type -------*/
86 void IDP_LinkID(struct IDProperty *prop, ID *id);
87 void IDP_UnlinkID(struct IDProperty *prop);
88
89 /*-------- Group Functions -------*/
90
91 /** Sync values from one group to another, only where they match */
92 void IDP_SyncGroupValues(struct IDProperty *dest, struct IDProperty *src);
93
94 /**
95  replaces all properties with the same name in a destination group from a source group.
96 */
97 void IDP_ReplaceGroupInGroup(struct IDProperty *dest, struct IDProperty *src);
98
99 /** checks if a property with the same name as prop exists, and if so replaces it.
100   Use this to preserve order!*/
101 void IDP_ReplaceInGroup(struct IDProperty *group, struct IDProperty *prop);
102
103 /**
104 This function has a sanity check to make sure ID properties with the same name don't
105 get added to the group.
106
107 The sanity check just means the property is not added to the group if another property
108 exists with the same name; the client code using ID properties then needs to detect this 
109 (the function that adds new properties to groups, IDP_AddToGroup, returns 0 if a property can't
110 be added to the group, and 1 if it can) and free the property.
111
112 Currently the code to free ID properties is designesd to leave the actual struct
113 you pass it un-freed, this is needed for how the system works.  This means
114 to free an ID property, you first call IDP_FreeProperty then MEM_freeN the
115 struct.  In the future this will just be IDP_FreeProperty and the code will
116 be reorganized to work properly.
117 */
118 int IDP_AddToGroup(struct IDProperty *group, struct IDProperty *prop);
119
120 /** this is the same as IDP_AddToGroup, only you pass an item
121   in the group list to be inserted after.*/
122 int IDP_InsertToGroup(struct IDProperty *group, struct IDProperty *previous, 
123                                           struct IDProperty *pnew);
124
125 /** \note this does not free the property!!
126
127  To free the property, you have to do:
128  IDP_FreeProperty(prop); //free all subdata
129  MEM_freeN(prop); //free property struct itself
130
131 */
132 void IDP_RemFromGroup(struct IDProperty *group, struct IDProperty *prop);
133
134 IDProperty *IDP_GetPropertyFromGroup(struct IDProperty *prop, const char *name);
135 /** same as above but ensure type match */
136 IDProperty *IDP_GetPropertyTypeFromGroup(struct IDProperty *prop, const char *name, const char type);
137
138 /** Get an iterator to iterate over the members of an id property group.
139  Note that this will automatically free the iterator once iteration is complete;
140  if you stop the iteration before hitting the end, make sure to call
141  IDP_FreeIterBeforeEnd().*/
142 void *IDP_GetGroupIterator(struct IDProperty *prop);
143
144 /** Returns the next item in the iteration.  To use, simple for a loop like the following:
145  while (IDP_GroupIterNext(iter) != NULL) {
146         . . .
147  }*/
148 IDProperty *IDP_GroupIterNext(void *vself);
149
150 /** Frees the iterator pointed to at vself, only use this if iteration is stopped early; 
151   when the iterator hits the end of the list it'll automatially free itself.*/
152 void IDP_FreeIterBeforeEnd(void *vself);
153
154 /*-------- Main Functions --------*/
155 /** Get the Group property that contains the id properties for ID id.  Set create_if_needed
156   to create the Group property and attach it to id if it doesn't exist; otherwise
157   the function will return NULL if there's no Group property attached to the ID.*/
158 struct IDProperty *IDP_GetProperties(struct ID *id, int create_if_needed);
159 struct IDProperty *IDP_CopyProperty(struct IDProperty *prop);
160
161 int IDP_EqualsProperties(struct IDProperty *prop1, struct IDProperty *prop2);
162
163 /**
164 Allocate a new ID.
165
166 This function takes three arguments: the ID property type, a union which defines
167 it's initial value, and a name.
168
169 The union is simple to use; see the top of this header file for its definition. 
170 An example of using this function:
171
172  IDPropertyTemplate val;
173  IDProperty *group, *idgroup, *color;
174  group = IDP_New(IDP_GROUP, val, "group1"); //groups don't need a template.
175
176  val.array.len = 4
177  val.array.type = IDP_FLOAT;
178  color = IDP_New(IDP_ARRAY, val, "color1");
179
180  idgroup = IDP_GetProperties(some_id, 1);
181  IDP_AddToGroup(idgroup, color);
182  IDP_AddToGroup(idgroup, group);
183
184 Note that you MUST either attach the id property to an id property group with 
185 IDP_AddToGroup or MEM_freeN the property, doing anything else might result in
186 a memory leak.
187 */
188 struct IDProperty *IDP_New(int type, IDPropertyTemplate val, const char *name);
189
190 /** \note this will free all child properties of list arrays and groups!
191   Also, note that this does NOT unlink anything!  Plus it doesn't free
192   the actual struct IDProperty struct either.*/
193 void IDP_FreeProperty(struct IDProperty *prop);
194
195 /** Unlinks any struct IDProperty<->ID linkage that might be going on.*/
196 void IDP_UnlinkProperty(struct IDProperty *prop);
197
198 #define IDP_Int(prop) ((prop)->data.val)
199 #define IDP_Float(prop) (*(float*)&(prop)->data.val)
200 #define IDP_String(prop) ((char*)(prop)->data.pointer)
201 #define IDP_Array(prop) ((prop)->data.pointer)
202 #define IDP_IDPArray(prop) ((IDProperty*)(prop)->data.pointer)
203 #define IDP_Double(prop) (*(double*)&(prop)->data.val)
204
205 #endif /* _BKE_IDPROP_H */