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