f09c1103922dc3052c5b90253b408f7c4eaa8ca1
[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/BL DUAL 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. The Blender
13  * Foundation also sells licenses for use in proprietary software under
14  * the Blender License.  See http://www.blender.org/BL/ for information
15  * about this.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25  *
26  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
27  * All rights reserved.
28  *
29  * The Original Code is: all of this file.
30  *
31  * Contributor(s): none yet.
32  *
33  * ***** END GPL/BL DUAL LICENSE BLOCK *****
34  */
35
36 #ifndef WIN32 
37     #include <unistd.h> // for read close
38     #include <sys/param.h> // for MAXPATHLEN
39 #else
40     #include <io.h> // for open close read
41 #endif
42
43 #include <stdlib.h>
44 #include <stdio.h>
45 #include <string.h>
46 #include <fcntl.h> // for open
47
48 #include "MEM_guardedalloc.h"
49
50 #include "DNA_curve_types.h"
51 #include "DNA_listBase.h"
52 #include "DNA_sdna_types.h"
53 #include "DNA_userdef_types.h"
54 #include "DNA_object_types.h"
55 #include "DNA_mesh_types.h"
56 #include "DNA_scene_types.h"
57 #include "DNA_screen_types.h"
58 #include "DNA_sound_types.h"
59 #include "DNA_sequence_types.h"
60
61 #include "BLI_blenlib.h"
62 #include "BLI_dynstr.h"
63
64 #include "IMB_imbuf_types.h"
65 #include "IMB_imbuf.h"
66
67 #include "BKE_blender.h"
68 #include "BKE_curve.h"
69 #include "BKE_depsgraph.h"
70 #include "BKE_displist.h"
71 #include "BKE_font.h"
72 #include "BKE_global.h"
73 #include "BKE_library.h"
74 #include "BKE_main.h"
75 #include "BKE_node.h"
76 #include "BKE_object.h"
77 #include "BKE_scene.h"
78 #include "BKE_sound.h"
79
80 #include "BLI_editVert.h"
81
82 #include "BLO_undofile.h"
83 #include "BLO_readfile.h" 
84 #include "BLO_writefile.h" 
85
86 #include "BKE_bad_level_calls.h" // for freeAllRad editNurb free_editMesh free_editText free_editArmature
87 #include "BKE_utildefines.h" // O_BINARY FALSE
88 #include "BIF_mainqueue.h" // mainqenter for onload script
89 #include "mydevice.h"
90 #include "nla.h"
91 #include "blendef.h"
92
93
94 Global G;
95 UserDef U;
96 ListBase WMlist= {NULL, NULL};
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 void free_blender(void)
173 {
174         /* samples are in a global list..., also sets G.main->sound->sample NULL */
175         sound_free_all_samples();
176         
177         free_main(G.main);
178         G.main= NULL;
179
180         IMB_freeImBufdata();            /* imbuf lib */
181         
182         free_nodesystem();      
183 }
184
185 void duplicatelist(ListBase *list1, ListBase *list2)  /* copy from 2 to 1 */
186 {
187         struct Link *link1, *link2;
188         
189         list1->first= list1->last= 0;
190         
191         link2= list2->first;
192         while(link2) {
193
194                 link1= MEM_dupallocN(link2);
195                 BLI_addtail(list1, link1);
196                 
197                 link2= link2->next;
198         }       
199 }
200
201 static EditMesh theEditMesh;
202
203 void initglobals(void)
204 {
205         memset(&G, 0, sizeof(Global));
206         
207         memset(&theEditMesh, 0, sizeof(theEditMesh));
208         G.editMesh = &theEditMesh;
209
210         U.savetime= 1;
211
212         G.main= MEM_callocN(sizeof(Main), "initglobals");
213
214         strcpy(G.ima, "//");
215
216         G.version= BLENDER_VERSION;
217
218         G.order= 1;
219         G.order= (((char*)&G.order)[0])?L_ENDIAN:B_ENDIAN;
220
221         if(BLENDER_SUBVERSION)
222                 sprintf(versionstr, "www.blender.org %d.%d", G.version, BLENDER_SUBVERSION);
223         else
224                 sprintf(versionstr, "www.blender.org %d", G.version);
225
226 #ifdef _WIN32   // FULLSCREEN
227         G.windowstate = G_WINDOWSTATE_USERDEF;
228 #endif
229
230         clear_workob(); /* object.c */
231
232         G.charstart = 0x0000;
233         G.charmin = 0x0000;
234         G.charmax = 0xffff;
235 }
236
237 /***/
238
239 static void clear_global(void) 
240 {
241         extern short winqueue_break;    /* screen.c */
242
243         freeAllRad();
244         fastshade_free_render();        /* lamps hang otherwise */
245         free_main(G.main);                      /* free all lib data */
246
247         /* force all queues to be left */
248         winqueue_break= 1;
249         
250         if (G.obedit) {
251                 freeNurblist(&editNurb);
252                 free_editMesh(G.editMesh);
253                 free_editText();
254                 free_editArmature();
255         }
256
257         G.curscreen= NULL;
258         G.scene= NULL;
259         G.main= NULL;
260         
261         G.obedit= NULL;
262         G.saction= NULL;
263         G.buts= NULL;
264         G.v2d= NULL;
265         G.vd= NULL;
266         G.soops= NULL;
267         G.sima= NULL;
268         G.sipo= NULL;
269         
270         free_vertexpaint();
271         
272         G.f &= ~(G_WEIGHTPAINT + G_VERTEXPAINT + G_FACESELECT + G_PARTICLEEDIT);
273 }
274
275 /* make sure path names are correct for OS */
276 static void clean_paths(Main *main)
277 {
278         Image *image= main->image.first;
279         bSound *sound= main->sound.first;
280         Scene *scene= main->scene.first;
281         Editing *ed;
282         Sequence *seq;
283         Strip *strip;
284         
285         while(image) {
286                 BLI_clean(image->name);
287                 image= image->id.next;
288         }
289         
290         while(sound) {
291                 BLI_clean(sound->name);
292                 sound= sound->id.next;
293         }
294         
295         while(scene) {
296                 ed= scene->ed;
297                 if(ed) {
298                         seq= ed->seqbasep->first;
299                         while(seq) {
300                                 if(seq->plugin) {
301                                         BLI_clean(seq->plugin->name);
302                                 }
303                                 strip= seq->strip;
304                                 while(strip) {
305                                         BLI_clean(strip->dir);
306                                         strip= strip->next;
307                                 }
308                                 seq= seq->next;
309                         }
310                 }
311                 BLI_clean(scene->r.backbuf);
312                 BLI_clean(scene->r.pic);
313                 BLI_clean(scene->r.ftype);
314                 
315                 scene= scene->id.next;
316         }
317 }
318
319 /* context matching */
320 /* handle no-ui case */
321
322 static void setup_app_data(bContext *C, BlendFileData *bfd, char *filename) 
323 {
324         Object *ob;
325         bScreen *curscreen= NULL;
326         Scene *curscene= NULL;
327         char mode;
328         
329         /* 'u' = undo save, 'n' = no UI load */
330         if(bfd->main->screen.first==NULL) mode= 'u';
331         else if(G.fileflags & G_FILE_NO_UI) mode= 'n';
332         else mode= 0;
333         
334         clean_paths(bfd->main);
335         
336         /* XXX here the complex windowmanager matching */
337         
338         /* no load screens? */
339         if(mode) {
340                 /* comes from readfile.c */
341                 extern void lib_link_screen_restore(Main *, Scene *);
342                 
343                 SWAP(ListBase, G.main->screen, bfd->main->screen);
344                 
345                 /* we re-use current screen */
346                 curscreen= C->screen;
347                 /* but use new Scene pointer */
348                 curscene= bfd->curscene;
349                 if(curscene==NULL) curscene= bfd->main->scene.first;
350                 /* and we enforce curscene to be in current screen */
351                 curscreen->scene= curscene;
352
353                 /* clear_global will free G.main, here we can still restore pointers */
354                 lib_link_screen_restore(bfd->main, curscene);
355         }
356         
357         /* free G.main Main database */
358         clear_global(); 
359         
360         if(mode!='u') G.save_over = 1;
361         
362         G.main= bfd->main;
363         
364         if (bfd->user) {
365                 
366                 /* only here free userdef themes... */
367                 BLI_freelistN(&U.themes);
368
369                 U= *bfd->user;
370                 MEM_freeN(bfd->user);
371         }
372         
373         /* samples is a global list... */
374         sound_free_all_samples();
375         
376         /* case G_FILE_NO_UI or no screens in file */
377         if(mode) {
378                 C->screen= curscreen;
379                 C->scene= curscene;
380         }
381         else {
382                 G.winpos= bfd->winpos;
383                 G.displaymode= bfd->displaymode;
384                 G.fileflags= bfd->fileflags;
385                 C->screen= bfd->curscreen;
386                 C->scene= C->screen->scene;
387         }
388         /* this can happen when active scene was lib-linked, and doesnt exist anymore */
389         if(C->scene==NULL) {
390                 C->scene= G.main->scene.first;
391                 C->screen->scene= C->scene;
392         }
393
394         /* special cases, override loaded flags: */
395         if (G.f & G_DEBUG) bfd->globalf |= G_DEBUG;
396         else bfd->globalf &= ~G_DEBUG;
397         if (!(G.f & G_DOSCRIPTLINKS)) bfd->globalf &= ~G_DOSCRIPTLINKS;
398
399         G.f= bfd->globalf;
400
401         if (!G.background) {
402                 //setscreen(G.curscreen);
403         }
404         
405         /* baseflags, groups, make depsgraph, etc */
406         set_scene_bg(C->scene);
407
408         /* last stage of do_versions actually, that sets recalc flags for recalc poses */
409         for(ob= G.main->object.first; ob; ob= ob->id.next) {
410                 if(ob->type==OB_ARMATURE)
411                         if(ob->recalc) object_handle_update(ob);
412         }
413         
414         /* now tag update flags, to ensure deformers get calculated on redraw */
415         DAG_scene_update_flags(C->scene, C->scene->lay);
416         
417         if (G.f & G_DOSCRIPTLINKS) {
418                 /* there's an onload scriptlink to execute in screenmain */
419                 mainqenter(ONLOAD_SCRIPT, 1);
420         }
421         if (G.sce != filename) /* these are the same at times, should never copy to the same location */
422                 strcpy(G.sce, filename);
423         
424         strcpy(G.main->name, filename); /* is guaranteed current file */
425         
426         MEM_freeN(bfd);
427 }
428
429 static void handle_subversion_warning(Main *main)
430 {
431         if(main->minversionfile > BLENDER_VERSION ||
432            (main->minversionfile == BLENDER_VERSION && 
433                  main->minsubversionfile > BLENDER_SUBVERSION)) {
434                 
435                 char str[128];
436                 
437                 sprintf(str, "File written by newer Blender binary: %d.%d , expect loss of data!", main->minversionfile, main->minsubversionfile);
438                 error(str);
439         }
440                 
441 }
442
443 /* returns:
444    0: no load file
445    1: OK
446    2: OK, and with new user settings
447 */
448
449 int BKE_read_file(bContext *C, char *dir, void *unused) 
450 {
451         BlendReadError bre;
452         BlendFileData *bfd;
453         int retval= 1;
454         
455         if (!G.background)
456                 waitcursor(1);
457                 
458         bfd= BLO_read_from_file(dir, &bre);
459         if (bfd) {
460                 if(bfd->user) retval= 2;
461                 
462                 setup_app_data(C, bfd, dir);
463                 
464                 handle_subversion_warning(G.main);
465         } 
466         else {
467                 error("Loading %s failed: %s", dir, BLO_bre_as_string(bre));
468         }
469         
470         if (!G.background)
471                 waitcursor(0);
472         
473         return (bfd?retval:0);
474 }
475
476 int BKE_read_file_from_memory(bContext *C, char* filebuf, int filelength, void *unused)
477 {
478         BlendReadError bre;
479         BlendFileData *bfd;
480         
481         if (!G.background)
482                 waitcursor(1);
483                 
484         bfd= BLO_read_from_memory(filebuf, filelength, &bre);
485         if (bfd) {              
486                 setup_app_data(C, bfd, "<memory>");
487         } else {
488                 error("Loading failed: %s", BLO_bre_as_string(bre));
489         }
490         
491         if (!G.background)
492                 waitcursor(0);
493         
494         return (bfd?1:0);
495 }
496
497 /* memfile is the undo buffer */
498 int BKE_read_file_from_memfile(bContext *C, MemFile *memfile)
499 {
500         BlendReadError bre;
501         BlendFileData *bfd;
502         
503         if (!G.background)
504                 waitcursor(1);
505                 
506         bfd= BLO_read_from_memfile(G.sce, memfile, &bre);
507         if (bfd) {
508                 setup_app_data(C, bfd, "<memory>");
509         } else {
510                 error("Loading failed: %s", BLO_bre_as_string(bre));
511         }
512         
513         if (!G.background)
514                 waitcursor(0);
515         
516         return (bfd?1:0);
517 }
518
519
520 /* ***************** GLOBAL UNDO *************** */
521
522 #define UNDO_DISK       0
523
524 #define MAXUNDONAME     64
525 typedef struct UndoElem {
526         struct UndoElem *next, *prev;
527         char str[FILE_MAXDIR+FILE_MAXFILE];
528         char name[MAXUNDONAME];
529         MemFile memfile;
530 } UndoElem;
531
532 static ListBase undobase={NULL, NULL};
533 static UndoElem *curundo= NULL;
534
535
536 static int read_undosave(bContext *C, UndoElem *uel)
537 {
538         char scestr[FILE_MAXDIR+FILE_MAXFILE];
539         int success=0, fileflags;
540         
541         strcpy(scestr, G.sce);  /* temporal store */
542         fileflags= G.fileflags;
543         G.fileflags |= G_FILE_NO_UI;
544
545         if(UNDO_DISK) 
546                 success= BKE_read_file(C, uel->str, NULL);
547         else
548                 success= BKE_read_file_from_memfile(C, &uel->memfile);
549         
550         /* restore */
551         strcpy(G.sce, scestr);
552         G.fileflags= fileflags;
553
554         return success;
555 }
556
557 /* name can be a dynamic string */
558 void BKE_write_undo(bContext *C, char *name)
559 {
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, U.tempdir, numstr);
610         
611                 success= BLO_write_file(C, 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                 success= BLO_write_file_mem(C, prevfile, &curundo->memfile, G.fileflags, &err);
622                 
623         }
624 }
625
626 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
627 void BKE_undo_step(bContext *C, int step)
628 {
629         
630         if(step==0) {
631                 read_undosave(C, curundo);
632         }
633         else if(step==1) {
634                 /* curundo should never be NULL, after restart or load file it should call undo_save */
635                 if(curundo==NULL || curundo->prev==NULL) error("No undo available");
636                 else {
637                         if(G.f & G_DEBUG) printf("undo %s\n", curundo->name);
638                         curundo= curundo->prev;
639                         read_undosave(C, curundo);
640                 }
641         }
642         else {
643                 
644                 /* curundo has to remain current situation! */
645                 
646                 if(curundo==NULL || curundo->next==NULL) error("No redo available");
647                 else {
648                         read_undosave(C, curundo->next);
649                         curundo= curundo->next;
650                         if(G.f & G_DEBUG) printf("redo %s\n", curundo->name);
651                 }
652         }
653 }
654
655 void BKE_reset_undo(void)
656 {
657         UndoElem *uel;
658         
659         uel= undobase.first;
660         while(uel) {
661                 BLO_free_memfile(&uel->memfile);
662                 uel= uel->next;
663         }
664         
665         BLI_freelistN(&undobase);
666         curundo= NULL;
667 }
668
669 /* based on index nr it does a restore */
670 void BKE_undo_number(bContext *C, int nr)
671 {
672         UndoElem *uel;
673         int a=1;
674         
675         for(uel= undobase.first; uel; uel= uel->next, a++) {
676                 if(a==nr) break;
677         }
678         curundo= uel;
679         BKE_undo_step(C, 0);
680 }
681
682 char *BKE_undo_menu_string(void)
683 {
684         UndoElem *uel;
685         DynStr *ds= BLI_dynstr_new();
686         char *menu;
687         
688         BLI_dynstr_append(ds, "Global Undo History %t");
689         
690         for(uel= undobase.first; uel; uel= uel->next) {
691                 BLI_dynstr_append(ds, "|");
692                 BLI_dynstr_append(ds, uel->name);
693         }
694         
695         menu= BLI_dynstr_get_cstring(ds);
696         BLI_dynstr_free(ds);
697
698         return menu;
699 }
700
701         /* saves quit.blend */
702 void BKE_undo_save_quit(void)
703 {
704         UndoElem *uel;
705         MemFileChunk *chunk;
706         int file;
707         char str[FILE_MAXDIR+FILE_MAXFILE];
708         
709         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
710         
711         uel= curundo;
712         if(uel==NULL) {
713                 printf("No undo buffer to save recovery file\n");
714                 return;
715         }
716         
717         /* no undo state to save */
718         if(undobase.first==undobase.last) return;
719                 
720         BLI_make_file_string("/", str, U.tempdir, "quit.blend");
721
722         file = open(str,O_BINARY+O_WRONLY+O_CREAT+O_TRUNC, 0666);
723         if(file == -1) {
724                 printf("Unable to save %s\n", str);
725                 return;
726         }
727
728         chunk= uel->memfile.chunks.first;
729         while(chunk) {
730                 if( write(file, chunk->buf, chunk->size) != chunk->size) break;
731                 chunk= chunk->next;
732         }
733         
734         close(file);
735         
736         if(chunk) printf("Unable to save %s\n", str);
737         else printf("Saved session recovery to %s\n", str);
738 }
739