doxygen: blender/blenkernel tagged.
[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         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 & G_DEBUG) bfd->globalf |= G_DEBUG;
275         else bfd->globalf &= ~G_DEBUG;
276         if (G.f & G_SWAP_EXCHANGE) bfd->globalf |= G_SWAP_EXCHANGE;
277         else bfd->globalf &= ~G_SWAP_EXCHANGE;
278         if (G.f & G_SCRIPT_AUTOEXEC) bfd->globalf |= G_SCRIPT_AUTOEXEC;
279         else bfd->globalf &= ~G_SCRIPT_AUTOEXEC;
280
281         G.f= bfd->globalf;
282
283         if (!G.background) {
284                 //setscreen(G.curscreen);
285         }
286         
287         // FIXME: this version patching should really be part of the file-reading code, 
288         // but we still get too many unrelated data-corruption crashes otherwise...
289         if (G.main->versionfile < 250)
290                 do_versions_ipos_to_animato(G.main);
291         
292         if(recover && bfd->filename[0] && G.relbase_valid) {
293                 /* in case of autosave or quit.blend, use original filename instead
294                  * use relbase_valid to make sure the file is saved, else we get <memory2> in the filename */
295                 filename= bfd->filename;
296         }
297 #if 0
298         else if (!G.relbase_valid) {
299                 /* otherwise, use an empty string as filename, rather than <memory2> */
300                 filename="";
301         }
302 #endif
303         
304         /* these are the same at times, should never copy to the same location */
305         if(G.main->name != filename)
306                 BLI_strncpy(G.main->name, filename, FILE_MAX);
307
308         /* baseflags, groups, make depsgraph, etc */
309         set_scene_bg(G.main, CTX_data_scene(C));
310         
311         MEM_freeN(bfd);
312 }
313
314 static int handle_subversion_warning(Main *main)
315 {
316         if(main->minversionfile > BLENDER_VERSION ||
317            (main->minversionfile == BLENDER_VERSION && 
318                  main->minsubversionfile > BLENDER_SUBVERSION)) {
319                 
320                 char str[128];
321                 
322                 BLI_snprintf(str, sizeof(str), "File written by newer Blender binary: %d.%d , expect loss of data!", main->minversionfile, main->minsubversionfile);
323 // XXX          error(str);
324         }
325         return 1;
326 }
327
328 void BKE_userdef_free(void)
329 {
330         wmKeyMap *km;
331         wmKeyMapItem *kmi;
332
333         for(km=U.keymaps.first; km; km=km->next) {
334                 for(kmi=km->items.first; kmi; kmi=kmi->next) {
335                         if(kmi->properties) {
336                                 IDP_FreeProperty(kmi->properties);
337                                 MEM_freeN(kmi->properties);
338                         }
339                         if(kmi->ptr)
340                                 MEM_freeN(kmi->ptr);
341                 }
342
343                 BLI_freelistN(&km->items);
344         }
345         
346         BLI_freelistN(&U.uistyles);
347         BLI_freelistN(&U.uifonts);
348         BLI_freelistN(&U.themes);
349         BLI_freelistN(&U.keymaps);
350         BLI_freelistN(&U.addons);
351 }
352
353 int BKE_read_file(bContext *C, const char *dir, ReportList *reports) 
354 {
355         BlendFileData *bfd;
356         int retval= 1;
357
358         if(strstr(dir, BLENDER_STARTUP_FILE)==NULL) /* dont print user-pref loading */
359                 printf("read blend: %s\n", dir);
360
361         bfd= BLO_read_from_file(dir, reports);
362         if (bfd) {
363                 if(bfd->user) retval= 2;
364                 
365                 if(0==handle_subversion_warning(bfd->main)) {
366                         free_main(bfd->main);
367                         MEM_freeN(bfd);
368                         bfd= NULL;
369                         retval= 0;
370                 }
371                 else
372                         setup_app_data(C, bfd, dir); // frees BFD
373         } 
374         else
375                 BKE_reports_prependf(reports, "Loading %s failed: ", dir);
376                 
377         return (bfd?retval:0);
378 }
379
380 int BKE_read_file_from_memory(bContext *C, char* filebuf, int filelength, ReportList *reports)
381 {
382         BlendFileData *bfd;
383
384         bfd= BLO_read_from_memory(filebuf, filelength, reports);
385         if (bfd)
386                 setup_app_data(C, bfd, "<memory2>");
387         else
388                 BKE_reports_prepend(reports, "Loading failed: ");
389
390         return (bfd?1:0);
391 }
392
393 /* memfile is the undo buffer */
394 int BKE_read_file_from_memfile(bContext *C, MemFile *memfile, ReportList *reports)
395 {
396         BlendFileData *bfd;
397
398         bfd= BLO_read_from_memfile(CTX_data_main(C), G.main->name, memfile, reports);
399         if (bfd)
400                 setup_app_data(C, bfd, "<memory1>");
401         else
402                 BKE_reports_prepend(reports, "Loading failed: ");
403
404         return (bfd?1:0);
405 }
406
407
408 /* *****************  testing for break ************* */
409
410 static void (*blender_test_break_cb)(void)= NULL;
411
412 void set_blender_test_break_cb(void (*func)(void) )
413 {
414         blender_test_break_cb= func;
415 }
416
417
418 int blender_test_break(void)
419 {
420         if (!G.background) {
421                 if (blender_test_break_cb)
422                         blender_test_break_cb();
423         }
424         
425         return (G.afbreek==1);
426 }
427
428
429 /* ***************** GLOBAL UNDO *************** */
430
431 #define UNDO_DISK       0
432
433 #define MAXUNDONAME     64
434 typedef struct UndoElem {
435         struct UndoElem *next, *prev;
436         char str[FILE_MAXDIR+FILE_MAXFILE];
437         char name[MAXUNDONAME];
438         MemFile memfile;
439         uintptr_t undosize;
440 } UndoElem;
441
442 static ListBase undobase={NULL, NULL};
443 static UndoElem *curundo= NULL;
444
445
446 static int read_undosave(bContext *C, UndoElem *uel)
447 {
448         char mainstr[sizeof(G.main->name)];
449         int success=0, fileflags;
450         
451         /* This is needed so undoing/redoing doesnt crash with threaded previews going */
452         WM_jobs_stop_all(CTX_wm_manager(C));
453
454         BLI_strncpy(mainstr, G.main->name, sizeof(mainstr));    /* temporal store */
455
456         fileflags= G.fileflags;
457         G.fileflags |= G_FILE_NO_UI;
458
459         if(UNDO_DISK) 
460                 success= (BKE_read_file(C, uel->str, NULL) != BKE_READ_FILE_FAIL);
461         else
462                 success= BKE_read_file_from_memfile(C, &uel->memfile, NULL);
463
464         /* restore */
465         BLI_strncpy(G.main->name, mainstr, sizeof(G.main->name)); /* restore */
466         G.fileflags= fileflags;
467
468         if(success) {
469                 /* important not to update time here, else non keyed tranforms are lost */
470                 DAG_on_load_update(G.main, FALSE);
471         }
472
473         return success;
474 }
475
476 /* name can be a dynamic string */
477 void BKE_write_undo(bContext *C, const char *name)
478 {
479         uintptr_t maxmem, totmem, memused;
480         int nr, success;
481         UndoElem *uel;
482         
483         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
484         if( U.undosteps==0) return;
485         
486         /* remove all undos after (also when curundo==NULL) */
487         while(undobase.last != curundo) {
488                 uel= undobase.last;
489                 BLI_remlink(&undobase, uel);
490                 BLO_free_memfile(&uel->memfile);
491                 MEM_freeN(uel);
492         }
493         
494         /* make new */
495         curundo= uel= MEM_callocN(sizeof(UndoElem), "undo file");
496         strncpy(uel->name, name, MAXUNDONAME-1);
497         BLI_addtail(&undobase, uel);
498         
499         /* and limit amount to the maximum */
500         nr= 0;
501         uel= undobase.last;
502         while(uel) {
503                 nr++;
504                 if(nr==U.undosteps) break;
505                 uel= uel->prev;
506         }
507         if(uel) {
508                 while(undobase.first!=uel) {
509                         UndoElem *first= undobase.first;
510                         BLI_remlink(&undobase, first);
511                         /* the merge is because of compression */
512                         BLO_merge_memfile(&first->memfile, &first->next->memfile);
513                         MEM_freeN(first);
514                 }
515         }
516
517
518         /* disk save version */
519         if(UNDO_DISK) {
520                 static int counter= 0;
521                 char tstr[FILE_MAXDIR+FILE_MAXFILE];
522                 char numstr[32];
523                 
524                 /* calculate current filename */
525                 counter++;
526                 counter= counter % U.undosteps; 
527         
528                 BLI_snprintf(numstr, sizeof(numstr), "%d.blend", counter);
529                 BLI_make_file_string("/", tstr, btempdir, numstr);
530         
531                 success= BLO_write_file(CTX_data_main(C), tstr, G.fileflags, NULL, NULL);
532                 
533                 BLI_strncpy(curundo->str, tstr, sizeof(curundo->str));
534         }
535         else {
536                 MemFile *prevfile=NULL;
537                 
538                 if(curundo->prev) prevfile= &(curundo->prev->memfile);
539                 
540                 memused= MEM_get_memory_in_use();
541                 success= BLO_write_file_mem(CTX_data_main(C), prevfile, &curundo->memfile, G.fileflags);
542                 curundo->undosize= MEM_get_memory_in_use() - memused;
543         }
544
545         if(U.undomemory != 0) {
546                 /* limit to maximum memory (afterwards, we can't know in advance) */
547                 totmem= 0;
548                 maxmem= ((uintptr_t)U.undomemory)*1024*1024;
549
550                 /* keep at least two (original + other) */
551                 uel= undobase.last;
552                 while(uel && uel->prev) {
553                         totmem+= uel->undosize;
554                         if(totmem>maxmem) break;
555                         uel= uel->prev;
556                 }
557
558                 if(uel) {
559                         if(uel->prev && uel->prev->prev)
560                                 uel= uel->prev;
561
562                         while(undobase.first!=uel) {
563                                 UndoElem *first= undobase.first;
564                                 BLI_remlink(&undobase, first);
565                                 /* the merge is because of compression */
566                                 BLO_merge_memfile(&first->memfile, &first->next->memfile);
567                                 MEM_freeN(first);
568                         }
569                 }
570         }
571 }
572
573 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
574 void BKE_undo_step(bContext *C, int step)
575 {
576         
577         if(step==0) {
578                 read_undosave(C, curundo);
579         }
580         else if(step==1) {
581                 /* curundo should never be NULL, after restart or load file it should call undo_save */
582                 if(curundo==NULL || curundo->prev==NULL) ; // XXX error("No undo available");
583                 else {
584                         if(G.f & G_DEBUG) printf("undo %s\n", curundo->name);
585                         curundo= curundo->prev;
586                         read_undosave(C, curundo);
587                 }
588         }
589         else {
590                 
591                 /* curundo has to remain current situation! */
592                 
593                 if(curundo==NULL || curundo->next==NULL) ; // XXX error("No redo available");
594                 else {
595                         read_undosave(C, curundo->next);
596                         curundo= curundo->next;
597                         if(G.f & G_DEBUG) printf("redo %s\n", curundo->name);
598                 }
599         }
600 }
601
602 void BKE_reset_undo(void)
603 {
604         UndoElem *uel;
605         
606         uel= undobase.first;
607         while(uel) {
608                 BLO_free_memfile(&uel->memfile);
609                 uel= uel->next;
610         }
611         
612         BLI_freelistN(&undobase);
613         curundo= NULL;
614 }
615
616 /* based on index nr it does a restore */
617 void BKE_undo_number(bContext *C, int nr)
618 {
619         UndoElem *uel;
620         int a=1;
621         
622         for(uel= undobase.first; uel; uel= uel->next, a++) {
623                 if(a==nr) break;
624         }
625         curundo= uel;
626         BKE_undo_step(C, 0);
627 }
628
629 /* go back to the last occurance of name in stack */
630 void BKE_undo_name(bContext *C, const char *name)
631 {
632         UndoElem *uel;
633
634         for(uel= undobase.last; uel; uel= uel->prev)
635                 if(strcmp(name, uel->name)==0)
636                         break;
637
638         if(uel && uel->prev) {
639                 curundo= uel->prev;
640                 BKE_undo_step(C, 0);
641         }
642 }
643
644 /* name optional */
645 int BKE_undo_valid(const char *name)
646 {
647         if(name) {
648                 UndoElem *uel;
649                 
650                 for(uel= undobase.last; uel; uel= uel->prev)
651                         if(strcmp(name, uel->name)==0)
652                                 break;
653                 
654                 return uel && uel->prev;
655         }
656         
657         return undobase.last != undobase.first;
658 }
659
660
661 char *BKE_undo_menu_string(void)
662 {
663         UndoElem *uel;
664         DynStr *ds= BLI_dynstr_new();
665         char *menu;
666
667         BLI_dynstr_append(ds, "Global Undo History %t");
668         
669         for(uel= undobase.first; uel; uel= uel->next) {
670                 BLI_dynstr_append(ds, "|");
671                 BLI_dynstr_append(ds, uel->name);
672         }
673
674         menu= BLI_dynstr_get_cstring(ds);
675         BLI_dynstr_free(ds);
676
677         return menu;
678 }
679
680         /* saves quit.blend */
681 void BKE_undo_save_quit(void)
682 {
683         UndoElem *uel;
684         MemFileChunk *chunk;
685         int file;
686         char str[FILE_MAXDIR+FILE_MAXFILE];
687         
688         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
689         
690         uel= curundo;
691         if(uel==NULL) {
692                 printf("No undo buffer to save recovery file\n");
693                 return;
694         }
695         
696         /* no undo state to save */
697         if(undobase.first==undobase.last) return;
698                 
699         BLI_make_file_string("/", str, btempdir, "quit.blend");
700
701         file = open(str,O_BINARY+O_WRONLY+O_CREAT+O_TRUNC, 0666);
702         if(file == -1) {
703                 //XXX error("Unable to save %s, check you have permissions", str);
704                 return;
705         }
706
707         chunk= uel->memfile.chunks.first;
708         while(chunk) {
709                 if( write(file, chunk->buf, chunk->size) != chunk->size) break;
710                 chunk= chunk->next;
711         }
712         
713         close(file);
714         
715         if(chunk) ; //XXX error("Unable to save %s, internal error", str);
716         else printf("Saved session recovery to %s\n", str);
717 }
718
719 /* sets curscene */
720 Main *BKE_undo_get_main(Scene **scene)
721 {
722         Main *mainp= NULL;
723         BlendFileData *bfd= BLO_read_from_memfile(G.main, G.main->name, &curundo->memfile, NULL);
724         
725         if(bfd) {
726                 mainp= bfd->main;
727                 if(scene)
728                         *scene= bfd->curscene;
729                 
730                 MEM_freeN(bfd);
731         }
732         
733         return mainp;
734 }
735