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