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