- UNUSED macro wasn't throwing an error with GCC if a var become used.
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 <stddef.h>
47 #include <string.h>
48 #include <fcntl.h> // for open
49
50 #include "MEM_guardedalloc.h"
51
52 #include "DNA_userdef_types.h"
53 #include "DNA_scene_types.h"
54 #include "DNA_screen_types.h"
55 #include "DNA_sequence_types.h"
56 #include "DNA_sound_types.h"
57
58 #include "BLI_blenlib.h"
59 #include "BLI_dynstr.h"
60 #include "BLI_path_util.h"
61
62 #include "IMB_imbuf.h"
63
64 #include "BKE_blender.h"
65 #include "BKE_context.h"
66 #include "BKE_depsgraph.h"
67 #include "BKE_displist.h"
68 #include "BKE_global.h"
69 #include "BKE_idprop.h"
70 #include "BKE_ipo.h"
71 #include "BKE_library.h"
72 #include "BKE_main.h"
73 #include "BKE_node.h"
74 #include "BKE_report.h"
75 #include "BKE_scene.h"
76 #include "BKE_screen.h"
77 #include "BKE_sequencer.h"
78
79
80 #include "BLO_undofile.h"
81 #include "BLO_readfile.h" 
82 #include "BLO_writefile.h" 
83
84 #include "BKE_utildefines.h" // O_BINARY FALSE
85
86 #include "WM_api.h" // XXXXX BAD, very BAD dependency (bad level call) - remove asap, elubie
87
88 Global G;
89 UserDef U;
90 ListBase WMlist= {NULL, NULL};
91 short ENDIAN_ORDER;
92
93 char versionstr[48]= "";
94
95 /* ********** free ********** */
96
97 /* only to be called on exit blender */
98 void free_blender(void)
99 {
100         /* samples are in a global list..., also sets G.main->sound->sample NULL */
101         free_main(G.main);
102         G.main= NULL;
103
104         BKE_spacetypes_free();          /* after free main, it uses space callbacks */
105         
106         IMB_exit();
107         seq_stripelem_cache_destruct();
108         
109         free_nodesystem();      
110 }
111
112 void initglobals(void)
113 {
114         memset(&G, 0, sizeof(Global));
115         
116         U.savetime= 1;
117
118         G.main= MEM_callocN(sizeof(Main), "initglobals");
119
120         strcpy(G.ima, "//");
121
122         ENDIAN_ORDER= 1;
123         ENDIAN_ORDER= (((char*)&ENDIAN_ORDER)[0])? L_ENDIAN: B_ENDIAN;
124
125         if(BLENDER_SUBVERSION)
126                 sprintf(versionstr, "www.blender.org %d.%d", BLENDER_VERSION, BLENDER_SUBVERSION);
127         else
128                 sprintf(versionstr, "www.blender.org %d", BLENDER_VERSION);
129
130 #ifdef _WIN32   // FULLSCREEN
131         G.windowstate = G_WINDOWSTATE_USERDEF;
132 #endif
133
134         G.charstart = 0x0000;
135         G.charmin = 0x0000;
136         G.charmax = 0xffff;
137         
138         G.f |= G_SCRIPT_AUTOEXEC;
139 }
140
141 /***/
142
143 static void clear_global(void) 
144 {
145 //      extern short winqueue_break;    /* screen.c */
146
147         fastshade_free_render();        /* lamps hang otherwise */
148         free_main(G.main);                      /* free all lib data */
149         
150 //      free_vertexpaint();
151
152         G.main= NULL;
153 }
154
155 /* make sure path names are correct for OS */
156 static void clean_paths(Main *main)
157 {
158         Image *image= main->image.first;
159         bSound *sound= main->sound.first;
160         Scene *scene= main->scene.first;
161         Editing *ed;
162         Sequence *seq;
163         Strip *strip;
164         
165         while(image) {
166                 BLI_clean(image->name);
167                 image= image->id.next;
168         }
169         
170         while(sound) {
171                 BLI_clean(sound->name);
172                 sound= sound->id.next;
173         }
174         
175         while(scene) {
176                 ed= seq_give_editing(scene, 0);
177                 if(ed) {
178                         seq= ed->seqbasep->first;
179                         while(seq) {
180                                 if(seq->plugin) {
181                                         BLI_clean(seq->plugin->name);
182                                 }
183                                 strip= seq->strip;
184                                 while(strip) {
185                                         BLI_clean(strip->dir);
186                                         strip= strip->next;
187                                 }
188                                 seq= seq->next;
189                         }
190                 }
191                 BLI_clean(scene->r.backbuf);
192                 BLI_clean(scene->r.pic);
193                 
194                 scene= scene->id.next;
195         }
196 }
197
198 /* context matching */
199 /* handle no-ui case */
200
201 static void setup_app_data(bContext *C, BlendFileData *bfd, char *filename) 
202 {
203         bScreen *curscreen= NULL;
204         Scene *curscene= NULL;
205         int recover;
206         char mode;
207
208         /* 'u' = undo save, 'n' = no UI load */
209         if(bfd->main->screen.first==NULL) mode= 'u';
210         else if(G.fileflags & G_FILE_NO_UI) mode= 'n';
211         else mode= 0;
212
213         recover= (G.fileflags & G_FILE_RECOVER);
214         
215         clean_paths(bfd->main);
216         
217         /* XXX here the complex windowmanager matching */
218         
219         /* no load screens? */
220         if(mode) {
221                 /* comes from readfile.c */
222                 extern void lib_link_screen_restore(Main *, bScreen *, Scene *);
223                 
224                 SWAP(ListBase, G.main->wm, bfd->main->wm);
225                 SWAP(ListBase, G.main->screen, bfd->main->screen);
226                 SWAP(ListBase, G.main->script, bfd->main->script);
227                 
228                 /* we re-use current screen */
229                 curscreen= CTX_wm_screen(C);
230                 /* but use new Scene pointer */
231                 curscene= bfd->curscene;
232                 if(curscene==NULL) curscene= bfd->main->scene.first;
233                 /* and we enforce curscene to be in current screen */
234                 if(curscreen) curscreen->scene= curscene; /* can run in bgmode */
235
236                 /* clear_global will free G.main, here we can still restore pointers */
237                 lib_link_screen_restore(bfd->main, curscreen, curscene);
238         }
239         
240         /* free G.main Main database */
241         clear_global(); 
242         
243         G.main= bfd->main;
244
245         CTX_data_main_set(C, G.main);
246         
247         if (bfd->user) {
248                 
249                 /* only here free userdef themes... */
250                 BKE_userdef_free();
251                 
252                 U= *bfd->user;
253                 MEM_freeN(bfd->user);
254         }
255         
256         /* case G_FILE_NO_UI or no screens in file */
257         if(mode) {
258                 /* leave entire context further unaltered? */
259                 CTX_data_scene_set(C, curscene);
260         }
261         else {
262                 G.winpos= bfd->winpos;
263                 G.displaymode= bfd->displaymode;
264                 G.fileflags= bfd->fileflags;
265                 
266                 CTX_wm_screen_set(C, bfd->curscreen);
267                 CTX_data_scene_set(C, bfd->curscreen->scene);
268                 CTX_wm_area_set(C, NULL);
269                 CTX_wm_region_set(C, NULL);
270                 CTX_wm_menu_set(C, NULL);
271         }
272         
273         /* this can happen when active scene was lib-linked, and doesnt exist anymore */
274         if(CTX_data_scene(C)==NULL) {
275                 CTX_data_scene_set(C, bfd->main->scene.first);
276                 CTX_wm_screen(C)->scene= CTX_data_scene(C);
277                 curscene= CTX_data_scene(C);
278         }
279
280         /* special cases, override loaded flags: */
281         if (G.f & G_DEBUG) bfd->globalf |= G_DEBUG;
282         else bfd->globalf &= ~G_DEBUG;
283         if (G.f & G_SWAP_EXCHANGE) bfd->globalf |= G_SWAP_EXCHANGE;
284         else bfd->globalf &= ~G_SWAP_EXCHANGE;
285         if (G.f & G_SCRIPT_AUTOEXEC) bfd->globalf |= G_SCRIPT_AUTOEXEC;
286         else bfd->globalf &= ~G_SCRIPT_AUTOEXEC;
287
288         G.f= bfd->globalf;
289
290         if (!G.background) {
291                 //setscreen(G.curscreen);
292         }
293         
294         // FIXME: this version patching should really be part of the file-reading code, 
295         // but we still get too many unrelated data-corruption crashes otherwise...
296         if (G.main->versionfile < 250)
297                 do_versions_ipos_to_animato(G.main);
298         
299         if(recover && bfd->filename[0] && G.relbase_valid) {
300                 /* in case of autosave or quit.blend, use original filename instead
301                  * use relbase_valid to make sure the file is saved, else we get <memory2> in the filename */
302                 filename= bfd->filename;
303         }
304 #if 0
305         else if (!G.relbase_valid) {
306                 /* otherwise, use an empty string as filename, rather than <memory2> */
307                 filename="";
308         }
309 #endif
310         
311         /* these are the same at times, should never copy to the same location */
312         if(G.sce != filename)
313                 BLI_strncpy(G.sce, filename, FILE_MAX);
314         
315         BLI_strncpy(G.main->name, filename, FILE_MAX); /* is guaranteed current file */
316
317         /* baseflags, groups, make depsgraph, etc */
318         set_scene_bg(G.main, CTX_data_scene(C));
319         
320         MEM_freeN(bfd);
321 }
322
323 static int handle_subversion_warning(Main *main)
324 {
325         if(main->minversionfile > BLENDER_VERSION ||
326            (main->minversionfile == BLENDER_VERSION && 
327                  main->minsubversionfile > BLENDER_SUBVERSION)) {
328                 
329                 char str[128];
330                 
331                 sprintf(str, "File written by newer Blender binary: %d.%d , expect loss of data!", main->minversionfile, main->minsubversionfile);
332 // XXX          error(str);
333         }
334         return 1;
335 }
336
337 void BKE_userdef_free(void)
338 {
339         wmKeyMap *km;
340         wmKeyMapItem *kmi;
341
342         for(km=U.keymaps.first; km; km=km->next) {
343                 for(kmi=km->items.first; kmi; kmi=kmi->next) {
344                         if(kmi->properties) {
345                                 IDP_FreeProperty(kmi->properties);
346                                 MEM_freeN(kmi->properties);
347                         }
348                         if(kmi->ptr)
349                                 MEM_freeN(kmi->ptr);
350                 }
351
352                 BLI_freelistN(&km->items);
353         }
354         
355         BLI_freelistN(&U.uistyles);
356         BLI_freelistN(&U.uifonts);
357         BLI_freelistN(&U.themes);
358         BLI_freelistN(&U.keymaps);
359         BLI_freelistN(&U.addons);
360 }
361
362 /* returns:
363    0: no load file
364    1: OK
365    2: OK, and with new user settings
366 */
367
368 int BKE_read_file(bContext *C, char *dir, ReportList *reports) 
369 {
370         BlendFileData *bfd;
371         int retval= 1;
372
373         if(strstr(dir, BLENDER_STARTUP_FILE)==0) /* dont print user-pref loading */
374                 printf("read blend: %s\n", dir);
375
376         bfd= BLO_read_from_file(dir, reports);
377         if (bfd) {
378                 if(bfd->user) retval= 2;
379                 
380                 if(0==handle_subversion_warning(bfd->main)) {
381                         free_main(bfd->main);
382                         MEM_freeN(bfd);
383                         bfd= NULL;
384                         retval= 0;
385                 }
386                 else
387                         setup_app_data(C, bfd, dir); // frees BFD
388         } 
389         else
390                 BKE_reports_prependf(reports, "Loading %s failed: ", dir);
391                 
392         return (bfd?retval:0);
393 }
394
395 int BKE_read_file_from_memory(bContext *C, char* filebuf, int filelength, ReportList *reports)
396 {
397         BlendFileData *bfd;
398
399         bfd= BLO_read_from_memory(filebuf, filelength, reports);
400         if (bfd)
401                 setup_app_data(C, bfd, "<memory2>");
402         else
403                 BKE_reports_prepend(reports, "Loading failed: ");
404
405         return (bfd?1:0);
406 }
407
408 /* memfile is the undo buffer */
409 int BKE_read_file_from_memfile(bContext *C, MemFile *memfile, ReportList *reports)
410 {
411         BlendFileData *bfd;
412
413         bfd= BLO_read_from_memfile(CTX_data_main(C), G.sce, memfile, reports);
414         if (bfd)
415                 setup_app_data(C, bfd, "<memory1>");
416         else
417                 BKE_reports_prepend(reports, "Loading failed: ");
418
419         return (bfd?1:0);
420 }
421
422
423 /* *****************  testing for break ************* */
424
425 static void (*blender_test_break_cb)(void)= NULL;
426
427 void set_blender_test_break_cb(void (*func)(void) )
428 {
429         blender_test_break_cb= func;
430 }
431
432
433 int blender_test_break(void)
434 {
435         if (!G.background) {
436                 if (blender_test_break_cb)
437                         blender_test_break_cb();
438         }
439         
440         return (G.afbreek==1);
441 }
442
443
444 /* ***************** GLOBAL UNDO *************** */
445
446 #define UNDO_DISK       0
447
448 #define MAXUNDONAME     64
449 typedef struct UndoElem {
450         struct UndoElem *next, *prev;
451         char str[FILE_MAXDIR+FILE_MAXFILE];
452         char name[MAXUNDONAME];
453         MemFile memfile;
454         uintptr_t undosize;
455 } UndoElem;
456
457 static ListBase undobase={NULL, NULL};
458 static UndoElem *curundo= NULL;
459
460
461 static int read_undosave(bContext *C, UndoElem *uel)
462 {
463         char scestr[FILE_MAXDIR+FILE_MAXFILE]; /* we should eventually just use G.main->name */
464         char mainstr[FILE_MAXDIR+FILE_MAXFILE];
465         int success=0, fileflags;
466         
467         /* This is needed so undoing/redoing doesnt crash with threaded previews going */
468         WM_jobs_stop_all(CTX_wm_manager(C));
469         
470         strcpy(scestr, G.sce);  /* temporal store */
471         strcpy(mainstr, G.main->name);  /* temporal store */
472
473         fileflags= G.fileflags;
474         G.fileflags |= G_FILE_NO_UI;
475
476         if(UNDO_DISK) 
477                 success= BKE_read_file(C, uel->str, NULL);
478         else
479                 success= BKE_read_file_from_memfile(C, &uel->memfile, NULL);
480
481         /* restore */
482         strcpy(G.sce, scestr); /* restore */
483         strcpy(G.main->name, mainstr); /* restore */
484         G.fileflags= fileflags;
485
486         if(success)
487                 DAG_on_load_update(G.main);
488
489         return success;
490 }
491
492 /* name can be a dynamic string */
493 void BKE_write_undo(bContext *C, char *name)
494 {
495         uintptr_t maxmem, totmem, memused;
496         int nr, success;
497         UndoElem *uel;
498         
499         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
500         if( U.undosteps==0) return;
501         
502         /* remove all undos after (also when curundo==NULL) */
503         while(undobase.last != curundo) {
504                 uel= undobase.last;
505                 BLI_remlink(&undobase, uel);
506                 BLO_free_memfile(&uel->memfile);
507                 MEM_freeN(uel);
508         }
509         
510         /* make new */
511         curundo= uel= MEM_callocN(sizeof(UndoElem), "undo file");
512         strncpy(uel->name, name, MAXUNDONAME-1);
513         BLI_addtail(&undobase, uel);
514         
515         /* and limit amount to the maximum */
516         nr= 0;
517         uel= undobase.last;
518         while(uel) {
519                 nr++;
520                 if(nr==U.undosteps) break;
521                 uel= uel->prev;
522         }
523         if(uel) {
524                 while(undobase.first!=uel) {
525                         UndoElem *first= undobase.first;
526                         BLI_remlink(&undobase, first);
527                         /* the merge is because of compression */
528                         BLO_merge_memfile(&first->memfile, &first->next->memfile);
529                         MEM_freeN(first);
530                 }
531         }
532
533
534         /* disk save version */
535         if(UNDO_DISK) {
536                 static int counter= 0;
537                 char tstr[FILE_MAXDIR+FILE_MAXFILE];
538                 char numstr[32];
539                 
540                 /* calculate current filename */
541                 counter++;
542                 counter= counter % U.undosteps; 
543         
544                 sprintf(numstr, "%d.blend", counter);
545                 BLI_make_file_string("/", tstr, btempdir, numstr);
546         
547                 success= BLO_write_file(CTX_data_main(C), tstr, G.fileflags, NULL, NULL);
548                 
549                 strcpy(curundo->str, tstr);
550         }
551         else {
552                 MemFile *prevfile=NULL;
553                 
554                 if(curundo->prev) prevfile= &(curundo->prev->memfile);
555                 
556                 memused= MEM_get_memory_in_use();
557                 success= BLO_write_file_mem(CTX_data_main(C), prevfile, &curundo->memfile, G.fileflags);
558                 curundo->undosize= MEM_get_memory_in_use() - memused;
559         }
560
561         if(U.undomemory != 0) {
562                 /* limit to maximum memory (afterwards, we can't know in advance) */
563                 totmem= 0;
564                 maxmem= ((uintptr_t)U.undomemory)*1024*1024;
565
566                 /* keep at least two (original + other) */
567                 uel= undobase.last;
568                 while(uel && uel->prev) {
569                         totmem+= uel->undosize;
570                         if(totmem>maxmem) break;
571                         uel= uel->prev;
572                 }
573
574                 if(uel) {
575                         if(uel->prev && uel->prev->prev)
576                                 uel= uel->prev;
577
578                         while(undobase.first!=uel) {
579                                 UndoElem *first= undobase.first;
580                                 BLI_remlink(&undobase, first);
581                                 /* the merge is because of compression */
582                                 BLO_merge_memfile(&first->memfile, &first->next->memfile);
583                                 MEM_freeN(first);
584                         }
585                 }
586         }
587 }
588
589 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
590 void BKE_undo_step(bContext *C, int step)
591 {
592         
593         if(step==0) {
594                 read_undosave(C, curundo);
595         }
596         else if(step==1) {
597                 /* curundo should never be NULL, after restart or load file it should call undo_save */
598                 if(curundo==NULL || curundo->prev==NULL) ; // XXX error("No undo available");
599                 else {
600                         if(G.f & G_DEBUG) printf("undo %s\n", curundo->name);
601                         curundo= curundo->prev;
602                         read_undosave(C, curundo);
603                 }
604         }
605         else {
606                 
607                 /* curundo has to remain current situation! */
608                 
609                 if(curundo==NULL || curundo->next==NULL) ; // XXX error("No redo available");
610                 else {
611                         read_undosave(C, curundo->next);
612                         curundo= curundo->next;
613                         if(G.f & G_DEBUG) printf("redo %s\n", curundo->name);
614                 }
615         }
616 }
617
618 void BKE_reset_undo(void)
619 {
620         UndoElem *uel;
621         
622         uel= undobase.first;
623         while(uel) {
624                 BLO_free_memfile(&uel->memfile);
625                 uel= uel->next;
626         }
627         
628         BLI_freelistN(&undobase);
629         curundo= NULL;
630 }
631
632 /* based on index nr it does a restore */
633 void BKE_undo_number(bContext *C, int nr)
634 {
635         UndoElem *uel;
636         int a=1;
637         
638         for(uel= undobase.first; uel; uel= uel->next, a++) {
639                 if(a==nr) break;
640         }
641         curundo= uel;
642         BKE_undo_step(C, 0);
643 }
644
645 /* go back to the last occurance of name in stack */
646 void BKE_undo_name(bContext *C, const char *name)
647 {
648         UndoElem *uel;
649
650         for(uel= undobase.last; uel; uel= uel->prev)
651                 if(strcmp(name, uel->name)==0)
652                         break;
653
654         if(uel && uel->prev) {
655                 curundo= uel->prev;
656                 BKE_undo_step(C, 0);
657         }
658 }
659
660
661 char *BKE_undo_menu_string(void)
662 {
663         UndoElem *uel;
664         DynStr *ds= BLI_dynstr_new();
665         char *menu;
666
667         BLI_dynstr_append(ds, "Global Undo History %t");
668         
669         for(uel= undobase.first; uel; uel= uel->next) {
670                 BLI_dynstr_append(ds, "|");
671                 BLI_dynstr_append(ds, uel->name);
672         }
673
674         menu= BLI_dynstr_get_cstring(ds);
675         BLI_dynstr_free(ds);
676
677         return menu;
678 }
679
680         /* saves quit.blend */
681 void BKE_undo_save_quit(void)
682 {
683         UndoElem *uel;
684         MemFileChunk *chunk;
685         int file;
686         char str[FILE_MAXDIR+FILE_MAXFILE];
687         
688         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
689         
690         uel= curundo;
691         if(uel==NULL) {
692                 printf("No undo buffer to save recovery file\n");
693                 return;
694         }
695         
696         /* no undo state to save */
697         if(undobase.first==undobase.last) return;
698                 
699         BLI_make_file_string("/", str, btempdir, "quit.blend");
700
701         file = open(str,O_BINARY+O_WRONLY+O_CREAT+O_TRUNC, 0666);
702         if(file == -1) {
703                 //XXX error("Unable to save %s, check you have permissions", str);
704                 return;
705         }
706
707         chunk= uel->memfile.chunks.first;
708         while(chunk) {
709                 if( write(file, chunk->buf, chunk->size) != chunk->size) break;
710                 chunk= chunk->next;
711         }
712         
713         close(file);
714         
715         if(chunk) ; //XXX error("Unable to save %s, internal error", str);
716         else printf("Saved session recovery to %s\n", str);
717 }
718
719 /* sets curscene */
720 Main *BKE_undo_get_main(Scene **scene)
721 {
722         Main *mainp= NULL;
723         BlendFileData *bfd= BLO_read_from_memfile(G.main, G.sce, &curundo->memfile, NULL);
724         
725         if(bfd) {
726                 mainp= bfd->main;
727                 if(scene)
728                         *scene= bfd->curscene;
729                 
730                 MEM_freeN(bfd);
731         }
732         
733         return mainp;
734 }
735