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