Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / blender_undo.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file blender/blenkernel/intern/blender_undo.c
22  *  \ingroup bke
23  *
24  * Blend file undo (known as 'Global Undo').
25  * DNA level diffing for undo.
26  */
27
28 #ifndef _WIN32
29 #  include <unistd.h> // for read close
30 #else
31 #  include <io.h> // for open close read
32 #endif
33
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <stddef.h>
37 #include <string.h>
38 #include <fcntl.h>  /* for open */
39 #include <errno.h>
40
41 #include "MEM_guardedalloc.h"
42
43 #include "DNA_scene_types.h"
44
45 #include "BLI_path_util.h"
46 #include "BLI_string.h"
47 #include "BLI_utildefines.h"
48
49 #include "BKE_appdir.h"
50 #include "BKE_blender_undo.h"  /* own include */
51 #include "BKE_blendfile.h"
52 #include "BKE_context.h"
53 #include "BKE_global.h"
54 #include "BKE_library.h"
55 #include "BKE_main.h"
56
57 #include "BLO_undofile.h"
58 #include "BLO_readfile.h"
59 #include "BLO_writefile.h"
60
61 #include "DEG_depsgraph.h"
62
63 /* -------------------------------------------------------------------- */
64
65 /** \name Global Undo
66  * \{ */
67
68 #define UNDO_DISK   0
69
70 bool BKE_memfile_undo_decode(MemFileUndoData *mfu, bContext *C)
71 {
72         Main *bmain = CTX_data_main(C);
73         char mainstr[sizeof(bmain->name)];
74         int success = 0, fileflags;
75
76         BLI_strncpy(mainstr, BKE_main_blendfile_path(bmain), sizeof(mainstr));    /* temporal store */
77
78         fileflags = G.fileflags;
79         G.fileflags |= G_FILE_NO_UI;
80
81         if (UNDO_DISK) {
82                 success = (BKE_blendfile_read(C, mfu->filename, NULL, 0) != BKE_BLENDFILE_READ_FAIL);
83         }
84         else {
85                 success = BKE_blendfile_read_from_memfile(
86                         C, &mfu->memfile,
87                         &(const struct BlendFileReadParams){0},
88                         NULL);
89         }
90
91         /* Restore, bmain has been re-allocated. */
92         bmain = CTX_data_main(C);
93         BLI_strncpy(bmain->name, mainstr, sizeof(bmain->name));
94         G.fileflags = fileflags;
95
96         if (success) {
97                 /* important not to update time here, else non keyed transforms are lost */
98                 DEG_on_visible_update(bmain, false);
99         }
100
101         return success;
102 }
103
104 MemFileUndoData *BKE_memfile_undo_encode(Main *bmain, MemFileUndoData *mfu_prev)
105 {
106         MemFileUndoData *mfu = MEM_callocN(sizeof(MemFileUndoData), __func__);
107
108         /* disk save version */
109         if (UNDO_DISK) {
110                 static int counter = 0;
111                 char filename[FILE_MAX];
112                 char numstr[32];
113                 int fileflags = G.fileflags & ~(G_FILE_HISTORY); /* don't do file history on undo */
114
115                 /* Calculate current filename. */
116                 counter++;
117                 counter = counter % U.undosteps;
118
119                 BLI_snprintf(numstr, sizeof(numstr), "%d.blend", counter);
120                 BLI_make_file_string("/", filename, BKE_tempdir_session(), numstr);
121
122                 /* success = */ /* UNUSED */ BLO_write_file(bmain, filename, fileflags, NULL, NULL);
123
124                 BLI_strncpy(mfu->filename, filename, sizeof(mfu->filename));
125         }
126         else {
127                 MemFile *prevfile = (mfu_prev) ? &(mfu_prev->memfile) : NULL;
128                 /* success = */ /* UNUSED */ BLO_write_file_mem(bmain, prevfile, &mfu->memfile, G.fileflags);
129                 mfu->undo_size = mfu->memfile.size;
130         }
131
132         bmain->is_memfile_undo_written = true;
133
134         return mfu;
135 }
136
137 void BKE_memfile_undo_free(MemFileUndoData *mfu)
138 {
139         BLO_memfile_free(&mfu->memfile);
140         MEM_freeN(mfu);
141 }
142
143 /** \} */