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