merge with 2.5 at r18679
[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_action.h"
69 #include "BKE_blender.h"
70 #include "BKE_context.h"
71 #include "BKE_curve.h"
72 #include "BKE_depsgraph.h"
73 #include "BKE_displist.h"
74 #include "BKE_font.h"
75 #include "BKE_global.h"
76 #include "BKE_library.h"
77 #include "BKE_ipo.h"
78 #include "BKE_main.h"
79 #include "BKE_node.h"
80 #include "BKE_object.h"
81 #include "BKE_report.h"
82 #include "BKE_scene.h"
83 #include "BKE_screen.h"
84 #include "BKE_sound.h"
85
86 #include "BLI_editVert.h"
87
88 #include "BLO_undofile.h"
89 #include "BLO_readfile.h" 
90 #include "BLO_writefile.h" 
91
92 #include "BKE_utildefines.h" // O_BINARY FALSE
93
94 Global G;
95 UserDef U;
96 ListBase WMlist= {NULL, NULL};
97 short ENDIAN_ORDER;
98
99 char versionstr[48]= "";
100
101 /* ************************************************ */
102 /* pushpop facility: to store data temporally, FIFO! */
103
104 ListBase ppmain={0, 0};
105
106 typedef struct PushPop {
107         struct PushPop *next, *prev;
108         void *data;
109         int len;
110 } PushPop;
111
112 void pushdata(void *data, int len)
113 {
114         PushPop *pp;
115         
116         pp= MEM_mallocN(sizeof(PushPop), "pushpop");
117         BLI_addtail(&ppmain, pp);
118         pp->data= MEM_mallocN(len, "pushpop");
119         pp->len= len;
120         memcpy(pp->data, data, len);
121 }
122
123 void popfirst(void *data)
124 {
125         PushPop *pp;
126         
127         pp= ppmain.first;
128         if(pp) {
129                 memcpy(data, pp->data, pp->len);
130                 BLI_remlink(&ppmain, pp);
131                 MEM_freeN(pp->data);
132                 MEM_freeN(pp);
133         }
134         else printf("error in popfirst\n");
135 }
136
137 void poplast(void *data)
138 {
139         PushPop *pp;
140         
141         pp= ppmain.last;
142         if(pp) {
143                 memcpy(data, pp->data, pp->len);
144                 BLI_remlink(&ppmain, pp);
145                 MEM_freeN(pp->data);
146                 MEM_freeN(pp);
147         }
148         else printf("error in poplast\n");
149 }
150
151 void free_pushpop()
152 {
153         PushPop *pp;
154
155         pp= ppmain.first;
156         while(pp) {
157                 BLI_remlink(&ppmain, pp);
158                 MEM_freeN(pp->data);
159                 MEM_freeN(pp);
160         }       
161 }
162
163 void pushpop_test()
164 {
165         if(ppmain.first) printf("pushpop not empty\n");
166         free_pushpop();
167 }
168
169
170
171 /* ********** free ********** */
172
173 /* only to be called on exit blender */
174 void free_blender(void)
175 {
176         /* samples are in a global list..., also sets G.main->sound->sample NULL */
177         sound_free_all_samples();
178         
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 // XXX  freeAllRad();
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_WEIGHTPAINT + G_VERTEXPAINT + G_FACESELECT + G_PARTICLEEDIT);
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= scene->ed;
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         if(mode!='u') G.save_over = 1;
320         
321         G.main= bfd->main;
322
323         CTX_data_main_set(C, G.main);
324         CTX_wm_screen_set(C, NULL);
325         CTX_wm_area_set(C, NULL);
326         CTX_wm_region_set(C, NULL);
327         CTX_wm_ui_block_set(C, NULL, NULL);
328         
329         if (bfd->user) {
330                 
331                 /* only here free userdef themes... */
332                 BLI_freelistN(&U.themes);
333
334                 U= *bfd->user;
335                 MEM_freeN(bfd->user);
336         }
337         
338         /* samples is a global list... */
339         sound_free_all_samples();
340         
341         /* case G_FILE_NO_UI or no screens in file */
342         if(mode) {
343                 CTX_wm_screen_set(C, curscreen);
344                 CTX_data_scene_set(C, curscene);
345         }
346         else {
347                 G.winpos= bfd->winpos;
348                 G.displaymode= bfd->displaymode;
349                 G.fileflags= bfd->fileflags;
350                 CTX_wm_screen_set(C, bfd->curscreen);
351                 CTX_data_scene_set(C, bfd->curscreen->scene);
352         }
353         
354         /* this can happen when active scene was lib-linked, and doesnt exist anymore */
355         if(CTX_data_scene(C)==NULL) {
356                 CTX_data_scene_set(C, bfd->main->scene.first);
357                 CTX_wm_screen(C)->scene= CTX_data_scene(C);
358                 curscene= CTX_data_scene(C);
359         }
360
361         /* special cases, override loaded flags: */
362         if (G.f & G_DEBUG) bfd->globalf |= G_DEBUG;
363         else bfd->globalf &= ~G_DEBUG;
364         if (G.f & G_SWAP_EXCHANGE) bfd->globalf |= G_SWAP_EXCHANGE;
365         else bfd->globalf &= ~G_SWAP_EXCHANGE;
366
367         if ((U.flag & USER_DONT_DOSCRIPTLINKS)) bfd->globalf &= ~G_DOSCRIPTLINKS;
368
369         G.f= bfd->globalf;
370
371         if (!G.background) {
372                 //setscreen(G.curscreen);
373         }
374         
375         // XXX is this in the right place?
376         do_versions_ipos_to_animato(G.main); // XXX fixme... complicated versionpatching
377         
378         /* baseflags, groups, make depsgraph, etc */
379         set_scene_bg(CTX_data_scene(C));
380
381         /* last stage of do_versions actually, that sets recalc flags for recalc poses */
382         for(ob= G.main->object.first; ob; ob= ob->id.next) {
383                 if(ob->type==OB_ARMATURE)
384                         if(ob->recalc) object_handle_update(CTX_data_scene(C), ob);
385         }
386         
387         /* now tag update flags, to ensure deformers get calculated on redraw */
388         DAG_scene_update_flags(CTX_data_scene(C), CTX_data_scene(C)->lay);
389         
390         if (G.f & G_DOSCRIPTLINKS) {
391                 /* there's an onload scriptlink to execute in screenmain */
392 // XXX          mainqenter(ONLOAD_SCRIPT, 1);
393         }
394         if (G.sce != filename) /* these are the same at times, should never copy to the same location */
395                 strcpy(G.sce, filename);
396         
397         BLI_strncpy(G.main->name, filename, FILE_MAX); /* is guaranteed current file */
398         
399         MEM_freeN(bfd);
400 }
401
402 static void handle_subversion_warning(Main *main)
403 {
404         if(main->minversionfile > BLENDER_VERSION ||
405            (main->minversionfile == BLENDER_VERSION && 
406                  main->minsubversionfile > BLENDER_SUBVERSION)) {
407                 
408                 char str[128];
409                 
410                 sprintf(str, "File written by newer Blender binary: %d.%d , expect loss of data!", main->minversionfile, main->minsubversionfile);
411 // XXX          error(str);
412         }
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                 setup_app_data(C, bfd, dir);
432                 
433                 handle_subversion_warning(G.main);
434         } 
435         else
436                 BKE_reports_prependf(reports, "Loading %s failed: ", dir);
437                 
438         return (bfd?retval:0);
439 }
440
441 int BKE_read_file_from_memory(bContext *C, char* filebuf, int filelength, void *unused, ReportList *reports)
442 {
443         BlendFileData *bfd;
444
445         bfd= BLO_read_from_memory(filebuf, filelength, reports);
446         if (bfd)
447                 setup_app_data(C, bfd, "<memory2>");
448         else
449                 BKE_reports_prepend(reports, "Loading failed: ");
450
451         return (bfd?1:0);
452 }
453
454 /* memfile is the undo buffer */
455 int BKE_read_file_from_memfile(bContext *C, MemFile *memfile, ReportList *reports)
456 {
457         BlendFileData *bfd;
458
459         bfd= BLO_read_from_memfile(CTX_data_main(C), G.sce, memfile, reports);
460         if (bfd)
461                 setup_app_data(C, bfd, "<memory1>");
462         else
463                 BKE_reports_prepend(reports, "Loading failed: ");
464
465         return (bfd?1:0);
466 }
467
468 /* *****************  testing for break ************* */
469
470 static void (*blender_test_break_cb)(void)= NULL;
471
472 void set_blender_test_break_cb(void (*func)(void) )
473 {
474         blender_test_break_cb= func;
475 }
476
477
478 int blender_test_break(void)
479 {
480         if (!G.background) {
481                 if (blender_test_break_cb)
482                         blender_test_break_cb();
483         }
484         
485         return (G.afbreek==1);
486 }
487
488
489 /* ***************** GLOBAL UNDO *************** */
490
491 #define UNDO_DISK       0
492
493 #define MAXUNDONAME     64
494 typedef struct UndoElem {
495         struct UndoElem *next, *prev;
496         char str[FILE_MAXDIR+FILE_MAXFILE];
497         char name[MAXUNDONAME];
498         MemFile memfile;
499         uintptr_t undosize;
500 } UndoElem;
501
502 static ListBase undobase={NULL, NULL};
503 static UndoElem *curundo= NULL;
504
505
506 static int read_undosave(bContext *C, UndoElem *uel)
507 {
508         char scestr[FILE_MAXDIR+FILE_MAXFILE];
509         int success=0, fileflags;
510         
511         strcpy(scestr, G.sce);  /* temporal store */
512         fileflags= G.fileflags;
513         G.fileflags |= G_FILE_NO_UI;
514
515         if(UNDO_DISK) 
516                 success= BKE_read_file(C, uel->str, NULL, NULL);
517         else
518                 success= BKE_read_file_from_memfile(C, &uel->memfile, NULL);
519
520         /* restore */
521         strcpy(G.sce, scestr);
522         G.fileflags= fileflags;
523
524         return success;
525 }
526
527 /* name can be a dynamic string */
528 void BKE_write_undo(bContext *C, char *name)
529 {
530         uintptr_t maxmem, totmem, memused;
531         int nr, success;
532         UndoElem *uel;
533         
534         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
535         if( U.undosteps==0) return;
536         
537         /* remove all undos after (also when curundo==NULL) */
538         while(undobase.last != curundo) {
539                 uel= undobase.last;
540                 BLI_remlink(&undobase, uel);
541                 BLO_free_memfile(&uel->memfile);
542                 MEM_freeN(uel);
543         }
544         
545         /* make new */
546         curundo= uel= MEM_callocN(sizeof(UndoElem), "undo file");
547         strncpy(uel->name, name, MAXUNDONAME-1);
548         BLI_addtail(&undobase, uel);
549         
550         /* and limit amount to the maximum */
551         nr= 0;
552         uel= undobase.last;
553         while(uel) {
554                 nr++;
555                 if(nr==U.undosteps) break;
556                 uel= uel->prev;
557         }
558         if(uel) {
559                 while(undobase.first!=uel) {
560                         UndoElem *first= undobase.first;
561                         BLI_remlink(&undobase, first);
562                         /* the merge is because of compression */
563                         BLO_merge_memfile(&first->memfile, &first->next->memfile);
564                         MEM_freeN(first);
565                 }
566         }
567
568
569         /* disk save version */
570         if(UNDO_DISK) {
571                 static int counter= 0;
572                 char tstr[FILE_MAXDIR+FILE_MAXFILE];
573                 char numstr[32];
574                 
575                 /* calculate current filename */
576                 counter++;
577                 counter= counter % U.undosteps; 
578         
579                 sprintf(numstr, "%d.blend", counter);
580                 BLI_make_file_string("/", tstr, btempdir, numstr);
581         
582                 success= BLO_write_file(CTX_data_main(C), tstr, G.fileflags, NULL);
583                 
584                 strcpy(curundo->str, tstr);
585         }
586         else {
587                 MemFile *prevfile=NULL;
588                 
589                 if(curundo->prev) prevfile= &(curundo->prev->memfile);
590                 
591                 memused= MEM_get_memory_in_use();
592                 success= BLO_write_file_mem(CTX_data_main(C), prevfile, &curundo->memfile, G.fileflags, NULL);
593                 curundo->undosize= MEM_get_memory_in_use() - memused;
594         }
595
596         if(U.undomemory != 0) {
597                 /* limit to maximum memory (afterwards, we can't know in advance) */
598                 totmem= 0;
599                 maxmem= ((uintptr_t)U.undomemory)*1024*1024;
600
601                 /* keep at least two (original + other) */
602                 uel= undobase.last;
603                 while(uel && uel->prev) {
604                         totmem+= uel->undosize;
605                         if(totmem>maxmem) break;
606                         uel= uel->prev;
607                 }
608
609                 if(uel) {
610                         if(uel->prev && uel->prev->prev)
611                                 uel= uel->prev;
612
613                         while(undobase.first!=uel) {
614                                 UndoElem *first= undobase.first;
615                                 BLI_remlink(&undobase, first);
616                                 /* the merge is because of compression */
617                                 BLO_merge_memfile(&first->memfile, &first->next->memfile);
618                                 MEM_freeN(first);
619                         }
620                 }
621         }
622 }
623
624 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation
625  * Note, ALWAYS call sound_initialize_sounds after BKE_undo_step() */
626 void BKE_undo_step(bContext *C, int step)
627 {
628         
629         if(step==0) {
630                 read_undosave(C, curundo);
631         }
632         else if(step==1) {
633                 /* curundo should never be NULL, after restart or load file it should call undo_save */
634                 if(curundo==NULL || curundo->prev==NULL) ; // XXX error("No undo available");
635                 else {
636                         if(G.f & G_DEBUG) printf("undo %s\n", curundo->name);
637                         curundo= curundo->prev;
638                         read_undosave(C, curundo);
639                 }
640         }
641         else {
642                 
643                 /* curundo has to remain current situation! */
644                 
645                 if(curundo==NULL || curundo->next==NULL) ; // XXX error("No redo available");
646                 else {
647                         read_undosave(C, curundo->next);
648                         curundo= curundo->next;
649                         if(G.f & G_DEBUG) printf("redo %s\n", curundo->name);
650                 }
651         }
652 }
653
654 void BKE_reset_undo(void)
655 {
656         UndoElem *uel;
657         
658         uel= undobase.first;
659         while(uel) {
660                 BLO_free_memfile(&uel->memfile);
661                 uel= uel->next;
662         }
663         
664         BLI_freelistN(&undobase);
665         curundo= NULL;
666 }
667
668 /* based on index nr it does a restore */
669 void BKE_undo_number(bContext *C, int nr)
670 {
671         UndoElem *uel;
672         int a=1;
673         
674         for(uel= undobase.first; uel; uel= uel->next, a++) {
675                 if(a==nr) break;
676         }
677         curundo= uel;
678         BKE_undo_step(C, 0);
679 }
680
681 char *BKE_undo_menu_string(void)
682 {
683         UndoElem *uel;
684         DynStr *ds= BLI_dynstr_new();
685         char *menu;
686
687         BLI_dynstr_append(ds, "Global Undo History %t");
688         
689         for(uel= undobase.first; uel; uel= uel->next) {
690                 BLI_dynstr_append(ds, "|");
691                 BLI_dynstr_append(ds, uel->name);
692         }
693
694         menu= BLI_dynstr_get_cstring(ds);
695         BLI_dynstr_free(ds);
696
697         return menu;
698 }
699
700         /* saves quit.blend */
701 void BKE_undo_save_quit(void)
702 {
703         UndoElem *uel;
704         MemFileChunk *chunk;
705         int file;
706         char str[FILE_MAXDIR+FILE_MAXFILE];
707         
708         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
709         
710         uel= curundo;
711         if(uel==NULL) {
712                 printf("No undo buffer to save recovery file\n");
713                 return;
714         }
715         
716         /* no undo state to save */
717         if(undobase.first==undobase.last) return;
718                 
719         BLI_make_file_string("/", str, btempdir, "quit.blend");
720
721         file = open(str,O_BINARY+O_WRONLY+O_CREAT+O_TRUNC, 0666);
722         if(file == -1) {
723                 //XXX error("Unable to save %s, check you have permissions", str);
724                 return;
725         }
726
727         chunk= uel->memfile.chunks.first;
728         while(chunk) {
729                 if( write(file, chunk->buf, chunk->size) != chunk->size) break;
730                 chunk= chunk->next;
731         }
732         
733         close(file);
734         
735         if(chunk) ; //XXX error("Unable to save %s, internal error", str);
736         else printf("Saved session recovery to %s\n", str);
737 }
738