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