First set of UI/i18n messages fixes (mostly new GP code).
[blender.git] / source / blender / editors / io / io_cache.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  * The Original Code is Copyright (C) 2016 Blender Foundation.
19  * All rights reserved.
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  *
23  */
24
25 #include "MEM_guardedalloc.h"
26
27 #include "DNA_cachefile_types.h"
28 #include "DNA_space_types.h"
29
30 #include "BLI_listbase.h"
31 #include "BLI_path_util.h"
32 #include "BLI_string.h"
33
34 #include "BKE_cachefile.h"
35 #include "BKE_context.h"
36 #include "BKE_global.h"
37 #include "BKE_library.h"
38 #include "BKE_main.h"
39 #include "BKE_report.h"
40
41 #include "RNA_access.h"
42
43 #include "UI_interface.h"
44
45 #include "WM_api.h"
46 #include "WM_types.h"
47
48 #include "io_cache.h"
49
50 static void cachefile_init(bContext *C, wmOperator *op)
51 {
52         PropertyPointerRNA *pprop;
53
54         op->customdata = pprop = MEM_callocN(sizeof(PropertyPointerRNA), "OpenPropertyPointerRNA");
55         UI_context_active_but_prop_get_templateID(C, &pprop->ptr, &pprop->prop);
56 }
57
58 static int cachefile_open_invoke(bContext *C, wmOperator *op, const wmEvent *event)
59 {
60         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
61                 char filepath[FILE_MAX];
62                 BLI_strncpy(filepath, G.main->name, sizeof(filepath));
63                 BLI_replace_extension(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));
95         BLI_strncpy(cache_file->filepath, filename, FILE_MAX);
96         BKE_cachefile_reload(bmain, cache_file);
97
98         /* hook into UI */
99         PropertyPointerRNA *pprop = op->customdata;
100
101         if (pprop->prop) {
102                 /* when creating new ID blocks, use is already 1, but RNA
103                  * pointer se also increases user, so this compensates it */
104                 id_us_min(&cache_file->id);
105
106                 PointerRNA idptr;
107                 RNA_id_pointer_create(&cache_file->id, &idptr);
108                 RNA_property_pointer_set(&pprop->ptr, pprop->prop, idptr);
109                 RNA_property_update(C, &pprop->ptr, pprop->prop);
110         }
111
112         MEM_freeN(op->customdata);
113
114         return OPERATOR_FINISHED;
115 }
116
117 void CACHEFILE_OT_open(wmOperatorType *ot)
118 {
119         ot->name = "Open Cache File";
120         ot->description = "Load a cache file";
121         ot->idname = "CACHEFILE_OT_open";
122
123         ot->invoke = cachefile_open_invoke;
124         ot->exec = cachefile_open_exec;
125         ot->cancel = open_cancel;
126
127         WM_operator_properties_filesel(ot, FILE_TYPE_ALEMBIC | FILE_TYPE_FOLDER,
128                                        FILE_BLENDER, FILE_SAVE, WM_FILESEL_FILEPATH,
129                                        FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
130 }
131
132 /* ***************************** Reload Operator **************************** */
133
134 static int cachefile_reload_exec(bContext *C, wmOperator *op)
135 {
136         CacheFile *cache_file = CTX_data_edit_cachefile(C);
137
138         if (!cache_file) {
139                 return OPERATOR_CANCELLED;
140         }
141
142         Main *bmain = CTX_data_main(C);
143
144         BLI_listbase_clear(&cache_file->object_paths);
145         BKE_cachefile_reload(bmain, cache_file);
146
147         return OPERATOR_FINISHED;
148
149         UNUSED_VARS(op);
150 }
151
152 void CACHEFILE_OT_reload(wmOperatorType *ot)
153 {
154         ot->name = "Refresh Archive";
155         ot->description = "Update objects paths list with new data from the archive";
156         ot->idname = "CACHEFILE_OT_reload";
157
158         /* api callbacks */
159         ot->exec = cachefile_reload_exec;
160
161         /* flags */
162         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
163 }