Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenloader / intern / readfile.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  *
26  */
27
28 /** \file blender/blenloader/intern/readfile.c
29  *  \ingroup blenloader
30  */
31
32
33 #include "zlib.h"
34
35 #include <limits.h>
36 #include <stdio.h> // for printf fopen fwrite fclose sprintf FILE
37 #include <stdlib.h> // for getenv atoi
38 #include <stddef.h> // for offsetof
39 #include <fcntl.h> // for open
40 #include <string.h> // for strrchr strncmp strstr
41 #include <math.h> // for fabs
42 #include <stdarg.h> /* for va_start/end */
43 #include <time.h> /* for gmtime */
44
45 #include "BLI_utildefines.h"
46 #ifndef WIN32
47 #  include <unistd.h> // for read close
48 #else
49 #  include <io.h> // for open close read
50 #  include "winsock2.h"
51 #  include "BLI_winstuff.h"
52 #endif
53
54 /* allow readfile to use deprecated functionality */
55 #define DNA_DEPRECATED_ALLOW
56
57 #include "DNA_anim_types.h"
58 #include "DNA_armature_types.h"
59 #include "DNA_actuator_types.h"
60 #include "DNA_brush_types.h"
61 #include "DNA_camera_types.h"
62 #include "DNA_cloth_types.h"
63 #include "DNA_controller_types.h"
64 #include "DNA_constraint_types.h"
65 #include "DNA_dynamicpaint_types.h"
66 #include "DNA_effect_types.h"
67 #include "DNA_fileglobal_types.h"
68 #include "DNA_genfile.h"
69 #include "DNA_group_types.h"
70 #include "DNA_gpencil_types.h"
71 #include "DNA_ipo_types.h"
72 #include "DNA_key_types.h"
73 #include "DNA_lattice_types.h"
74 #include "DNA_lamp_types.h"
75 #include "DNA_linestyle_types.h"
76 #include "DNA_meta_types.h"
77 #include "DNA_material_types.h"
78 #include "DNA_mesh_types.h"
79 #include "DNA_meshdata_types.h"
80 #include "DNA_nla_types.h"
81 #include "DNA_node_types.h"
82 #include "DNA_object_fluidsim.h" // NT
83 #include "DNA_object_force.h"
84 #include "DNA_object_types.h"
85 #include "DNA_packedFile_types.h"
86 #include "DNA_property_types.h"
87 #include "DNA_rigidbody_types.h"
88 #include "DNA_text_types.h"
89 #include "DNA_view3d_types.h"
90 #include "DNA_screen_types.h"
91 #include "DNA_sensor_types.h"
92 #include "DNA_sdna_types.h"
93 #include "DNA_scene_types.h"
94 #include "DNA_sequence_types.h"
95 #include "DNA_smoke_types.h"
96 #include "DNA_speaker_types.h"
97 #include "DNA_sound_types.h"
98 #include "DNA_space_types.h"
99 #include "DNA_vfont_types.h"
100 #include "DNA_world_types.h"
101 #include "DNA_movieclip_types.h"
102 #include "DNA_mask_types.h"
103
104 #include "MEM_guardedalloc.h"
105
106 #include "BLI_endian_switch.h"
107 #include "BLI_blenlib.h"
108 #include "BLI_math.h"
109 #include "BLI_threads.h"
110 #include "BLI_mempool.h"
111
112 #include "BLT_translation.h"
113
114 #include "BKE_action.h"
115 #include "BKE_armature.h"
116 #include "BKE_brush.h"
117 #include "BKE_cloth.h"
118 #include "BKE_constraint.h"
119 #include "BKE_context.h"
120 #include "BKE_curve.h"
121 #include "BKE_depsgraph.h"
122 #include "BKE_effect.h"
123 #include "BKE_fcurve.h"
124 #include "BKE_global.h" // for G
125 #include "BKE_group.h"
126 #include "BKE_library.h" // for which_libbase
127 #include "BKE_library_idmap.h"
128 #include "BKE_library_query.h"
129 #include "BKE_idcode.h"
130 #include "BKE_material.h"
131 #include "BKE_main.h" // for Main
132 #include "BKE_mesh.h" // for ME_ defines (patching)
133 #include "BKE_modifier.h"
134 #include "BKE_multires.h"
135 #include "BKE_node.h" // for tree type defines
136 #include "BKE_object.h"
137 #include "BKE_paint.h"
138 #include "BKE_report.h"
139 #include "BKE_sca.h" // for init_actuator
140 #include "BKE_scene.h"
141 #include "BKE_screen.h"
142 #include "BKE_sequencer.h"
143 #include "BKE_outliner_treehash.h"
144 #include "BKE_sound.h"
145
146
147 #include "NOD_common.h"
148 #include "NOD_socket.h"
149
150 #include "BLO_readfile.h"
151 #include "BLO_undofile.h"
152 #include "BLO_blend_defs.h"
153
154 #include "RE_engine.h"
155
156 #include "readfile.h"
157
158
159 #include <errno.h>
160
161 /**
162  * READ
163  * ====
164  *
165  * - Existing Library (#Main) push or free
166  * - allocate new #Main
167  * - load file
168  * - read #SDNA
169  * - for each LibBlock
170  *   - read LibBlock
171  *   - if a Library
172  *     - make a new #Main
173  *     - attach ID's to it
174  *   - else
175  *     - read associated 'direct data'
176  *     - link direct data (internal and to LibBlock)
177  * - read #FileGlobal
178  * - read #USER data, only when indicated (file is ``~/X.XX/startup.blend``)
179  * - free file
180  * - per Library (per #Main)
181  *   - read file
182  *   - read #SDNA
183  *   - find LibBlocks and attach #ID's to #Main
184  *     - if external LibBlock
185  *       - search all #Main's
186  *         - or it's already read,
187  *         - or not read yet
188  *         - or make new #Main
189  *   - per LibBlock
190  *     - read recursive
191  *     - read associated direct data
192  *     - link direct data (internal and to LibBlock)
193  *   - free file
194  * - per Library with unread LibBlocks
195  *   - read file
196  *   - read #SDNA
197  *   - per LibBlock
198  *     - read recursive
199  *     - read associated direct data
200  *     - link direct data (internal and to LibBlock)
201  *   - free file
202  * - join all #Main's
203  * - link all LibBlocks and indirect pointers to libblocks
204  * - initialize #FileGlobal and copy pointers to #Global
205  *
206  * \note Still a weak point is the new-address function, that doesnt solve reading from
207  * multiple files at the same time.
208  * (added remark: oh, i thought that was solved? will look at that... (ton).
209  */
210
211 /* use GHash for BHead name-based lookups (speeds up linking) */
212 #define USE_GHASH_BHEAD
213
214 /* Use GHash for restoring pointers by name */
215 #define USE_GHASH_RESTORE_POINTER
216
217 /***/
218
219 typedef struct OldNew {
220         const void *old;
221         void *newp;
222         int nr;
223 } OldNew;
224
225 typedef struct OldNewMap {
226         OldNew *entries;
227         int nentries, entriessize;
228         bool sorted;
229         int lasthit;
230 } OldNewMap;
231
232
233 /* local prototypes */
234 static void *read_struct(FileData *fd, BHead *bh, const char *blockname);
235 static void direct_link_modifiers(FileData *fd, ListBase *lb);
236 static void convert_tface_mt(FileData *fd, Main *main);
237 static BHead *find_bhead_from_code_name(FileData *fd, const short idcode, const char *name);
238 static BHead *find_bhead_from_idname(FileData *fd, const char *idname);
239
240 /* this function ensures that reports are printed,
241  * in the case of libraray linking errors this is important!
242  *
243  * bit kludge but better then doubling up on prints,
244  * we could alternatively have a versions of a report function which forces printing - campbell
245  */
246
247 void blo_reportf_wrap(ReportList *reports, ReportType type, const char *format, ...)
248 {
249         char fixed_buf[1024]; /* should be long enough */
250         
251         va_list args;
252         
253         va_start(args, format);
254         vsnprintf(fixed_buf, sizeof(fixed_buf), format, args);
255         va_end(args);
256         
257         fixed_buf[sizeof(fixed_buf) - 1] = '\0';
258         
259         BKE_report(reports, type, fixed_buf);
260         
261         if (G.background == 0) {
262                 printf("%s: %s\n", BKE_report_type_str(type), fixed_buf);
263         }
264 }
265
266 /* for reporting linking messages */
267 static const char *library_parent_filepath(Library *lib)
268 {
269         return lib->parent ? lib->parent->filepath : "<direct>";
270 }
271
272 static OldNewMap *oldnewmap_new(void) 
273 {
274         OldNewMap *onm= MEM_callocN(sizeof(*onm), "OldNewMap");
275         
276         onm->entriessize = 1024;
277         onm->entries = MEM_mallocN(sizeof(*onm->entries)*onm->entriessize, "OldNewMap.entries");
278         
279         return onm;
280 }
281
282 static int verg_oldnewmap(const void *v1, const void *v2)
283 {
284         const struct OldNew *x1=v1, *x2=v2;
285         
286         if (x1->old > x2->old) return 1;
287         else if (x1->old < x2->old) return -1;
288         return 0;
289 }
290
291
292 static void oldnewmap_sort(FileData *fd) 
293 {
294         BLI_assert(fd->libmap->sorted == false);
295         qsort(fd->libmap->entries, fd->libmap->nentries, sizeof(OldNew), verg_oldnewmap);
296         fd->libmap->sorted = 1;
297 }
298
299 /* nr is zero for data, and ID code for libdata */
300 static void oldnewmap_insert(OldNewMap *onm, const void *oldaddr, void *newaddr, int nr)
301 {
302         OldNew *entry;
303         
304         if (oldaddr==NULL || newaddr==NULL) return;
305         
306         if (UNLIKELY(onm->nentries == onm->entriessize)) {
307                 onm->entriessize *= 2;
308                 onm->entries = MEM_reallocN(onm->entries, sizeof(*onm->entries) * onm->entriessize);
309         }
310
311         entry = &onm->entries[onm->nentries++];
312         entry->old = oldaddr;
313         entry->newp = newaddr;
314         entry->nr = nr;
315 }
316
317 void blo_do_versions_oldnewmap_insert(OldNewMap *onm, const void *oldaddr, void *newaddr, int nr)
318 {
319         oldnewmap_insert(onm, oldaddr, newaddr, nr);
320 }
321
322 /**
323  * Do a full search (no state).
324  *
325  * \param lasthit: Use as a reference position to avoid a full search
326  * from either end of the array, giving more efficient lookups.
327  *
328  * \note This would seem an ideal case for hash or btree lookups.
329  * However the data is written in-order, using the \a lasthit will normally avoid calling this function.
330  * Creating a btree/hash structure adds overhead for the common-case to optimize the corner-case
331  * (since most entries will never be retrieved).
332  * So just keep full lookups as a fall-back.
333  */
334 static int oldnewmap_lookup_entry_full(const OldNewMap *onm, const void *addr, int lasthit)
335 {
336         const int nentries = onm->nentries;
337         const OldNew *entries = onm->entries;
338         int i;
339
340         /* search relative to lasthit where possible */
341         if (lasthit >= 0 && lasthit < nentries) {
342
343                 /* search forwards */
344                 i = lasthit;
345                 while (++i != nentries) {
346                         if (entries[i].old == addr) {
347                                 return i;
348                         }
349                 }
350
351                 /* search backwards */
352                 i = lasthit + 1;
353                 while (i--) {
354                         if (entries[i].old == addr) {
355                                 return i;
356                         }
357                 }
358         }
359         else {
360                 /* search backwards (full) */
361                 i = nentries;
362                 while (i--) {
363                         if (entries[i].old == addr) {
364                                 return i;
365                         }
366                 }
367         }
368
369         return -1;
370 }
371
372 static void *oldnewmap_lookup_and_inc(OldNewMap *onm, const void *addr, bool increase_users)
373 {
374         int i;
375         
376         if (addr == NULL) return NULL;
377         
378         if (onm->lasthit < onm->nentries-1) {
379                 OldNew *entry = &onm->entries[++onm->lasthit];
380                 
381                 if (entry->old == addr) {
382                         if (increase_users)
383                                 entry->nr++;
384                         return entry->newp;
385                 }
386         }
387         
388         i = oldnewmap_lookup_entry_full(onm, addr, onm->lasthit);
389         if (i != -1) {
390                 OldNew *entry = &onm->entries[i];
391                 BLI_assert(entry->old == addr);
392                 onm->lasthit = i;
393                 if (increase_users)
394                         entry->nr++;
395                 return entry->newp;
396         }
397         
398         return NULL;
399 }
400
401 /* for libdata, nr has ID code, no increment */
402 static void *oldnewmap_liblookup(OldNewMap *onm, const void *addr, const void *lib)
403 {
404         if (addr == NULL) {
405                 return NULL;
406         }
407
408         /* lasthit works fine for non-libdata, linking there is done in same sequence as writing */
409         if (onm->sorted) {
410                 const OldNew entry_s = {.old = addr};
411                 OldNew *entry = bsearch(&entry_s, onm->entries, onm->nentries, sizeof(OldNew), verg_oldnewmap);
412                 if (entry) {
413                         ID *id = entry->newp;
414
415                         if (id && (!lib || id->lib)) {
416                                 return id;
417                         }
418                 }
419         }
420         else {
421                 /* note, this can be a bottle neck when loading some files */
422                 const int i = oldnewmap_lookup_entry_full(onm, addr, -1);
423                 if (i != -1) {
424                         OldNew *entry = &onm->entries[i];
425                         ID *id = entry->newp;
426                         BLI_assert(entry->old == addr);
427                         if (id && (!lib || id->lib)) {
428                                 return id;
429                         }
430                 }
431         }
432
433         return NULL;
434 }
435
436 static void oldnewmap_free_unused(OldNewMap *onm) 
437 {
438         int i;
439
440         for (i = 0; i < onm->nentries; i++) {
441                 OldNew *entry = &onm->entries[i];
442                 if (entry->nr == 0) {
443                         MEM_freeN(entry->newp);
444                         entry->newp = NULL;
445                 }
446         }
447 }
448
449 static void oldnewmap_clear(OldNewMap *onm) 
450 {
451         onm->nentries = 0;
452         onm->lasthit = 0;
453 }
454
455 static void oldnewmap_free(OldNewMap *onm) 
456 {
457         MEM_freeN(onm->entries);
458         MEM_freeN(onm);
459 }
460
461 /***/
462
463 static void read_libraries(FileData *basefd, ListBase *mainlist);
464
465 /* ************ help functions ***************** */
466
467 static void add_main_to_main(Main *mainvar, Main *from)
468 {
469         ListBase *lbarray[MAX_LIBARRAY], *fromarray[MAX_LIBARRAY];
470         int a;
471         
472         set_listbasepointers(mainvar, lbarray);
473         a = set_listbasepointers(from, fromarray);
474         while (a--) {
475                 BLI_movelisttolist(lbarray[a], fromarray[a]);
476         }
477 }
478
479 void blo_join_main(ListBase *mainlist)
480 {
481         Main *tojoin, *mainl;
482         
483         mainl = mainlist->first;
484         while ((tojoin = mainl->next)) {
485                 add_main_to_main(mainl, tojoin);
486                 BLI_remlink(mainlist, tojoin);
487                 BKE_main_free(tojoin);
488         }
489 }
490
491 static void split_libdata(ListBase *lb_src, Main **lib_main_array, const unsigned int lib_main_array_len)
492 {
493         for (ID *id = lb_src->first, *idnext; id; id = idnext) {
494                 idnext = id->next;
495
496                 if (id->lib) {
497                         if (((unsigned int)id->lib->temp_index < lib_main_array_len) &&
498                             /* this check should never fail, just incase 'id->lib' is a dangling pointer. */
499                             (lib_main_array[id->lib->temp_index]->curlib == id->lib))
500                         {
501                                 Main *mainvar = lib_main_array[id->lib->temp_index];
502                                 ListBase *lb_dst = which_libbase(mainvar, GS(id->name));
503                                 BLI_remlink(lb_src, id);
504                                 BLI_addtail(lb_dst, id);
505                         }
506                         else {
507                                 printf("%s: invalid library for '%s'\n", __func__, id->name);
508                                 BLI_assert(0);
509                         }
510                 }
511         }
512 }
513
514 void blo_split_main(ListBase *mainlist, Main *main)
515 {
516         mainlist->first = mainlist->last = main;
517         main->next = NULL;
518         
519         if (BLI_listbase_is_empty(&main->library))
520                 return;
521         
522         /* (Library.temp_index -> Main), lookup table */
523         const unsigned int lib_main_array_len = BLI_listbase_count(&main->library);
524         Main             **lib_main_array     = MEM_mallocN(lib_main_array_len * sizeof(*lib_main_array), __func__);
525
526         int i = 0;
527         for (Library *lib = main->library.first; lib; lib = lib->id.next, i++) {
528                 Main *libmain = BKE_main_new();
529                 libmain->curlib = lib;
530                 BLI_addtail(mainlist, libmain);
531                 lib->temp_index = i;
532                 lib_main_array[i] = libmain;
533         }
534         
535         ListBase *lbarray[MAX_LIBARRAY];
536         i = set_listbasepointers(main, lbarray);
537         while (i--) {
538                 split_libdata(lbarray[i], lib_main_array, lib_main_array_len);
539         }
540
541         MEM_freeN(lib_main_array);
542 }
543
544 static void read_file_version(FileData *fd, Main *main)
545 {
546         BHead *bhead;
547         
548         for (bhead= blo_firstbhead(fd); bhead; bhead= blo_nextbhead(fd, bhead)) {
549                 if (bhead->code == GLOB) {
550                         FileGlobal *fg= read_struct(fd, bhead, "Global");
551                         if (fg) {
552                                 main->subversionfile= fg->subversion;
553                                 main->minversionfile= fg->minversion;
554                                 main->minsubversionfile= fg->minsubversion;
555                                 MEM_freeN(fg);
556                         }
557                         else if (bhead->code == ENDB)
558                                 break;
559                 }
560         }
561 }
562
563 #ifdef USE_GHASH_BHEAD
564 static void read_file_bhead_idname_map_create(FileData *fd)
565 {
566         BHead *bhead;
567
568         /* dummy values */
569         bool is_link = false;
570         int code_prev = ENDB;
571         unsigned int reserve = 0;
572
573         for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
574                 if (code_prev != bhead->code) {
575                         code_prev = bhead->code;
576                         is_link = BKE_idcode_is_valid(code_prev) ? BKE_idcode_is_linkable(code_prev) : false;
577                 }
578
579                 if (is_link) {
580                         reserve += 1;
581                 }
582         }
583
584         BLI_assert(fd->bhead_idname_hash == NULL);
585
586         fd->bhead_idname_hash = BLI_ghash_str_new_ex(__func__, reserve);
587
588         for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
589                 if (code_prev != bhead->code) {
590                         code_prev = bhead->code;
591                         is_link = BKE_idcode_is_valid(code_prev) ? BKE_idcode_is_linkable(code_prev) : false;
592                 }
593
594                 if (is_link) {
595                         BLI_ghash_insert(fd->bhead_idname_hash, (void *)bhead_id_name(fd, bhead), bhead);
596                 }
597         }
598 }
599 #endif
600
601
602 static Main *blo_find_main(FileData *fd, const char *filepath, const char *relabase)
603 {
604         ListBase *mainlist = fd->mainlist;
605         Main *m;
606         Library *lib;
607         char name1[FILE_MAX];
608         
609         BLI_strncpy(name1, filepath, sizeof(name1));
610         BLI_cleanup_path(relabase, name1);
611         
612 //      printf("blo_find_main: relabase  %s\n", relabase);
613 //      printf("blo_find_main: original in  %s\n", filepath);
614 //      printf("blo_find_main: converted to %s\n", name1);
615         
616         for (m = mainlist->first; m; m = m->next) {
617                 const char *libname = (m->curlib) ? m->curlib->filepath : m->name;
618                 
619                 if (BLI_path_cmp(name1, libname) == 0) {
620                         if (G.debug & G_DEBUG) printf("blo_find_main: found library %s\n", libname);
621                         return m;
622                 }
623         }
624         
625         m = BKE_main_new();
626         BLI_addtail(mainlist, m);
627         
628         /* Add library datablock itself to 'main' Main, since libraries are **never** linked data.
629          * Fixes bug where you could end with all ID_LI datablocks having the same name... */
630         lib = BKE_libblock_alloc(mainlist->first, ID_LI, "Lib");
631         lib->id.us = ID_FAKE_USERS(lib);  /* Important, consistency with main ID reading code from read_libblock(). */
632         BLI_strncpy(lib->name, filepath, sizeof(lib->name));
633         BLI_strncpy(lib->filepath, name1, sizeof(lib->filepath));
634         
635         m->curlib = lib;
636         
637         read_file_version(fd, m);
638         
639         if (G.debug & G_DEBUG) printf("blo_find_main: added new lib %s\n", filepath);
640         return m;
641 }
642
643
644 /* ************ FILE PARSING ****************** */
645
646 static void switch_endian_bh4(BHead4 *bhead)
647 {
648         /* the ID_.. codes */
649         if ((bhead->code & 0xFFFF)==0) bhead->code >>= 16;
650         
651         if (bhead->code != ENDB) {
652                 BLI_endian_switch_int32(&bhead->len);
653                 BLI_endian_switch_int32(&bhead->SDNAnr);
654                 BLI_endian_switch_int32(&bhead->nr);
655         }
656 }
657
658 static void switch_endian_bh8(BHead8 *bhead)
659 {
660         /* the ID_.. codes */
661         if ((bhead->code & 0xFFFF)==0) bhead->code >>= 16;
662         
663         if (bhead->code != ENDB) {
664                 BLI_endian_switch_int32(&bhead->len);
665                 BLI_endian_switch_int32(&bhead->SDNAnr);
666                 BLI_endian_switch_int32(&bhead->nr);
667         }
668 }
669
670 static void bh4_from_bh8(BHead *bhead, BHead8 *bhead8, int do_endian_swap)
671 {
672         BHead4 *bhead4 = (BHead4 *) bhead;
673         int64_t old;
674
675         bhead4->code = bhead8->code;
676         bhead4->len = bhead8->len;
677
678         if (bhead4->code != ENDB) {
679                 /* perform a endian swap on 64bit pointers, otherwise the pointer might map to zero
680                  * 0x0000000000000000000012345678 would become 0x12345678000000000000000000000000
681                  */
682                 if (do_endian_swap) {
683                         BLI_endian_switch_int64(&bhead8->old);
684                 }
685                 
686                 /* this patch is to avoid a long long being read from not-eight aligned positions
687                  * is necessary on any modern 64bit architecture) */
688                 memcpy(&old, &bhead8->old, 8);
689                 bhead4->old = (int) (old >> 3);
690                 
691                 bhead4->SDNAnr = bhead8->SDNAnr;
692                 bhead4->nr = bhead8->nr;
693         }
694 }
695
696 static void bh8_from_bh4(BHead *bhead, BHead4 *bhead4)
697 {
698         BHead8 *bhead8 = (BHead8 *) bhead;
699         
700         bhead8->code = bhead4->code;
701         bhead8->len = bhead4->len;
702         
703         if (bhead8->code != ENDB) {
704                 bhead8->old = bhead4->old;
705                 bhead8->SDNAnr = bhead4->SDNAnr;
706                 bhead8->nr= bhead4->nr;
707         }
708 }
709
710 static BHeadN *get_bhead(FileData *fd)
711 {
712         BHeadN *new_bhead = NULL;
713         int readsize;
714         
715         if (fd) {
716                 if (!fd->eof) {
717                         /* initializing to zero isn't strictly needed but shuts valgrind up
718                          * since uninitialized memory gets compared */
719                         BHead8 bhead8 = {0};
720                         BHead4 bhead4 = {0};
721                         BHead  bhead = {0};
722                         
723                         /* First read the bhead structure.
724                          * Depending on the platform the file was written on this can
725                          * be a big or little endian BHead4 or BHead8 structure.
726                          *
727                          * As usual 'ENDB' (the last *partial* bhead of the file)
728                          * needs some special handling. We don't want to EOF just yet.
729                          */
730                         if (fd->flags & FD_FLAGS_FILE_POINTSIZE_IS_4) {
731                                 bhead4.code = DATA;
732                                 readsize = fd->read(fd, &bhead4, sizeof(bhead4));
733                                 
734                                 if (readsize == sizeof(bhead4) || bhead4.code == ENDB) {
735                                         if (fd->flags & FD_FLAGS_SWITCH_ENDIAN) {
736                                                 switch_endian_bh4(&bhead4);
737                                         }
738                                         
739                                         if (fd->flags & FD_FLAGS_POINTSIZE_DIFFERS) {
740                                                 bh8_from_bh4(&bhead, &bhead4);
741                                         }
742                                         else {
743                                                 memcpy(&bhead, &bhead4, sizeof(bhead));
744                                         }
745                                 }
746                                 else {
747                                         fd->eof = 1;
748                                         bhead.len= 0;
749                                 }
750                         }
751                         else {
752                                 bhead8.code = DATA;
753                                 readsize = fd->read(fd, &bhead8, sizeof(bhead8));
754                                 
755                                 if (readsize == sizeof(bhead8) || bhead8.code == ENDB) {
756                                         if (fd->flags & FD_FLAGS_SWITCH_ENDIAN) {
757                                                 switch_endian_bh8(&bhead8);
758                                         }
759                                         
760                                         if (fd->flags & FD_FLAGS_POINTSIZE_DIFFERS) {
761                                                 bh4_from_bh8(&bhead, &bhead8, (fd->flags & FD_FLAGS_SWITCH_ENDIAN));
762                                         }
763                                         else {
764                                                 memcpy(&bhead, &bhead8, sizeof(bhead));
765                                         }
766                                 }
767                                 else {
768                                         fd->eof = 1;
769                                         bhead.len= 0;
770                                 }
771                         }
772                         
773                         /* make sure people are not trying to pass bad blend files */
774                         if (bhead.len < 0) fd->eof = 1;
775                         
776                         /* bhead now contains the (converted) bhead structure. Now read
777                          * the associated data and put everything in a BHeadN (creative naming !)
778                          */
779                         if (!fd->eof) {
780                                 new_bhead = MEM_mallocN(sizeof(BHeadN) + bhead.len, "new_bhead");
781                                 if (new_bhead) {
782                                         new_bhead->next = new_bhead->prev = NULL;
783                                         new_bhead->bhead = bhead;
784                                         
785                                         readsize = fd->read(fd, new_bhead + 1, bhead.len);
786                                         
787                                         if (readsize != bhead.len) {
788                                                 fd->eof = 1;
789                                                 MEM_freeN(new_bhead);
790                                                 new_bhead = NULL;
791                                         }
792                                 }
793                                 else {
794                                         fd->eof = 1;
795                                 }
796                         }
797                 }
798         }
799
800         /* We've read a new block. Now add it to the list
801          * of blocks.
802          */
803         if (new_bhead) {
804                 BLI_addtail(&fd->listbase, new_bhead);
805         }
806         
807         return(new_bhead);
808 }
809
810 BHead *blo_firstbhead(FileData *fd)
811 {
812         BHeadN *new_bhead;
813         BHead *bhead = NULL;
814         
815         /* Rewind the file
816          * Read in a new block if necessary
817          */
818         new_bhead = fd->listbase.first;
819         if (new_bhead == NULL) {
820                 new_bhead = get_bhead(fd);
821         }
822         
823         if (new_bhead) {
824                 bhead = &new_bhead->bhead;
825         }
826         
827         return(bhead);
828 }
829
830 BHead *blo_prevbhead(FileData *UNUSED(fd), BHead *thisblock)
831 {
832         BHeadN *bheadn = (BHeadN *)POINTER_OFFSET(thisblock, -offsetof(BHeadN, bhead));
833         BHeadN *prev = bheadn->prev;
834         
835         return (prev) ? &prev->bhead : NULL;
836 }
837
838 BHead *blo_nextbhead(FileData *fd, BHead *thisblock)
839 {
840         BHeadN *new_bhead = NULL;
841         BHead *bhead = NULL;
842         
843         if (thisblock) {
844                 /* bhead is actually a sub part of BHeadN
845                  * We calculate the BHeadN pointer from the BHead pointer below */
846                 new_bhead = (BHeadN *)POINTER_OFFSET(thisblock, -offsetof(BHeadN, bhead));
847                 
848                 /* get the next BHeadN. If it doesn't exist we read in the next one */
849                 new_bhead = new_bhead->next;
850                 if (new_bhead == NULL) {
851                         new_bhead = get_bhead(fd);
852                 }
853         }
854         
855         if (new_bhead) {
856                 /* here we do the reverse:
857                  * go from the BHeadN pointer to the BHead pointer */
858                 bhead = &new_bhead->bhead;
859         }
860         
861         return(bhead);
862 }
863
864 /* Warning! Caller's responsability to ensure given bhead **is** and ID one! */
865 const char *bhead_id_name(const FileData *fd, const BHead *bhead)
866 {
867         return (const char *)POINTER_OFFSET(bhead, sizeof(*bhead) + fd->id_name_offs);
868 }
869
870 static void decode_blender_header(FileData *fd)
871 {
872         char header[SIZEOFBLENDERHEADER], num[4];
873         int readsize;
874         
875         /* read in the header data */
876         readsize = fd->read(fd, header, sizeof(header));
877         
878         if (readsize == sizeof(header)) {
879                 if (STREQLEN(header, "BLENDER", 7)) {
880                         fd->flags |= FD_FLAGS_FILE_OK;
881                         
882                         /* what size are pointers in the file ? */
883                         if (header[7]=='_') {
884                                 fd->flags |= FD_FLAGS_FILE_POINTSIZE_IS_4;
885                                 if (sizeof(void *) != 4) {
886                                         fd->flags |= FD_FLAGS_POINTSIZE_DIFFERS;
887                                 }
888                         }
889                         else {
890                                 if (sizeof(void *) != 8) {
891                                         fd->flags |= FD_FLAGS_POINTSIZE_DIFFERS;
892                                 }
893                         }
894                         
895                         /* is the file saved in a different endian
896                          * than we need ?
897                          */
898                         if (((header[8] == 'v') ? L_ENDIAN : B_ENDIAN) != ENDIAN_ORDER) {
899                                 fd->flags |= FD_FLAGS_SWITCH_ENDIAN;
900                         }
901                         
902                         /* get the version number */
903                         memcpy(num, header + 9, 3);
904                         num[3] = 0;
905                         fd->fileversion = atoi(num);
906                 }
907         }
908 }
909
910 static int read_file_dna(FileData *fd)
911 {
912         BHead *bhead;
913         
914         for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
915                 if (bhead->code == DNA1) {
916                         const bool do_endian_swap = (fd->flags & FD_FLAGS_SWITCH_ENDIAN) != 0;
917                         
918                         fd->filesdna = DNA_sdna_from_data(&bhead[1], bhead->len, do_endian_swap, true);
919                         if (fd->filesdna) {
920                                 fd->compflags = DNA_struct_get_compareflags(fd->filesdna, fd->memsdna);
921                                 /* used to retrieve ID names from (bhead+1) */
922                                 fd->id_name_offs = DNA_elem_offset(fd->filesdna, "ID", "char", "name[]");
923                         }
924                         
925                         return 1;
926                 }
927                 else if (bhead->code == ENDB)
928                         break;
929         }
930         
931         return 0;
932 }
933
934 static int *read_file_thumbnail(FileData *fd)
935 {
936         BHead *bhead;
937         int *blend_thumb = NULL;
938
939         for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
940                 if (bhead->code == TEST) {
941                         const bool do_endian_swap = (fd->flags & FD_FLAGS_SWITCH_ENDIAN) != 0;
942                         int *data = (int *)(bhead + 1);
943
944                         if (bhead->len < (2 * sizeof(int))) {
945                                 break;
946                         }
947
948                         if (do_endian_swap) {
949                                 BLI_endian_switch_int32(&data[0]);
950                                 BLI_endian_switch_int32(&data[1]);
951                         }
952
953                         if (bhead->len < BLEN_THUMB_MEMSIZE_FILE(data[0], data[1])) {
954                                 break;
955                         }
956
957                         blend_thumb = data;
958                         break;
959                 }
960                 else if (bhead->code != REND) {
961                         /* Thumbnail is stored in TEST immediately after first REND... */
962                         break;
963                 }
964         }
965
966         return blend_thumb;
967 }
968
969 static int fd_read_from_file(FileData *filedata, void *buffer, unsigned int size)
970 {
971         int readsize = read(filedata->filedes, buffer, size);
972         
973         if (readsize < 0) {
974                 readsize = EOF;
975         }
976         else {
977                 filedata->seek += readsize;
978         }
979         
980         return readsize;
981 }
982
983 static int fd_read_gzip_from_file(FileData *filedata, void *buffer, unsigned int size)
984 {
985         int readsize = gzread(filedata->gzfiledes, buffer, size);
986         
987         if (readsize < 0) {
988                 readsize = EOF;
989         }
990         else {
991                 filedata->seek += readsize;
992         }
993         
994         return (readsize);
995 }
996
997 static int fd_read_from_memory(FileData *filedata, void *buffer, unsigned int size)
998 {
999         /* don't read more bytes then there are available in the buffer */
1000         int readsize = (int)MIN2(size, (unsigned int)(filedata->buffersize - filedata->seek));
1001         
1002         memcpy(buffer, filedata->buffer + filedata->seek, readsize);
1003         filedata->seek += readsize;
1004         
1005         return (readsize);
1006 }
1007
1008 static int fd_read_from_memfile(FileData *filedata, void *buffer, unsigned int size)
1009 {
1010         static unsigned int seek = (1<<30);     /* the current position */
1011         static unsigned int offset = 0;         /* size of previous chunks */
1012         static MemFileChunk *chunk = NULL;
1013         unsigned int chunkoffset, readsize, totread;
1014         
1015         if (size == 0) return 0;
1016         
1017         if (seek != (unsigned int)filedata->seek) {
1018                 chunk = filedata->memfile->chunks.first;
1019                 seek = 0;
1020                 
1021                 while (chunk) {
1022                         if (seek + chunk->size > (unsigned) filedata->seek) break;
1023                         seek += chunk->size;
1024                         chunk = chunk->next;
1025                 }
1026                 offset = seek;
1027                 seek = filedata->seek;
1028         }
1029         
1030         if (chunk) {
1031                 totread = 0;
1032                 
1033                 do {
1034                         /* first check if it's on the end if current chunk */
1035                         if (seek-offset == chunk->size) {
1036                                 offset += chunk->size;
1037                                 chunk = chunk->next;
1038                         }
1039                         
1040                         /* debug, should never happen */
1041                         if (chunk == NULL) {
1042                                 printf("illegal read, chunk zero\n");
1043                                 return 0;
1044                         }
1045                         
1046                         chunkoffset = seek-offset;
1047                         readsize = size-totread;
1048                         
1049                         /* data can be spread over multiple chunks, so clamp size
1050                          * to within this chunk, and then it will read further in
1051                          * the next chunk */
1052                         if (chunkoffset+readsize > chunk->size)
1053                                 readsize= chunk->size-chunkoffset;
1054                         
1055                         memcpy(POINTER_OFFSET(buffer, totread), chunk->buf + chunkoffset, readsize);
1056                         totread += readsize;
1057                         filedata->seek += readsize;
1058                         seek += readsize;
1059                 } while (totread < size);
1060                 
1061                 return totread;
1062         }
1063         
1064         return 0;
1065 }
1066
1067 static FileData *filedata_new(void)
1068 {
1069         FileData *fd = MEM_callocN(sizeof(FileData), "FileData");
1070         
1071         fd->filedes = -1;
1072         fd->gzfiledes = NULL;
1073         
1074         /* XXX, this doesn't need to be done all the time,
1075          * but it keeps us re-entrant,  remove once we have
1076          * a lib that provides a nice lock. - zr
1077          */
1078         fd->memsdna = DNA_sdna_from_data(DNAstr, DNAlen, false, false);
1079         
1080         fd->datamap = oldnewmap_new();
1081         fd->globmap = oldnewmap_new();
1082         fd->libmap = oldnewmap_new();
1083         
1084         return fd;
1085 }
1086
1087 static FileData *blo_decode_and_check(FileData *fd, ReportList *reports)
1088 {
1089         decode_blender_header(fd);
1090         
1091         if (fd->flags & FD_FLAGS_FILE_OK) {
1092                 if (!read_file_dna(fd)) {
1093                         BKE_reportf(reports, RPT_ERROR, "Failed to read blend file '%s', incomplete", fd->relabase);
1094                         blo_freefiledata(fd);
1095                         fd = NULL;
1096                 }
1097         }
1098         else {
1099                 BKE_reportf(reports, RPT_ERROR, "Failed to read blend file '%s', not a blend file", fd->relabase);
1100                 blo_freefiledata(fd);
1101                 fd = NULL;
1102         }
1103         
1104         return fd;
1105 }
1106
1107 /* cannot be called with relative paths anymore! */
1108 /* on each new library added, it now checks for the current FileData and expands relativeness */
1109 FileData *blo_openblenderfile(const char *filepath, ReportList *reports)
1110 {
1111         gzFile gzfile;
1112         errno = 0;
1113         gzfile = BLI_gzopen(filepath, "rb");
1114         
1115         if (gzfile == (gzFile)Z_NULL) {
1116                 BKE_reportf(reports, RPT_WARNING, "Unable to open '%s': %s",
1117                             filepath, errno ? strerror(errno) : TIP_("unknown error reading file"));
1118                 return NULL;
1119         }
1120         else {
1121                 FileData *fd = filedata_new();
1122                 fd->gzfiledes = gzfile;
1123                 fd->read = fd_read_gzip_from_file;
1124                 
1125                 /* needed for library_append and read_libraries */
1126                 BLI_strncpy(fd->relabase, filepath, sizeof(fd->relabase));
1127                 
1128                 return blo_decode_and_check(fd, reports);
1129         }
1130 }
1131
1132 /**
1133  * Same as blo_openblenderfile(), but does not reads DNA data, only header. Use it for light access
1134  * (e.g. thumbnail reading).
1135  */
1136 static FileData *blo_openblenderfile_minimal(const char *filepath)
1137 {
1138         gzFile gzfile;
1139         errno = 0;
1140         gzfile = BLI_gzopen(filepath, "rb");
1141
1142         if (gzfile != (gzFile)Z_NULL) {
1143                 FileData *fd = filedata_new();
1144                 fd->gzfiledes = gzfile;
1145                 fd->read = fd_read_gzip_from_file;
1146
1147                 decode_blender_header(fd);
1148
1149                 if (fd->flags & FD_FLAGS_FILE_OK) {
1150                         return fd;
1151                 }
1152
1153                 blo_freefiledata(fd);
1154         }
1155
1156         return NULL;
1157 }
1158
1159 static int fd_read_gzip_from_memory(FileData *filedata, void *buffer, unsigned int size)
1160 {
1161         int err;
1162
1163         filedata->strm.next_out = (Bytef *) buffer;
1164         filedata->strm.avail_out = size;
1165
1166         // Inflate another chunk.
1167         err = inflate (&filedata->strm, Z_SYNC_FLUSH);
1168
1169         if (err == Z_STREAM_END) {
1170                 return 0;
1171         }
1172         else if (err != Z_OK) {
1173                 printf("fd_read_gzip_from_memory: zlib error\n");
1174                 return 0;
1175         }
1176
1177         filedata->seek += size;
1178
1179         return (size);
1180 }
1181
1182 static int fd_read_gzip_from_memory_init(FileData *fd)
1183 {
1184
1185         fd->strm.next_in = (Bytef *) fd->buffer;
1186         fd->strm.avail_in = fd->buffersize;
1187         fd->strm.total_out = 0;
1188         fd->strm.zalloc = Z_NULL;
1189         fd->strm.zfree = Z_NULL;
1190         
1191         if (inflateInit2(&fd->strm, (16+MAX_WBITS)) != Z_OK)
1192                 return 0;
1193
1194         fd->read = fd_read_gzip_from_memory;
1195         
1196         return 1;
1197 }
1198
1199 FileData *blo_openblendermemory(const void *mem, int memsize, ReportList *reports)
1200 {
1201         if (!mem || memsize<SIZEOFBLENDERHEADER) {
1202                 BKE_report(reports, RPT_WARNING, (mem) ? TIP_("Unable to read"): TIP_("Unable to open"));
1203                 return NULL;
1204         }
1205         else {
1206                 FileData *fd = filedata_new();
1207                 const char *cp = mem;
1208                 
1209                 fd->buffer = mem;
1210                 fd->buffersize = memsize;
1211                 
1212                 /* test if gzip */
1213                 if (cp[0] == 0x1f && cp[1] == 0x8b) {
1214                         if (0 == fd_read_gzip_from_memory_init(fd)) {
1215                                 blo_freefiledata(fd);
1216                                 return NULL;
1217                         }
1218                 }
1219                 else
1220                         fd->read = fd_read_from_memory;
1221                         
1222                 fd->flags |= FD_FLAGS_NOT_MY_BUFFER;
1223
1224                 return blo_decode_and_check(fd, reports);
1225         }
1226 }
1227
1228 FileData *blo_openblendermemfile(MemFile *memfile, ReportList *reports)
1229 {
1230         if (!memfile) {
1231                 BKE_report(reports, RPT_WARNING, "Unable to open blend <memory>");
1232                 return NULL;
1233         }
1234         else {
1235                 FileData *fd = filedata_new();
1236                 fd->memfile = memfile;
1237                 
1238                 fd->read = fd_read_from_memfile;
1239                 fd->flags |= FD_FLAGS_NOT_MY_BUFFER;
1240                 
1241                 return blo_decode_and_check(fd, reports);
1242         }
1243 }
1244
1245
1246 void blo_freefiledata(FileData *fd)
1247 {
1248         if (fd) {
1249                 if (fd->filedes != -1) {
1250                         close(fd->filedes);
1251                 }
1252                 
1253                 if (fd->gzfiledes != NULL) {
1254                         gzclose(fd->gzfiledes);
1255                 }
1256                 
1257                 if (fd->strm.next_in) {
1258                         if (inflateEnd(&fd->strm) != Z_OK) {
1259                                 printf("close gzip stream error\n");
1260                         }
1261                 }
1262                 
1263                 if (fd->buffer && !(fd->flags & FD_FLAGS_NOT_MY_BUFFER)) {
1264                         MEM_freeN((void *)fd->buffer);
1265                         fd->buffer = NULL;
1266                 }
1267                 
1268                 // Free all BHeadN data blocks
1269                 BLI_freelistN(&fd->listbase);
1270                 
1271                 if (fd->memsdna)
1272                         DNA_sdna_free(fd->memsdna);
1273                 if (fd->filesdna)
1274                         DNA_sdna_free(fd->filesdna);
1275                 if (fd->compflags)
1276                         MEM_freeN(fd->compflags);
1277                 
1278                 if (fd->datamap)
1279                         oldnewmap_free(fd->datamap);
1280                 if (fd->globmap)
1281                         oldnewmap_free(fd->globmap);
1282                 if (fd->imamap)
1283                         oldnewmap_free(fd->imamap);
1284                 if (fd->movieclipmap)
1285                         oldnewmap_free(fd->movieclipmap);
1286                 if (fd->soundmap)
1287                         oldnewmap_free(fd->soundmap);
1288                 if (fd->packedmap)
1289                         oldnewmap_free(fd->packedmap);
1290                 if (fd->libmap && !(fd->flags & FD_FLAGS_NOT_MY_LIBMAP))
1291                         oldnewmap_free(fd->libmap);
1292                 if (fd->bheadmap)
1293                         MEM_freeN(fd->bheadmap);
1294                 
1295 #ifdef USE_GHASH_BHEAD
1296                 if (fd->bhead_idname_hash) {
1297                         BLI_ghash_free(fd->bhead_idname_hash, NULL, NULL);
1298                 }
1299 #endif
1300
1301                 MEM_freeN(fd);
1302         }
1303 }
1304
1305 /* ************ DIV ****************** */
1306
1307 /**
1308  * Check whether given path ends with a blend file compatible extension (.blend, .ble or .blend.gz).
1309  *
1310  * \param str The path to check.
1311  * \return true is this path ends with a blender file extension.
1312  */
1313 bool BLO_has_bfile_extension(const char *str)
1314 {
1315         const char *ext_test[4] = {".blend", ".ble", ".blend.gz", NULL};
1316         return BLI_testextensie_array(str, ext_test);
1317 }
1318
1319 /**
1320  * Try to explode given path into its 'library components' (i.e. a .blend file, id type/group, and datablock itself).
1321  *
1322  * \param path the full path to explode.
1323  * \param r_dir the string that'll contain path up to blend file itself ('library' path).
1324  *              WARNING! Must be FILE_MAX_LIBEXTRA long (it also stores group and name strings)!
1325  * \param r_group the string that'll contain 'group' part of the path, if any. May be NULL.
1326  * \param r_name the string that'll contain data's name part of the path, if any. May be NULL.
1327  * \return true if path contains a blend file.
1328  */
1329 bool BLO_library_path_explode(const char *path, char *r_dir, char **r_group, char **r_name)
1330 {
1331         /* We might get some data names with slashes, so we have to go up in path until we find blend file itself,
1332          * then we now next path item is group, and everything else is data name. */
1333         char *slash = NULL, *prev_slash = NULL, c = '\0';
1334
1335         r_dir[0] = '\0';
1336         if (r_group) {
1337                 *r_group = NULL;
1338         }
1339         if (r_name) {
1340                 *r_name = NULL;
1341         }
1342
1343         /* if path leads to an existing directory, we can be sure we're not (in) a library */
1344         if (BLI_is_dir(path)) {
1345                 return false;
1346         }
1347
1348         strcpy(r_dir, path);
1349
1350         while ((slash = (char *)BLI_last_slash(r_dir))) {
1351                 char tc = *slash;
1352                 *slash = '\0';
1353                 if (BLO_has_bfile_extension(r_dir) && BLI_is_file(r_dir)) {
1354                         break;
1355                 }
1356
1357                 if (prev_slash) {
1358                         *prev_slash = c;
1359                 }
1360                 prev_slash = slash;
1361                 c = tc;
1362         }
1363
1364         if (!slash) {
1365                 return false;
1366         }
1367
1368         if (slash[1] != '\0') {
1369                 BLI_assert(strlen(slash + 1) < BLO_GROUP_MAX);
1370                 if (r_group) {
1371                         *r_group = slash + 1;
1372                 }
1373         }
1374
1375         if (prev_slash && (prev_slash[1] != '\0')) {
1376                 BLI_assert(strlen(prev_slash + 1) < MAX_ID_NAME - 2);
1377                 if (r_name) {
1378                         *r_name = prev_slash + 1;
1379                 }
1380         }
1381
1382         return true;
1383 }
1384
1385 /**
1386  * Does a very light reading of given .blend file to extract its stored thumbnail.
1387  *
1388  * \param filepath The path of the file to extract thumbnail from.
1389  * \return The raw thumbnail
1390  *         (MEM-allocated, as stored in file, use BKE_main_thumbnail_to_imbuf() to convert it to ImBuf image).
1391  */
1392 BlendThumbnail *BLO_thumbnail_from_file(const char *filepath)
1393 {
1394         FileData *fd;
1395         BlendThumbnail *data;
1396         int *fd_data;
1397
1398         fd = blo_openblenderfile_minimal(filepath);
1399         fd_data = fd ? read_file_thumbnail(fd) : NULL;
1400
1401         if (fd_data) {
1402                 const size_t sz = BLEN_THUMB_MEMSIZE(fd_data[0], fd_data[1]);
1403                 data = MEM_mallocN(sz, __func__);
1404
1405                 BLI_assert((sz - sizeof(*data)) == (BLEN_THUMB_MEMSIZE_FILE(fd_data[0], fd_data[1]) - (sizeof(*fd_data) * 2)));
1406                 data->width = fd_data[0];
1407                 data->height = fd_data[1];
1408                 memcpy(data->rect, &fd_data[2], sz - sizeof(*data));
1409         }
1410         else {
1411                 data = NULL;
1412         }
1413
1414         blo_freefiledata(fd);
1415
1416         return data;
1417 }
1418
1419 /* ************** OLD POINTERS ******************* */
1420
1421 static void *newdataadr(FileData *fd, const void *adr)          /* only direct databocks */
1422 {
1423         return oldnewmap_lookup_and_inc(fd->datamap, adr, true);
1424 }
1425
1426 /* This is a special version of newdataadr() which allows us to keep lasthit of
1427  * map unchanged. In certain cases this makes file loading time significantly
1428  * faster.
1429  *
1430  * Use this function in cases like restoring pointer from one list element to
1431  * another list element, but keep lasthit value so we can continue restoring
1432  * pointers efficiently.
1433  *
1434  * Example of this could be found in direct_link_fcurves() which restores the
1435  * fcurve group pointer and keeps lasthit optimal for linking all further
1436  * fcurves.
1437  */
1438 static void *newdataadr_ex(FileData *fd, const void *adr, bool increase_lasthit)                /* only direct databocks */
1439 {
1440         if (increase_lasthit) {
1441                 return newdataadr(fd, adr);
1442         }
1443         else {
1444                 int lasthit = fd->datamap->lasthit;
1445                 void *newadr = newdataadr(fd, adr);
1446                 fd->datamap->lasthit = lasthit;
1447                 return newadr;
1448         }
1449 }
1450
1451 static void *newdataadr_no_us(FileData *fd, const void *adr)            /* only direct databocks */
1452 {
1453         return oldnewmap_lookup_and_inc(fd->datamap, adr, false);
1454 }
1455
1456 static void *newglobadr(FileData *fd, const void *adr)      /* direct datablocks with global linking */
1457 {
1458         return oldnewmap_lookup_and_inc(fd->globmap, adr, true);
1459 }
1460
1461 static void *newimaadr(FileData *fd, const void *adr)               /* used to restore image data after undo */
1462 {
1463         if (fd->imamap && adr)
1464                 return oldnewmap_lookup_and_inc(fd->imamap, adr, true);
1465         return NULL;
1466 }
1467
1468 static void *newmclipadr(FileData *fd, const void *adr)      /* used to restore movie clip data after undo */
1469 {
1470         if (fd->movieclipmap && adr)
1471                 return oldnewmap_lookup_and_inc(fd->movieclipmap, adr, true);
1472         return NULL;
1473 }
1474
1475 static void *newsoundadr(FileData *fd, const void *adr)      /* used to restore sound data after undo */
1476 {
1477         if (fd->soundmap && adr)
1478                 return oldnewmap_lookup_and_inc(fd->soundmap, adr, true);
1479         return NULL;
1480 }
1481
1482 static void *newpackedadr(FileData *fd, const void *adr)      /* used to restore packed data after undo */
1483 {
1484         if (fd->packedmap && adr)
1485                 return oldnewmap_lookup_and_inc(fd->packedmap, adr, true);
1486         
1487         return oldnewmap_lookup_and_inc(fd->datamap, adr, true);
1488 }
1489
1490
1491 static void *newlibadr(FileData *fd, const void *lib, const void *adr)          /* only lib data */
1492 {
1493         return oldnewmap_liblookup(fd->libmap, adr, lib);
1494 }
1495
1496 void *blo_do_versions_newlibadr(FileData *fd, const void *lib, const void *adr)         /* only lib data */
1497 {
1498         return newlibadr(fd, lib, adr);
1499 }
1500
1501 static void *newlibadr_us(FileData *fd, const void *lib, const void *adr)       /* increases user number */
1502 {
1503         ID *id = newlibadr(fd, lib, adr);
1504         
1505         id_us_plus_no_lib(id);
1506         
1507         return id;
1508 }
1509
1510 void *blo_do_versions_newlibadr_us(FileData *fd, const void *lib, const void *adr)      /* increases user number */
1511 {
1512         return newlibadr_us(fd, lib, adr);
1513 }
1514
1515 static void *newlibadr_real_us(FileData *fd, const void *lib, const void *adr)  /* ensures real user */
1516 {
1517         ID *id = newlibadr(fd, lib, adr);
1518
1519         id_us_ensure_real(id);
1520
1521         return id;
1522 }
1523
1524 static void change_idid_adr_fd(FileData *fd, const void *old, void *new)
1525 {
1526         int i;
1527         
1528         /* use a binary search if we have a sorted libmap, for now it's not needed. */
1529         BLI_assert(fd->libmap->sorted == false);
1530
1531         for (i = 0; i < fd->libmap->nentries; i++) {
1532                 OldNew *entry = &fd->libmap->entries[i];
1533                 
1534                 if (old==entry->newp && entry->nr==ID_ID) {
1535                         entry->newp = new;
1536                         if (new) entry->nr = GS( ((ID *)new)->name );
1537                 }
1538         }
1539 }
1540
1541 static void change_idid_adr(ListBase *mainlist, FileData *basefd, void *old, void *new)
1542 {
1543         Main *mainptr;
1544         
1545         for (mainptr = mainlist->first; mainptr; mainptr = mainptr->next) {
1546                 FileData *fd;
1547                 
1548                 if (mainptr->curlib)
1549                         fd = mainptr->curlib->filedata;
1550                 else
1551                         fd = basefd;
1552                 
1553                 if (fd) {
1554                         change_idid_adr_fd(fd, old, new);
1555                 }
1556         }
1557 }
1558
1559 /* lib linked proxy objects point to our local data, we need
1560  * to clear that pointer before reading the undo memfile since
1561  * the object might be removed, it is set again in reading
1562  * if the local object still exists */
1563 void blo_clear_proxy_pointers_from_lib(Main *oldmain)
1564 {
1565         Object *ob = oldmain->object.first;
1566         
1567         for (; ob; ob= ob->id.next) {
1568                 if (ob->id.lib)
1569                         ob->proxy_from = NULL;
1570         }
1571 }
1572
1573 void blo_make_image_pointer_map(FileData *fd, Main *oldmain)
1574 {
1575         Image *ima = oldmain->image.first;
1576         Scene *sce = oldmain->scene.first;
1577         int a;
1578         
1579         fd->imamap = oldnewmap_new();
1580         
1581         for (; ima; ima = ima->id.next) {
1582                 if (ima->cache)
1583                         oldnewmap_insert(fd->imamap, ima->cache, ima->cache, 0);
1584                 for (a = 0; a < TEXTARGET_COUNT; a++)
1585                         if (ima->gputexture[a])
1586                                 oldnewmap_insert(fd->imamap, ima->gputexture[a], ima->gputexture[a], 0);
1587                 if (ima->rr)
1588                         oldnewmap_insert(fd->imamap, ima->rr, ima->rr, 0);
1589                 for (a=0; a < IMA_MAX_RENDER_SLOT; a++)
1590                         if (ima->renders[a])
1591                                 oldnewmap_insert(fd->imamap, ima->renders[a], ima->renders[a], 0);
1592         }
1593         for (; sce; sce = sce->id.next) {
1594                 if (sce->nodetree && sce->nodetree->previews) {
1595                         bNodeInstanceHashIterator iter;
1596                         NODE_INSTANCE_HASH_ITER(iter, sce->nodetree->previews) {
1597                                 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1598                                 oldnewmap_insert(fd->imamap, preview, preview, 0);
1599                         }
1600                 }
1601         }
1602 }
1603
1604 /* set old main image ibufs to zero if it has been restored */
1605 /* this works because freeing old main only happens after this call */
1606 void blo_end_image_pointer_map(FileData *fd, Main *oldmain)
1607 {
1608         OldNew *entry = fd->imamap->entries;
1609         Image *ima = oldmain->image.first;
1610         Scene *sce = oldmain->scene.first;
1611         int i;
1612         
1613         /* used entries were restored, so we put them to zero */
1614         for (i = 0; i < fd->imamap->nentries; i++, entry++) {
1615                 if (entry->nr > 0)
1616                         entry->newp = NULL;
1617         }
1618         
1619         for (; ima; ima = ima->id.next) {
1620                 ima->cache = newimaadr(fd, ima->cache);
1621                 if (ima->cache == NULL) {
1622                         ima->tpageflag &= ~IMA_GLBIND_IS_DATA;
1623                         for (i = 0; i < TEXTARGET_COUNT; i++) {
1624                                 ima->bindcode[i] = 0;
1625                                 ima->gputexture[i] = NULL;
1626                         }
1627                         ima->rr = NULL;
1628                 }
1629                 for (i = 0; i < IMA_MAX_RENDER_SLOT; i++)
1630                         ima->renders[i] = newimaadr(fd, ima->renders[i]);
1631                 
1632                 for (i = 0; i < TEXTARGET_COUNT; i++)
1633                         ima->gputexture[i] = newimaadr(fd, ima->gputexture[i]);
1634                 ima->rr = newimaadr(fd, ima->rr);
1635         }
1636         for (; sce; sce = sce->id.next) {
1637                 if (sce->nodetree && sce->nodetree->previews) {
1638                         bNodeInstanceHash *new_previews = BKE_node_instance_hash_new("node previews");
1639                         bNodeInstanceHashIterator iter;
1640                         
1641                         /* reconstruct the preview hash, only using remaining pointers */
1642                         NODE_INSTANCE_HASH_ITER(iter, sce->nodetree->previews) {
1643                                 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1644                                 if (preview) {
1645                                         bNodePreview *new_preview = newimaadr(fd, preview);
1646                                         if (new_preview) {
1647                                                 bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1648                                                 BKE_node_instance_hash_insert(new_previews, key, new_preview);
1649                                         }
1650                                 }
1651                         }
1652                         BKE_node_instance_hash_free(sce->nodetree->previews, NULL);
1653                         sce->nodetree->previews = new_previews;
1654                 }
1655         }
1656 }
1657
1658 void blo_make_movieclip_pointer_map(FileData *fd, Main *oldmain)
1659 {
1660         MovieClip *clip = oldmain->movieclip.first;
1661         Scene *sce = oldmain->scene.first;
1662         
1663         fd->movieclipmap = oldnewmap_new();
1664         
1665         for (; clip; clip = clip->id.next) {
1666                 if (clip->cache)
1667                         oldnewmap_insert(fd->movieclipmap, clip->cache, clip->cache, 0);
1668                 
1669                 if (clip->tracking.camera.intrinsics)
1670                         oldnewmap_insert(fd->movieclipmap, clip->tracking.camera.intrinsics, clip->tracking.camera.intrinsics, 0);
1671         }
1672         
1673         for (; sce; sce = sce->id.next) {
1674                 if (sce->nodetree) {
1675                         bNode *node;
1676                         for (node = sce->nodetree->nodes.first; node; node = node->next)
1677                                 if (node->type == CMP_NODE_MOVIEDISTORTION)
1678                                         oldnewmap_insert(fd->movieclipmap, node->storage, node->storage, 0);
1679                 }
1680         }
1681 }
1682
1683 /* set old main movie clips caches to zero if it has been restored */
1684 /* this works because freeing old main only happens after this call */
1685 void blo_end_movieclip_pointer_map(FileData *fd, Main *oldmain)
1686 {
1687         OldNew *entry = fd->movieclipmap->entries;
1688         MovieClip *clip = oldmain->movieclip.first;
1689         Scene *sce = oldmain->scene.first;
1690         int i;
1691         
1692         /* used entries were restored, so we put them to zero */
1693         for (i=0; i < fd->movieclipmap->nentries; i++, entry++) {
1694                 if (entry->nr > 0)
1695                         entry->newp = NULL;
1696         }
1697         
1698         for (; clip; clip = clip->id.next) {
1699                 clip->cache = newmclipadr(fd, clip->cache);
1700                 clip->tracking.camera.intrinsics = newmclipadr(fd, clip->tracking.camera.intrinsics);
1701         }
1702         
1703         for (; sce; sce = sce->id.next) {
1704                 if (sce->nodetree) {
1705                         bNode *node;
1706                         for (node = sce->nodetree->nodes.first; node; node = node->next)
1707                                 if (node->type == CMP_NODE_MOVIEDISTORTION)
1708                                         node->storage = newmclipadr(fd, node->storage);
1709                 }
1710         }
1711 }
1712
1713 void blo_make_sound_pointer_map(FileData *fd, Main *oldmain)
1714 {
1715         bSound *sound = oldmain->sound.first;
1716         
1717         fd->soundmap = oldnewmap_new();
1718         
1719         for (; sound; sound = sound->id.next) {
1720                 if (sound->waveform)
1721                         oldnewmap_insert(fd->soundmap, sound->waveform, sound->waveform, 0);                    
1722         }
1723 }
1724
1725 /* set old main sound caches to zero if it has been restored */
1726 /* this works because freeing old main only happens after this call */
1727 void blo_end_sound_pointer_map(FileData *fd, Main *oldmain)
1728 {
1729         OldNew *entry = fd->soundmap->entries;
1730         bSound *sound = oldmain->sound.first;
1731         int i;
1732         
1733         /* used entries were restored, so we put them to zero */
1734         for (i = 0; i < fd->soundmap->nentries; i++, entry++) {
1735                 if (entry->nr > 0)
1736                         entry->newp = NULL;
1737         }
1738         
1739         for (; sound; sound = sound->id.next) {
1740                 sound->waveform = newsoundadr(fd, sound->waveform);
1741         }
1742 }
1743
1744 /* XXX disabled this feature - packed files also belong in temp saves and quit.blend, to make restore work */
1745
1746 static void insert_packedmap(FileData *fd, PackedFile *pf)
1747 {
1748         oldnewmap_insert(fd->packedmap, pf, pf, 0);
1749         oldnewmap_insert(fd->packedmap, pf->data, pf->data, 0);
1750 }
1751
1752 void blo_make_packed_pointer_map(FileData *fd, Main *oldmain)
1753 {
1754         Image *ima;
1755         VFont *vfont;
1756         bSound *sound;
1757         Library *lib;
1758         
1759         fd->packedmap = oldnewmap_new();
1760         
1761         for (ima = oldmain->image.first; ima; ima = ima->id.next) {
1762                 ImagePackedFile *imapf;
1763
1764                 if (ima->packedfile)
1765                         insert_packedmap(fd, ima->packedfile);
1766
1767                 for (imapf = ima->packedfiles.first; imapf; imapf = imapf->next)
1768                         if (imapf->packedfile)
1769                                 insert_packedmap(fd, imapf->packedfile);
1770         }
1771                         
1772         for (vfont = oldmain->vfont.first; vfont; vfont = vfont->id.next)
1773                 if (vfont->packedfile)
1774                         insert_packedmap(fd, vfont->packedfile);
1775         
1776         for (sound = oldmain->sound.first; sound; sound = sound->id.next)
1777                 if (sound->packedfile)
1778                         insert_packedmap(fd, sound->packedfile);
1779         
1780         for (lib = oldmain->library.first; lib; lib = lib->id.next)
1781                 if (lib->packedfile)
1782                         insert_packedmap(fd, lib->packedfile);
1783
1784 }
1785
1786 /* set old main packed data to zero if it has been restored */
1787 /* this works because freeing old main only happens after this call */
1788 void blo_end_packed_pointer_map(FileData *fd, Main *oldmain)
1789 {
1790         Image *ima;
1791         VFont *vfont;
1792         bSound *sound;
1793         Library *lib;
1794         OldNew *entry = fd->packedmap->entries;
1795         int i;
1796         
1797         /* used entries were restored, so we put them to zero */
1798         for (i=0; i < fd->packedmap->nentries; i++, entry++) {
1799                 if (entry->nr > 0)
1800                         entry->newp = NULL;
1801         }
1802         
1803         for (ima = oldmain->image.first; ima; ima = ima->id.next) {
1804                 ImagePackedFile *imapf;
1805
1806                 ima->packedfile = newpackedadr(fd, ima->packedfile);
1807
1808                 for (imapf = ima->packedfiles.first; imapf; imapf = imapf->next)
1809                         imapf->packedfile = newpackedadr(fd, imapf->packedfile);
1810         }
1811         
1812         for (vfont = oldmain->vfont.first; vfont; vfont = vfont->id.next)
1813                 vfont->packedfile = newpackedadr(fd, vfont->packedfile);
1814
1815         for (sound = oldmain->sound.first; sound; sound = sound->id.next)
1816                 sound->packedfile = newpackedadr(fd, sound->packedfile);
1817                 
1818         for (lib = oldmain->library.first; lib; lib = lib->id.next)
1819                 lib->packedfile = newpackedadr(fd, lib->packedfile);
1820 }
1821
1822
1823 /* undo file support: add all library pointers in lookup */
1824 void blo_add_library_pointer_map(ListBase *old_mainlist, FileData *fd)
1825 {
1826         Main *ptr = old_mainlist->first;
1827         ListBase *lbarray[MAX_LIBARRAY];
1828         
1829         for (ptr = ptr->next; ptr; ptr = ptr->next) {
1830                 int i = set_listbasepointers(ptr, lbarray);
1831                 while (i--) {
1832                         ID *id;
1833                         for (id = lbarray[i]->first; id; id = id->next)
1834                                 oldnewmap_insert(fd->libmap, id, id, GS(id->name));
1835                 }
1836         }
1837
1838         fd->old_mainlist = old_mainlist;
1839 }
1840
1841
1842 /* ********** END OLD POINTERS ****************** */
1843 /* ********** READ FILE ****************** */
1844
1845 static void switch_endian_structs(struct SDNA *filesdna, BHead *bhead)
1846 {
1847         int blocksize, nblocks;
1848         char *data;
1849         
1850         data = (char *)(bhead+1);
1851         blocksize = filesdna->typelens[ filesdna->structs[bhead->SDNAnr][0] ];
1852         
1853         nblocks = bhead->nr;
1854         while (nblocks--) {
1855                 DNA_struct_switch_endian(filesdna, bhead->SDNAnr, data);
1856                 
1857                 data += blocksize;
1858         }
1859 }
1860
1861 static void *read_struct(FileData *fd, BHead *bh, const char *blockname)
1862 {
1863         void *temp = NULL;
1864         
1865         if (bh->len) {
1866                 /* switch is based on file dna */
1867                 if (bh->SDNAnr && (fd->flags & FD_FLAGS_SWITCH_ENDIAN))
1868                         switch_endian_structs(fd->filesdna, bh);
1869                 
1870                 if (fd->compflags[bh->SDNAnr] != SDNA_CMP_REMOVED) {
1871                         if (fd->compflags[bh->SDNAnr] == SDNA_CMP_NOT_EQUAL) {
1872                                 temp = DNA_struct_reconstruct(fd->memsdna, fd->filesdna, fd->compflags, bh->SDNAnr, bh->nr, (bh+1));
1873                         }
1874                         else {
1875                                 /* SDNA_CMP_EQUAL */
1876                                 temp = MEM_mallocN(bh->len, blockname);
1877                                 memcpy(temp, (bh+1), bh->len);
1878                         }
1879                 }
1880         }
1881
1882         return temp;
1883 }
1884
1885 typedef void (*link_list_cb)(FileData *fd, void *data);
1886
1887 static void link_list_ex(FileData *fd, ListBase *lb, link_list_cb callback)             /* only direct data */
1888 {
1889         Link *ln, *prev;
1890         
1891         if (BLI_listbase_is_empty(lb)) return;
1892         
1893         lb->first = newdataadr(fd, lb->first);
1894         if (callback != NULL) {
1895                 callback(fd, lb->first);
1896         }
1897         ln = lb->first;
1898         prev = NULL;
1899         while (ln) {
1900                 ln->next = newdataadr(fd, ln->next);
1901                 if (ln->next != NULL && callback != NULL) {
1902                         callback(fd, ln->next);
1903                 }
1904                 ln->prev = prev;
1905                 prev = ln;
1906                 ln = ln->next;
1907         }
1908         lb->last = prev;
1909 }
1910
1911 static void link_list(FileData *fd, ListBase *lb)               /* only direct data */
1912 {
1913         link_list_ex(fd, lb, NULL);
1914 }
1915
1916 static void link_glob_list(FileData *fd, ListBase *lb)          /* for glob data */
1917 {
1918         Link *ln, *prev;
1919         void *poin;
1920
1921         if (BLI_listbase_is_empty(lb)) return;
1922         poin = newdataadr(fd, lb->first);
1923         if (lb->first) {
1924                 oldnewmap_insert(fd->globmap, lb->first, poin, 0);
1925         }
1926         lb->first = poin;
1927         
1928         ln = lb->first;
1929         prev = NULL;
1930         while (ln) {
1931                 poin = newdataadr(fd, ln->next);
1932                 if (ln->next) {
1933                         oldnewmap_insert(fd->globmap, ln->next, poin, 0);
1934                 }
1935                 ln->next = poin;
1936                 ln->prev = prev;
1937                 prev = ln;
1938                 ln = ln->next;
1939         }
1940         lb->last = prev;
1941 }
1942
1943 static void test_pointer_array(FileData *fd, void **mat)
1944 {
1945         int64_t *lpoin, *lmat;
1946         int *ipoin, *imat;
1947         size_t len;
1948
1949                 /* manually convert the pointer array in
1950                  * the old dna format to a pointer array in
1951                  * the new dna format.
1952                  */
1953         if (*mat) {
1954                 len = MEM_allocN_len(*mat)/fd->filesdna->pointerlen;
1955                         
1956                 if (fd->filesdna->pointerlen==8 && fd->memsdna->pointerlen==4) {
1957                         ipoin=imat= MEM_mallocN(len * 4, "newmatar");
1958                         lpoin= *mat;
1959                         
1960                         while (len-- > 0) {
1961                                 if ((fd->flags & FD_FLAGS_SWITCH_ENDIAN))
1962                                         BLI_endian_switch_int64(lpoin);
1963                                 *ipoin = (int)((*lpoin) >> 3);
1964                                 ipoin++;
1965                                 lpoin++;
1966                         }
1967                         MEM_freeN(*mat);
1968                         *mat = imat;
1969                 }
1970                 
1971                 if (fd->filesdna->pointerlen==4 && fd->memsdna->pointerlen==8) {
1972                         lpoin = lmat = MEM_mallocN(len * 8, "newmatar");
1973                         ipoin = *mat;
1974                         
1975                         while (len-- > 0) {
1976                                 *lpoin = *ipoin;
1977                                 ipoin++;
1978                                 lpoin++;
1979                         }
1980                         MEM_freeN(*mat);
1981                         *mat= lmat;
1982                 }
1983         }
1984 }
1985
1986 /* ************ READ ID Properties *************** */
1987
1988 static void IDP_DirectLinkProperty(IDProperty *prop, int switch_endian, FileData *fd);
1989 static void IDP_LibLinkProperty(IDProperty *prop, int switch_endian, FileData *fd);
1990
1991 static void IDP_DirectLinkIDPArray(IDProperty *prop, int switch_endian, FileData *fd)
1992 {
1993         IDProperty *array;
1994         int i;
1995         
1996         /* since we didn't save the extra buffer, set totallen to len */
1997         prop->totallen = prop->len;
1998         prop->data.pointer = newdataadr(fd, prop->data.pointer);
1999
2000         array = (IDProperty *)prop->data.pointer;
2001         
2002         /* note!, idp-arrays didn't exist in 2.4x, so the pointer will be cleared
2003          * theres not really anything we can do to correct this, at least don't crash */
2004         if (array == NULL) {
2005                 prop->len = 0;
2006                 prop->totallen = 0;
2007         }
2008         
2009         
2010         for (i = 0; i < prop->len; i++)
2011                 IDP_DirectLinkProperty(&array[i], switch_endian, fd);
2012 }
2013
2014 static void IDP_DirectLinkArray(IDProperty *prop, int switch_endian, FileData *fd)
2015 {
2016         IDProperty **array;
2017         int i;
2018         
2019         /* since we didn't save the extra buffer, set totallen to len */
2020         prop->totallen = prop->len;
2021         prop->data.pointer = newdataadr(fd, prop->data.pointer);
2022         
2023         if (prop->subtype == IDP_GROUP) {
2024                 test_pointer_array(fd, prop->data.pointer);
2025                 array = prop->data.pointer;
2026                 
2027                 for (i = 0; i < prop->len; i++)
2028                         IDP_DirectLinkProperty(array[i], switch_endian, fd);
2029         }
2030         else if (prop->subtype == IDP_DOUBLE) {
2031                 if (switch_endian) {
2032                         BLI_endian_switch_double_array(prop->data.pointer, prop->len);
2033                 }
2034         }
2035         else {
2036                 if (switch_endian) {
2037                         /* also used for floats */
2038                         BLI_endian_switch_int32_array(prop->data.pointer, prop->len);
2039                 }
2040         }
2041 }
2042
2043 static void IDP_DirectLinkString(IDProperty *prop, FileData *fd)
2044 {
2045         /*since we didn't save the extra string buffer, set totallen to len.*/
2046         prop->totallen = prop->len;
2047         prop->data.pointer = newdataadr(fd, prop->data.pointer);
2048 }
2049
2050 static void IDP_DirectLinkGroup(IDProperty *prop, int switch_endian, FileData *fd)
2051 {
2052         ListBase *lb = &prop->data.group;
2053         IDProperty *loop;
2054         
2055         link_list(fd, lb);
2056         
2057         /*Link child id properties now*/
2058         for (loop=prop->data.group.first; loop; loop=loop->next) {
2059                 IDP_DirectLinkProperty(loop, switch_endian, fd);
2060         }
2061 }
2062
2063 static void IDP_DirectLinkProperty(IDProperty *prop, int switch_endian, FileData *fd)
2064 {
2065         switch (prop->type) {
2066                 case IDP_GROUP:
2067                         IDP_DirectLinkGroup(prop, switch_endian, fd);
2068                         break;
2069                 case IDP_STRING:
2070                         IDP_DirectLinkString(prop, fd);
2071                         break;
2072                 case IDP_ARRAY:
2073                         IDP_DirectLinkArray(prop, switch_endian, fd);
2074                         break;
2075                 case IDP_IDPARRAY:
2076                         IDP_DirectLinkIDPArray(prop, switch_endian, fd);
2077                         break;
2078                 case IDP_DOUBLE:
2079                         /* erg, stupid doubles.  since I'm storing them
2080                          * in the same field as int val; val2 in the
2081                          * IDPropertyData struct, they have to deal with
2082                          * endianness specifically
2083                          *
2084                          * in theory, val and val2 would've already been swapped
2085                          * if switch_endian is true, so we have to first unswap
2086                          * them then reswap them as a single 64-bit entity.
2087                          */
2088                         
2089                         if (switch_endian) {
2090                                 BLI_endian_switch_int32(&prop->data.val);
2091                                 BLI_endian_switch_int32(&prop->data.val2);
2092                                 BLI_endian_switch_int64((int64_t *)&prop->data.val);
2093                         }
2094                         
2095                         break;
2096         }
2097 }
2098
2099 #define IDP_DirectLinkGroup_OrFree(prop, switch_endian, fd) \
2100        _IDP_DirectLinkGroup_OrFree(prop, switch_endian, fd, __func__)
2101
2102 static void _IDP_DirectLinkGroup_OrFree(IDProperty **prop, int switch_endian, FileData *fd,
2103                                         const char *caller_func_id)
2104 {
2105         if (*prop) {
2106                 if ((*prop)->type == IDP_GROUP) {
2107                         IDP_DirectLinkGroup(*prop, switch_endian, fd);
2108                 }
2109                 else {
2110                         /* corrupt file! */
2111                         printf("%s: found non group data, freeing type %d!\n",
2112                                caller_func_id, (*prop)->type);
2113                         /* don't risk id, data's likely corrupt. */
2114                         // IDP_FreeProperty(*prop);
2115                         *prop = NULL;
2116                 }
2117         }
2118 }
2119
2120 /* stub function */
2121 static void IDP_LibLinkProperty(IDProperty *UNUSED(prop), int UNUSED(switch_endian), FileData *UNUSED(fd))
2122 {
2123         /* Should we do something here, prop should be ensured to be non-NULL first... */
2124 }
2125
2126 /* ************ READ IMAGE PREVIEW *************** */
2127
2128 static PreviewImage *direct_link_preview_image(FileData *fd, PreviewImage *old_prv)
2129 {
2130         PreviewImage *prv = newdataadr(fd, old_prv);
2131         
2132         if (prv) {
2133                 int i;
2134                 for (i = 0; i < NUM_ICON_SIZES; ++i) {
2135                         if (prv->rect[i]) {
2136                                 prv->rect[i] = newdataadr(fd, prv->rect[i]);
2137                         }
2138                         prv->gputexture[i] = NULL;
2139                 }
2140         }
2141         
2142         return prv;
2143 }
2144
2145 /* ************ READ ID *************** */
2146
2147 static void direct_link_id(FileData *fd, ID *id)
2148 {
2149         /*link direct data of ID properties*/
2150         if (id->properties) {
2151                 id->properties = newdataadr(fd, id->properties);
2152                 /* this case means the data was written incorrectly, it should not happen */
2153                 IDP_DirectLinkGroup_OrFree(&id->properties, (fd->flags & FD_FLAGS_SWITCH_ENDIAN), fd);
2154         }
2155 }
2156
2157 /* ************ READ CurveMapping *************** */
2158
2159 /* cuma itself has been read! */
2160 static void direct_link_curvemapping(FileData *fd, CurveMapping *cumap)
2161 {
2162         int a;
2163         
2164         /* flag seems to be able to hang? Maybe old files... not bad to clear anyway */
2165         cumap->flag &= ~CUMA_PREMULLED;
2166         
2167         for (a = 0; a < CM_TOT; a++) {
2168                 cumap->cm[a].curve = newdataadr(fd, cumap->cm[a].curve);
2169                 cumap->cm[a].table = NULL;
2170                 cumap->cm[a].premultable = NULL;
2171         }
2172 }
2173
2174 /* ************ READ Brush *************** */
2175 /* library brush linking after fileread */
2176 static void lib_link_brush(FileData *fd, Main *main)
2177 {
2178         Brush *brush;
2179         
2180         /* only link ID pointers */
2181         for (brush = main->brush.first; brush; brush = brush->id.next) {
2182                 if (brush->id.tag & LIB_TAG_NEED_LINK) {
2183                         brush->id.tag &= ~LIB_TAG_NEED_LINK;
2184                         
2185                         /* brush->(mask_)mtex.obj is ignored on purpose? */
2186                         brush->mtex.tex = newlibadr_us(fd, brush->id.lib, brush->mtex.tex);
2187                         brush->mask_mtex.tex = newlibadr_us(fd, brush->id.lib, brush->mask_mtex.tex);
2188                         brush->clone.image = newlibadr(fd, brush->id.lib, brush->clone.image);
2189                         brush->toggle_brush = newlibadr(fd, brush->id.lib, brush->toggle_brush);
2190                         brush->paint_curve = newlibadr_us(fd, brush->id.lib, brush->paint_curve);
2191                 }
2192         }
2193 }
2194
2195 static void direct_link_brush(FileData *fd, Brush *brush)
2196 {
2197         /* brush itself has been read */
2198
2199         /* fallof curve */
2200         brush->curve = newdataadr(fd, brush->curve);
2201         brush->gradient = newdataadr(fd, brush->gradient);
2202
2203         if (brush->curve)
2204                 direct_link_curvemapping(fd, brush->curve);
2205         else
2206                 BKE_brush_curve_preset(brush, CURVE_PRESET_SHARP);
2207
2208         brush->preview = NULL;
2209         brush->icon_imbuf = NULL;
2210 }
2211
2212 /* ************ READ Palette *************** */
2213 static void lib_link_palette(FileData *UNUSED(fd), Main *main)
2214 {
2215         Palette *palette;
2216
2217         /* only link ID pointers */
2218         for (palette = main->palettes.first; palette; palette = palette->id.next) {
2219                 if (palette->id.tag & LIB_TAG_NEED_LINK) {
2220                         palette->id.tag &= ~LIB_TAG_NEED_LINK;
2221                 }
2222         }
2223 }
2224
2225 static void direct_link_palette(FileData *fd, Palette *palette)
2226 {
2227         /* palette itself has been read */
2228         link_list(fd, &palette->colors);
2229 }
2230
2231 static void lib_link_paint_curve(FileData *UNUSED(fd), Main *main)
2232 {
2233         PaintCurve *pc;
2234
2235         /* only link ID pointers */
2236         for (pc = main->paintcurves.first; pc; pc = pc->id.next) {
2237                 if (pc->id.tag & LIB_TAG_NEED_LINK) {
2238                         pc->id.tag &= ~LIB_TAG_NEED_LINK;
2239                 }
2240         }
2241 }
2242
2243 static void direct_link_paint_curve(FileData *fd, PaintCurve *pc)
2244 {
2245         pc->points = newdataadr(fd, pc->points);
2246 }
2247
2248 /* ************ READ PACKEDFILE *************** */
2249
2250 static PackedFile *direct_link_packedfile(FileData *fd, PackedFile *oldpf)
2251 {
2252         PackedFile *pf = newpackedadr(fd, oldpf);
2253
2254         if (pf) {
2255                 pf->data = newpackedadr(fd, pf->data);
2256         }
2257         
2258         return pf;
2259 }
2260
2261 /* ************ READ ANIMATION STUFF ***************** */
2262
2263 /* Legacy Data Support (for Version Patching) ----------------------------- */
2264
2265 // XXX deprecated - old animation system
2266 static void lib_link_ipo(FileData *fd, Main *main)
2267 {
2268         Ipo *ipo;
2269         
2270         for (ipo = main->ipo.first; ipo; ipo = ipo->id.next) {
2271                 if (ipo->id.tag & LIB_TAG_NEED_LINK) {
2272                         IpoCurve *icu;
2273                         for (icu = ipo->curve.first; icu; icu = icu->next) {
2274                                 if (icu->driver)
2275                                         icu->driver->ob = newlibadr(fd, ipo->id.lib, icu->driver->ob);
2276                         }
2277                         ipo->id.tag &= ~LIB_TAG_NEED_LINK;
2278                 }
2279         }
2280 }
2281
2282 // XXX deprecated - old animation system
2283 static void direct_link_ipo(FileData *fd, Ipo *ipo)
2284 {
2285         IpoCurve *icu;
2286
2287         link_list(fd, &(ipo->curve));
2288         
2289         for (icu = ipo->curve.first; icu; icu = icu->next) {
2290                 icu->bezt = newdataadr(fd, icu->bezt);
2291                 icu->bp = newdataadr(fd, icu->bp);
2292                 icu->driver = newdataadr(fd, icu->driver);
2293         }
2294 }
2295
2296 // XXX deprecated - old animation system
2297 static void lib_link_nlastrips(FileData *fd, ID *id, ListBase *striplist)
2298 {
2299         bActionStrip *strip;
2300         bActionModifier *amod;
2301         
2302         for (strip=striplist->first; strip; strip=strip->next) {
2303                 strip->object = newlibadr(fd, id->lib, strip->object);
2304                 strip->act = newlibadr_us(fd, id->lib, strip->act);
2305                 strip->ipo = newlibadr(fd, id->lib, strip->ipo);
2306                 for (amod = strip->modifiers.first; amod; amod = amod->next)
2307                         amod->ob = newlibadr(fd, id->lib, amod->ob);
2308         }
2309 }
2310
2311 // XXX deprecated - old animation system
2312 static void direct_link_nlastrips(FileData *fd, ListBase *strips)
2313 {
2314         bActionStrip *strip;
2315         
2316         link_list(fd, strips);
2317         
2318         for (strip = strips->first; strip; strip = strip->next)
2319                 link_list(fd, &strip->modifiers);
2320 }
2321
2322 // XXX deprecated - old animation system
2323 static void lib_link_constraint_channels(FileData *fd, ID *id, ListBase *chanbase)
2324 {
2325         bConstraintChannel *chan;
2326
2327         for (chan=chanbase->first; chan; chan=chan->next) {
2328                 chan->ipo = newlibadr_us(fd, id->lib, chan->ipo);
2329         }
2330 }
2331
2332 /* Data Linking ----------------------------- */
2333
2334 static void lib_link_fmodifiers(FileData *fd, ID *id, ListBase *list)
2335 {
2336         FModifier *fcm;
2337         
2338         for (fcm = list->first; fcm; fcm = fcm->next) {
2339                 /* data for specific modifiers */
2340                 switch (fcm->type) {
2341                         case FMODIFIER_TYPE_PYTHON:
2342                         {
2343                                 FMod_Python *data = (FMod_Python *)fcm->data;
2344                                 data->script = newlibadr(fd, id->lib, data->script);
2345
2346                                 break;
2347                         }
2348                 }
2349         }
2350 }
2351
2352 static void lib_link_fcurves(FileData *fd, ID *id, ListBase *list) 
2353 {
2354         FCurve *fcu;
2355         
2356         if (list == NULL)
2357                 return;
2358         
2359         /* relink ID-block references... */
2360         for (fcu = list->first; fcu; fcu = fcu->next) {
2361                 /* driver data */
2362                 if (fcu->driver) {
2363                         ChannelDriver *driver = fcu->driver;
2364                         DriverVar *dvar;
2365                         
2366                         for (dvar= driver->variables.first; dvar; dvar= dvar->next) {
2367                                 DRIVER_TARGETS_LOOPER(dvar)
2368                                 {
2369                                         /* only relink if still used */
2370                                         if (tarIndex < dvar->num_targets)
2371                                                 dtar->id = newlibadr(fd, id->lib, dtar->id); 
2372                                         else
2373                                                 dtar->id = NULL;
2374                                 }
2375                                 DRIVER_TARGETS_LOOPER_END
2376                         }
2377                 }
2378                 
2379                 /* modifiers */
2380                 lib_link_fmodifiers(fd, id, &fcu->modifiers);
2381         }
2382 }
2383
2384
2385 /* NOTE: this assumes that link_list has already been called on the list */
2386 static void direct_link_fmodifiers(FileData *fd, ListBase *list)
2387 {
2388         FModifier *fcm;
2389         
2390         for (fcm = list->first; fcm; fcm = fcm->next) {
2391                 /* relink general data */
2392                 fcm->data  = newdataadr(fd, fcm->data);
2393                 
2394                 /* do relinking of data for specific types */
2395                 switch (fcm->type) {
2396                         case FMODIFIER_TYPE_GENERATOR:
2397                         {
2398                                 FMod_Generator *data = (FMod_Generator *)fcm->data;
2399                                 
2400                                 data->coefficients = newdataadr(fd, data->coefficients);
2401                                 
2402                                 if (fd->flags & FD_FLAGS_SWITCH_ENDIAN) {
2403                                         BLI_endian_switch_float_array(data->coefficients, data->arraysize);
2404                                 }
2405
2406                                 break;
2407                         }
2408                         case FMODIFIER_TYPE_ENVELOPE:
2409                         {
2410                                 FMod_Envelope *data=  (FMod_Envelope *)fcm->data;
2411                                 
2412                                 data->data= newdataadr(fd, data->data);
2413
2414                                 break;
2415                         }
2416                         case FMODIFIER_TYPE_PYTHON:
2417                         {
2418                                 FMod_Python *data = (FMod_Python *)fcm->data;
2419                                 
2420                                 data->prop = newdataadr(fd, data->prop);
2421                                 IDP_DirectLinkGroup_OrFree(&data->prop, (fd->flags & FD_FLAGS_SWITCH_ENDIAN), fd);
2422
2423                                 break;
2424                         }
2425                 }
2426         }
2427 }
2428
2429 /* NOTE: this assumes that link_list has already been called on the list */
2430 static void direct_link_fcurves(FileData *fd, ListBase *list)
2431 {
2432         FCurve *fcu;
2433         
2434         /* link F-Curve data to F-Curve again (non ID-libs) */
2435         for (fcu = list->first; fcu; fcu = fcu->next) {
2436                 /* curve data */
2437                 fcu->bezt = newdataadr(fd, fcu->bezt);
2438                 fcu->fpt = newdataadr(fd, fcu->fpt);
2439                 
2440                 /* rna path */
2441                 fcu->rna_path = newdataadr(fd, fcu->rna_path);
2442                 
2443                 /* group */
2444                 fcu->grp = newdataadr_ex(fd, fcu->grp, false);
2445                 
2446                 /* clear disabled flag - allows disabled drivers to be tried again ([#32155]),
2447                  * but also means that another method for "reviving disabled F-Curves" exists
2448                  */
2449                 fcu->flag &= ~FCURVE_DISABLED;
2450                 
2451                 /* driver */
2452                 fcu->driver= newdataadr(fd, fcu->driver);
2453                 if (fcu->driver) {
2454                         ChannelDriver *driver= fcu->driver;
2455                         DriverVar *dvar;
2456                         
2457                         /* compiled expression data will need to be regenerated (old pointer may still be set here) */
2458                         driver->expr_comp = NULL;
2459                         
2460                         /* give the driver a fresh chance - the operating environment may be different now 
2461                          * (addons, etc. may be different) so the driver namespace may be sane now [#32155]
2462                          */
2463                         driver->flag &= ~DRIVER_FLAG_INVALID;
2464                         
2465                         /* relink variables, targets and their paths */
2466                         link_list(fd, &driver->variables);
2467                         for (dvar= driver->variables.first; dvar; dvar= dvar->next) {
2468                                 DRIVER_TARGETS_LOOPER(dvar)
2469                                 {
2470                                         /* only relink the targets being used */
2471                                         if (tarIndex < dvar->num_targets)
2472                                                 dtar->rna_path = newdataadr(fd, dtar->rna_path);
2473                                         else
2474                                                 dtar->rna_path = NULL;
2475                                 }
2476                                 DRIVER_TARGETS_LOOPER_END
2477                         }
2478                 }
2479                 
2480                 /* modifiers */
2481                 link_list(fd, &fcu->modifiers);
2482                 direct_link_fmodifiers(fd, &fcu->modifiers);
2483         }
2484 }
2485
2486
2487 static void lib_link_action(FileData *fd, Main *main)
2488 {
2489         bAction *act;
2490         bActionChannel *chan;
2491
2492         for (act = main->action.first; act; act = act->id.next) {
2493                 if (act->id.tag & LIB_TAG_NEED_LINK) {
2494                         act->id.tag &= ~LIB_TAG_NEED_LINK;
2495                         
2496 // XXX deprecated - old animation system <<<
2497                         for (chan=act->chanbase.first; chan; chan=chan->next) {
2498                                 chan->ipo = newlibadr_us(fd, act->id.lib, chan->ipo);
2499                                 lib_link_constraint_channels(fd, &act->id, &chan->constraintChannels);
2500                         }
2501 // >>> XXX deprecated - old animation system
2502                         
2503                         lib_link_fcurves(fd, &act->id, &act->curves);
2504                 }
2505         }
2506 }
2507
2508 static void direct_link_action(FileData *fd, bAction *act)
2509 {
2510         bActionChannel *achan; // XXX deprecated - old animation system
2511         bActionGroup *agrp;
2512
2513         link_list(fd, &act->curves);
2514         link_list(fd, &act->chanbase); // XXX deprecated - old animation system
2515         link_list(fd, &act->groups);
2516         link_list(fd, &act->markers);
2517
2518 // XXX deprecated - old animation system <<<
2519         for (achan = act->chanbase.first; achan; achan=achan->next) {
2520                 achan->grp = newdataadr(fd, achan->grp);
2521                 
2522                 link_list(fd, &achan->constraintChannels);
2523         }
2524 // >>> XXX deprecated - old animation system
2525
2526         direct_link_fcurves(fd, &act->curves);
2527         
2528         for (agrp = act->groups.first; agrp; agrp= agrp->next) {
2529                 agrp->channels.first= newdataadr(fd, agrp->channels.first);
2530                 agrp->channels.last= newdataadr(fd, agrp->channels.last);
2531         }
2532 }
2533
2534 static void lib_link_nladata_strips(FileData *fd, ID *id, ListBase *list)
2535 {
2536         NlaStrip *strip;
2537         
2538         for (strip = list->first; strip; strip = strip->next) {
2539                 /* check strip's children */
2540                 lib_link_nladata_strips(fd, id, &strip->strips);
2541                 
2542                 /* check strip's F-Curves */
2543                 lib_link_fcurves(fd, id, &strip->fcurves);
2544                 
2545                 /* reassign the counted-reference to action */
2546                 strip->act = newlibadr_us(fd, id->lib, strip->act);
2547                 
2548                 /* fix action id-root (i.e. if it comes from a pre 2.57 .blend file) */
2549                 if ((strip->act) && (strip->act->idroot == 0))
2550                         strip->act->idroot = GS(id->name);
2551         }
2552 }
2553
2554 static void lib_link_nladata(FileData *fd, ID *id, ListBase *list)
2555 {
2556         NlaTrack *nlt;
2557         
2558         /* we only care about the NLA strips inside the tracks */
2559         for (nlt = list->first; nlt; nlt = nlt->next) {
2560                 lib_link_nladata_strips(fd, id, &nlt->strips);
2561         }
2562 }
2563
2564 /* This handles Animato NLA-Strips linking 
2565  * NOTE: this assumes that link_list has already been called on the list 
2566  */
2567 static void direct_link_nladata_strips(FileData *fd, ListBase *list)
2568 {
2569         NlaStrip *strip;
2570         
2571         for (strip = list->first; strip; strip = strip->next) {
2572                 /* strip's child strips */
2573                 link_list(fd, &strip->strips);
2574                 direct_link_nladata_strips(fd, &strip->strips);
2575                 
2576                 /* strip's F-Curves */
2577                 link_list(fd, &strip->fcurves);
2578                 direct_link_fcurves(fd, &strip->fcurves);
2579                 
2580                 /* strip's F-Modifiers */
2581                 link_list(fd, &strip->modifiers);
2582                 direct_link_fmodifiers(fd, &strip->modifiers);
2583         }
2584 }
2585
2586 /* NOTE: this assumes that link_list has already been called on the list */
2587 static void direct_link_nladata(FileData *fd, ListBase *list)
2588 {
2589         NlaTrack *nlt;
2590         
2591         for (nlt = list->first; nlt; nlt = nlt->next) {
2592                 /* relink list of strips */
2593                 link_list(fd, &nlt->strips);
2594                 
2595                 /* relink strip data */
2596                 direct_link_nladata_strips(fd, &nlt->strips);
2597         }
2598 }
2599
2600 /* ------- */
2601
2602 static void lib_link_keyingsets(FileData *fd, ID *id, ListBase *list)
2603 {
2604         KeyingSet *ks;
2605         KS_Path *ksp;
2606         
2607         /* here, we're only interested in the ID pointer stored in some of the paths */
2608         for (ks = list->first; ks; ks = ks->next) {
2609                 for (ksp = ks->paths.first; ksp; ksp = ksp->next) {
2610                         ksp->id= newlibadr(fd, id->lib, ksp->id); 
2611                 }
2612         }
2613 }
2614
2615 /* NOTE: this assumes that link_list has already been called on the list */
2616 static void direct_link_keyingsets(FileData *fd, ListBase *list)
2617 {
2618         KeyingSet *ks;
2619         KS_Path *ksp;
2620         
2621         /* link KeyingSet data to KeyingSet again (non ID-libs) */
2622         for (ks = list->first; ks; ks = ks->next) {
2623                 /* paths */
2624                 link_list(fd, &ks->paths);
2625                 
2626                 for (ksp = ks->paths.first; ksp; ksp = ksp->next) {
2627                         /* rna path */
2628                         ksp->rna_path= newdataadr(fd, ksp->rna_path);
2629                 }
2630         }
2631 }
2632
2633 /* ------- */
2634
2635 static void lib_link_animdata(FileData *fd, ID *id, AnimData *adt)
2636 {
2637         if (adt == NULL)
2638                 return;
2639         
2640         /* link action data */
2641         adt->action= newlibadr_us(fd, id->lib, adt->action);
2642         adt->tmpact= newlibadr_us(fd, id->lib, adt->tmpact);
2643         
2644         /* fix action id-roots (i.e. if they come from a pre 2.57 .blend file) */
2645         if ((adt->action) && (adt->action->idroot == 0))
2646                 adt->action->idroot = GS(id->name);
2647         if ((adt->tmpact) && (adt->tmpact->idroot == 0))
2648                 adt->tmpact->idroot = GS(id->name);
2649         
2650         /* link drivers */
2651         lib_link_fcurves(fd, id, &adt->drivers);
2652         
2653         /* overrides don't have lib-link for now, so no need to do anything */
2654         
2655         /* link NLA-data */
2656         lib_link_nladata(fd, id, &adt->nla_tracks);
2657 }
2658
2659 static void direct_link_animdata(FileData *fd, AnimData *adt)
2660 {
2661         /* NOTE: must have called newdataadr already before doing this... */
2662         if (adt == NULL)
2663                 return;
2664         
2665         /* link drivers */
2666         link_list(fd, &adt->drivers);
2667         direct_link_fcurves(fd, &adt->drivers);
2668         
2669         /* link overrides */
2670         // TODO...
2671         
2672         /* link NLA-data */
2673         link_list(fd, &adt->nla_tracks);
2674         direct_link_nladata(fd, &adt->nla_tracks);
2675         
2676         /* relink active track/strip - even though strictly speaking this should only be used
2677          * if we're in 'tweaking mode', we need to be able to have this loaded back for
2678          * undo, but also since users may not exit tweakmode before saving (#24535)
2679          */
2680         // TODO: it's not really nice that anyone should be able to save the file in this
2681         //              state, but it's going to be too hard to enforce this single case...
2682         adt->act_track = newdataadr(fd, adt->act_track);
2683         adt->actstrip = newdataadr(fd, adt->actstrip);
2684 }       
2685
2686 /* ************ READ MOTION PATHS *************** */
2687
2688 /* direct data for cache */
2689 static void direct_link_motionpath(FileData *fd, bMotionPath *mpath)
2690 {
2691         /* sanity check */
2692         if (mpath == NULL)
2693                 return;
2694         
2695         /* relink points cache */
2696         mpath->points = newdataadr(fd, mpath->points);
2697 }
2698
2699 /* ************ READ NODE TREE *************** */
2700
2701 static void lib_link_node_socket(FileData *fd, ID *UNUSED(id), bNodeSocket *sock)
2702 {
2703         /* Link ID Properties -- and copy this comment EXACTLY for easy finding
2704          * of library blocks that implement this.*/
2705         IDP_LibLinkProperty(sock->prop, (fd->flags & FD_FLAGS_SWITCH_ENDIAN), fd);
2706 }
2707
2708 /* singe node tree (also used for material/scene trees), ntree is not NULL */
2709 static void lib_link_ntree(FileData *fd, ID *id, bNodeTree *ntree)
2710 {
2711         bNode *node;
2712         bNodeSocket *sock;
2713         
2714         lib_link_animdata(fd, &ntree->id, ntree->adt);
2715         
2716         ntree->gpd = newlibadr_us(fd, id->lib, ntree->gpd);
2717         
2718         for (node = ntree->nodes.first; node; node = node->next) {
2719                 /* Link ID Properties -- and copy this comment EXACTLY for easy finding
2720                  * of library blocks that implement this.*/
2721                 IDP_LibLinkProperty(node->prop, (fd->flags & FD_FLAGS_SWITCH_ENDIAN), fd);
2722                 
2723                 node->id= newlibadr_us(fd, id->lib, node->id);
2724
2725                 for (sock = node->inputs.first; sock; sock = sock->next)
2726                         lib_link_node_socket(fd, id, sock);
2727                 for (sock = node->outputs.first; sock; sock = sock->next)
2728                         lib_link_node_socket(fd, id, sock);
2729         }
2730         
2731         for (sock = ntree->inputs.first; sock; sock = sock->next)
2732                 lib_link_node_socket(fd, id, sock);
2733         for (sock = ntree->outputs.first; sock; sock = sock->next)
2734                 lib_link_node_socket(fd, id, sock);
2735 }
2736
2737 /* library ntree linking after fileread */
2738 static void lib_link_nodetree(FileData *fd, Main *main)
2739 {
2740         bNodeTree *ntree;
2741         
2742         /* only link ID pointers */
2743         for (ntree = main->nodetree.first; ntree; ntree = ntree->id.next) {
2744                 if (ntree->id.tag & LIB_TAG_NEED_LINK) {
2745                         ntree->id.tag &= ~LIB_TAG_NEED_LINK;
2746                         lib_link_ntree(fd, &ntree->id, ntree);
2747                 }
2748         }
2749 }
2750
2751 /* get node tree stored locally in other IDs */
2752 static bNodeTree *nodetree_from_id(ID *id)
2753 {
2754         if (!id)
2755                 return NULL;
2756         switch (GS(id->name)) {
2757                 case ID_SCE: return ((Scene *)id)->nodetree;
2758                 case ID_MA: return ((Material *)id)->nodetree;
2759                 case ID_WO: return ((World *)id)->nodetree;
2760                 case ID_LA: return ((Lamp *)id)->nodetree;
2761                 case ID_TE: return ((Tex *)id)->nodetree;
2762                 case ID_LS: return ((FreestyleLineStyle *)id)->nodetree;
2763         }
2764         return NULL;
2765 }
2766
2767 /* updates group node socket identifier so that
2768  * external links to/from the group node are preserved.
2769  */
2770 static void lib_node_do_versions_group_indices(bNode *gnode)
2771 {
2772         bNodeTree *ngroup = (bNodeTree*)gnode->id;
2773         bNodeSocket *sock;
2774         bNodeLink *link;
2775         
2776         for (sock=gnode->outputs.first; sock; sock = sock->next) {
2777                 int old_index = sock->to_index;
2778                 
2779                 for (link = ngroup->links.first; link; link = link->next) {
2780                         if (link->tonode == NULL && link->fromsock->own_index == old_index) {
2781                                 strcpy(sock->identifier, link->fromsock->identifier);
2782                                 /* deprecated */
2783                                 sock->own_index = link->fromsock->own_index;
2784                                 sock->to_index = 0;
2785                                 sock->groupsock = NULL;
2786                         }
2787                 }
2788         }
2789         for (sock=gnode->inputs.first; sock; sock = sock->next) {
2790                 int old_index = sock->to_index;
2791                 
2792                 for (link = ngroup->links.first; link; link = link->next) {
2793                         if (link->fromnode == NULL && link->tosock->own_index == old_index) {
2794                                 strcpy(sock->identifier, link->tosock->identifier);
2795                                 /* deprecated */
2796                                 sock->own_index = link->tosock->own_index;
2797                                 sock->to_index = 0;
2798                                 sock->groupsock = NULL;
2799                         }
2800                 }
2801         }
2802 }
2803
2804 /* verify types for nodes and groups, all data has to be read */
2805 /* open = 0: appending/linking, open = 1: open new file (need to clean out dynamic
2806  * typedefs */
2807 static void lib_verify_nodetree(Main *main, int UNUSED(open))
2808 {
2809         /* this crashes blender on undo/redo */
2810 #if 0
2811                 if (open == 1) {
2812                         reinit_nodesystem();
2813                 }
2814 #endif
2815         
2816         /* set node->typeinfo pointers */
2817         FOREACH_NODETREE(main, ntree, id) {
2818                 ntreeSetTypes(NULL, ntree);
2819         } FOREACH_NODETREE_END
2820         
2821         /* verify static socket templates */
2822         FOREACH_NODETREE(main, ntree, id) {
2823                 bNode *node;
2824                 for (node=ntree->nodes.first; node; node=node->next)
2825                         node_verify_socket_templates(ntree, node);
2826         } FOREACH_NODETREE_END
2827         
2828         {
2829                 bool has_old_groups = false;
2830                 /* XXX this should actually be part of do_versions, but since we need
2831                  * finished library linking, it is not possible there. Instead in do_versions
2832                  * we have set the NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2 flag, so at this point we can do the
2833                  * actual group node updates.
2834                  */
2835                 for (bNodeTree *ntree = main->nodetree.first; ntree; ntree = ntree->id.next) {
2836                         if (ntree->flag & NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2) {
2837                                 has_old_groups = 1;
2838                         }
2839                 }
2840                 
2841                 if (has_old_groups) {
2842                         FOREACH_NODETREE(main, ntree, id) {
2843                                 /* updates external links for all group nodes in a tree */
2844                                 bNode *node;
2845                                 for (node = ntree->nodes.first; node; node = node->next) {
2846                                         if (node->type == NODE_GROUP) {
2847                                                 bNodeTree *ngroup = (bNodeTree*)node->id;
2848                                                 if (ngroup && (ngroup->flag & NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2))
2849                                                         lib_node_do_versions_group_indices(node);
2850                                         }
2851                                 }
2852                         } FOREACH_NODETREE_END
2853                 }
2854                 
2855                 for (bNodeTree *ntree = main->nodetree.first; ntree; ntree = ntree->id.next) {
2856                         ntree->flag &= ~NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2;
2857                 }
2858         }
2859         
2860         {
2861                 /* Convert the previously used ntree->inputs/ntree->outputs lists to interface nodes.
2862                  * Pre 2.56.2 node trees automatically have all unlinked sockets exposed already
2863                  * (see NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2).
2864                  *
2865                  * XXX this should actually be part of do_versions,
2866                  * but needs valid typeinfo pointers to create interface nodes.
2867                  *
2868                  * Note: theoretically only needed in node groups (main->nodetree),
2869                  * but due to a temporary bug such links could have been added in all trees,
2870                  * so have to clean up all of them ...
2871                  */
2872                 
2873                 FOREACH_NODETREE(main, ntree, id) {
2874                         if (ntree->flag & NTREE_DO_VERSIONS_CUSTOMNODES_GROUP) {
2875                                 bNode *input_node = NULL, *output_node = NULL;
2876                                 int num_inputs = 0, num_outputs = 0;
2877                                 bNodeLink *link, *next_link;
2878                                 /* Only create new interface nodes for actual older files.
2879                                  * New file versions already have input/output nodes with duplicate links,
2880                                  * in that case just remove the invalid links.
2881                                  */
2882                                 const bool create_io_nodes = (ntree->flag & NTREE_DO_VERSIONS_CUSTOMNODES_GROUP_CREATE_INTERFACE) != 0;
2883                                 
2884                                 float input_locx = 1000000.0f, input_locy = 0.0f;
2885                                 float output_locx = -1000000.0f, output_locy = 0.0f;
2886                                 /* rough guess, not nice but we don't have access to UI constants here ... */
2887                                 static const float offsetx = 42 + 3*20 + 20;
2888                                 /*static const float offsety = 0.0f;*/
2889                                 
2890                                 if (create_io_nodes) {
2891                                         if (ntree->inputs.first)
2892                                                 input_node = nodeAddStaticNode(NULL, ntree, NODE_GROUP_INPUT);
2893                                         
2894                                         if (ntree->outputs.first)
2895                                                 output_node = nodeAddStaticNode(NULL, ntree, NODE_GROUP_OUTPUT);
2896                                 }
2897                                 
2898                                 /* Redirect links from/to the node tree interface to input/output node.
2899                                  * If the fromnode/tonode pointers are NULL, this means a link from/to
2900                                  * the ntree interface sockets, which need to be redirected to new interface nodes.
2901                                  */
2902                                 for (link = ntree->links.first; link; link = next_link) {
2903                                         bool free_link = false;
2904                                         next_link = link->next;
2905                                         
2906                                         if (link->fromnode == NULL) {
2907                                                 if (input_node) {
2908                                                         link->fromnode = input_node;
2909                                                         link->fromsock = node_group_input_find_socket(input_node, link->fromsock->identifier);
2910                                                         ++num_inputs;
2911                                                         
2912                                                         if (link->tonode) {
2913                                                                 if (input_locx > link->tonode->locx - offsetx)
2914                                                                         input_locx = link->tonode->locx - offsetx;
2915                                                                 input_locy += link->tonode->locy;
2916                                                         }
2917                                                 }
2918                                                 else {
2919                                                         free_link = true;
2920                                                 }
2921                                         }
2922                                         
2923                                         if (link->tonode == NULL) {
2924                                                 if (output_node) {
2925                                                         link->tonode = output_node;
2926                                                         link->tosock = node_group_output_find_socket(output_node, link->tosock->identifier);
2927                                                         ++num_outputs;
2928                                                         
2929                                                         if (link->fromnode) {
2930                                                                 if (output_locx < link->fromnode->locx + offsetx)
2931                                                                         output_locx = link->fromnode->locx + offsetx;
2932                                                                 output_locy += link->fromnode->locy;
2933                                                         }
2934                                                 }
2935                                                 else {
2936                                                         free_link = true;
2937                                                 }
2938                                         }
2939                                         
2940                                         if (free_link)
2941                                                 nodeRemLink(ntree, link);
2942                                 }
2943                                 
2944                                 if (num_inputs > 0) {
2945                                         input_locy /= num_inputs;
2946                                         input_node->locx = input_locx;
2947                                         input_node->locy = input_locy;
2948                                 }
2949                                 if (num_outputs > 0) {
2950                                         output_locy /= num_outputs;
2951                                         output_node->locx = output_locx;
2952                                         output_node->locy = output_locy;
2953                                 }
2954                                 
2955                                 /* clear do_versions flags */
2956                                 ntree->flag &= ~(NTREE_DO_VERSIONS_CUSTOMNODES_GROUP | NTREE_DO_VERSIONS_CUSTOMNODES_GROUP_CREATE_INTERFACE);
2957                         }
2958                 }
2959                 FOREACH_NODETREE_END
2960         }
2961         
2962         /* verify all group user nodes */
2963         for (bNodeTree *ntree = main->nodetree.first; ntree; ntree = ntree->id.next) {
2964                 ntreeVerifyNodes(main, &ntree->id);
2965         }
2966         
2967         /* make update calls where necessary */
2968         {
2969                 FOREACH_NODETREE(main, ntree, id) {
2970                         /* make an update call for the tree */
2971                         ntreeUpdateTree(main, ntree);
2972                 } FOREACH_NODETREE_END
2973         }
2974 }
2975
2976 static void direct_link_node_socket(FileData *fd, bNodeSocket *sock)
2977 {
2978         sock->prop = newdataadr(fd, sock->prop);
2979         IDP_DirectLinkGroup_OrFree(&sock->prop, (fd->flags & FD_FLAGS_SWITCH_ENDIAN), fd);
2980         
2981         sock->link = newdataadr(fd, sock->link);
2982         sock->typeinfo = NULL;
2983         sock->storage = newdataadr(fd, sock->storage);
2984         sock->default_value = newdataadr(fd, sock->default_value);
2985         sock->cache = NULL;
2986 }
2987
2988 /* ntree itself has been read! */
2989 static void direct_link_nodetree(FileData *fd, bNodeTree *ntree)
2990 {
2991         /* note: writing and reading goes in sync, for speed */
2992         bNode *node;
2993         bNodeSocket *sock;
2994         bNodeLink *link;
2995         
2996         ntree->init = 0;                /* to set callbacks and force setting types */
2997         ntree->is_updating = false;
2998         ntree->typeinfo= NULL;
2999         ntree->interface_type = NULL;
3000         
3001         ntree->progress = NULL;
3002         ntree->execdata = NULL;
3003         ntree->duplilock = NULL;
3004
3005         ntree->adt = newdataadr(fd, ntree->adt);
3006         direct_link_animdata(fd, ntree->adt);
3007         
3008         ntree->id.tag &= ~(LIB_TAG_ID_RECALC|LIB_TAG_ID_RECALC_DATA);
3009
3010         link_list(fd, &ntree->nodes);
3011         for (node = ntree->nodes.first; node; node = node->next) {
3012                 node->typeinfo = NULL;
3013                 
3014                 link_list(fd, &node->inputs);
3015                 link_list(fd, &node->outputs);
3016                 
3017                 node->prop = newdataadr(fd, node->prop);
3018                 IDP_DirectLinkGroup_OrFree(&node->prop, (fd->flags & FD_FLAGS_SWITCH_ENDIAN), fd);
3019                 
3020                 link_list(fd, &node->internal_links);
3021                 for (link = node->internal_links.first; link; link = link->next) {
3022                         link->fromnode = newdataadr(fd, link->fromnode);
3023                         link->fromsock = newdataadr(fd, link->fromsock);
3024                         link->tonode = newdataadr(fd, link->tonode);
3025                         link->tosock = newdataadr(fd, link->tosock);
3026                 }
3027                 
3028                 if (node->type == CMP_NODE_MOVIEDISTORTION) {
3029                         node->storage = newmclipadr(fd, node->storage);
3030                 }
3031                 else {
3032                         node->storage = newdataadr(fd, node->storage);
3033                 }
3034                 
3035                 if (node->storage) {
3036                         /* could be handlerized at some point */
3037                         if (ntree->type==NTREE_SHADER) {
3038                                 if (node->type==SH_NODE_CURVE_VEC || node->type==SH_NODE_CURVE_RGB) {
3039                                         direct_link_curvemapping(fd, node->storage);
3040                                 }
3041                                 else if (node->type==SH_NODE_SCRIPT) {
3042                                         NodeShaderScript *nss = (NodeShaderScript *) node->storage;
3043                                         nss->bytecode = newdataadr(fd, nss->bytecode);
3044                                 }
3045                                 else if (node->type==SH_NODE_TEX_POINTDENSITY) {
3046                                         NodeShaderTexPointDensity *npd = (NodeShaderTexPointDensity *) node->storage;
3047                                         memset(&npd->pd, 0, sizeof(npd->pd));
3048                                 }
3049                         }
3050                         else if (ntree->type==NTREE_COMPOSIT) {
3051                                 if (ELEM(node->type, CMP_NODE_TIME, CMP_NODE_CURVE_VEC, CMP_NODE_CURVE_RGB, CMP_NODE_HUECORRECT))
3052                                         direct_link_curvemapping(fd, node->storage);
3053                                 else if (ELEM(node->type, CMP_NODE_IMAGE, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER))
3054                                         ((ImageUser *)node->storage)->ok = 1;
3055                         }
3056                         else if ( ntree->type==NTREE_TEXTURE) {
3057                                 if (node->type==TEX_NODE_CURVE_RGB || node->type==TEX_NODE_CURVE_TIME)
3058                                         direct_link_curvemapping(fd, node->storage);
3059                                 else if (node->type==TEX_NODE_IMAGE)
3060                                         ((ImageUser *)node->storage)->ok = 1;
3061                         }
3062                 }
3063         }
3064         link_list(fd, &ntree->links);
3065         
3066         /* and we connect the rest */
3067         for (node = ntree->nodes.first; node; node = node->next) {
3068                 node->parent = newdataadr(fd, node->parent);
3069                 node->lasty = 0;
3070                 
3071                 for (sock = node->inputs.first; sock; sock = sock->next)
3072                         direct_link_node_socket(fd, sock);
3073                 for (sock = node->outputs.first; sock; sock = sock->next)
3074                         direct_link_node_socket(fd, sock);
3075         }
3076         
3077         /* interface socket lists */
3078         link_list(fd, &ntree->inputs);
3079         link_list(fd, &ntree->outputs);
3080         for (sock = ntree->inputs.first; sock; sock = sock->next)
3081                 direct_link_node_socket(fd, sock);
3082         for (sock = ntree->outputs.first; sock; sock = sock->next)
3083                 direct_link_node_socket(fd, sock);
3084         
3085         for (link = ntree->links.first; link; link= link->next) {
3086                 link->fromnode = newdataadr(fd, link->fromnode);
3087                 link->tonode = newdataadr(fd, link->tonode);
3088                 link->fromsock = newdataadr(fd, link->fromsock);
3089                 link->tosock = newdataadr(fd, link->tosock);
3090         }
3091         
3092 #if 0
3093         if (ntree->previews) {
3094                 bNodeInstanceHash *new_previews = BKE_node_instance_hash_new("node previews");
3095                 bNodeInstanceHashIterator iter;
3096                 
3097                 NODE_INSTANCE_HASH_ITER(iter, ntree->previews) {
3098                         bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
3099                         if (preview) {
3100                                 bNodePreview *new_preview = newimaadr(fd, preview);
3101                                 if (new_preview) {
3102                                         bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
3103                                         BKE_node_instance_hash_insert(new_previews, key, new_preview);
3104                                 }
3105                         }
3106                 }
3107                 BKE_node_instance_hash_free(ntree->previews, NULL);
3108                 ntree->previews = new_previews;
3109         }
3110 #else
3111         /* XXX TODO */
3112         ntree->previews = NULL;
3113 #endif
3114         
3115         /* type verification is in lib-link */
3116 }
3117
3118 /* ************ READ ARMATURE ***************** */
3119
3120 /* temp struct used to transport needed info to lib_link_constraint_cb() */
3121 typedef struct tConstraintLinkData {
3122         FileData *fd;
3123         ID *id;
3124 } tConstraintLinkData;
3125 /* callback function used to relink constraint ID-links */
3126 static void lib_link_constraint_cb(bConstraint *UNUSED(con), ID **idpoin, bool is_reference, void *userdata)
3127 {
3128         tConstraintLinkData *cld= (tConstraintLinkData *)userdata;
3129         
3130         /* for reference types, we need to increment the usercounts on load... */
3131         if (is_reference) {
3132                 /* reference type - with usercount */
3133                 *idpoin = newlibadr_us(cld->fd, cld->id->lib, *idpoin);
3134         }
3135         else {
3136                 /* target type - no usercount needed */
3137                 *idpoin = newlibadr(cld->fd, cld->id->lib, *idpoin);
3138         }
3139 }
3140
3141 static void lib_link_constraints(FileData *fd, ID *id, ListBase *conlist)
3142 {
3143         tConstraintLinkData cld;
3144         bConstraint *con;
3145         
3146         /* legacy fixes */
3147         for (con = conlist->first; con; con=con->next) {
3148                 /* patch for error introduced by changing constraints (dunno how) */
3149                 /* if con->data type changes, dna cannot resolve the pointer! (ton) */
3150                 if (con->data == NULL) {
3151                         con->type = CONSTRAINT_TYPE_NULL;
3152                 }
3153                 /* own ipo, all constraints have it */
3154                 con->ipo = newlibadr_us(fd, id->lib, con->ipo); // XXX deprecated - old animation system
3155         }
3156         
3157         /* relink all ID-blocks used by the constraints */
3158         cld.fd = fd;
3159         cld.id = id;
3160         
3161         BKE_constraints_id_loop(conlist, lib_link_constraint_cb, &cld);
3162 }
3163
3164 static void direct_link_constraints(FileData *fd, ListBase *lb)
3165 {
3166         bConstraint *con;
3167         
3168         link_list(fd, lb);
3169         for (con=lb->first; con; con=con->next) {
3170                 con->data = newdataadr(fd, con->data);
3171                 
3172                 switch (con->type) {
3173                         case CONSTRAINT_TYPE_PYTHON:
3174                         {
3175                                 bPythonConstraint *data= con->data;
3176                                 
3177                                 link_list(fd, &data->targets);
3178                                 
3179                                 data->prop = newdataadr(fd, data->prop);
3180                                 IDP_DirectLinkGroup_OrFree(&data->prop, (fd->flags & FD_FLAGS_SWITCH_ENDIAN), fd);
3181                                 break;
3182                         }