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