Cleanup work for 2.5 branch. Target is to get it compile and link
[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_utildefines.h" // O_BINARY FALSE
87 #include "BIF_mainqueue.h" // mainqenter for onload script
88 #include "mydevice.h"
89 #include "nla.h"
90 #include "blendef.h"
91
92
93 Global G;
94 UserDef U;
95 ListBase WMlist= {NULL, NULL};
96
97 char versionstr[48]= "";
98
99 /* ************************************************ */
100 /* pushpop facility: to store data temporally, FIFO! */
101
102 ListBase ppmain={0, 0};
103
104 typedef struct PushPop {
105         struct PushPop *next, *prev;
106         void *data;
107         int len;
108 } PushPop;
109
110 void pushdata(void *data, int len)
111 {
112         PushPop *pp;
113         
114         pp= MEM_mallocN(sizeof(PushPop), "pushpop");
115         BLI_addtail(&ppmain, pp);
116         pp->data= MEM_mallocN(len, "pushpop");
117         pp->len= len;
118         memcpy(pp->data, data, len);
119 }
120
121 void popfirst(void *data)
122 {
123         PushPop *pp;
124         
125         pp= ppmain.first;
126         if(pp) {
127                 memcpy(data, pp->data, pp->len);
128                 BLI_remlink(&ppmain, pp);
129                 MEM_freeN(pp->data);
130                 MEM_freeN(pp);
131         }
132         else printf("error in popfirst\n");
133 }
134
135 void poplast(void *data)
136 {
137         PushPop *pp;
138         
139         pp= ppmain.last;
140         if(pp) {
141                 memcpy(data, pp->data, pp->len);
142                 BLI_remlink(&ppmain, pp);
143                 MEM_freeN(pp->data);
144                 MEM_freeN(pp);
145         }
146         else printf("error in poplast\n");
147 }
148
149 void free_pushpop()
150 {
151         PushPop *pp;
152
153         pp= ppmain.first;
154         while(pp) {
155                 BLI_remlink(&ppmain, pp);
156                 MEM_freeN(pp->data);
157                 MEM_freeN(pp);
158         }       
159 }
160
161 void pushpop_test()
162 {
163         if(ppmain.first) printf("pushpop not empty\n");
164         free_pushpop();
165 }
166
167
168
169 /* ********** free ********** */
170
171 void free_blender(void)
172 {
173         /* samples are in a global list..., also sets G.main->sound->sample NULL */
174         sound_free_all_samples();
175         
176         free_main(G.main);
177         G.main= NULL;
178
179         IMB_freeImBufdata();            /* imbuf lib */
180         
181         free_nodesystem();      
182 }
183
184 void duplicatelist(ListBase *list1, ListBase *list2)  /* copy from 2 to 1 */
185 {
186         struct Link *link1, *link2;
187         
188         list1->first= list1->last= 0;
189         
190         link2= list2->first;
191         while(link2) {
192
193                 link1= MEM_dupallocN(link2);
194                 BLI_addtail(list1, link1);
195                 
196                 link2= link2->next;
197         }       
198 }
199
200 static EditMesh theEditMesh;
201
202 void initglobals(void)
203 {
204         memset(&G, 0, sizeof(Global));
205         
206         memset(&theEditMesh, 0, sizeof(theEditMesh));
207         G.editMesh = &theEditMesh;
208
209         U.savetime= 1;
210
211         G.main= MEM_callocN(sizeof(Main), "initglobals");
212
213         strcpy(G.ima, "//");
214
215         G.version= BLENDER_VERSION;
216
217         G.order= 1;
218         G.order= (((char*)&G.order)[0])?L_ENDIAN:B_ENDIAN;
219
220         if(BLENDER_SUBVERSION)
221                 sprintf(versionstr, "www.blender.org %d.%d", G.version, BLENDER_SUBVERSION);
222         else
223                 sprintf(versionstr, "www.blender.org %d", G.version);
224
225 #ifdef _WIN32   // FULLSCREEN
226         G.windowstate = G_WINDOWSTATE_USERDEF;
227 #endif
228
229         clear_workob(); /* object.c */
230
231         G.charstart = 0x0000;
232         G.charmin = 0x0000;
233         G.charmax = 0xffff;
234 }
235
236 /***/
237
238 static void clear_global(void) 
239 {
240 //      extern short winqueue_break;    /* screen.c */
241
242 // XXX  freeAllRad();
243         fastshade_free_render();        /* lamps hang otherwise */
244         free_main(G.main);                      /* free all lib data */
245         
246         if (G.obedit) {
247 //              freeNurblist(&editNurb);
248 //              free_editMesh(G.editMesh);
249 //              free_editText();
250 //              free_editArmature();
251         }
252 //      free_vertexpaint();
253
254         G.curscreen= NULL;
255         G.scene= NULL;
256         G.main= NULL;
257         
258         G.obedit= NULL;
259         G.saction= NULL;
260         G.buts= NULL;
261         G.v2d= NULL;
262         G.vd= NULL;
263         G.soops= NULL;
264         G.sima= NULL;
265         G.sipo= NULL;
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                 BLI_clean(scene->r.ftype);
309                 
310                 scene= scene->id.next;
311         }
312 }
313
314 /* context matching */
315 /* handle no-ui case */
316
317 static void setup_app_data(bContext *C, BlendFileData *bfd, char *filename) 
318 {
319         Object *ob;
320         bScreen *curscreen= NULL;
321         Scene *curscene= NULL;
322         char mode;
323         
324         /* 'u' = undo save, 'n' = no UI load */
325         if(bfd->main->screen.first==NULL) mode= 'u';
326         else if(G.fileflags & G_FILE_NO_UI) mode= 'n';
327         else mode= 0;
328         
329         clean_paths(bfd->main);
330         
331         /* XXX here the complex windowmanager matching */
332         
333         /* no load screens? */
334         if(mode) {
335                 /* comes from readfile.c */
336                 extern void lib_link_screen_restore(Main *, Scene *);
337                 
338                 SWAP(ListBase, G.main->screen, bfd->main->screen);
339                 
340                 /* we re-use current screen */
341                 curscreen= C->screen;
342                 /* but use new Scene pointer */
343                 curscene= bfd->curscene;
344                 if(curscene==NULL) curscene= bfd->main->scene.first;
345                 /* and we enforce curscene to be in current screen */
346                 curscreen->scene= curscene;
347
348                 /* clear_global will free G.main, here we can still restore pointers */
349                 lib_link_screen_restore(bfd->main, curscene);
350         }
351         
352         /* free G.main Main database */
353         clear_global(); 
354         
355         if(mode!='u') G.save_over = 1;
356         
357         G.main= bfd->main;
358         
359         if (bfd->user) {
360                 
361                 /* only here free userdef themes... */
362                 BLI_freelistN(&U.themes);
363
364                 U= *bfd->user;
365                 MEM_freeN(bfd->user);
366         }
367         
368         /* samples is a global list... */
369         sound_free_all_samples();
370         
371         /* case G_FILE_NO_UI or no screens in file */
372         if(mode) {
373                 C->screen= curscreen;
374                 C->scene= curscene;
375         }
376         else {
377                 G.winpos= bfd->winpos;
378                 G.displaymode= bfd->displaymode;
379                 G.fileflags= bfd->fileflags;
380                 C->screen= bfd->curscreen;
381                 C->scene= C->screen->scene;
382         }
383         /* this can happen when active scene was lib-linked, and doesnt exist anymore */
384         if(C->scene==NULL) {
385                 C->scene= G.main->scene.first;
386                 C->screen->scene= C->scene;
387         }
388
389         /* special cases, override loaded flags: */
390         if (G.f & G_DEBUG) bfd->globalf |= G_DEBUG;
391         else bfd->globalf &= ~G_DEBUG;
392         if (!(G.f & G_DOSCRIPTLINKS)) bfd->globalf &= ~G_DOSCRIPTLINKS;
393
394         G.f= bfd->globalf;
395
396         if (!G.background) {
397                 //setscreen(G.curscreen);
398         }
399         
400         /* baseflags, groups, make depsgraph, etc */
401         set_scene_bg(C->scene);
402
403         /* last stage of do_versions actually, that sets recalc flags for recalc poses */
404         for(ob= G.main->object.first; ob; ob= ob->id.next) {
405                 if(ob->type==OB_ARMATURE)
406                         if(ob->recalc) object_handle_update(ob);
407         }
408         
409         /* now tag update flags, to ensure deformers get calculated on redraw */
410         DAG_scene_update_flags(C->scene, C->scene->lay);
411         
412         if (G.f & G_DOSCRIPTLINKS) {
413                 /* there's an onload scriptlink to execute in screenmain */
414                 mainqenter(ONLOAD_SCRIPT, 1);
415         }
416         if (G.sce != filename) /* these are the same at times, should never copy to the same location */
417                 strcpy(G.sce, filename);
418         
419         strcpy(G.main->name, filename); /* is guaranteed current file */
420         
421         MEM_freeN(bfd);
422 }
423
424 static void handle_subversion_warning(Main *main)
425 {
426         if(main->minversionfile > BLENDER_VERSION ||
427            (main->minversionfile == BLENDER_VERSION && 
428                  main->minsubversionfile > BLENDER_SUBVERSION)) {
429                 
430                 char str[128];
431                 
432                 sprintf(str, "File written by newer Blender binary: %d.%d , expect loss of data!", main->minversionfile, main->minsubversionfile);
433                 error(str);
434         }
435                 
436 }
437
438 /* returns:
439    0: no load file
440    1: OK
441    2: OK, and with new user settings
442 */
443
444 int BKE_read_file(bContext *C, char *dir, void *unused) 
445 {
446         BlendReadError bre;
447         BlendFileData *bfd;
448         int retval= 1;
449         
450         bfd= BLO_read_from_file(dir, &bre);
451         if (bfd) {
452                 if(bfd->user) retval= 2;
453                 
454                 setup_app_data(C, bfd, dir);
455                 
456                 handle_subversion_warning(G.main);
457         } 
458         else {
459                 error("Loading %s failed: %s", dir, BLO_bre_as_string(bre));
460         }
461                 
462         return (bfd?retval:0);
463 }
464
465 int BKE_read_file_from_memory(bContext *C, char* filebuf, int filelength, void *unused)
466 {
467         BlendReadError bre;
468         BlendFileData *bfd;
469                         
470         bfd= BLO_read_from_memory(filebuf, filelength, &bre);
471         if (bfd) {              
472                 setup_app_data(C, bfd, "<memory>");
473         } else {
474                 error("Loading failed: %s", BLO_bre_as_string(bre));
475         }
476                 
477         return (bfd?1:0);
478 }
479
480 /* memfile is the undo buffer */
481 int BKE_read_file_from_memfile(bContext *C, MemFile *memfile)
482 {
483         BlendReadError bre;
484         BlendFileData *bfd;
485         
486         bfd= BLO_read_from_memfile(G.sce, memfile, &bre);
487         if (bfd) {
488                 setup_app_data(C, bfd, "<memory>");
489         } else {
490                 error("Loading failed: %s", BLO_bre_as_string(bre));
491         }
492                 
493         return (bfd?1:0);
494 }
495
496
497 /* ***************** GLOBAL UNDO *************** */
498
499 #define UNDO_DISK       0
500
501 #define MAXUNDONAME     64
502 typedef struct UndoElem {
503         struct UndoElem *next, *prev;
504         char str[FILE_MAXDIR+FILE_MAXFILE];
505         char name[MAXUNDONAME];
506         MemFile memfile;
507 } UndoElem;
508
509 static ListBase undobase={NULL, NULL};
510 static UndoElem *curundo= NULL;
511
512
513 static int read_undosave(bContext *C, UndoElem *uel)
514 {
515         char scestr[FILE_MAXDIR+FILE_MAXFILE];
516         int success=0, fileflags;
517         
518         strcpy(scestr, G.sce);  /* temporal store */
519         fileflags= G.fileflags;
520         G.fileflags |= G_FILE_NO_UI;
521
522         if(UNDO_DISK) 
523                 success= BKE_read_file(C, uel->str, NULL);
524         else
525                 success= BKE_read_file_from_memfile(C, &uel->memfile);
526         
527         /* restore */
528         strcpy(G.sce, scestr);
529         G.fileflags= fileflags;
530
531         return success;
532 }
533
534 /* name can be a dynamic string */
535 void BKE_write_undo(bContext *C, char *name)
536 {
537         int nr, success;
538         UndoElem *uel;
539         
540         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
541         if( U.undosteps==0) return;
542         
543         /* remove all undos after (also when curundo==NULL) */
544         while(undobase.last != curundo) {
545                 uel= undobase.last;
546                 BLI_remlink(&undobase, uel);
547                 BLO_free_memfile(&uel->memfile);
548                 MEM_freeN(uel);
549         }
550         
551         /* make new */
552         curundo= uel= MEM_callocN(sizeof(UndoElem), "undo file");
553         strncpy(uel->name, name, MAXUNDONAME-1);
554         BLI_addtail(&undobase, uel);
555         
556         /* and limit amount to the maximum */
557         nr= 0;
558         uel= undobase.last;
559         while(uel) {
560                 nr++;
561                 if(nr==U.undosteps) break;
562                 uel= uel->prev;
563         }
564         if(uel) {
565                 while(undobase.first!=uel) {
566                         UndoElem *first= undobase.first;
567                         BLI_remlink(&undobase, first);
568                         /* the merge is because of compression */
569                         BLO_merge_memfile(&first->memfile, &first->next->memfile);
570                         MEM_freeN(first);
571                 }
572         }
573
574
575         /* disk save version */
576         if(UNDO_DISK) {
577                 static int counter= 0;
578                 char *err, tstr[FILE_MAXDIR+FILE_MAXFILE];
579                 char numstr[32];
580                 
581                 /* calculate current filename */
582                 counter++;
583                 counter= counter % U.undosteps; 
584         
585                 sprintf(numstr, "%d.blend", counter);
586                 BLI_make_file_string("/", tstr, U.tempdir, numstr);
587         
588                 success= BLO_write_file(C, tstr, G.fileflags, &err);
589                 
590                 strcpy(curundo->str, tstr);
591         }
592         else {
593                 MemFile *prevfile=NULL;
594                 char *err;
595                 
596                 if(curundo->prev) prevfile= &(curundo->prev->memfile);
597                 
598                 success= BLO_write_file_mem(C, prevfile, &curundo->memfile, G.fileflags, &err);
599                 
600         }
601 }
602
603 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
604 void BKE_undo_step(bContext *C, int step)
605 {
606         
607         if(step==0) {
608                 read_undosave(C, curundo);
609         }
610         else if(step==1) {
611                 /* curundo should never be NULL, after restart or load file it should call undo_save */
612                 if(curundo==NULL || curundo->prev==NULL) error("No undo available");
613                 else {
614                         if(G.f & G_DEBUG) printf("undo %s\n", curundo->name);
615                         curundo= curundo->prev;
616                         read_undosave(C, curundo);
617                 }
618         }
619         else {
620                 
621                 /* curundo has to remain current situation! */
622                 
623                 if(curundo==NULL || curundo->next==NULL) error("No redo available");
624                 else {
625                         read_undosave(C, curundo->next);
626                         curundo= curundo->next;
627                         if(G.f & G_DEBUG) printf("redo %s\n", curundo->name);
628                 }
629         }
630 }
631
632 void BKE_reset_undo(void)
633 {
634         UndoElem *uel;
635         
636         uel= undobase.first;
637         while(uel) {
638                 BLO_free_memfile(&uel->memfile);
639                 uel= uel->next;
640         }
641         
642         BLI_freelistN(&undobase);
643         curundo= NULL;
644 }
645
646 /* based on index nr it does a restore */
647 void BKE_undo_number(bContext *C, int nr)
648 {
649         UndoElem *uel;
650         int a=1;
651         
652         for(uel= undobase.first; uel; uel= uel->next, a++) {
653                 if(a==nr) break;
654         }
655         curundo= uel;
656         BKE_undo_step(C, 0);
657 }
658
659 char *BKE_undo_menu_string(void)
660 {
661         UndoElem *uel;
662         DynStr *ds= BLI_dynstr_new();
663         char *menu;
664         
665         BLI_dynstr_append(ds, "Global Undo History %t");
666         
667         for(uel= undobase.first; uel; uel= uel->next) {
668                 BLI_dynstr_append(ds, "|");
669                 BLI_dynstr_append(ds, uel->name);
670         }
671         
672         menu= BLI_dynstr_get_cstring(ds);
673         BLI_dynstr_free(ds);
674
675         return menu;
676 }
677
678         /* saves quit.blend */
679 void BKE_undo_save_quit(void)
680 {
681         UndoElem *uel;
682         MemFileChunk *chunk;
683         int file;
684         char str[FILE_MAXDIR+FILE_MAXFILE];
685         
686         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
687         
688         uel= curundo;
689         if(uel==NULL) {
690                 printf("No undo buffer to save recovery file\n");
691                 return;
692         }
693         
694         /* no undo state to save */
695         if(undobase.first==undobase.last) return;
696                 
697         BLI_make_file_string("/", str, U.tempdir, "quit.blend");
698
699         file = open(str,O_BINARY+O_WRONLY+O_CREAT+O_TRUNC, 0666);
700         if(file == -1) {
701                 printf("Unable to save %s\n", str);
702                 return;
703         }
704
705         chunk= uel->memfile.chunks.first;
706         while(chunk) {
707                 if( write(file, chunk->buf, chunk->size) != chunk->size) break;
708                 chunk= chunk->next;
709         }
710         
711         close(file);
712         
713         if(chunk) printf("Unable to save %s\n", str);
714         else printf("Saved session recovery to %s\n", str);
715 }
716