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