Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_main.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_MAIN_H__
28 #define __BKE_MAIN_H__
29
30 /** \file BKE_main.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  *  \section aboutmain Main struct
35  * Main is the root of the 'database' of a Blender context. All data
36  * is stuffed into lists, and all these lists are knotted to here. A
37  * Blender file is not much more but a binary dump of these
38  * lists. This list of lists is not serialized itself.
39  *
40  * Oops... this should be a _types.h file.
41  *
42  */
43 #include "DNA_listBase.h"
44
45 #include "BLI_compiler_attrs.h"
46 #include "BLI_sys_types.h"
47
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51
52 struct BlendThumbnail;
53 struct BLI_mempool;
54 struct Depsgraph;
55 struct GHash;
56 struct ImBuf;
57 struct Library;
58 struct MainLock;
59
60 /* Blender thumbnail, as written on file (width, height, and data as char RGBA). */
61 /* We pack pixel data after that struct. */
62 typedef struct BlendThumbnail {
63         int width, height;
64         char rect[0];
65 } BlendThumbnail;
66
67 /* Structs caching relations between data-blocks in a given Main. */
68 typedef struct MainIDRelationsEntry {
69         struct MainIDRelationsEntry *next;
70         /* WARNING! for user_to_used, that pointer is really an ID** one, but for used_to_user, it’s only an ID* one! */
71         struct ID **id_pointer;
72         int usage_flag;  /* Using IDWALK_ enums, in BKE_library_query.h */
73 } MainIDRelationsEntry;
74
75 typedef struct MainIDRelations {
76         struct GHash *id_user_to_used;
77         struct GHash *id_used_to_user;
78
79         /* Private... */
80         struct BLI_mempool *entry_pool;
81 } MainIDRelations;
82
83 typedef struct Main {
84         struct Main *next, *prev;
85         char name[1024]; /* 1024 = FILE_MAX */
86         short versionfile, subversionfile;  /* see BLENDER_VERSION, BLENDER_SUBVERSION */
87         short minversionfile, minsubversionfile;
88         uint64_t build_commit_timestamp; /* commit's timestamp from buildinfo */
89         char build_hash[16];  /* hash from buildinfo */
90         char recovered; /* indicate the main->name (file) is the recovered one */
91         /** All current ID's exist in the last memfile undo step. */
92         char is_memfile_undo_written;
93
94         BlendThumbnail *blen_thumb;
95
96         struct Library *curlib;
97         ListBase scene;
98         ListBase library;
99         ListBase object;
100         ListBase mesh;
101         ListBase curve;
102         ListBase mball;
103         ListBase mat;
104         ListBase tex;
105         ListBase image;
106         ListBase latt;
107         ListBase lamp;
108         ListBase camera;
109         ListBase ipo;   // XXX deprecated
110         ListBase key;
111         ListBase world;
112         ListBase screen;
113         ListBase vfont;
114         ListBase text;
115         ListBase speaker;
116         ListBase lightprobe;
117         ListBase sound;
118         ListBase collection;
119         ListBase armature;
120         ListBase action;
121         ListBase nodetree;
122         ListBase brush;
123         ListBase particle;
124         ListBase palettes;
125         ListBase paintcurves;
126         ListBase wm;
127         ListBase gpencil;
128         ListBase movieclip;
129         ListBase mask;
130         ListBase linestyle;
131         ListBase cachefiles;
132         ListBase workspaces;
133
134         /* Must be generated, used and freed by same code - never assume this is valid data unless you know
135          * when, who and how it was created.
136          * Used by code doing a lot of remapping etc. at once to speed things up. */
137         struct MainIDRelations *relations;
138
139         struct MainLock *lock;
140 } Main;
141
142 struct Main *BKE_main_new(void);
143 void BKE_main_free(struct Main *mainvar);
144
145 void BKE_main_lock(struct Main *bmain);
146 void BKE_main_unlock(struct Main *bmain);
147
148 void BKE_main_relations_create(struct Main *bmain);
149 void BKE_main_relations_free(struct Main *bmain);
150
151 struct BlendThumbnail *BKE_main_thumbnail_from_imbuf(struct Main *bmain, struct ImBuf *img);
152 struct ImBuf *BKE_main_thumbnail_to_imbuf(struct Main *bmain, struct BlendThumbnail *data);
153 void BKE_main_thumbnail_create(struct Main *bmain);
154
155 const char *BKE_main_blendfile_path(const struct Main *bmain) ATTR_NONNULL();
156 const char *BKE_main_blendfile_path_from_global(void);
157
158 struct ListBase *which_libbase(struct Main *mainlib, short type);
159
160 #define MAX_LIBARRAY    37
161 int set_listbasepointers(struct Main *main, struct ListBase *lb[MAX_LIBARRAY]);
162
163 #define MAIN_VERSION_ATLEAST(main, ver, subver) \
164         ((main)->versionfile > (ver) || (main->versionfile == (ver) && (main)->subversionfile >= (subver)))
165
166 #define MAIN_VERSION_OLDER(main, ver, subver) \
167         ((main)->versionfile < (ver) || (main->versionfile == (ver) && (main)->subversionfile < (subver)))
168
169 #define BLEN_THUMB_SIZE 128
170
171 #define BLEN_THUMB_MEMSIZE(_x, _y) (sizeof(BlendThumbnail) + ((size_t)(_x) * (size_t)(_y)) * sizeof(int))
172 #define BLEN_THUMB_SAFE_MEMSIZE(_x, _y) ((uint64_t)_x * (uint64_t)_y < (SIZE_MAX / (sizeof(int) * 4)))
173
174 #ifdef __cplusplus
175 }
176 #endif
177
178 #endif  /* __BKE_MAIN_H__ */