doxygen: add newline after \file
[blender.git] / source / blender / editors / io / io_cache.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software  Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2016 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup editor/io
22  */
23
24 #include "MEM_guardedalloc.h"
25
26 #include "DNA_cachefile_types.h"
27 #include "DNA_space_types.h"
28
29 #include "BLI_listbase.h"
30 #include "BLI_path_util.h"
31 #include "BLI_string.h"
32
33 #include "BKE_cachefile.h"
34 #include "BKE_context.h"
35 #include "BKE_library.h"
36 #include "BKE_main.h"
37 #include "BKE_report.h"
38
39 #include "RNA_access.h"
40
41 #include "UI_interface.h"
42
43 #include "WM_api.h"
44 #include "WM_types.h"
45
46 #include "io_cache.h"
47
48 static void cachefile_init(bContext *C, wmOperator *op)
49 {
50         PropertyPointerRNA *pprop;
51
52         op->customdata = pprop = MEM_callocN(sizeof(PropertyPointerRNA), "OpenPropertyPointerRNA");
53         UI_context_active_but_prop_get_templateID(C, &pprop->ptr, &pprop->prop);
54 }
55
56 static int cachefile_open_invoke(bContext *C, wmOperator *op, const wmEvent *event)
57 {
58         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
59                 char filepath[FILE_MAX];
60                 Main *bmain = CTX_data_main(C);
61
62                 BLI_strncpy(filepath, BKE_main_blendfile_path(bmain), sizeof(filepath));
63                 BLI_path_extension_replace(filepath, sizeof(filepath), ".abc");
64                 RNA_string_set(op->ptr, "filepath", filepath);
65         }
66
67         cachefile_init(C, op);
68
69         WM_event_add_fileselect(C, op);
70
71         return OPERATOR_RUNNING_MODAL;
72
73         UNUSED_VARS(event);
74 }
75
76 static void open_cancel(bContext *UNUSED(C), wmOperator *op)
77 {
78         MEM_freeN(op->customdata);
79         op->customdata = NULL;
80 }
81
82 static int cachefile_open_exec(bContext *C, wmOperator *op)
83 {
84         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
85                 BKE_report(op->reports, RPT_ERROR, "No filename given");
86                 return OPERATOR_CANCELLED;
87         }
88
89         char filename[FILE_MAX];
90         RNA_string_get(op->ptr, "filepath", filename);
91
92         Main *bmain = CTX_data_main(C);
93
94         CacheFile *cache_file = BKE_libblock_alloc(bmain, ID_CF, BLI_path_basename(filename), 0);
95         BLI_strncpy(cache_file->filepath, filename, FILE_MAX);
96         BKE_cachefile_reload(bmain, cache_file);
97
98         /* Will be set when running invoke, not exec directly. */
99         if (op->customdata != NULL) {
100                 /* hook into UI */
101                 PropertyPointerRNA *pprop = op->customdata;
102                 if (pprop->prop) {
103                         /* when creating new ID blocks, use is already 1, but RNA
104                          * pointer se also increases user, so this compensates it */
105                         id_us_min(&cache_file->id);
106
107                         PointerRNA idptr;
108                         RNA_id_pointer_create(&cache_file->id, &idptr);
109                         RNA_property_pointer_set(&pprop->ptr, pprop->prop, idptr);
110                         RNA_property_update(C, &pprop->ptr, pprop->prop);
111                 }
112
113                 MEM_freeN(op->customdata);
114         }
115
116         return OPERATOR_FINISHED;
117 }
118
119 void CACHEFILE_OT_open(wmOperatorType *ot)
120 {
121         ot->name = "Open Cache File";
122         ot->description = "Load a cache file";
123         ot->idname = "CACHEFILE_OT_open";
124
125         ot->invoke = cachefile_open_invoke;
126         ot->exec = cachefile_open_exec;
127         ot->cancel = open_cancel;
128
129         WM_operator_properties_filesel(ot, FILE_TYPE_ALEMBIC | FILE_TYPE_FOLDER,
130                                        FILE_BLENDER, FILE_SAVE, WM_FILESEL_FILEPATH,
131                                        FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
132 }
133
134 /* ***************************** Reload Operator **************************** */
135
136 static int cachefile_reload_exec(bContext *C, wmOperator *op)
137 {
138         CacheFile *cache_file = CTX_data_edit_cachefile(C);
139
140         if (!cache_file) {
141                 return OPERATOR_CANCELLED;
142         }
143
144         Main *bmain = CTX_data_main(C);
145
146         BLI_freelistN(&cache_file->object_paths);
147         BKE_cachefile_reload(bmain, cache_file);
148
149         return OPERATOR_FINISHED;
150
151         UNUSED_VARS(op);
152 }
153
154 void CACHEFILE_OT_reload(wmOperatorType *ot)
155 {
156         ot->name = "Refresh Archive";
157         ot->description = "Update objects paths list with new data from the archive";
158         ot->idname = "CACHEFILE_OT_reload";
159
160         /* api callbacks */
161         ot->exec = cachefile_reload_exec;
162
163         /* flags */
164         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
165 }