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