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