Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / blender_copybuffer.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_copybuffer.c
22  *  \ingroup bke
23  *
24  * Used for copy/paste operator, (using a temporary file).
25  */
26
27 #include <stdlib.h>
28
29 #include "MEM_guardedalloc.h"
30
31 #include "DNA_userdef_types.h"
32 #include "DNA_scene_types.h"
33 #include "DNA_screen_types.h"
34 #include "DNA_view3d_types.h"
35 #include "DNA_windowmanager_types.h"
36
37 #include "BLI_blenlib.h"
38 #include "BLI_utildefines.h"
39 #include "BLI_callbacks.h"
40
41 #include "IMB_imbuf.h"
42 #include "IMB_moviecache.h"
43
44 #include "BKE_blender_copybuffer.h"  /* own include */
45 #include "BKE_blendfile.h"
46 #include "BKE_context.h"
47 #include "BKE_global.h"
48 #include "BKE_layer.h"
49 #include "BKE_library.h"
50 #include "BKE_main.h"
51 #include "BKE_scene.h"
52
53 #include "DEG_depsgraph.h"
54 #include "DEG_depsgraph_build.h"
55
56 #include "BLO_readfile.h"
57 #include "BLO_writefile.h"
58
59 #include "IMB_colormanagement.h"
60
61
62 /* -------------------------------------------------------------------- */
63
64 /** \name Copy/Paste `.blend`, partial saves.
65  * \{ */
66
67 void BKE_copybuffer_begin(Main *bmain_src)
68 {
69         BKE_blendfile_write_partial_begin(bmain_src);
70 }
71
72 void BKE_copybuffer_tag_ID(ID *id)
73 {
74         BKE_blendfile_write_partial_tag_ID(id, true);
75 }
76
77 /**
78  * \return Success.
79  */
80 bool BKE_copybuffer_save(Main *bmain_src, const char *filename, ReportList *reports)
81 {
82         const int write_flags = G_FILE_RELATIVE_REMAP;
83
84         bool retval = BKE_blendfile_write_partial(bmain_src, filename, write_flags, reports);
85
86         BKE_blendfile_write_partial_end(bmain_src);
87
88         return retval;
89 }
90
91 bool BKE_copybuffer_read(Main *bmain_dst, const char *libname, ReportList *reports)
92 {
93         BlendHandle *bh = BLO_blendhandle_from_file(libname, reports);
94         if (bh == NULL) {
95                 /* Error reports will have been made by BLO_blendhandle_from_file(). */
96                 return false;
97         }
98         /* Here appending/linking starts. */
99         Main *mainl = BLO_library_link_begin(bmain_dst, &bh, libname);
100         BLO_library_link_copypaste(mainl, bh);
101         BLO_library_link_end(mainl, &bh, 0, NULL, NULL, NULL, NULL);
102         /* Mark all library linked objects to be updated. */
103         BKE_main_lib_objects_recalc_all(bmain_dst);
104         IMB_colormanagement_check_file_config(bmain_dst);
105         /* Append, rather than linking. */
106         Library *lib = BLI_findstring(&bmain_dst->library, libname, offsetof(Library, filepath));
107         BKE_library_make_local(bmain_dst, lib, NULL, true, false);
108         /* Important we unset, otherwise these object wont
109          * link into other scenes from this blend file.
110          */
111         BKE_main_id_tag_all(bmain_dst, LIB_TAG_PRE_EXISTING, false);
112         BLO_blendhandle_close(bh);
113         return true;
114 }
115
116 /**
117  * \return Success.
118  */
119 bool BKE_copybuffer_paste(bContext *C, const char *libname, const short flag, ReportList *reports)
120 {
121         Main *bmain = CTX_data_main(C);
122         Scene *scene = CTX_data_scene(C);
123         ViewLayer *view_layer = CTX_data_view_layer(C);
124         View3D *v3d = CTX_wm_view3d(C);  /* may be NULL. */
125         Main *mainl = NULL;
126         Library *lib;
127         BlendHandle *bh;
128
129         bh = BLO_blendhandle_from_file(libname, reports);
130
131         if (bh == NULL) {
132                 /* error reports will have been made by BLO_blendhandle_from_file() */
133                 return false;
134         }
135
136         BKE_view_layer_base_deselect_all(view_layer);
137
138         /* tag everything, all untagged data can be made local
139          * its also generally useful to know what is new
140          *
141          * take extra care BKE_main_id_flag_all(bmain, LIB_TAG_PRE_EXISTING, false) is called after! */
142         BKE_main_id_tag_all(bmain, LIB_TAG_PRE_EXISTING, true);
143
144         /* here appending/linking starts */
145         mainl = BLO_library_link_begin(bmain, &bh, libname);
146
147         BLO_library_link_copypaste(mainl, bh);
148
149         BLO_library_link_end(mainl, &bh, flag, bmain, scene, view_layer, v3d);
150
151         /* mark all library linked objects to be updated */
152         BKE_main_lib_objects_recalc_all(bmain);
153         IMB_colormanagement_check_file_config(bmain);
154
155         /* append, rather than linking */
156         lib = BLI_findstring(&bmain->library, libname, offsetof(Library, filepath));
157         BKE_library_make_local(bmain, lib, NULL, true, false);
158
159         /* important we unset, otherwise these object wont
160          * link into other scenes from this blend file */
161         BKE_main_id_tag_all(bmain, LIB_TAG_PRE_EXISTING, false);
162
163         /* recreate dependency graph to include new objects */
164         DEG_relations_tag_update(bmain);
165
166         /* Tag update the scene to flush base collection settings, since the new object is added to a
167          * new (active) collection, not its original collection, thus need recalculation. */
168         DEG_id_tag_update(&scene->id, 0);
169
170         BLO_blendhandle_close(bh);
171         /* remove library... */
172
173         return true;
174 }
175
176 /** \} */