copy animdata and id-props when copying material node tree's to avoid double memory...
[blender.git] / source / blender / blenkernel / BKE_idprop.h
1 /**
2  * $Id: BKE_idprop.h
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 #include "DNA_ID.h"
32
33 struct IDProperty;
34 struct ID;
35
36 typedef union {
37         int i;
38         float f;
39         double d;
40         char *str;
41         struct ID *id;
42         struct {
43                 short type;
44                 short len;
45         } array;
46         struct {
47                 int matvec_size;
48                 float *example;
49         } matrix_or_vector;
50 } IDPropertyTemplate;
51
52 /* ----------- Property Array Type ---------- */
53
54 /*note: as a start to move away from the stupid IDP_New function, this type
55   has it's own allocation function.*/
56 IDProperty *IDP_NewIDPArray(const char *name);
57 IDProperty *IDP_CopyIDPArray(IDProperty *array);
58
59 void IDP_FreeIDPArray(IDProperty *prop);
60
61 /* shallow copies item */
62 void IDP_SetIndexArray(struct IDProperty *prop, int index, struct IDProperty *item);
63 struct IDProperty *IDP_GetIndexArray(struct IDProperty *prop, int index);
64 struct IDProperty *IDP_AppendArray(struct IDProperty *prop, struct IDProperty *item);
65 void IDP_ResizeIDPArray(struct IDProperty *prop, int len);
66
67 /* ----------- Numeric Array Type ----------- */
68 /*this function works for strings too!*/
69 void IDP_ResizeArray(struct IDProperty *prop, int newlen);
70 void IDP_FreeArray(struct IDProperty *prop);
71 void IDP_UnlinkArray(struct IDProperty *prop);
72
73 /* ---------- String Type ------------ */
74 void IDP_AssignString(struct IDProperty *prop, char *st);
75 void IDP_ConcatStringC(struct IDProperty *prop, char *st);
76 void IDP_ConcatString(struct IDProperty *str1, struct IDProperty *append);
77 void IDP_FreeString(struct IDProperty *prop);
78
79 /*-------- ID Type -------*/
80 void IDP_LinkID(struct IDProperty *prop, ID *id);
81 void IDP_UnlinkID(struct IDProperty *prop);
82
83 /*-------- Group Functions -------*/
84
85 /*
86  replaces all properties with the same name in a destination group from a source group.
87 */
88 void IDP_ReplaceGroupInGroup(struct IDProperty *dest, struct IDProperty *src);
89
90 /*checks if a property with the same name as prop exists, and if so replaces it.
91   Use this to preserve order!*/
92 void IDP_ReplaceInGroup(struct IDProperty *group, struct IDProperty *prop);
93
94 /*
95 This function has a sanity check to make sure ID properties with the same name don't
96 get added to the group.
97
98 The sanity check just means the property is not added to the group if another property
99 exists with the same name; the client code using ID properties then needs to detect this 
100 (the function that adds new properties to groups, IDP_AddToGroup, returns 0 if a property can't
101 be added to the group, and 1 if it can) and free the property.
102
103 Currently the code to free ID properties is designesd to leave the actual struct
104 you pass it un-freed, this is needed for how the system works.  This means
105 to free an ID property, you first call IDP_FreeProperty then MEM_freeN the
106 struct.  In the future this will just be IDP_FreeProperty and the code will
107 be reorganized to work properly.
108 */
109 int IDP_AddToGroup(struct IDProperty *group, struct IDProperty *prop);
110
111 /*this is the same as IDP_AddToGroup, only you pass an item
112   in the group list to be inserted after.*/
113 int IDP_InsertToGroup(struct IDProperty *group, struct IDProperty *previous, 
114                       struct IDProperty *pnew);
115
116 /*NOTE: this does not free the property!!
117
118  To free the property, you have to do:
119  IDP_FreeProperty(prop); //free all subdata
120  MEM_freeN(prop); //free property struct itself
121
122 */
123 void IDP_RemFromGroup(struct IDProperty *group, struct IDProperty *prop);
124
125 IDProperty *IDP_GetPropertyFromGroup(struct IDProperty *prop, const char *name);
126
127 /*Get an iterator to iterate over the members of an id property group.
128  Note that this will automatically free the iterator once iteration is complete;
129  if you stop the iteration before hitting the end, make sure to call
130  IDP_FreeIterBeforeEnd().*/
131 void *IDP_GetGroupIterator(struct IDProperty *prop);
132
133 /*Returns the next item in the iteration.  To use, simple for a loop like the following:
134  while (IDP_GroupIterNext(iter) != NULL) {
135         . . .
136  }*/
137 IDProperty *IDP_GroupIterNext(void *vself);
138
139 /*Frees the iterator pointed to at vself, only use this if iteration is stopped early; 
140   when the iterator hits the end of the list it'll automatially free itself.*/
141 void IDP_FreeIterBeforeEnd(void *vself);
142
143 /*-------- Main Functions --------*/
144 /*Get the Group property that contains the id properties for ID id.  Set create_if_needed
145   to create the Group property and attach it to id if it doesn't exist; otherwise
146   the function will return NULL if there's no Group property attached to the ID.*/
147 struct IDProperty *IDP_GetProperties(struct ID *id, int create_if_needed);
148 struct IDProperty *IDP_CopyProperty(struct IDProperty *prop);
149
150 int IDP_EqualsProperties(struct IDProperty *prop1, struct IDProperty *prop2);
151
152 /*
153 Allocate a new ID.
154
155 This function takes three arguments: the ID property type, a union which defines
156 it's initial value, and a name.
157
158 The union is simple to use; see the top of this header file for its definition. 
159 An example of using this function:
160
161  IDPropertyTemplate val;
162  IDProperty *group, *idgroup, *color;
163  group = IDP_New(IDP_GROUP, val, "group1"); //groups don't need a template.
164
165  val.array.len = 4
166  val.array.type = IDP_FLOAT;
167  color = IDP_New(IDP_ARRAY, val, "color1");
168
169  idgroup = IDP_GetProperties(some_id, 1);
170  IDP_AddToGroup(idgroup, color);
171  IDP_AddToGroup(idgroup, group);
172
173 Note that you MUST either attach the id property to an id property group with 
174 IDP_AddToGroup or MEM_freeN the property, doing anything else might result in
175 a memory leak.
176 */
177 struct IDProperty *IDP_New(int type, IDPropertyTemplate val, const char *name);
178 \
179 /*NOTE: this will free all child properties of list arrays and groups!
180   Also, note that this does NOT unlink anything!  Plus it doesn't free
181   the actual struct IDProperty struct either.*/
182 void IDP_FreeProperty(struct IDProperty *prop);
183
184 /*Unlinks any struct IDProperty<->ID linkage that might be going on.*/
185 void IDP_UnlinkProperty(struct IDProperty *prop);
186
187 #define IDP_Int(prop) ((prop)->data.val)
188 #define IDP_Float(prop) (*(float*)&(prop)->data.val)
189 #define IDP_String(prop) ((char*)(prop)->data.pointer)
190 #define IDP_Array(prop) ((prop)->data.pointer)
191 #define IDP_IDPArray(prop) ((IDProperty*)(prop)->data.pointer)
192 #define IDP_Double(prop) (*(double*)&(prop)->data.val)
193
194 #endif /* _BKE_IDPROP_H */