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