Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_global.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_GLOBAL_H__
28 #define __BKE_GLOBAL_H__
29
30 /** \file BKE_global.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  *  \section aboutglobal Global settings
35  *   Global settings, handles, pointers. This is the root for finding
36  *   any data in Blender. This block is not serialized, but built anew
37  *   for every fresh Blender run.
38  */
39
40 #include "DNA_listBase.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 /* forwards */
47 struct Main;
48
49 typedef struct Global {
50
51         /* active pointers */
52         struct Main *main;
53         
54         /* strings: lastsaved */
55         char ima[1024], lib[1024]; /* 1024 = FILE_MAX */
56
57         /* when set: G_MAIN->name contains valid relative base path */
58         bool relbase_valid;
59         bool file_loaded;
60         bool save_over;
61
62         /* strings of recent opened files */
63         struct ListBase recent_files;
64
65         /* has escape been pressed or Ctrl+C pressed in background mode, used for render quit */
66         bool is_break;
67
68         bool background;
69         bool factory_startup;
70
71         short moving;
72
73         /* to indicate render is busy, prevent renderwindow events etc */
74         bool is_rendering;
75
76         /* debug value, can be set from the UI and python, used for testing nonstandard features */
77         short debug_value;
78
79         /* saved to the blend file as FileGlobal.globalf,
80          * however this is now only used for runtime options */
81         int f;
82
83         struct {
84                 /* Logging vars (different loggers may use). */
85                 int level;
86                 /* FILE handle or use stderr (we own this so close when done). */
87                 void *file;
88         } log;
89
90         /* debug flag, G_DEBUG, G_DEBUG_PYTHON & friends, set python or command line args */
91         int debug;
92
93         /* this variable is written to / read from FileGlobal->fileflags */
94         int fileflags;
95
96         /* message to use when autoexec fails */
97         char autoexec_fail[200];
98 } Global;
99
100 /* **************** GLOBAL ********************* */
101
102 /* G.f */
103 #define G_RENDER_OGL    (1 <<  0)
104 #define G_SWAP_EXCHANGE (1 <<  1)
105 /* #define G_RENDER_SHADOW      (1 <<  3) */ /* temp flag, removed */
106 #define G_BACKBUFSEL    (1 <<  4)
107 #define G_PICKSEL       (1 <<  5)
108
109 /* #define G_FACESELECT (1 <<  8) use (mesh->editflag & ME_EDIT_PAINT_FACE_SEL) */
110
111 #define G_SCRIPT_AUTOEXEC (1 << 13)
112 #define G_SCRIPT_OVERRIDE_PREF (1 << 14) /* when this flag is set ignore the userprefs */
113 #define G_SCRIPT_AUTOEXEC_FAIL (1 << 15)
114 #define G_SCRIPT_AUTOEXEC_FAIL_QUIET (1 << 16)
115
116 /* #define G_NOFROZEN   (1 << 17) also removed */
117 /* #define G_GREASEPENCIL   (1 << 17)   also removed */
118
119 /* #define G_AUTOMATKEYS        (1 << 30)   also removed */
120
121 /* G.debug */
122 enum {
123         G_DEBUG =           (1 << 0), /* general debug flag, print more info in unexpected cases */
124         G_DEBUG_FFMPEG =    (1 << 1),
125         G_DEBUG_PYTHON =    (1 << 2), /* extra python info */
126         G_DEBUG_EVENTS =    (1 << 3), /* input/window/screen events */
127         G_DEBUG_HANDLERS =  (1 << 4), /* events handling */
128         G_DEBUG_WM =        (1 << 5), /* operator, undo */
129         G_DEBUG_JOBS =      (1 << 6), /* jobs time profiling */
130         G_DEBUG_FREESTYLE = (1 << 7), /* freestyle messages */
131         G_DEBUG_DEPSGRAPH_BUILD      = (1 << 8),   /* depsgraph construction messages */
132         G_DEBUG_DEPSGRAPH_EVAL       = (1 << 9),   /* depsgraph evaluation messages */
133         G_DEBUG_DEPSGRAPH_TAG        = (1 << 10),  /* depsgraph tagging messages */
134         G_DEBUG_DEPSGRAPH_TIME       = (1 << 11),  /* depsgraph timing statistics and messages */
135         G_DEBUG_DEPSGRAPH_NO_THREADS = (1 << 12),  /* single threaded depsgraph */
136         G_DEBUG_DEPSGRAPH_PRETTY     = (1 << 13),  /* use pretty colors in depsgraph messages */
137         G_DEBUG_DEPSGRAPH = (G_DEBUG_DEPSGRAPH_BUILD |
138                              G_DEBUG_DEPSGRAPH_EVAL |
139                              G_DEBUG_DEPSGRAPH_TAG |
140                              G_DEBUG_DEPSGRAPH_TIME),
141         G_DEBUG_SIMDATA =   (1 << 14), /* sim debug data display */
142         G_DEBUG_GPU_MEM =   (1 << 15), /* gpu memory in status bar */
143         G_DEBUG_GPU =        (1 << 16), /* gpu debug */
144         G_DEBUG_IO = (1 << 17),   /* IO Debugging (for Collada, ...)*/
145         G_DEBUG_GPU_SHADERS = (1 << 18),   /* GLSL shaders */
146 };
147
148 #define G_DEBUG_ALL  (G_DEBUG | G_DEBUG_FFMPEG | G_DEBUG_PYTHON | G_DEBUG_EVENTS | G_DEBUG_WM | G_DEBUG_JOBS | \
149                       G_DEBUG_FREESTYLE | G_DEBUG_DEPSGRAPH | G_DEBUG_GPU_MEM | G_DEBUG_IO | G_DEBUG_GPU_SHADERS)
150
151
152 /* G.fileflags */
153
154 #define G_AUTOPACK               (1 << 0)
155 #define G_FILE_COMPRESS          (1 << 1)
156
157 #define G_FILE_USERPREFS         (1 << 9)
158 #define G_FILE_NO_UI             (1 << 10)
159 #ifdef DNA_DEPRECATED_ALLOW
160 /* #define G_FILE_GAME_TO_IPO    (1 << 11) */           /* deprecated */
161 #define G_FILE_GAME_MAT          (1 << 12)              /* deprecated */
162 /* #define G_FILE_DISPLAY_LISTS  (1 << 13) */           /* deprecated */
163 #define G_FILE_SHOW_PHYSICS      (1 << 14)              /* deprecated */
164 #define G_FILE_GAME_MAT_GLSL     (1 << 15)              /* deprecated */
165 /* #define G_FILE_GLSL_NO_LIGHTS     (1 << 16) */       /* deprecated */
166 #define G_FILE_GLSL_NO_SHADERS   (1 << 17)              /* deprecated */
167 #define G_FILE_GLSL_NO_SHADOWS   (1 << 18)              /* deprecated */
168 #define G_FILE_GLSL_NO_RAMPS     (1 << 19)              /* deprecated */
169 #define G_FILE_GLSL_NO_NODES     (1 << 20)              /* deprecated */
170 #define G_FILE_GLSL_NO_EXTRA_TEX (1 << 21)              /* deprecated */
171 #define G_FILE_IGNORE_DEPRECATION_WARNINGS  (1 << 22)   /* deprecated */
172 #endif  /* DNA_DEPRECATED_ALLOW */
173
174 /* On read, use #FileGlobal.filename instead of the real location on-disk,
175  * needed for recovering temp files so relative paths resolve */
176 #define G_FILE_RECOVER           (1 << 23)
177 /* On write, remap relative file paths to the new file location. */
178 #define G_FILE_RELATIVE_REMAP    (1 << 24)
179 /* On write, make backup `.blend1`, `.blend2` ... files, when the users preference is enabled */
180 #define G_FILE_HISTORY           (1 << 25)
181 /* BMesh option to save as older mesh format */
182 #define G_FILE_MESH_COMPAT       (1 << 26)
183 /* On write, restore paths after editing them (G_FILE_RELATIVE_REMAP) */
184 #define G_FILE_SAVE_COPY         (1 << 27)
185 #define G_FILE_GLSL_NO_ENV_LIGHTING (1 << 28)
186
187 #define G_FILE_FLAGS_RUNTIME (G_FILE_NO_UI | G_FILE_RELATIVE_REMAP | G_FILE_MESH_COMPAT | G_FILE_SAVE_COPY)
188
189 /* ENDIAN_ORDER: indicates what endianness the platform where the file was
190  * written had. */
191 #if !defined(__BIG_ENDIAN__) && !defined(__LITTLE_ENDIAN__)
192 #  error Either __BIG_ENDIAN__ or __LITTLE_ENDIAN__ must be defined.
193 #endif
194
195 #define L_ENDIAN    1
196 #define B_ENDIAN    0
197
198 #ifdef __BIG_ENDIAN__
199 #  define ENDIAN_ORDER B_ENDIAN
200 #else
201 #  define ENDIAN_ORDER L_ENDIAN
202 #endif
203
204 /* G.moving, signals drawing in (3d) window to denote transform */
205 #define G_TRANSFORM_OBJ         1
206 #define G_TRANSFORM_EDIT        2
207 #define G_TRANSFORM_SEQ         4
208 #define G_TRANSFORM_FCURVES     8
209
210 /* Memory is allocated where? blender.c */
211 extern Global G;
212
213 /**
214  * Stupid macro to hide the few *valid* usages of G.main (from startup/exit code e.g.), helps with cleanup task.
215  */
216 #define G_MAIN (G).main
217
218 #ifdef __cplusplus
219 }
220 #endif
221         
222 #endif