Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_main.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_MAIN_H__
20 #define __BKE_MAIN_H__
21
22 /** \file
23  * \ingroup bke
24  * \section aboutmain Main struct
25  * Main is the root of the 'database' of a Blender context. All data
26  * is stuffed into lists, and all these lists are knotted to here. A
27  * Blender file is not much more but a binary dump of these
28  * lists. This list of lists is not serialized itself.
29  *
30  * Oops... this should be a _types.h file.
31  */
32 #include "DNA_listBase.h"
33
34 #include "BLI_compiler_attrs.h"
35 #include "BLI_sys_types.h"
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct BLI_mempool;
42 struct BlendThumbnail;
43 struct Depsgraph;
44 struct GHash;
45 struct GSet;
46 struct ImBuf;
47 struct Library;
48 struct MainLock;
49
50 /* Blender thumbnail, as written on file (width, height, and data as char RGBA). */
51 /* We pack pixel data after that struct. */
52 typedef struct BlendThumbnail {
53         int width, height;
54         char rect[0];
55 } BlendThumbnail;
56
57 /* Structs caching relations between data-blocks in a given Main. */
58 typedef struct MainIDRelationsEntry {
59         struct MainIDRelationsEntry *next;
60         /* WARNING! for user_to_used, that pointer is really an ID** one, but for used_to_user, it’s only an ID* one! */
61         struct ID **id_pointer;
62         int usage_flag;  /* Using IDWALK_ enums, in BKE_library_query.h */
63 } MainIDRelationsEntry;
64
65 typedef struct MainIDRelations {
66         struct GHash *id_user_to_used;
67         struct GHash *id_used_to_user;
68
69         /* Private... */
70         struct BLI_mempool *entry_pool;
71 } MainIDRelations;
72
73 typedef struct Main {
74         struct Main *next, *prev;
75         char name[1024]; /* 1024 = FILE_MAX */
76         short versionfile, subversionfile;  /* see BLENDER_VERSION, BLENDER_SUBVERSION */
77         short minversionfile, minsubversionfile;
78         uint64_t build_commit_timestamp; /* commit's timestamp from buildinfo */
79         char build_hash[16];  /* hash from buildinfo */
80         char recovered; /* indicate the main->name (file) is the recovered one */
81         /** All current ID's exist in the last memfile undo step. */
82         char is_memfile_undo_written;
83
84         BlendThumbnail *blen_thumb;
85
86         struct Library *curlib;
87         ListBase scenes;
88         ListBase libraries;
89         ListBase objects;
90         ListBase meshes;
91         ListBase curves;
92         ListBase metaballs;
93         ListBase materials;
94         ListBase textures;
95         ListBase images;
96         ListBase lattices;
97         ListBase lights;
98         ListBase cameras;
99         ListBase ipo;  /* Deprecated (only for versioning). */
100         ListBase shapekeys;
101         ListBase worlds;
102         ListBase screens;
103         ListBase fonts;
104         ListBase texts;
105         ListBase speakers;
106         ListBase lightprobes;
107         ListBase sounds;
108         ListBase collections;
109         ListBase armatures;
110         ListBase actions;
111         ListBase nodetrees;
112         ListBase brushes;
113         ListBase particles;
114         ListBase palettes;
115         ListBase paintcurves;
116         ListBase wm;  /* Singleton (exception). */
117         ListBase gpencils;
118         ListBase movieclips;
119         ListBase masks;
120         ListBase linestyles;
121         ListBase cachefiles;
122         ListBase workspaces;
123
124         /* Must be generated, used and freed by same code - never assume this is valid data unless you know
125          * when, who and how it was created.
126          * Used by code doing a lot of remapping etc. at once to speed things up. */
127         struct MainIDRelations *relations;
128
129         struct MainLock *lock;
130 } Main;
131
132 struct Main *BKE_main_new(void);
133 void BKE_main_free(struct Main *mainvar);
134
135 void BKE_main_lock(struct Main *bmain);
136 void BKE_main_unlock(struct Main *bmain);
137
138 void BKE_main_relations_create(struct Main *bmain);
139 void BKE_main_relations_free(struct Main *bmain);
140
141 struct GSet *BKE_main_gset_create(struct Main *bmain, struct GSet *gset);
142
143 /* *** Generic utils to loop over whole Main database. *** */
144
145 #define FOREACH_MAIN_LISTBASE_ID_BEGIN(_lb, _id)                          \
146         {                                                                     \
147                 ID *_id_next = _lb->first;                                        \
148                 for (_id = _id_next; _id != NULL; _id = _id_next) {               \
149                         _id_next = _id->next;
150
151 #define FOREACH_MAIN_LISTBASE_ID_END                                      \
152                 }                                                                 \
153         } ((void)0)
154
155 #define FOREACH_MAIN_LISTBASE_BEGIN(_bmain, _lb)                          \
156         {                                                                     \
157                 ListBase *_lbarray[MAX_LIBARRAY];                                 \
158                 int _i = set_listbasepointers(_bmain, _lbarray);                  \
159                 while (_i--) {                                                    \
160                         _lb = _lbarray[_i];
161
162 #define FOREACH_MAIN_LISTBASE_END                                         \
163                 }                                                                 \
164         } ((void)0)
165
166 /* DO NOT use break statement with that macro, use FOREACH_MAIN_LISTBASE and FOREACH_MAIN_LISTBASE_ID instead
167  * if you need that kind of control flow. */
168 #define FOREACH_MAIN_ID_BEGIN(_bmain, _id)                                \
169         {                                                                     \
170                 ListBase *_lb;                                                    \
171                 FOREACH_MAIN_LISTBASE_BEGIN(_bmain, _lb) {                        \
172                         FOREACH_MAIN_LISTBASE_ID_BEGIN(_lb, _id)
173
174 #define FOREACH_MAIN_ID_END                                               \
175                         FOREACH_MAIN_LISTBASE_ID_END;                                 \
176                 } FOREACH_MAIN_LISTBASE_END;                                      \
177         } ((void)0)
178
179
180 struct BlendThumbnail *BKE_main_thumbnail_from_imbuf(struct Main *bmain, struct ImBuf *img);
181 struct ImBuf *BKE_main_thumbnail_to_imbuf(struct Main *bmain, struct BlendThumbnail *data);
182 void BKE_main_thumbnail_create(struct Main *bmain);
183
184 const char *BKE_main_blendfile_path(const struct Main *bmain) ATTR_NONNULL();
185 const char *BKE_main_blendfile_path_from_global(void);
186
187 struct ListBase *which_libbase(struct Main *mainlib, short type);
188
189 #define MAX_LIBARRAY    37
190 int set_listbasepointers(struct Main *main, struct ListBase *lb[MAX_LIBARRAY]);
191
192 #define MAIN_VERSION_ATLEAST(main, ver, subver) \
193         ((main)->versionfile > (ver) || (main->versionfile == (ver) && (main)->subversionfile >= (subver)))
194
195 #define MAIN_VERSION_OLDER(main, ver, subver) \
196         ((main)->versionfile < (ver) || (main->versionfile == (ver) && (main)->subversionfile < (subver)))
197
198 #define BLEN_THUMB_SIZE 128
199
200 #define BLEN_THUMB_MEMSIZE(_x, _y) \
201         (sizeof(BlendThumbnail) + ((size_t)(_x) * (size_t)(_y)) * sizeof(int))
202 /** Protect against buffer overflow vulnerability & negative sizes. */
203 #define BLEN_THUMB_MEMSIZE_IS_VALID(_x, _y) \
204         (((_x) > 0 && (_y) > 0) && \
205          ((uint64_t)(_x) * (uint64_t)(_y) < (SIZE_MAX / (sizeof(int) * 4))))
206
207 #ifdef __cplusplus
208 }
209 #endif
210
211 #endif  /* __BKE_MAIN_H__ */