Type checks for internal ID-Property UI min/max/tip & use defines to get values from...
[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 #include "DNA_ID.h"
32
33 struct IDProperty;
34 struct ID;
35
36 typedef union IDPropertyTemplate {
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 IDProperty *IDP_NewString(const char *st, const char *name, int maxlen);/* maxlen excludes '\0' */
75 void IDP_AssignString(struct IDProperty *prop, const char *st, int maxlen);     /* maxlen excludes '\0' */
76 void IDP_ConcatStringC(struct IDProperty *prop, const char *st);
77 void IDP_ConcatString(struct IDProperty *str1, struct IDProperty *append);
78 void IDP_FreeString(struct IDProperty *prop);
79
80 /*-------- ID Type -------*/
81 void IDP_LinkID(struct IDProperty *prop, ID *id);
82 void IDP_UnlinkID(struct IDProperty *prop);
83
84 /*-------- Group Functions -------*/
85
86 /* Sync values from one group to another, only where they match */
87 void IDP_SyncGroupValues(struct IDProperty *dest, struct IDProperty *src);
88
89 /*
90  replaces all properties with the same name in a destination group from a source group.
91 */
92 void IDP_ReplaceGroupInGroup(struct IDProperty *dest, struct IDProperty *src);
93
94 /*checks if a property with the same name as prop exists, and if so replaces it.
95   Use this to preserve order!*/
96 void IDP_ReplaceInGroup(struct IDProperty *group, struct IDProperty *prop);
97
98 /*
99 This function has a sanity check to make sure ID properties with the same name don't
100 get added to the group.
101
102 The sanity check just means the property is not added to the group if another property
103 exists with the same name; the client code using ID properties then needs to detect this 
104 (the function that adds new properties to groups, IDP_AddToGroup, returns 0 if a property can't
105 be added to the group, and 1 if it can) and free the property.
106
107 Currently the code to free ID properties is designesd to leave the actual struct
108 you pass it un-freed, this is needed for how the system works.  This means
109 to free an ID property, you first call IDP_FreeProperty then MEM_freeN the
110 struct.  In the future this will just be IDP_FreeProperty and the code will
111 be reorganized to work properly.
112 */
113 int IDP_AddToGroup(struct IDProperty *group, struct IDProperty *prop);
114
115 /*this is the same as IDP_AddToGroup, only you pass an item
116   in the group list to be inserted after.*/
117 int IDP_InsertToGroup(struct IDProperty *group, struct IDProperty *previous, 
118                                           struct IDProperty *pnew);
119
120 /*NOTE: this does not free the property!!
121
122  To free the property, you have to do:
123  IDP_FreeProperty(prop); //free all subdata
124  MEM_freeN(prop); //free property struct itself
125
126 */
127 void IDP_RemFromGroup(struct IDProperty *group, struct IDProperty *prop);
128
129 IDProperty *IDP_GetPropertyFromGroup(struct IDProperty *prop, const char *name);
130 /* same as above but ensure type match */
131 IDProperty *IDP_GetPropertyTypeFromGroup(struct IDProperty *prop, const char *name, const char type);
132
133 /*Get an iterator to iterate over the members of an id property group.
134  Note that this will automatically free the iterator once iteration is complete;
135  if you stop the iteration before hitting the end, make sure to call
136  IDP_FreeIterBeforeEnd().*/
137 void *IDP_GetGroupIterator(struct IDProperty *prop);
138
139 /*Returns the next item in the iteration.  To use, simple for a loop like the following:
140  while (IDP_GroupIterNext(iter) != NULL) {
141         . . .
142  }*/
143 IDProperty *IDP_GroupIterNext(void *vself);
144
145 /*Frees the iterator pointed to at vself, only use this if iteration is stopped early; 
146   when the iterator hits the end of the list it'll automatially free itself.*/
147 void IDP_FreeIterBeforeEnd(void *vself);
148
149 /*-------- Main Functions --------*/
150 /*Get the Group property that contains the id properties for ID id.  Set create_if_needed
151   to create the Group property and attach it to id if it doesn't exist; otherwise
152   the function will return NULL if there's no Group property attached to the ID.*/
153 struct IDProperty *IDP_GetProperties(struct ID *id, int create_if_needed);
154 struct IDProperty *IDP_CopyProperty(struct IDProperty *prop);
155
156 int IDP_EqualsProperties(struct IDProperty *prop1, struct IDProperty *prop2);
157
158 /*
159 Allocate a new ID.
160
161 This function takes three arguments: the ID property type, a union which defines
162 it's initial value, and a name.
163
164 The union is simple to use; see the top of this header file for its definition. 
165 An example of using this function:
166
167  IDPropertyTemplate val;
168  IDProperty *group, *idgroup, *color;
169  group = IDP_New(IDP_GROUP, val, "group1"); //groups don't need a template.
170
171  val.array.len = 4
172  val.array.type = IDP_FLOAT;
173  color = IDP_New(IDP_ARRAY, val, "color1");
174
175  idgroup = IDP_GetProperties(some_id, 1);
176  IDP_AddToGroup(idgroup, color);
177  IDP_AddToGroup(idgroup, group);
178
179 Note that you MUST either attach the id property to an id property group with 
180 IDP_AddToGroup or MEM_freeN the property, doing anything else might result in
181 a memory leak.
182 */
183 struct IDProperty *IDP_New(int type, IDPropertyTemplate val, const char *name);
184 \
185 /*NOTE: this will free all child properties of list arrays and groups!
186   Also, note that this does NOT unlink anything!  Plus it doesn't free
187   the actual struct IDProperty struct either.*/
188 void IDP_FreeProperty(struct IDProperty *prop);
189
190 /*Unlinks any struct IDProperty<->ID linkage that might be going on.*/
191 void IDP_UnlinkProperty(struct IDProperty *prop);
192
193 #define IDP_Int(prop) ((prop)->data.val)
194 #define IDP_Float(prop) (*(float*)&(prop)->data.val)
195 #define IDP_String(prop) ((char*)(prop)->data.pointer)
196 #define IDP_Array(prop) ((prop)->data.pointer)
197 #define IDP_IDPArray(prop) ((IDProperty*)(prop)->data.pointer)
198 #define IDP_Double(prop) (*(double*)&(prop)->data.val)
199
200 #endif /* _BKE_IDPROP_H */