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