d1a181046a6c2cf47ebe166459188993cacc5480
[blender-staging.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         G.f |= G_SCRIPT_AUTOEXEC;
145 }
146
147 /***/
148
149 static void clear_global(void) 
150 {
151 //      extern short winqueue_break;    /* screen.c */
152
153         fastshade_free_render();        /* lamps hang otherwise */
154         free_main(G.main);                      /* free all lib data */
155         
156 //      free_vertexpaint();
157
158         G.main= NULL;
159 }
160
161 /* make sure path names are correct for OS */
162 static void clean_paths(Main *main)
163 {
164         struct BPathIterator *bpi;
165         char filepath_expanded[1024];
166         Scene *scene;
167
168         for(BLI_bpathIterator_init(&bpi, main, main->name, BPATH_USE_PACKED); !BLI_bpathIterator_isDone(bpi); BLI_bpathIterator_step(bpi)) {
169                 BLI_bpathIterator_getPath(bpi, filepath_expanded);
170
171                 BLI_clean(filepath_expanded);
172
173                 BLI_bpathIterator_setPath(bpi, filepath_expanded);
174         }
175
176         BLI_bpathIterator_free(bpi);
177
178         for(scene= main->scene.first; scene; scene= scene->id.next) {
179                 BLI_clean(scene->r.backbuf);
180                 BLI_clean(scene->r.pic);
181         }
182 }
183
184 /* context matching */
185 /* handle no-ui case */
186
187 /* note, this is called on Undo so any slow conversion functions here
188  * should be avoided or check (mode!='u') */
189
190 static void setup_app_data(bContext *C, BlendFileData *bfd, const char *filename) 
191 {
192         bScreen *curscreen= NULL;
193         Scene *curscene= NULL;
194         int recover;
195         char mode;
196
197         /* 'u' = undo save, 'n' = no UI load */
198         if(bfd->main->screen.first==NULL) mode= 'u';
199         else if(G.fileflags & G_FILE_NO_UI) mode= 'n';
200         else mode= 0;
201
202         recover= (G.fileflags & G_FILE_RECOVER);
203
204         /* Only make filepaths compatible when loading for real (not undo) */
205         if(mode != 'u') {
206                 clean_paths(bfd->main);
207         }
208
209         /* XXX here the complex windowmanager matching */
210         
211         /* no load screens? */
212         if(mode) {
213                 /* comes from readfile.c */
214                 extern void lib_link_screen_restore(Main *, bScreen *, Scene *);
215                 
216                 SWAP(ListBase, G.main->wm, bfd->main->wm);
217                 SWAP(ListBase, G.main->screen, bfd->main->screen);
218                 SWAP(ListBase, G.main->script, bfd->main->script);
219                 
220                 /* we re-use current screen */
221                 curscreen= CTX_wm_screen(C);
222                 /* but use new Scene pointer */
223                 curscene= bfd->curscene;
224                 if(curscene==NULL) curscene= bfd->main->scene.first;
225                 /* and we enforce curscene to be in current screen */
226                 if(curscreen) curscreen->scene= curscene; /* can run in bgmode */
227
228                 /* clear_global will free G.main, here we can still restore pointers */
229                 lib_link_screen_restore(bfd->main, curscreen, curscene);
230         }
231         
232         /* free G.main Main database */
233 //      CTX_wm_manager_set(C, NULL);
234         clear_global(); 
235         
236         G.main= bfd->main;
237
238         CTX_data_main_set(C, G.main);
239         
240         if (bfd->user) {
241                 
242                 /* only here free userdef themes... */
243                 BKE_userdef_free();
244                 
245                 U= *bfd->user;
246                 MEM_freeN(bfd->user);
247         }
248         
249         /* case G_FILE_NO_UI or no screens in file */
250         if(mode) {
251                 /* leave entire context further unaltered? */
252                 CTX_data_scene_set(C, curscene);
253         }
254         else {
255                 G.winpos= bfd->winpos;
256                 G.displaymode= bfd->displaymode;
257                 G.fileflags= bfd->fileflags;
258                 CTX_wm_manager_set(C, bfd->main->wm.first);
259                 CTX_wm_screen_set(C, bfd->curscreen);
260                 CTX_data_scene_set(C, bfd->curscreen->scene);
261                 CTX_wm_area_set(C, NULL);
262                 CTX_wm_region_set(C, NULL);
263                 CTX_wm_menu_set(C, NULL);
264         }
265         
266         /* this can happen when active scene was lib-linked, and doesnt exist anymore */
267         if(CTX_data_scene(C)==NULL) {
268                 CTX_data_scene_set(C, bfd->main->scene.first);
269                 CTX_wm_screen(C)->scene= CTX_data_scene(C);
270                 curscene= CTX_data_scene(C);
271         }
272
273         /* special cases, override loaded flags: */
274         if(G.f != bfd->globalf) {
275                 const int flags_keep= (G_DEBUG | G_SWAP_EXCHANGE | G_SCRIPT_AUTOEXEC | G_SCRIPT_OVERRIDE_PREF);
276                 bfd->globalf= (bfd->globalf & ~flags_keep) | (G.f & flags_keep);
277         }
278
279
280         G.f= bfd->globalf;
281
282         if (!G.background) {
283                 //setscreen(G.curscreen);
284         }
285         
286         // FIXME: this version patching should really be part of the file-reading code, 
287         // but we still get too many unrelated data-corruption crashes otherwise...
288         if (G.main->versionfile < 250)
289                 do_versions_ipos_to_animato(G.main);
290         
291         if(recover && bfd->filename[0] && G.relbase_valid) {
292                 /* in case of autosave or quit.blend, use original filename instead
293                  * use relbase_valid to make sure the file is saved, else we get <memory2> in the filename */
294                 filename= bfd->filename;
295         }
296 #if 0
297         else if (!G.relbase_valid) {
298                 /* otherwise, use an empty string as filename, rather than <memory2> */
299                 filename="";
300         }
301 #endif
302         
303         /* these are the same at times, should never copy to the same location */
304         if(G.main->name != filename)
305                 BLI_strncpy(G.main->name, filename, FILE_MAX);
306
307         /* baseflags, groups, make depsgraph, etc */
308         set_scene_bg(G.main, CTX_data_scene(C));
309         
310         MEM_freeN(bfd);
311 }
312
313 static int handle_subversion_warning(Main *main)
314 {
315         if(main->minversionfile > BLENDER_VERSION ||
316            (main->minversionfile == BLENDER_VERSION && 
317                  main->minsubversionfile > BLENDER_SUBVERSION)) {
318                 
319                 char str[128];
320                 
321                 BLI_snprintf(str, sizeof(str), "File written by newer Blender binary: %d.%d , expect loss of data!", main->minversionfile, main->minsubversionfile);
322 // XXX          error(str);
323         }
324         return 1;
325 }
326
327 void BKE_userdef_free(void)
328 {
329         wmKeyMap *km;
330         wmKeyMapItem *kmi;
331
332         for(km=U.keymaps.first; km; km=km->next) {
333                 for(kmi=km->items.first; kmi; kmi=kmi->next) {
334                         if(kmi->properties) {
335                                 IDP_FreeProperty(kmi->properties);
336                                 MEM_freeN(kmi->properties);
337                         }
338                         if(kmi->ptr)
339                                 MEM_freeN(kmi->ptr);
340                 }
341
342                 BLI_freelistN(&km->items);
343         }
344         
345         BLI_freelistN(&U.uistyles);
346         BLI_freelistN(&U.uifonts);
347         BLI_freelistN(&U.themes);
348         BLI_freelistN(&U.keymaps);
349         BLI_freelistN(&U.addons);
350 }
351
352 int BKE_read_file(bContext *C, const char *dir, ReportList *reports) 
353 {
354         BlendFileData *bfd;
355         int retval= BKE_READ_FILE_OK;
356
357         if(strstr(dir, BLENDER_STARTUP_FILE)==NULL) /* dont print user-pref loading */
358                 printf("read blend: %s\n", dir);
359
360         bfd= BLO_read_from_file(dir, reports);
361         if (bfd) {
362                 if(bfd->user) retval= BKE_READ_FILE_OK_USERPREFS;
363                 
364                 if(0==handle_subversion_warning(bfd->main)) {
365                         free_main(bfd->main);
366                         MEM_freeN(bfd);
367                         bfd= NULL;
368                         retval= BKE_READ_FILE_FAIL;
369                 }
370                 else
371                         setup_app_data(C, bfd, dir); // frees BFD
372         } 
373         else
374                 BKE_reports_prependf(reports, "Loading %s failed: ", dir);
375                 
376         return (bfd?retval:BKE_READ_FILE_FAIL);
377 }
378
379 int BKE_read_file_from_memory(bContext *C, char* filebuf, int filelength, ReportList *reports)
380 {
381         BlendFileData *bfd;
382
383         bfd= BLO_read_from_memory(filebuf, filelength, reports);
384         if (bfd)
385                 setup_app_data(C, bfd, "<memory2>");
386         else
387                 BKE_reports_prepend(reports, "Loading failed: ");
388
389         return (bfd?1:0);
390 }
391
392 /* memfile is the undo buffer */
393 int BKE_read_file_from_memfile(bContext *C, MemFile *memfile, ReportList *reports)
394 {
395         BlendFileData *bfd;
396
397         bfd= BLO_read_from_memfile(CTX_data_main(C), G.main->name, memfile, reports);
398         if (bfd)
399                 setup_app_data(C, bfd, "<memory1>");
400         else
401                 BKE_reports_prepend(reports, "Loading failed: ");
402
403         return (bfd?1:0);
404 }
405
406
407 /* *****************  testing for break ************* */
408
409 static void (*blender_test_break_cb)(void)= NULL;
410
411 void set_blender_test_break_cb(void (*func)(void) )
412 {
413         blender_test_break_cb= func;
414 }
415
416
417 int blender_test_break(void)
418 {
419         if (!G.background) {
420                 if (blender_test_break_cb)
421                         blender_test_break_cb();
422         }
423         
424         return (G.afbreek==1);
425 }
426
427
428 /* ***************** GLOBAL UNDO *************** */
429
430 #define UNDO_DISK       0
431
432 #define MAXUNDONAME     64
433 typedef struct UndoElem {
434         struct UndoElem *next, *prev;
435         char str[FILE_MAXDIR+FILE_MAXFILE];
436         char name[MAXUNDONAME];
437         MemFile memfile;
438         uintptr_t undosize;
439 } UndoElem;
440
441 static ListBase undobase={NULL, NULL};
442 static UndoElem *curundo= NULL;
443
444
445 static int read_undosave(bContext *C, UndoElem *uel)
446 {
447         char mainstr[sizeof(G.main->name)];
448         int success=0, fileflags;
449         
450         /* This is needed so undoing/redoing doesnt crash with threaded previews going */
451         WM_jobs_stop_all(CTX_wm_manager(C));
452
453         BLI_strncpy(mainstr, G.main->name, sizeof(mainstr));    /* temporal store */
454
455         fileflags= G.fileflags;
456         G.fileflags |= G_FILE_NO_UI;
457
458         if(UNDO_DISK) 
459                 success= (BKE_read_file(C, uel->str, NULL) != BKE_READ_FILE_FAIL);
460         else
461                 success= BKE_read_file_from_memfile(C, &uel->memfile, NULL);
462
463         /* restore */
464         BLI_strncpy(G.main->name, mainstr, sizeof(G.main->name)); /* restore */
465         G.fileflags= fileflags;
466
467         if(success) {
468                 /* important not to update time here, else non keyed tranforms are lost */
469                 DAG_on_visible_update(G.main, FALSE);
470         }
471
472         return success;
473 }
474
475 /* name can be a dynamic string */
476 void BKE_write_undo(bContext *C, const char *name)
477 {
478         uintptr_t maxmem, totmem, memused;
479         int nr, success;
480         UndoElem *uel;
481         
482         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
483         if( U.undosteps==0) return;
484         
485         /* remove all undos after (also when curundo==NULL) */
486         while(undobase.last != curundo) {
487                 uel= undobase.last;
488                 BLI_remlink(&undobase, uel);
489                 BLO_free_memfile(&uel->memfile);
490                 MEM_freeN(uel);
491         }
492         
493         /* make new */
494         curundo= uel= MEM_callocN(sizeof(UndoElem), "undo file");
495         strncpy(uel->name, name, MAXUNDONAME-1);
496         BLI_addtail(&undobase, uel);
497         
498         /* and limit amount to the maximum */
499         nr= 0;
500         uel= undobase.last;
501         while(uel) {
502                 nr++;
503                 if(nr==U.undosteps) break;
504                 uel= uel->prev;
505         }
506         if(uel) {
507                 while(undobase.first!=uel) {
508                         UndoElem *first= undobase.first;
509                         BLI_remlink(&undobase, first);
510                         /* the merge is because of compression */
511                         BLO_merge_memfile(&first->memfile, &first->next->memfile);
512                         MEM_freeN(first);
513                 }
514         }
515
516
517         /* disk save version */
518         if(UNDO_DISK) {
519                 static int counter= 0;
520                 char tstr[FILE_MAXDIR+FILE_MAXFILE];
521                 char numstr[32];
522                 
523                 /* calculate current filename */
524                 counter++;
525                 counter= counter % U.undosteps; 
526         
527                 BLI_snprintf(numstr, sizeof(numstr), "%d.blend", counter);
528                 BLI_make_file_string("/", tstr, btempdir, numstr);
529         
530                 success= BLO_write_file(CTX_data_main(C), tstr, G.fileflags, NULL, NULL);
531                 
532                 BLI_strncpy(curundo->str, tstr, sizeof(curundo->str));
533         }
534         else {
535                 MemFile *prevfile=NULL;
536                 
537                 if(curundo->prev) prevfile= &(curundo->prev->memfile);
538                 
539                 memused= MEM_get_memory_in_use();
540                 success= BLO_write_file_mem(CTX_data_main(C), prevfile, &curundo->memfile, G.fileflags);
541                 curundo->undosize= MEM_get_memory_in_use() - memused;
542         }
543
544         if(U.undomemory != 0) {
545                 /* limit to maximum memory (afterwards, we can't know in advance) */
546                 totmem= 0;
547                 maxmem= ((uintptr_t)U.undomemory)*1024*1024;
548
549                 /* keep at least two (original + other) */
550                 uel= undobase.last;
551                 while(uel && uel->prev) {
552                         totmem+= uel->undosize;
553                         if(totmem>maxmem) break;
554                         uel= uel->prev;
555                 }
556
557                 if(uel) {
558                         if(uel->prev && uel->prev->prev)
559                                 uel= uel->prev;
560
561                         while(undobase.first!=uel) {
562                                 UndoElem *first= undobase.first;
563                                 BLI_remlink(&undobase, first);
564                                 /* the merge is because of compression */
565                                 BLO_merge_memfile(&first->memfile, &first->next->memfile);
566                                 MEM_freeN(first);
567                         }
568                 }
569         }
570 }
571
572 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
573 void BKE_undo_step(bContext *C, int step)
574 {
575         
576         if(step==0) {
577                 read_undosave(C, curundo);
578         }
579         else if(step==1) {
580                 /* curundo should never be NULL, after restart or load file it should call undo_save */
581                 if(curundo==NULL || curundo->prev==NULL) ; // XXX error("No undo available");
582                 else {
583                         if(G.f & G_DEBUG) printf("undo %s\n", curundo->name);
584                         curundo= curundo->prev;
585                         read_undosave(C, curundo);
586                 }
587         }
588         else {
589                 
590                 /* curundo has to remain current situation! */
591                 
592                 if(curundo==NULL || curundo->next==NULL) ; // XXX error("No redo available");
593                 else {
594                         read_undosave(C, curundo->next);
595                         curundo= curundo->next;
596                         if(G.f & G_DEBUG) printf("redo %s\n", curundo->name);
597                 }
598         }
599 }
600
601 void BKE_reset_undo(void)
602 {
603         UndoElem *uel;
604         
605         uel= undobase.first;
606         while(uel) {
607                 BLO_free_memfile(&uel->memfile);
608                 uel= uel->next;
609         }
610         
611         BLI_freelistN(&undobase);
612         curundo= NULL;
613 }
614
615 /* based on index nr it does a restore */
616 void BKE_undo_number(bContext *C, int nr)
617 {
618         UndoElem *uel;
619         int a=1;
620         
621         for(uel= undobase.first; uel; uel= uel->next, a++) {
622                 if(a==nr) break;
623         }
624         curundo= uel;
625         BKE_undo_step(C, 0);
626 }
627
628 /* go back to the last occurance of name in stack */
629 void BKE_undo_name(bContext *C, const char *name)
630 {
631         UndoElem *uel;
632
633         for(uel= undobase.last; uel; uel= uel->prev)
634                 if(strcmp(name, uel->name)==0)
635                         break;
636
637         if(uel && uel->prev) {
638                 curundo= uel->prev;
639                 BKE_undo_step(C, 0);
640         }
641 }
642
643 /* name optional */
644 int BKE_undo_valid(const char *name)
645 {
646         if(name) {
647                 UndoElem *uel;
648                 
649                 for(uel= undobase.last; uel; uel= uel->prev)
650                         if(strcmp(name, uel->name)==0)
651                                 break;
652                 
653                 return uel && uel->prev;
654         }
655         
656         return undobase.last != undobase.first;
657 }
658
659
660 char *BKE_undo_menu_string(void)
661 {
662         UndoElem *uel;
663         DynStr *ds= BLI_dynstr_new();
664         char *menu;
665
666         BLI_dynstr_append(ds, "Global Undo History %t");
667         
668         for(uel= undobase.first; uel; uel= uel->next) {
669                 BLI_dynstr_append(ds, "|");
670                 BLI_dynstr_append(ds, uel->name);
671         }
672
673         menu= BLI_dynstr_get_cstring(ds);
674         BLI_dynstr_free(ds);
675
676         return menu;
677 }
678
679         /* saves quit.blend */
680 void BKE_undo_save_quit(void)
681 {
682         UndoElem *uel;
683         MemFileChunk *chunk;
684         int file;
685         char str[FILE_MAXDIR+FILE_MAXFILE];
686         
687         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
688         
689         uel= curundo;
690         if(uel==NULL) {
691                 printf("No undo buffer to save recovery file\n");
692                 return;
693         }
694         
695         /* no undo state to save */
696         if(undobase.first==undobase.last) return;
697                 
698         BLI_make_file_string("/", str, btempdir, "quit.blend");
699
700         file = open(str,O_BINARY+O_WRONLY+O_CREAT+O_TRUNC, 0666);
701         if(file == -1) {
702                 //XXX error("Unable to save %s, check you have permissions", str);
703                 return;
704         }
705
706         chunk= uel->memfile.chunks.first;
707         while(chunk) {
708                 if( write(file, chunk->buf, chunk->size) != chunk->size) break;
709                 chunk= chunk->next;
710         }
711         
712         close(file);
713         
714         if(chunk) ; //XXX error("Unable to save %s, internal error", str);
715         else printf("Saved session recovery to %s\n", str);
716 }
717
718 /* sets curscene */
719 Main *BKE_undo_get_main(Scene **scene)
720 {
721         Main *mainp= NULL;
722         BlendFileData *bfd= BLO_read_from_memfile(G.main, G.main->name, &curundo->memfile, NULL);
723         
724         if(bfd) {
725                 mainp= bfd->main;
726                 if(scene)
727                         *scene= bfd->curscene;
728                 
729                 MEM_freeN(bfd);
730         }
731         
732         return mainp;
733 }
734