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