aac43768acf5236d1c7294e930826f0145bd3dc8
[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 "BKE_library.h"
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 struct EvaluationContext;
52 struct Library;
53 struct MainLock;
54 struct GHash;
55 struct BLI_mempool;
56
57 /* Blender thumbnail, as written on file (width, height, and data as char RGBA). */
58 /* We pack pixel data after that struct. */
59 typedef struct BlendThumbnail {
60         int width, height;
61         char rect[0];
62 } BlendThumbnail;
63
64 /* Structs caching relations between data-blocks in a given Main. */
65 typedef struct MainIDRelationsEntry {
66         struct MainIDRelationsEntry *next;
67         /* WARNING! for user_to_used, that pointer is really an ID** one, but for used_to_user, it’s only an ID* one! */
68         struct ID **id_pointer;
69         int usage_flag;  /* Using IDWALK_ enums, in BKE_library_query.h */
70 } MainIDRelationsEntry;
71
72 typedef struct MainIDRelations {
73         struct GHash *id_user_to_used;
74         struct GHash *id_used_to_user;
75
76         /* Private... */
77         struct BLI_mempool *entry_pool;
78 } MainIDRelations;
79
80 typedef struct Main {
81         struct Main *next, *prev;
82         char name[1024]; /* 1024 = FILE_MAX */
83         short versionfile, subversionfile;  /* see BLENDER_VERSION, BLENDER_SUBVERSION */
84         short minversionfile, minsubversionfile;
85         uint64_t build_commit_timestamp; /* commit's timestamp from buildinfo */
86         char build_hash[16];  /* hash from buildinfo */
87         char recovered; /* indicate the main->name (file) is the recovered one */
88         /** All current ID's exist in the last memfile undo step. */
89         char is_memfile_undo_written;
90
91         BlendThumbnail *blen_thumb;
92
93         struct Library *curlib;
94         ListBase scene;
95         ListBase library;
96         ListBase object;
97         ListBase mesh;
98         ListBase curve;
99         ListBase mball;
100         ListBase mat;
101         ListBase tex;
102         ListBase image;
103         ListBase latt;
104         ListBase lamp;
105         ListBase camera;
106         ListBase ipo;   // XXX deprecated
107         ListBase key;
108         ListBase world;
109         ListBase screen;
110         ListBase vfont;
111         ListBase text;
112         ListBase speaker;
113         ListBase lightprobe;
114         ListBase sound;
115         ListBase group;
116         ListBase armature;
117         ListBase action;
118         ListBase nodetree;
119         ListBase brush;
120         ListBase particle;
121         ListBase palettes;
122         ListBase paintcurves;
123         ListBase wm;
124         ListBase gpencil;
125         ListBase movieclip;
126         ListBase mask;
127         ListBase linestyle;
128         ListBase cachefiles;
129         ListBase workspaces;
130
131         char id_tag_update[MAX_LIBARRAY];
132
133         /* Evaluation context used by viewport */
134         struct EvaluationContext *eval_ctx;
135
136         /* Must be generated, used and freed by same code - never assume this is valid data unless you know
137          * when, who and how it was created.
138          * Used by code doing a lot of remapping etc. at once to speed things up. */
139         struct MainIDRelations *relations;
140
141         struct MainLock *lock;
142 } Main;
143
144 #define MAIN_VERSION_ATLEAST(main, ver, subver) \
145         ((main)->versionfile > (ver) || (main->versionfile == (ver) && (main)->subversionfile >= (subver)))
146
147 #define MAIN_VERSION_OLDER(main, ver, subver) \
148         ((main)->versionfile < (ver) || (main->versionfile == (ver) && (main)->subversionfile < (subver)))
149
150 #define BLEN_THUMB_SIZE 128
151
152 #define BLEN_THUMB_MEMSIZE(_x, _y) (sizeof(BlendThumbnail) + ((size_t)(_x) * (size_t)(_y)) * sizeof(int))
153 #define BLEN_THUMB_SAFE_MEMSIZE(_x, _y) ((uint64_t)_x * (uint64_t)_y < (SIZE_MAX / (sizeof(int) * 4)))
154
155 #ifdef __cplusplus
156 }
157 #endif
158
159 #endif  /* __BKE_MAIN_H__ */