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