Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenloader / intern / readblenentry.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) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  * .blend file reading entry point
19  */
20
21 /** \file \ingroup blenloader
22  */
23
24
25 #include <stddef.h>
26
27 #include <stdlib.h>
28 #include <string.h>
29 #include <stdio.h>
30 #include <math.h>
31
32 #include "MEM_guardedalloc.h"
33
34 #include "BLI_utildefines.h"
35 #include "BLI_ghash.h"
36 #include "BLI_linklist.h"
37 #include "BLI_listbase.h"
38 #include "BLI_string.h"
39
40 #include "DNA_genfile.h"
41 #include "DNA_sdna_types.h"
42
43
44 #include "BKE_main.h"
45 #include "BKE_idcode.h"
46
47 #include "BLO_readfile.h"
48 #include "BLO_undofile.h"
49 #include "BLO_blend_defs.h"
50
51 #include "readfile.h"
52
53 #include "BLI_sys_types.h" // needed for intptr_t
54
55 #ifdef WIN32
56 #  include "BLI_winstuff.h"
57 #endif
58
59 /* local prototypes --------------------- */
60 void BLO_blendhandle_print_sizes(BlendHandle *, void *);
61
62 /* Access routines used by filesel. */
63
64 /**
65  * Open a blendhandle from a file path.
66  *
67  * \param filepath: The file path to open.
68  * \param reports: Report errors in opening the file (can be NULL).
69  * \return A handle on success, or NULL on failure.
70  */
71 BlendHandle *BLO_blendhandle_from_file(const char *filepath, ReportList *reports)
72 {
73         BlendHandle *bh;
74
75         bh = (BlendHandle *)blo_openblenderfile(filepath, reports);
76
77         return bh;
78 }
79
80 /**
81  * Open a blendhandle from memory.
82  *
83  * \param mem: The data to load from.
84  * \param memsize: The size of the data.
85  * \return A handle on success, or NULL on failure.
86  */
87 BlendHandle *BLO_blendhandle_from_memory(const void *mem, int memsize)
88 {
89         BlendHandle *bh;
90
91         bh = (BlendHandle *)blo_openblendermemory(mem, memsize, NULL);
92
93         return bh;
94 }
95
96 void BLO_blendhandle_print_sizes(BlendHandle *bh, void *fp)
97 {
98         FileData *fd = (FileData *)bh;
99         BHead *bhead;
100
101         fprintf(fp, "[\n");
102         for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
103                 if (bhead->code == ENDB)
104                         break;
105                 else {
106                         const short *sp = fd->filesdna->structs[bhead->SDNAnr];
107                         const char *name = fd->filesdna->types[sp[0]];
108                         char buf[4];
109
110                         buf[0] = (bhead->code >> 24) & 0xFF;
111                         buf[1] = (bhead->code >> 16) & 0xFF;
112                         buf[2] = (bhead->code >> 8) & 0xFF;
113                         buf[3] = (bhead->code >> 0) & 0xFF;
114
115                         buf[0] = buf[0] ? buf[0] : ' ';
116                         buf[1] = buf[1] ? buf[1] : ' ';
117                         buf[2] = buf[2] ? buf[2] : ' ';
118                         buf[3] = buf[3] ? buf[3] : ' ';
119
120                         fprintf(fp, "['%.4s', '%s', %d, %ld ],\n", buf, name, bhead->nr, (long int)(bhead->len + sizeof(BHead)));
121                 }
122         }
123         fprintf(fp, "]\n");
124 }
125
126 /**
127  * Gets the names of all the datablocks in a file of a certain type (e.g. all the scene names in a file).
128  *
129  * \param bh: The blendhandle to access.
130  * \param ofblocktype: The type of names to get.
131  * \param tot_names: The length of the returned list.
132  * \return A BLI_linklist of strings. The string links should be freed with malloc.
133  */
134 LinkNode *BLO_blendhandle_get_datablock_names(BlendHandle *bh, int ofblocktype, int *tot_names)
135 {
136         FileData *fd = (FileData *)bh;
137         LinkNode *names = NULL;
138         BHead *bhead;
139         int tot = 0;
140
141         for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
142                 if (bhead->code == ofblocktype) {
143                         const char *idname = bhead_id_name(fd, bhead);
144
145                         BLI_linklist_prepend(&names, strdup(idname + 2));
146                         tot++;
147                 }
148                 else if (bhead->code == ENDB)
149                         break;
150         }
151
152         *tot_names = tot;
153         return names;
154 }
155
156 /**
157  * Gets the previews of all the datablocks in a file of a certain type (e.g. all the scene previews in a file).
158  *
159  * \param bh: The blendhandle to access.
160  * \param ofblocktype: The type of names to get.
161  * \param tot_prev: The length of the returned list.
162  * \return A BLI_linklist of PreviewImage. The PreviewImage links should be freed with malloc.
163  */
164 LinkNode *BLO_blendhandle_get_previews(BlendHandle *bh, int ofblocktype, int *tot_prev)
165 {
166         FileData *fd = (FileData *)bh;
167         LinkNode *previews = NULL;
168         BHead *bhead;
169         int looking = 0;
170         PreviewImage *prv = NULL;
171         PreviewImage *new_prv = NULL;
172         int tot = 0;
173
174         for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
175                 if (bhead->code == ofblocktype) {
176                         const char *idname = bhead_id_name(fd, bhead);
177                         switch (GS(idname)) {
178                                 case ID_MA: /* fall through */
179                                 case ID_TE: /* fall through */
180                                 case ID_IM: /* fall through */
181                                 case ID_WO: /* fall through */
182                                 case ID_LA: /* fall through */
183                                 case ID_OB: /* fall through */
184                                 case ID_GR: /* fall through */
185                                 case ID_SCE: /* fall through */
186                                         new_prv = MEM_callocN(sizeof(PreviewImage), "newpreview");
187                                         BLI_linklist_prepend(&previews, new_prv);
188                                         tot++;
189                                         looking = 1;
190                                         break;
191                                 default:
192                                         break;
193                         }
194                 }
195                 else if (bhead->code == DATA) {
196                         if (looking) {
197                                 if (bhead->SDNAnr == DNA_struct_find_nr(fd->filesdna, "PreviewImage") ) {
198                                         prv = BLO_library_read_struct(fd, bhead, "PreviewImage");
199                                         if (prv) {
200                                                 memcpy(new_prv, prv, sizeof(PreviewImage));
201                                                 if (prv->rect[0] && prv->w[0] && prv->h[0]) {
202                                                         uint *rect = NULL;
203                                                         size_t len = new_prv->w[0] * new_prv->h[0] * sizeof(uint);
204                                                         new_prv->rect[0] = MEM_callocN(len, __func__);
205                                                         bhead = blo_nextbhead(fd, bhead);
206                                                         rect = (uint *)(bhead + 1);
207                                                         BLI_assert(len == bhead->len);
208                                                         memcpy(new_prv->rect[0], rect, len);
209                                                 }
210                                                 else {
211                                                         /* This should not be needed, but can happen in 'broken' .blend files,
212                                                          * better handle this gracefully than crashing. */
213                                                         BLI_assert(prv->rect[0] == NULL && prv->w[0] == 0 && prv->h[0] == 0);
214                                                         new_prv->rect[0] = NULL;
215                                                         new_prv->w[0] = new_prv->h[0] = 0;
216                                                 }
217
218                                                 if (prv->rect[1] && prv->w[1] && prv->h[1]) {
219                                                         uint *rect = NULL;
220                                                         size_t len = new_prv->w[1] * new_prv->h[1] * sizeof(uint);
221                                                         new_prv->rect[1] = MEM_callocN(len, __func__);
222                                                         bhead = blo_nextbhead(fd, bhead);
223                                                         rect = (uint *)(bhead + 1);
224                                                         BLI_assert(len == bhead->len);
225                                                         memcpy(new_prv->rect[1], rect, len);
226                                                 }
227                                                 else {
228                                                         /* This should not be needed, but can happen in 'broken' .blend files,
229                                                          * better handle this gracefully than crashing. */
230                                                         BLI_assert(prv->rect[1] == NULL && prv->w[1] == 0 && prv->h[1] == 0);
231                                                         new_prv->rect[1] = NULL;
232                                                         new_prv->w[1] = new_prv->h[1] = 0;
233                                                 }
234                                                 MEM_freeN(prv);
235                                         }
236                                 }
237                         }
238                 }
239                 else if (bhead->code == ENDB) {
240                         break;
241                 }
242                 else {
243                         looking = 0;
244                         new_prv = NULL;
245                         prv = NULL;
246                 }
247
248         }
249
250         *tot_prev = tot;
251         return previews;
252 }
253
254 /**
255  * Gets the names of all the linkable datablock types available in a file. (e.g. "Scene", "Mesh", "Lamp", etc.).
256  *
257  * \param bh: The blendhandle to access.
258  * \return A BLI_linklist of strings. The string links should be freed with malloc.
259  */
260 LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh)
261 {
262         FileData *fd = (FileData *)bh;
263         GSet *gathered = BLI_gset_ptr_new("linkable_groups gh");
264         LinkNode *names = NULL;
265         BHead *bhead;
266
267         for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
268                 if (bhead->code == ENDB) {
269                         break;
270                 }
271                 else if (BKE_idcode_is_valid(bhead->code)) {
272                         if (BKE_idcode_is_linkable(bhead->code)) {
273                                 const char *str = BKE_idcode_to_name(bhead->code);
274
275                                 if (BLI_gset_add(gathered, (void *)str)) {
276                                         BLI_linklist_prepend(&names, strdup(str));
277                                 }
278                         }
279                 }
280         }
281
282         BLI_gset_free(gathered, NULL);
283
284         return names;
285 }
286
287 /**
288  * Close and free a blendhandle. The handle becomes invalid after this call.
289  *
290  * \param bh: The handle to close.
291  */
292 void BLO_blendhandle_close(BlendHandle *bh)
293 {
294         FileData *fd = (FileData *)bh;
295
296         blo_freefiledata(fd);
297 }
298
299 /**********/
300
301 /**
302  * Open a blender file from a pathname. The function returns NULL
303  * and sets a report in the list if it cannot open the file.
304  *
305  * \param filepath: The path of the file to open.
306  * \param reports: If the return value is NULL, errors indicating the cause of the failure.
307  * \return The data of the file.
308  */
309 BlendFileData *BLO_read_from_file(
310         const char *filepath,
311         eBLOReadSkip skip_flags,
312         ReportList *reports)
313 {
314         BlendFileData *bfd = NULL;
315         FileData *fd;
316
317         fd = blo_openblenderfile(filepath, reports);
318         if (fd) {
319                 fd->reports = reports;
320                 fd->skip_flags = skip_flags;
321                 bfd = blo_read_file_internal(fd, filepath);
322                 blo_freefiledata(fd);
323         }
324
325         return bfd;
326 }
327
328 /**
329  * Open a blender file from memory. The function returns NULL
330  * and sets a report in the list if it cannot open the file.
331  *
332  * \param mem: The file data.
333  * \param memsize: The length of \a mem.
334  * \param reports: If the return value is NULL, errors indicating the cause of the failure.
335  * \return The data of the file.
336  */
337 BlendFileData *BLO_read_from_memory(
338         const void *mem, int memsize,
339         eBLOReadSkip skip_flags,
340         ReportList *reports)
341 {
342         BlendFileData *bfd = NULL;
343         FileData *fd;
344
345         fd = blo_openblendermemory(mem, memsize,  reports);
346         if (fd) {
347                 fd->reports = reports;
348                 fd->skip_flags = skip_flags;
349                 bfd = blo_read_file_internal(fd, "");
350                 blo_freefiledata(fd);
351         }
352
353         return bfd;
354 }
355
356 /**
357  * Used for undo/redo, skips part of libraries reading (assuming their data are already loaded & valid).
358  *
359  * \param oldmain: old main, from which we will keep libraries and other datablocks that should not have changed.
360  * \param filename: current file, only for retrieving library data.
361  */
362 BlendFileData *BLO_read_from_memfile(
363         Main *oldmain, const char *filename, MemFile *memfile,
364         eBLOReadSkip skip_flags,
365         ReportList *reports)
366 {
367         BlendFileData *bfd = NULL;
368         FileData *fd;
369         ListBase old_mainlist;
370
371         fd = blo_openblendermemfile(memfile, reports);
372         if (fd) {
373                 fd->reports = reports;
374                 fd->skip_flags = skip_flags;
375                 BLI_strncpy(fd->relabase, filename, sizeof(fd->relabase));
376
377                 /* clear ob->proxy_from pointers in old main */
378                 blo_clear_proxy_pointers_from_lib(oldmain);
379
380                 /* separate libraries from old main */
381                 blo_split_main(&old_mainlist, oldmain);
382                 /* add the library pointers in oldmap lookup */
383                 blo_add_library_pointer_map(&old_mainlist, fd);
384
385                 /* makes lookup of existing images in old main */
386                 blo_make_image_pointer_map(fd, oldmain);
387
388                 /* makes lookup of existing light caches in old main */
389                 blo_make_scene_pointer_map(fd, oldmain);
390
391                 /* makes lookup of existing video clips in old main */
392                 blo_make_movieclip_pointer_map(fd, oldmain);
393
394                 /* make lookups of existing sound data in old main */
395                 blo_make_sound_pointer_map(fd, oldmain);
396
397                 /* removed packed data from this trick - it's internal data that needs saves */
398
399                 bfd = blo_read_file_internal(fd, filename);
400
401                 /* ensures relinked light caches are not freed */
402                 blo_end_scene_pointer_map(fd, oldmain);
403
404                 /* ensures relinked images are not freed */
405                 blo_end_image_pointer_map(fd, oldmain);
406
407                 /* ensures relinked movie clips are not freed */
408                 blo_end_movieclip_pointer_map(fd, oldmain);
409
410                 /* ensures relinked sounds are not freed */
411                 blo_end_sound_pointer_map(fd, oldmain);
412
413                 /* Still in-use libraries have already been moved from oldmain to new mainlist,
414                  * but oldmain itself shall *never* be 'transferred' to new mainlist! */
415                 BLI_assert(old_mainlist.first == oldmain);
416
417                 if (bfd && old_mainlist.first != old_mainlist.last) {
418                         /* Even though directly used libs have been already moved to new main, indirect ones have not.
419                          * This is a bit annoying, but we have no choice but to keep them all for now - means some now unused
420                          * data may remain in memory, but think we'll have to live with it. */
421                         Main *libmain, *libmain_next;
422                         Main *newmain = bfd->main;
423                         ListBase new_mainlist = {newmain, newmain};
424
425                         for (libmain = oldmain->next; libmain; libmain = libmain_next) {
426                                 libmain_next = libmain->next;
427                                 /* Note that LIB_INDIRECT does not work with libraries themselves, so we use non-NULL parent
428                                  * to detect indirect-linked ones... */
429                                 if (libmain->curlib && (libmain->curlib->parent != NULL)) {
430                                         BLI_remlink(&old_mainlist, libmain);
431                                         BLI_addtail(&new_mainlist, libmain);
432                                 }
433                                 else {
434 #ifdef PRINT_DEBUG
435                                         printf("Dropped Main for lib: %s\n", libmain->curlib->id.name);
436 #endif
437                                 }
438                         }
439                         /* In any case, we need to move all lib datablocks themselves - those are 'first level data',
440                          * getting rid of them would imply updating spaces & co to prevent invalid pointers access. */
441                         BLI_movelisttolist(&newmain->library, &oldmain->library);
442
443                         blo_join_main(&new_mainlist);
444                 }
445
446                 /* printf("Remaining mains/libs in oldmain: %d\n", BLI_listbase_count(&fd->old_mainlist) - 1); */
447
448                 /* That way, libs (aka mains) we did not reuse in new undone/redone state
449                  * will be cleared together with oldmain... */
450                 blo_join_main(&old_mainlist);
451
452                 blo_freefiledata(fd);
453         }
454
455         return bfd;
456 }
457
458 /**
459  * Frees a BlendFileData structure and *all* the data associated with it (the userdef data, and the main libblock data).
460  *
461  * \param bfd: The structure to free.
462  */
463 void BLO_blendfiledata_free(BlendFileData *bfd)
464 {
465         if (bfd->main) {
466                 BKE_main_free(bfd->main);
467         }
468
469         if (bfd->user) {
470                 MEM_freeN(bfd->user);
471         }
472
473         MEM_freeN(bfd);
474 }