0f545ad3ff904b59274992865fd60eef1dca2337
[blender.git] / source / blender / blenkernel / intern / blender.c
1 /*  blender.c   jan 94     MIXED MODEL
2  * 
3  * common help functions and data
4  * 
5  * $Id$
6  *
7  * ***** BEGIN GPL LICENSE BLOCK *****
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL LICENSE BLOCK *****
31  */
32
33 /** \file blender/blenkernel/intern/blender.c
34  *  \ingroup bke
35  */
36
37
38 #ifndef _WIN32 
39         #include <unistd.h> // for read close
40 #else
41         #include <io.h> // for open close read
42         #define open _open
43         #define read _read
44         #define close _close
45         #define write _write
46 #endif
47
48 #include <stdlib.h>
49 #include <stdio.h>
50 #include <stddef.h>
51 #include <string.h>
52 #include <fcntl.h> // for open
53
54 #include "MEM_guardedalloc.h"
55
56 #include "DNA_userdef_types.h"
57 #include "DNA_scene_types.h"
58 #include "DNA_screen_types.h"
59 #include "DNA_sequence_types.h"
60 #include "DNA_sound_types.h"
61
62 #include "BLI_blenlib.h"
63 #include "BLI_bpath.h"
64 #include "BLI_dynstr.h"
65 #include "BLI_path_util.h"
66 #include "BLI_utildefines.h"
67
68 #include "IMB_imbuf.h"
69
70 #include "BKE_blender.h"
71 #include "BKE_context.h"
72 #include "BKE_depsgraph.h"
73 #include "BKE_displist.h"
74 #include "BKE_global.h"
75 #include "BKE_idprop.h"
76 #include "BKE_ipo.h"
77 #include "BKE_library.h"
78 #include "BKE_main.h"
79 #include "BKE_node.h"
80 #include "BKE_report.h"
81 #include "BKE_scene.h"
82 #include "BKE_screen.h"
83 #include "BKE_sequencer.h"
84
85
86 #include "BLO_undofile.h"
87 #include "BLO_readfile.h" 
88 #include "BLO_writefile.h" 
89
90 #include "BKE_utildefines.h"
91
92 #include "WM_api.h" // XXXXX BAD, very BAD dependency (bad level call) - remove asap, elubie
93
94 Global G;
95 UserDef U;
96 /* ListBase = {NULL, NULL}; */
97 short ENDIAN_ORDER;
98
99 static char versionstr[48]= "";
100
101 /* ********** free ********** */
102
103 /* only to be called on exit blender */
104 void free_blender(void)
105 {
106         /* samples are in a global list..., also sets G.main->sound->sample NULL */
107         free_main(G.main);
108         G.main= NULL;
109
110         BKE_spacetypes_free();          /* after free main, it uses space callbacks */
111         
112         IMB_exit();
113         seq_stripelem_cache_destruct();
114         
115         free_nodesystem();      
116 }
117
118 void initglobals(void)
119 {
120         memset(&G, 0, sizeof(Global));
121         
122         U.savetime= 1;
123
124         G.main= MEM_callocN(sizeof(Main), "initglobals");
125
126         strcpy(G.ima, "//");
127
128         ENDIAN_ORDER= 1;
129         ENDIAN_ORDER= (((char*)&ENDIAN_ORDER)[0])? L_ENDIAN: B_ENDIAN;
130
131         if(BLENDER_SUBVERSION)
132                 BLI_snprintf(versionstr, sizeof(versionstr), "www.blender.org %d.%d", BLENDER_VERSION, BLENDER_SUBVERSION);
133         else
134                 BLI_snprintf(versionstr, sizeof(versionstr), "www.blender.org %d", BLENDER_VERSION);
135
136 #ifdef _WIN32   // FULLSCREEN
137         G.windowstate = G_WINDOWSTATE_USERDEF;
138 #endif
139
140         G.charstart = 0x0000;
141         G.charmin = 0x0000;
142         G.charmax = 0xffff;
143
144 #ifndef WITH_PYTHON_SECURITY /* default */
145         G.f |= G_SCRIPT_AUTOEXEC;
146 #else
147         G.f &= ~G_SCRIPT_AUTOEXEC;
148 #endif
149 }
150
151 /***/
152
153 static void clear_global(void) 
154 {
155 //      extern short winqueue_break;    /* screen.c */
156
157         free_main(G.main);                      /* free all lib data */
158         
159 //      free_vertexpaint();
160
161         G.main= NULL;
162 }
163
164 /* make sure path names are correct for OS */
165 static void clean_paths(Main *main)
166 {
167         struct BPathIterator *bpi;
168         char filepath_expanded[1024];
169         Scene *scene;
170
171         for(BLI_bpathIterator_init(&bpi, main, main->name, BPATH_USE_PACKED); !BLI_bpathIterator_isDone(bpi); BLI_bpathIterator_step(bpi)) {
172                 BLI_bpathIterator_getPath(bpi, filepath_expanded);
173
174                 BLI_clean(filepath_expanded);
175
176                 BLI_bpathIterator_setPath(bpi, filepath_expanded);
177         }
178
179         BLI_bpathIterator_free(bpi);
180
181         for(scene= main->scene.first; scene; scene= scene->id.next) {
182                 BLI_clean(scene->r.pic);
183         }
184 }
185
186 /* context matching */
187 /* handle no-ui case */
188
189 /* note, this is called on Undo so any slow conversion functions here
190  * should be avoided or check (mode!='u') */
191
192 static void setup_app_data(bContext *C, BlendFileData *bfd, const char *filepath)
193 {
194         bScreen *curscreen= NULL;
195         Scene *curscene= NULL;
196         int recover;
197         char mode;
198
199         /* 'u' = undo save, 'n' = no UI load */
200         if(bfd->main->screen.first==NULL) mode= 'u';
201         else if(G.fileflags & G_FILE_NO_UI) mode= 'n';
202         else mode= 0;
203
204         recover= (G.fileflags & G_FILE_RECOVER);
205
206         /* Only make filepaths compatible when loading for real (not undo) */
207         if(mode != 'u') {
208                 clean_paths(bfd->main);
209         }
210
211         /* XXX here the complex windowmanager matching */
212         
213         /* no load screens? */
214         if(mode) {
215                 /* comes from readfile.c */
216                 extern void lib_link_screen_restore(Main *, bScreen *, Scene *);
217                 
218                 SWAP(ListBase, G.main->wm, bfd->main->wm);
219                 SWAP(ListBase, G.main->screen, bfd->main->screen);
220                 SWAP(ListBase, G.main->script, bfd->main->script);
221                 
222                 /* we re-use current screen */
223                 curscreen= CTX_wm_screen(C);
224                 /* but use new Scene pointer */
225                 curscene= bfd->curscene;
226                 if(curscene==NULL) curscene= bfd->main->scene.first;
227                 /* and we enforce curscene to be in current screen */
228                 if(curscreen) curscreen->scene= curscene; /* can run in bgmode */
229
230                 /* clear_global will free G.main, here we can still restore pointers */
231                 lib_link_screen_restore(bfd->main, curscreen, curscene);
232         }
233         
234         /* free G.main Main database */
235 //      CTX_wm_manager_set(C, NULL);
236         clear_global(); 
237         
238         G.main= bfd->main;
239
240         CTX_data_main_set(C, G.main);
241         
242         if (bfd->user) {
243                 
244                 /* only here free userdef themes... */
245                 BKE_userdef_free();
246                 
247                 U= *bfd->user;
248                 MEM_freeN(bfd->user);
249         }
250         
251         /* case G_FILE_NO_UI or no screens in file */
252         if(mode) {
253                 /* leave entire context further unaltered? */
254                 CTX_data_scene_set(C, curscene);
255         }
256         else {
257                 G.winpos= bfd->winpos;
258                 G.displaymode= bfd->displaymode;
259                 G.fileflags= bfd->fileflags;
260                 CTX_wm_manager_set(C, bfd->main->wm.first);
261                 CTX_wm_screen_set(C, bfd->curscreen);
262                 CTX_data_scene_set(C, bfd->curscreen->scene);
263                 CTX_wm_area_set(C, NULL);
264                 CTX_wm_region_set(C, NULL);
265                 CTX_wm_menu_set(C, NULL);
266         }
267         
268         /* this can happen when active scene was lib-linked, and doesnt exist anymore */
269         if(CTX_data_scene(C)==NULL) {
270                 CTX_data_scene_set(C, bfd->main->scene.first);
271                 CTX_wm_screen(C)->scene= CTX_data_scene(C);
272                 curscene= CTX_data_scene(C);
273         }
274
275         /* special cases, override loaded flags: */
276         if(G.f != bfd->globalf) {
277                 const int flags_keep= (G_DEBUG | G_SWAP_EXCHANGE | G_SCRIPT_AUTOEXEC | G_SCRIPT_OVERRIDE_PREF);
278                 bfd->globalf= (bfd->globalf & ~flags_keep) | (G.f & flags_keep);
279         }
280
281
282         G.f= bfd->globalf;
283
284         if (!G.background) {
285                 //setscreen(G.curscreen);
286         }
287         
288         // FIXME: this version patching should really be part of the file-reading code, 
289         // but we still get too many unrelated data-corruption crashes otherwise...
290         if (G.main->versionfile < 250)
291                 do_versions_ipos_to_animato(G.main);
292         
293         if(recover && bfd->filename[0] && G.relbase_valid) {
294                 /* in case of autosave or quit.blend, use original filename instead
295                  * use relbase_valid to make sure the file is saved, else we get <memory2> in the filename */
296                 filepath= bfd->filename;
297         }
298 #if 0
299         else if (!G.relbase_valid) {
300                 /* otherwise, use an empty string as filename, rather than <memory2> */
301                 filepath="";
302         }
303 #endif
304         
305         /* these are the same at times, should never copy to the same location */
306         if(G.main->name != filepath)
307                 BLI_strncpy(G.main->name, filepath, FILE_MAX);
308
309         /* baseflags, groups, make depsgraph, etc */
310         set_scene_bg(G.main, CTX_data_scene(C));
311         
312         MEM_freeN(bfd);
313 }
314
315 static int handle_subversion_warning(Main *main)
316 {
317         if(main->minversionfile > BLENDER_VERSION ||
318            (main->minversionfile == BLENDER_VERSION && 
319                  main->minsubversionfile > BLENDER_SUBVERSION)) {
320                 
321                 char str[128];
322                 
323                 BLI_snprintf(str, sizeof(str), "File written by newer Blender binary: %d.%d , expect loss of data!", main->minversionfile, main->minsubversionfile);
324 // XXX          error(str);
325         }
326         return 1;
327 }
328
329 void BKE_userdef_free(void)
330 {
331         wmKeyMap *km;
332         wmKeyMapItem *kmi;
333
334         for(km=U.keymaps.first; km; km=km->next) {
335                 for(kmi=km->items.first; kmi; kmi=kmi->next) {
336                         if(kmi->properties) {
337                                 IDP_FreeProperty(kmi->properties);
338                                 MEM_freeN(kmi->properties);
339                         }
340                         if(kmi->ptr)
341                                 MEM_freeN(kmi->ptr);
342                 }
343
344                 BLI_freelistN(&km->items);
345         }
346         
347         BLI_freelistN(&U.uistyles);
348         BLI_freelistN(&U.uifonts);
349         BLI_freelistN(&U.themes);
350         BLI_freelistN(&U.keymaps);
351         BLI_freelistN(&U.addons);
352 }
353
354 int BKE_read_file(bContext *C, const char *filepath, ReportList *reports)
355 {
356         BlendFileData *bfd;
357         int retval= BKE_READ_FILE_OK;
358
359         if(strstr(filepath, BLENDER_STARTUP_FILE)==NULL) /* dont print user-pref loading */
360                 printf("read blend: %s\n", filepath);
361
362         bfd= BLO_read_from_file(filepath, reports);
363         if (bfd) {
364                 if(bfd->user) retval= BKE_READ_FILE_OK_USERPREFS;
365                 
366                 if(0==handle_subversion_warning(bfd->main)) {
367                         free_main(bfd->main);
368                         MEM_freeN(bfd);
369                         bfd= NULL;
370                         retval= BKE_READ_FILE_FAIL;
371                 }
372                 else
373                         setup_app_data(C, bfd, filepath); // frees BFD
374         } 
375         else
376                 BKE_reports_prependf(reports, "Loading %s failed: ", filepath);
377                 
378         return (bfd?retval:BKE_READ_FILE_FAIL);
379 }
380
381 int BKE_read_file_from_memory(bContext *C, char* filebuf, int filelength, ReportList *reports)
382 {
383         BlendFileData *bfd;
384
385         bfd= BLO_read_from_memory(filebuf, filelength, reports);
386         if (bfd)
387                 setup_app_data(C, bfd, "<memory2>");
388         else
389                 BKE_reports_prepend(reports, "Loading failed: ");
390
391         return (bfd?1:0);
392 }
393
394 /* memfile is the undo buffer */
395 int BKE_read_file_from_memfile(bContext *C, MemFile *memfile, ReportList *reports)
396 {
397         BlendFileData *bfd;
398
399         bfd= BLO_read_from_memfile(CTX_data_main(C), G.main->name, memfile, reports);
400         if (bfd)
401                 setup_app_data(C, bfd, "<memory1>");
402         else
403                 BKE_reports_prepend(reports, "Loading failed: ");
404
405         return (bfd?1:0);
406 }
407
408
409 /* *****************  testing for break ************* */
410
411 static void (*blender_test_break_cb)(void)= NULL;
412
413 void set_blender_test_break_cb(void (*func)(void) )
414 {
415         blender_test_break_cb= func;
416 }
417
418
419 int blender_test_break(void)
420 {
421         if (!G.background) {
422                 if (blender_test_break_cb)
423                         blender_test_break_cb();
424         }
425         
426         return (G.afbreek==1);
427 }
428
429
430 /* ***************** GLOBAL UNDO *************** */
431
432 #define UNDO_DISK       0
433
434 #define MAXUNDONAME     64
435 typedef struct UndoElem {
436         struct UndoElem *next, *prev;
437         char str[FILE_MAXDIR+FILE_MAXFILE];
438         char name[MAXUNDONAME];
439         MemFile memfile;
440         uintptr_t undosize;
441 } UndoElem;
442
443 static ListBase undobase={NULL, NULL};
444 static UndoElem *curundo= NULL;
445
446
447 static int read_undosave(bContext *C, UndoElem *uel)
448 {
449         char mainstr[sizeof(G.main->name)];
450         int success=0, fileflags;
451         
452         /* This is needed so undoing/redoing doesnt crash with threaded previews going */
453         WM_jobs_stop_all(CTX_wm_manager(C));
454
455         BLI_strncpy(mainstr, G.main->name, sizeof(mainstr));    /* temporal store */
456
457         fileflags= G.fileflags;
458         G.fileflags |= G_FILE_NO_UI;
459
460         if(UNDO_DISK) 
461                 success= (BKE_read_file(C, uel->str, NULL) != BKE_READ_FILE_FAIL);
462         else
463                 success= BKE_read_file_from_memfile(C, &uel->memfile, NULL);
464
465         /* restore */
466         BLI_strncpy(G.main->name, mainstr, sizeof(G.main->name)); /* restore */
467         G.fileflags= fileflags;
468
469         if(success) {
470                 /* important not to update time here, else non keyed tranforms are lost */
471                 DAG_on_visible_update(G.main, FALSE);
472         }
473
474         return success;
475 }
476
477 /* name can be a dynamic string */
478 void BKE_write_undo(bContext *C, const char *name)
479 {
480         uintptr_t maxmem, totmem, memused;
481         int nr, success;
482         UndoElem *uel;
483         
484         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
485         if( U.undosteps==0) return;
486         
487         /* remove all undos after (also when curundo==NULL) */
488         while(undobase.last != curundo) {
489                 uel= undobase.last;
490                 BLI_remlink(&undobase, uel);
491                 BLO_free_memfile(&uel->memfile);
492                 MEM_freeN(uel);
493         }
494         
495         /* make new */
496         curundo= uel= MEM_callocN(sizeof(UndoElem), "undo file");
497         strncpy(uel->name, name, MAXUNDONAME-1);
498         BLI_addtail(&undobase, uel);
499         
500         /* and limit amount to the maximum */
501         nr= 0;
502         uel= undobase.last;
503         while(uel) {
504                 nr++;
505                 if(nr==U.undosteps) break;
506                 uel= uel->prev;
507         }
508         if(uel) {
509                 while(undobase.first!=uel) {
510                         UndoElem *first= undobase.first;
511                         BLI_remlink(&undobase, first);
512                         /* the merge is because of compression */
513                         BLO_merge_memfile(&first->memfile, &first->next->memfile);
514                         MEM_freeN(first);
515                 }
516         }
517
518
519         /* disk save version */
520         if(UNDO_DISK) {
521                 static int counter= 0;
522                 char filepath[FILE_MAXDIR+FILE_MAXFILE];
523                 char numstr[32];
524                 int fileflags = G.fileflags & ~(G_FILE_HISTORY); /* don't do file history on undo */
525
526                 /* calculate current filepath */
527                 counter++;
528                 counter= counter % U.undosteps; 
529         
530                 BLI_snprintf(numstr, sizeof(numstr), "%d.blend", counter);
531                 BLI_make_file_string("/", filepath, btempdir, numstr);
532         
533                 success= BLO_write_file(CTX_data_main(C), filepath, fileflags, NULL, NULL);
534                 
535                 BLI_strncpy(curundo->str, filepath, sizeof(curundo->str));
536         }
537         else {
538                 MemFile *prevfile=NULL;
539                 
540                 if(curundo->prev) prevfile= &(curundo->prev->memfile);
541                 
542                 memused= MEM_get_memory_in_use();
543                 success= BLO_write_file_mem(CTX_data_main(C), prevfile, &curundo->memfile, G.fileflags);
544                 curundo->undosize= MEM_get_memory_in_use() - memused;
545         }
546
547         if(U.undomemory != 0) {
548                 /* limit to maximum memory (afterwards, we can't know in advance) */
549                 totmem= 0;
550                 maxmem= ((uintptr_t)U.undomemory)*1024*1024;
551
552                 /* keep at least two (original + other) */
553                 uel= undobase.last;
554                 while(uel && uel->prev) {
555                         totmem+= uel->undosize;
556                         if(totmem>maxmem) break;
557                         uel= uel->prev;
558                 }
559
560                 if(uel) {
561                         if(uel->prev && uel->prev->prev)
562                                 uel= uel->prev;
563
564                         while(undobase.first!=uel) {
565                                 UndoElem *first= undobase.first;
566                                 BLI_remlink(&undobase, first);
567                                 /* the merge is because of compression */
568                                 BLO_merge_memfile(&first->memfile, &first->next->memfile);
569                                 MEM_freeN(first);
570                         }
571                 }
572         }
573 }
574
575 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
576 void BKE_undo_step(bContext *C, int step)
577 {
578         
579         if(step==0) {
580                 read_undosave(C, curundo);
581         }
582         else if(step==1) {
583                 /* curundo should never be NULL, after restart or load file it should call undo_save */
584                 if(curundo==NULL || curundo->prev==NULL) ; // XXX error("No undo available");
585                 else {
586                         if(G.f & G_DEBUG) printf("undo %s\n", curundo->name);
587                         curundo= curundo->prev;
588                         read_undosave(C, curundo);
589                 }
590         }
591         else {
592                 
593                 /* curundo has to remain current situation! */
594                 
595                 if(curundo==NULL || curundo->next==NULL) ; // XXX error("No redo available");
596                 else {
597                         read_undosave(C, curundo->next);
598                         curundo= curundo->next;
599                         if(G.f & G_DEBUG) printf("redo %s\n", curundo->name);
600                 }
601         }
602 }
603
604 void BKE_reset_undo(void)
605 {
606         UndoElem *uel;
607         
608         uel= undobase.first;
609         while(uel) {
610                 BLO_free_memfile(&uel->memfile);
611                 uel= uel->next;
612         }
613         
614         BLI_freelistN(&undobase);
615         curundo= NULL;
616 }
617
618 /* based on index nr it does a restore */
619 void BKE_undo_number(bContext *C, int nr)
620 {
621         curundo= BLI_findlink(&undobase, nr);
622         BKE_undo_step(C, 0);
623 }
624
625 /* go back to the last occurance of name in stack */
626 void BKE_undo_name(bContext *C, const char *name)
627 {
628         UndoElem *uel= BLI_rfindstring(&undobase, name, offsetof(UndoElem, name));
629
630         if(uel && uel->prev) {
631                 curundo= uel->prev;
632                 BKE_undo_step(C, 0);
633         }
634 }
635
636 /* name optional */
637 int BKE_undo_valid(const char *name)
638 {
639         if(name) {
640                 UndoElem *uel= BLI_rfindstring(&undobase, name, offsetof(UndoElem, name));
641                 return uel && uel->prev;
642         }
643         
644         return undobase.last != undobase.first;
645 }
646
647 /* get name of undo item, return null if no item with this index */
648 /* if active pointer, set it to 1 if true */
649 char *BKE_undo_get_name(int nr, int *active)
650 {
651         UndoElem *uel= BLI_findlink(&undobase, nr);
652         
653         if(active) *active= 0;
654         
655         if(uel) {
656                 if(active && uel==curundo)
657                         *active= 1;
658                 return uel->name;
659         }
660         return NULL;
661 }
662
663 char *BKE_undo_menu_string(void)
664 {
665         UndoElem *uel;
666         DynStr *ds= BLI_dynstr_new();
667         char *menu;
668
669         BLI_dynstr_append(ds, "Global Undo History %t");
670         
671         for(uel= undobase.first; uel; uel= uel->next) {
672                 BLI_dynstr_append(ds, "|");
673                 BLI_dynstr_append(ds, uel->name);
674         }
675
676         menu= BLI_dynstr_get_cstring(ds);
677         BLI_dynstr_free(ds);
678
679         return menu;
680 }
681
682         /* saves quit.blend */
683 void BKE_undo_save_quit(void)
684 {
685         UndoElem *uel;
686         MemFileChunk *chunk;
687         int file;
688         char str[FILE_MAXDIR+FILE_MAXFILE];
689         
690         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
691         
692         uel= curundo;
693         if(uel==NULL) {
694                 printf("No undo buffer to save recovery file\n");
695                 return;
696         }
697         
698         /* no undo state to save */
699         if(undobase.first==undobase.last) return;
700                 
701         BLI_make_file_string("/", str, btempdir, "quit.blend");
702
703         file = open(str,O_BINARY+O_WRONLY+O_CREAT+O_TRUNC, 0666);
704         if(file == -1) {
705                 //XXX error("Unable to save %s, check you have permissions", str);
706                 return;
707         }
708
709         chunk= uel->memfile.chunks.first;
710         while(chunk) {
711                 if( write(file, chunk->buf, chunk->size) != chunk->size) break;
712                 chunk= chunk->next;
713         }
714         
715         close(file);
716         
717         if(chunk) ; //XXX error("Unable to save %s, internal error", str);
718         else printf("Saved session recovery to %s\n", str);
719 }
720
721 /* sets curscene */
722 Main *BKE_undo_get_main(Scene **scene)
723 {
724         Main *mainp= NULL;
725         BlendFileData *bfd= BLO_read_from_memfile(G.main, G.main->name, &curundo->memfile, NULL);
726         
727         if(bfd) {
728                 mainp= bfd->main;
729                 if(scene)
730                         *scene= bfd->curscene;
731                 
732                 MEM_freeN(bfd);
733         }
734         
735         return mainp;
736 }
737