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