Viewport: cannot select object by clicking on its instances
[blender.git] / source / blender / blenloader / intern / writefile.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup blenloader
22  */
23
24 /**
25  *
26  * FILE FORMAT
27  * ===========
28  *
29  * IFF-style structure (but not IFF compatible!)
30  *
31  * Start file:
32  * <pre>
33  * `BLENDER_V100`  `12` bytes  (version 1.00 is just an example).
34  *                 `V` = big endian, `v` = little endian.
35  *                 `_` = 4 byte pointer, `-` = 8 byte pointer.
36  * </pre>
37  *
38  * data-blocks: (also see struct #BHead).
39  * <pre>
40  * `bh.code`       `char[4]` see `BLO_blend_defs.h` for a list of known types.
41  * `bh.len`        `int32` length data after #BHead in bytes.
42  * `bh.old`        `void *` old pointer (the address at the time of writing the file).
43  * `bh.SDNAnr`     `int32` struct index of structs stored in #DNA1 data.
44  * `bh.nr`         `int32` in case of array: number of structs.
45  * data
46  * ...
47  * ...
48  * </pre>
49  *
50  * Almost all data in Blender are structures. Each struct saved
51  * gets a BHead header.  With BHead the struct can be linked again
52  * and compared with #StructDNA.
53
54  * WRITE
55  * =====
56  *
57  * Preferred writing order: (not really a must, but why would you do it random?)
58  * Any case: direct data is ALWAYS after the lib block.
59  *
60  * (Local file data)
61  * - for each LibBlock
62  *   - write LibBlock
63  *   - write associated direct data
64  * (External file data)
65  * - per library
66  *   - write library block
67  *   - per LibBlock
68  *     - write the ID of LibBlock
69  * - write #TEST (#RenderInfo struct. 128x128 blend file preview is optional).
70  * - write #GLOB (#FileGlobal struct) (some global vars).
71  * - write #DNA1 (#SDNA struct)
72  * - write #USER (#UserDef struct) if filename is ``~/.config/blender/X.XX/config/startup.blend``.
73  */
74
75 #include <fcntl.h>
76 #include <limits.h>
77 #include <math.h>
78 #include <stdio.h>
79 #include <stdlib.h>
80 #include <string.h>
81
82 #ifdef WIN32
83 #  include "BLI_winstuff.h"
84 #  include "winsock2.h"
85 #  include <io.h>
86 #  include <zlib.h> /* odd include order-issue */
87 #else
88 #  include <unistd.h> /* FreeBSD, for write() and close(). */
89 #endif
90
91 #include "BLI_utildefines.h"
92
93 /* allow writefile to use deprecated functionality (for forward compatibility code) */
94 #define DNA_DEPRECATED_ALLOW
95
96 #include "DNA_fileglobal_types.h"
97 #include "DNA_genfile.h"
98 #include "DNA_sdna_types.h"
99
100 #include "BLI_bitmap.h"
101 #include "BLI_blenlib.h"
102 #include "BLI_mempool.h"
103 #include "MEM_guardedalloc.h" /* MEM_freeN */
104
105 #include "BKE_blender_version.h"
106 #include "BKE_bpath.h"
107 #include "BKE_global.h" /* for G */
108 #include "BKE_idprop.h"
109 #include "BKE_idtype.h"
110 #include "BKE_layer.h"
111 #include "BKE_lib_id.h"
112 #include "BKE_lib_override.h"
113 #include "BKE_main.h"
114 #include "BKE_node.h"
115 #include "BKE_packedFile.h"
116 #include "BKE_report.h"
117 #include "BKE_workspace.h"
118
119 #include "BLO_blend_defs.h"
120 #include "BLO_blend_validate.h"
121 #include "BLO_read_write.h"
122 #include "BLO_readfile.h"
123 #include "BLO_undofile.h"
124 #include "BLO_writefile.h"
125
126 #include "readfile.h"
127
128 #include <errno.h>
129
130 /* Make preferences read-only. */
131 #define U (*((const UserDef *)&U))
132
133 /* ********* my write, buffered writing with minimum size chunks ************ */
134
135 /* Use optimal allocation since blocks of this size are kept in memory for undo. */
136 #define MYWRITE_BUFFER_SIZE (MEM_SIZE_OPTIMAL(1 << 17)) /* 128kb */
137 #define MYWRITE_MAX_CHUNK (MEM_SIZE_OPTIMAL(1 << 15))   /* ~32kb */
138
139 /** Use if we want to store how many bytes have been written to the file. */
140 // #define USE_WRITE_DATA_LEN
141
142 /* -------------------------------------------------------------------- */
143 /** \name Internal Write Wrapper's (Abstracts Compression)
144  * \{ */
145
146 typedef enum {
147   WW_WRAP_NONE = 1,
148   WW_WRAP_ZLIB,
149 } eWriteWrapType;
150
151 typedef struct WriteWrap WriteWrap;
152 struct WriteWrap {
153   /* callbacks */
154   bool (*open)(WriteWrap *ww, const char *filepath);
155   bool (*close)(WriteWrap *ww);
156   size_t (*write)(WriteWrap *ww, const char *data, size_t data_len);
157
158   /* Buffer output (we only want when output isn't already buffered). */
159   bool use_buf;
160
161   /* internal */
162   union {
163     int file_handle;
164     gzFile gz_handle;
165   } _user_data;
166 };
167
168 /* none */
169 #define FILE_HANDLE(ww) (ww)->_user_data.file_handle
170
171 static bool ww_open_none(WriteWrap *ww, const char *filepath)
172 {
173   int file;
174
175   file = BLI_open(filepath, O_BINARY + O_WRONLY + O_CREAT + O_TRUNC, 0666);
176
177   if (file != -1) {
178     FILE_HANDLE(ww) = file;
179     return true;
180   }
181
182   return false;
183 }
184 static bool ww_close_none(WriteWrap *ww)
185 {
186   return (close(FILE_HANDLE(ww)) != -1);
187 }
188 static size_t ww_write_none(WriteWrap *ww, const char *buf, size_t buf_len)
189 {
190   return write(FILE_HANDLE(ww), buf, buf_len);
191 }
192 #undef FILE_HANDLE
193
194 /* zlib */
195 #define FILE_HANDLE(ww) (ww)->_user_data.gz_handle
196
197 static bool ww_open_zlib(WriteWrap *ww, const char *filepath)
198 {
199   gzFile file;
200
201   file = BLI_gzopen(filepath, "wb1");
202
203   if (file != Z_NULL) {
204     FILE_HANDLE(ww) = file;
205     return true;
206   }
207
208   return false;
209 }
210 static bool ww_close_zlib(WriteWrap *ww)
211 {
212   return (gzclose(FILE_HANDLE(ww)) == Z_OK);
213 }
214 static size_t ww_write_zlib(WriteWrap *ww, const char *buf, size_t buf_len)
215 {
216   return gzwrite(FILE_HANDLE(ww), buf, buf_len);
217 }
218 #undef FILE_HANDLE
219
220 /* --- end compression types --- */
221
222 static void ww_handle_init(eWriteWrapType ww_type, WriteWrap *r_ww)
223 {
224   memset(r_ww, 0, sizeof(*r_ww));
225
226   switch (ww_type) {
227     case WW_WRAP_ZLIB: {
228       r_ww->open = ww_open_zlib;
229       r_ww->close = ww_close_zlib;
230       r_ww->write = ww_write_zlib;
231       r_ww->use_buf = false;
232       break;
233     }
234     default: {
235       r_ww->open = ww_open_none;
236       r_ww->close = ww_close_none;
237       r_ww->write = ww_write_none;
238       r_ww->use_buf = true;
239       break;
240     }
241   }
242 }
243
244 /** \} */
245
246 /* -------------------------------------------------------------------- */
247 /** \name Write Data Type & Functions
248  * \{ */
249
250 typedef struct {
251   const struct SDNA *sdna;
252
253   /** Use for file and memory writing (fixed size of #MYWRITE_BUFFER_SIZE). */
254   uchar *buf;
255   /** Number of bytes used in #WriteData.buf (flushed when exceeded). */
256   size_t buf_used_len;
257
258 #ifdef USE_WRITE_DATA_LEN
259   /** Total number of bytes written. */
260   size_t write_len;
261 #endif
262
263   /** Set on unlikely case of an error (ignores further file writing).  */
264   bool error;
265
266   /** #MemFile writing (used for undo). */
267   MemFileWriteData mem;
268   /** When true, write to #WriteData.current, could also call 'is_undo'. */
269   bool use_memfile;
270
271   /**
272    * Wrap writing, so we can use zlib or
273    * other compression types later, see: G_FILE_COMPRESS
274    * Will be NULL for UNDO.
275    */
276   WriteWrap *ww;
277 } WriteData;
278
279 typedef struct BlendWriter {
280   WriteData *wd;
281 } BlendWriter;
282
283 static WriteData *writedata_new(WriteWrap *ww)
284 {
285   WriteData *wd = MEM_callocN(sizeof(*wd), "writedata");
286
287   wd->sdna = DNA_sdna_current_get();
288
289   wd->ww = ww;
290
291   if ((ww == NULL) || (ww->use_buf)) {
292     wd->buf = MEM_mallocN(MYWRITE_BUFFER_SIZE, "wd->buf");
293   }
294
295   return wd;
296 }
297
298 static void writedata_do_write(WriteData *wd, const void *mem, size_t memlen)
299 {
300   if ((wd == NULL) || wd->error || (mem == NULL) || memlen < 1) {
301     return;
302   }
303
304   if (memlen > INT_MAX) {
305     BLI_assert(!"Cannot write chunks bigger than INT_MAX.");
306     return;
307   }
308
309   if (UNLIKELY(wd->error)) {
310     return;
311   }
312
313   /* memory based save */
314   if (wd->use_memfile) {
315     BLO_memfile_chunk_add(&wd->mem, mem, memlen);
316   }
317   else {
318     if (wd->ww->write(wd->ww, mem, memlen) != memlen) {
319       wd->error = true;
320     }
321   }
322 }
323
324 static void writedata_free(WriteData *wd)
325 {
326   if (wd->buf) {
327     MEM_freeN(wd->buf);
328   }
329   MEM_freeN(wd);
330 }
331
332 /** \} */
333
334 /* -------------------------------------------------------------------- */
335 /** \name Local Writing API 'mywrite'
336  * \{ */
337
338 /**
339  * Flush helps the de-duplicating memory for undo-save by logically segmenting data,
340  * so differences in one part of memory won't cause unrelated data to be duplicated.
341  */
342 static void mywrite_flush(WriteData *wd)
343 {
344   if (wd->buf_used_len != 0) {
345     writedata_do_write(wd, wd->buf, wd->buf_used_len);
346     wd->buf_used_len = 0;
347   }
348 }
349
350 /**
351  * Low level WRITE(2) wrapper that buffers data
352  * \param adr: Pointer to new chunk of data
353  * \param len: Length of new chunk of data
354  */
355 static void mywrite(WriteData *wd, const void *adr, size_t len)
356 {
357   if (UNLIKELY(wd->error)) {
358     return;
359   }
360
361   if (UNLIKELY(adr == NULL)) {
362     BLI_assert(0);
363     return;
364   }
365
366 #ifdef USE_WRITE_DATA_LEN
367   wd->write_len += len;
368 #endif
369
370   if (wd->buf == NULL) {
371     writedata_do_write(wd, adr, len);
372   }
373   else {
374     /* if we have a single big chunk, write existing data in
375      * buffer and write out big chunk in smaller pieces */
376     if (len > MYWRITE_MAX_CHUNK) {
377       if (wd->buf_used_len != 0) {
378         writedata_do_write(wd, wd->buf, wd->buf_used_len);
379         wd->buf_used_len = 0;
380       }
381
382       do {
383         size_t writelen = MIN2(len, MYWRITE_MAX_CHUNK);
384         writedata_do_write(wd, adr, writelen);
385         adr = (const char *)adr + writelen;
386         len -= writelen;
387       } while (len > 0);
388
389       return;
390     }
391
392     /* if data would overflow buffer, write out the buffer */
393     if (len + wd->buf_used_len > MYWRITE_BUFFER_SIZE - 1) {
394       writedata_do_write(wd, wd->buf, wd->buf_used_len);
395       wd->buf_used_len = 0;
396     }
397
398     /* append data at end of buffer */
399     memcpy(&wd->buf[wd->buf_used_len], adr, len);
400     wd->buf_used_len += len;
401   }
402 }
403
404 /**
405  * BeGiN initializer for mywrite
406  * \param ww: File write wrapper.
407  * \param compare: Previous memory file (can be NULL).
408  * \param current: The current memory file (can be NULL).
409  * \warning Talks to other functions with global parameters
410  */
411 static WriteData *mywrite_begin(WriteWrap *ww, MemFile *compare, MemFile *current)
412 {
413   WriteData *wd = writedata_new(ww);
414
415   if (current != NULL) {
416     BLO_memfile_write_init(&wd->mem, current, compare);
417     wd->use_memfile = true;
418   }
419
420   return wd;
421 }
422
423 /**
424  * END the mywrite wrapper
425  * \return 1 if write failed
426  * \return unknown global variable otherwise
427  * \warning Talks to other functions with global parameters
428  */
429 static bool mywrite_end(WriteData *wd)
430 {
431   if (wd->buf_used_len != 0) {
432     writedata_do_write(wd, wd->buf, wd->buf_used_len);
433     wd->buf_used_len = 0;
434   }
435
436   if (wd->use_memfile) {
437     BLO_memfile_write_finalize(&wd->mem);
438   }
439
440   const bool err = wd->error;
441   writedata_free(wd);
442
443   return err;
444 }
445
446 /**
447  * Start writing of data related to a single ID.
448  *
449  * Only does something when storing an undo step.
450  */
451 static void mywrite_id_begin(WriteData *wd, ID *id)
452 {
453   if (wd->use_memfile) {
454     wd->mem.current_id_session_uuid = id->session_uuid;
455
456     /* If current next memchunk does not match the ID we are about to write, try to find the
457      * correct memchunk in the mapping using ID's session_uuid. */
458     if (wd->mem.id_session_uuid_mapping != NULL &&
459         (wd->mem.reference_current_chunk == NULL ||
460          wd->mem.reference_current_chunk->id_session_uuid != id->session_uuid)) {
461       void *ref = BLI_ghash_lookup(wd->mem.id_session_uuid_mapping,
462                                    POINTER_FROM_UINT(id->session_uuid));
463       if (ref != NULL) {
464         wd->mem.reference_current_chunk = ref;
465       }
466       /* Else, no existing memchunk found, i.e. this is supposed to be a new ID. */
467     }
468     /* Otherwise, we try with the current memchunk in any case, whether it is matching current
469      * ID's session_uuid or not. */
470   }
471 }
472
473 /**
474  * Start writing of data related to a single ID.
475  *
476  * Only does something when storing an undo step.
477  */
478 static void mywrite_id_end(WriteData *wd, ID *UNUSED(id))
479 {
480   if (wd->use_memfile) {
481     /* Very important to do it after every ID write now, otherwise we cannot know whether a
482      * specific ID changed or not. */
483     mywrite_flush(wd);
484     wd->mem.current_id_session_uuid = MAIN_ID_SESSION_UUID_UNSET;
485   }
486 }
487
488 /** \} */
489
490 /* -------------------------------------------------------------------- */
491 /** \name Generic DNA File Writing
492  * \{ */
493
494 static void writestruct_at_address_nr(
495     WriteData *wd, int filecode, const int struct_nr, int nr, const void *adr, const void *data)
496 {
497   BHead bh;
498
499   BLI_assert(struct_nr > 0 && struct_nr < SDNA_TYPE_MAX);
500
501   if (adr == NULL || data == NULL || nr == 0) {
502     return;
503   }
504
505   /* init BHead */
506   bh.code = filecode;
507   bh.old = adr;
508   bh.nr = nr;
509
510   bh.SDNAnr = struct_nr;
511   const SDNA_Struct *struct_info = wd->sdna->structs[bh.SDNAnr];
512
513   bh.len = nr * wd->sdna->types_size[struct_info->type];
514
515   if (bh.len == 0) {
516     return;
517   }
518
519   mywrite(wd, &bh, sizeof(BHead));
520   mywrite(wd, data, (size_t)bh.len);
521 }
522
523 static void writestruct_nr(
524     WriteData *wd, int filecode, const int struct_nr, int nr, const void *adr)
525 {
526   writestruct_at_address_nr(wd, filecode, struct_nr, nr, adr, adr);
527 }
528
529 /* do not use for structs */
530 static void writedata(WriteData *wd, int filecode, size_t len, const void *adr)
531 {
532   BHead bh;
533
534   if (adr == NULL || len == 0) {
535     return;
536   }
537
538   if (len > INT_MAX) {
539     BLI_assert(!"Cannot write chunks bigger than INT_MAX.");
540     return;
541   }
542
543   /* align to 4 (writes uninitialized bytes in some cases) */
544   len = (len + 3) & ~((size_t)3);
545
546   /* init BHead */
547   bh.code = filecode;
548   bh.old = adr;
549   bh.nr = 1;
550   bh.SDNAnr = 0;
551   bh.len = (int)len;
552
553   mywrite(wd, &bh, sizeof(BHead));
554   mywrite(wd, adr, len);
555 }
556
557 /* use this to force writing of lists in same order as reading (using link_list) */
558 static void writelist_nr(WriteData *wd, int filecode, const int struct_nr, const ListBase *lb)
559 {
560   const Link *link = lb->first;
561
562   while (link) {
563     writestruct_nr(wd, filecode, struct_nr, 1, link);
564     link = link->next;
565   }
566 }
567
568 #if 0
569 static void writelist_id(WriteData *wd, int filecode, const char *structname, const ListBase *lb)
570 {
571   const Link *link = lb->first;
572   if (link) {
573
574     const int struct_nr = DNA_struct_find_nr(wd->sdna, structname);
575     if (struct_nr == -1) {
576       printf("error: can't find SDNA code <%s>\n", structname);
577       return;
578     }
579
580     while (link) {
581       writestruct_nr(wd, filecode, struct_nr, 1, link);
582       link = link->next;
583     }
584   }
585 }
586 #endif
587
588 #define writestruct_at_address(wd, filecode, struct_id, nr, adr, data) \
589   writestruct_at_address_nr(wd, filecode, SDNA_TYPE_FROM_STRUCT(struct_id), nr, adr, data)
590
591 #define writestruct(wd, filecode, struct_id, nr, adr) \
592   writestruct_nr(wd, filecode, SDNA_TYPE_FROM_STRUCT(struct_id), nr, adr)
593
594 #define writelist(wd, filecode, struct_id, lb) \
595   writelist_nr(wd, filecode, SDNA_TYPE_FROM_STRUCT(struct_id), lb)
596
597 /** \} */
598
599 /* -------------------------------------------------------------------- */
600 /** \name Typed DNA File Writing
601  *
602  * These functions are used by blender's .blend system for file saving/loading.
603  * \{ */
604
605 /**
606  * Take care using 'use_active_win', since we wont want the currently active window
607  * to change which scene renders (currently only used for undo).
608  */
609 static void current_screen_compat(Main *mainvar,
610                                   bool use_active_win,
611                                   bScreen **r_screen,
612                                   Scene **r_scene,
613                                   ViewLayer **r_view_layer)
614 {
615   wmWindowManager *wm;
616   wmWindow *window = NULL;
617
618   /* find a global current screen in the first open window, to have
619    * a reasonable default for reading in older versions */
620   wm = mainvar->wm.first;
621
622   if (wm) {
623     if (use_active_win) {
624       /* write the active window into the file, needed for multi-window undo T43424 */
625       for (window = wm->windows.first; window; window = window->next) {
626         if (window->active) {
627           break;
628         }
629       }
630
631       /* fallback */
632       if (window == NULL) {
633         window = wm->windows.first;
634       }
635     }
636     else {
637       window = wm->windows.first;
638     }
639   }
640
641   *r_screen = (window) ? BKE_workspace_active_screen_get(window->workspace_hook) : NULL;
642   *r_scene = (window) ? window->scene : NULL;
643   *r_view_layer = (window && *r_scene) ? BKE_view_layer_find(*r_scene, window->view_layer_name) :
644                                          NULL;
645 }
646
647 typedef struct RenderInfo {
648   int sfra;
649   int efra;
650   char scene_name[MAX_ID_NAME - 2];
651 } RenderInfo;
652
653 /**
654  * This was originally added for the historic render-daemon feature,
655  * now write because it can be easily extracted without reading the whole blend file.
656  *
657  * See: `release/scripts/modules/blend_render_info.py`
658  */
659 static void write_renderinfo(WriteData *wd, Main *mainvar)
660 {
661   bScreen *curscreen;
662   Scene *curscene = NULL;
663   ViewLayer *view_layer;
664
665   /* XXX in future, handle multiple windows with multiple screens? */
666   current_screen_compat(mainvar, false, &curscreen, &curscene, &view_layer);
667
668   LISTBASE_FOREACH (Scene *, sce, &mainvar->scenes) {
669     if (sce->id.lib == NULL && (sce == curscene || (sce->r.scemode & R_BG_RENDER))) {
670       RenderInfo data;
671       data.sfra = sce->r.sfra;
672       data.efra = sce->r.efra;
673       memset(data.scene_name, 0, sizeof(data.scene_name));
674
675       BLI_strncpy(data.scene_name, sce->id.name + 2, sizeof(data.scene_name));
676
677       writedata(wd, REND, sizeof(data), &data);
678     }
679   }
680 }
681
682 static void write_keymapitem(BlendWriter *writer, const wmKeyMapItem *kmi)
683 {
684   BLO_write_struct(writer, wmKeyMapItem, kmi);
685   if (kmi->properties) {
686     IDP_BlendWrite(writer, kmi->properties);
687   }
688 }
689
690 static void write_userdef(BlendWriter *writer, const UserDef *userdef)
691 {
692   writestruct(writer->wd, USER, UserDef, 1, userdef);
693
694   LISTBASE_FOREACH (const bTheme *, btheme, &userdef->themes) {
695     BLO_write_struct(writer, bTheme, btheme);
696   }
697
698   LISTBASE_FOREACH (const wmKeyMap *, keymap, &userdef->user_keymaps) {
699     BLO_write_struct(writer, wmKeyMap, keymap);
700
701     LISTBASE_FOREACH (const wmKeyMapDiffItem *, kmdi, &keymap->diff_items) {
702       BLO_write_struct(writer, wmKeyMapDiffItem, kmdi);
703       if (kmdi->remove_item) {
704         write_keymapitem(writer, kmdi->remove_item);
705       }
706       if (kmdi->add_item) {
707         write_keymapitem(writer, kmdi->add_item);
708       }
709     }
710
711     LISTBASE_FOREACH (const wmKeyMapItem *, kmi, &keymap->items) {
712       write_keymapitem(writer, kmi);
713     }
714   }
715
716   LISTBASE_FOREACH (const wmKeyConfigPref *, kpt, &userdef->user_keyconfig_prefs) {
717     BLO_write_struct(writer, wmKeyConfigPref, kpt);
718     if (kpt->prop) {
719       IDP_BlendWrite(writer, kpt->prop);
720     }
721   }
722
723   LISTBASE_FOREACH (const bUserMenu *, um, &userdef->user_menus) {
724     BLO_write_struct(writer, bUserMenu, um);
725     LISTBASE_FOREACH (const bUserMenuItem *, umi, &um->items) {
726       if (umi->type == USER_MENU_TYPE_OPERATOR) {
727         const bUserMenuItem_Op *umi_op = (const bUserMenuItem_Op *)umi;
728         BLO_write_struct(writer, bUserMenuItem_Op, umi_op);
729         if (umi_op->prop) {
730           IDP_BlendWrite(writer, umi_op->prop);
731         }
732       }
733       else if (umi->type == USER_MENU_TYPE_MENU) {
734         const bUserMenuItem_Menu *umi_mt = (const bUserMenuItem_Menu *)umi;
735         BLO_write_struct(writer, bUserMenuItem_Menu, umi_mt);
736       }
737       else if (umi->type == USER_MENU_TYPE_PROP) {
738         const bUserMenuItem_Prop *umi_pr = (const bUserMenuItem_Prop *)umi;
739         BLO_write_struct(writer, bUserMenuItem_Prop, umi_pr);
740       }
741       else {
742         BLO_write_struct(writer, bUserMenuItem, umi);
743       }
744     }
745   }
746
747   LISTBASE_FOREACH (const bAddon *, bext, &userdef->addons) {
748     BLO_write_struct(writer, bAddon, bext);
749     if (bext->prop) {
750       IDP_BlendWrite(writer, bext->prop);
751     }
752   }
753
754   LISTBASE_FOREACH (const bPathCompare *, path_cmp, &userdef->autoexec_paths) {
755     BLO_write_struct(writer, bPathCompare, path_cmp);
756   }
757
758   LISTBASE_FOREACH (const uiStyle *, style, &userdef->uistyles) {
759     BLO_write_struct(writer, uiStyle, style);
760   }
761 }
762
763 /* Keep it last of write_foodata functions. */
764 static void write_libraries(WriteData *wd, Main *main)
765 {
766   ListBase *lbarray[MAX_LIBARRAY];
767   ID *id;
768   int a, tot;
769   bool found_one;
770
771   for (; main; main = main->next) {
772     a = tot = set_listbasepointers(main, lbarray);
773
774     /* test: is lib being used */
775     if (main->curlib && main->curlib->packedfile) {
776       found_one = true;
777     }
778     else if (wd->use_memfile) {
779       /* When writing undo step we always write all existing libraries, makes reading undo step
780        * much easier when dealing with purely indirectly used libraries. */
781       found_one = true;
782     }
783     else {
784       found_one = false;
785       while (!found_one && tot--) {
786         for (id = lbarray[tot]->first; id; id = id->next) {
787           if (id->us > 0 &&
788               ((id->tag & LIB_TAG_EXTERN) ||
789                ((id->tag & LIB_TAG_INDIRECT) && (id->flag & LIB_INDIRECT_WEAK_LINK)))) {
790             found_one = true;
791             break;
792           }
793         }
794       }
795     }
796
797     /* To be able to restore 'quit.blend' and temp saves,
798      * the packed blend has to be in undo buffers... */
799     /* XXX needs rethink, just like save UI in undo files now -
800      * would be nice to append things only for the 'quit.blend' and temp saves. */
801     if (found_one) {
802       /* Not overridable. */
803
804       BlendWriter writer = {wd};
805       writestruct(wd, ID_LI, Library, 1, main->curlib);
806       BKE_id_blend_write(&writer, &main->curlib->id);
807
808       if (main->curlib->packedfile) {
809         BKE_packedfile_blend_write(&writer, main->curlib->packedfile);
810         if (wd->use_memfile == false) {
811           printf("write packed .blend: %s\n", main->curlib->filepath);
812         }
813       }
814
815       /* Write link placeholders for all direct linked IDs. */
816       while (a--) {
817         for (id = lbarray[a]->first; id; id = id->next) {
818           if (id->us > 0 &&
819               ((id->tag & LIB_TAG_EXTERN) ||
820                ((id->tag & LIB_TAG_INDIRECT) && (id->flag & LIB_INDIRECT_WEAK_LINK)))) {
821             if (!BKE_idtype_idcode_is_linkable(GS(id->name))) {
822               printf(
823                   "ERROR: write file: data-block '%s' from lib '%s' is not linkable "
824                   "but is flagged as directly linked",
825                   id->name,
826                   main->curlib->filepath_abs);
827               BLI_assert(0);
828             }
829             writestruct(wd, ID_LINK_PLACEHOLDER, ID, 1, id);
830           }
831         }
832       }
833     }
834   }
835
836   mywrite_flush(wd);
837 }
838
839 /* context is usually defined by WM, two cases where no WM is available:
840  * - for forward compatibility, curscreen has to be saved
841  * - for undofile, curscene needs to be saved */
842 static void write_global(WriteData *wd, int fileflags, Main *mainvar)
843 {
844   const bool is_undo = wd->use_memfile;
845   FileGlobal fg;
846   bScreen *screen;
847   Scene *scene;
848   ViewLayer *view_layer;
849   char subvstr[8];
850
851   /* prevent mem checkers from complaining */
852   memset(fg._pad, 0, sizeof(fg._pad));
853   memset(fg.filename, 0, sizeof(fg.filename));
854   memset(fg.build_hash, 0, sizeof(fg.build_hash));
855   fg._pad1 = NULL;
856
857   current_screen_compat(mainvar, is_undo, &screen, &scene, &view_layer);
858
859   /* XXX still remap G */
860   fg.curscreen = screen;
861   fg.curscene = scene;
862   fg.cur_view_layer = view_layer;
863
864   /* prevent to save this, is not good convention, and feature with concerns... */
865   fg.fileflags = (fileflags & ~G_FILE_FLAG_ALL_RUNTIME);
866
867   fg.globalf = G.f;
868   BLI_strncpy(fg.filename, mainvar->name, sizeof(fg.filename));
869   sprintf(subvstr, "%4d", BLENDER_FILE_SUBVERSION);
870   memcpy(fg.subvstr, subvstr, 4);
871
872   fg.subversion = BLENDER_FILE_SUBVERSION;
873   fg.minversion = BLENDER_FILE_MIN_VERSION;
874   fg.minsubversion = BLENDER_FILE_MIN_SUBVERSION;
875 #ifdef WITH_BUILDINFO
876   {
877     extern unsigned long build_commit_timestamp;
878     extern char build_hash[];
879     /* TODO(sergey): Add branch name to file as well? */
880     fg.build_commit_timestamp = build_commit_timestamp;
881     BLI_strncpy(fg.build_hash, build_hash, sizeof(fg.build_hash));
882   }
883 #else
884   fg.build_commit_timestamp = 0;
885   BLI_strncpy(fg.build_hash, "unknown", sizeof(fg.build_hash));
886 #endif
887   writestruct(wd, GLOB, FileGlobal, 1, &fg);
888 }
889
890 /* preview image, first 2 values are width and height
891  * second are an RGBA image (uchar)
892  * note, this uses 'TEST' since new types will segfault on file load for older blender versions.
893  */
894 static void write_thumb(WriteData *wd, const BlendThumbnail *thumb)
895 {
896   if (thumb) {
897     writedata(wd, TEST, BLEN_THUMB_MEMSIZE_FILE(thumb->width, thumb->height), thumb);
898   }
899 }
900
901 /** \} */
902
903 /* -------------------------------------------------------------------- */
904 /** \name File Writing (Private)
905  * \{ */
906
907 /* if MemFile * there's filesave to memory */
908 static bool write_file_handle(Main *mainvar,
909                               WriteWrap *ww,
910                               MemFile *compare,
911                               MemFile *current,
912                               int write_flags,
913                               bool use_userdef,
914                               const BlendThumbnail *thumb)
915 {
916   BHead bhead;
917   ListBase mainlist;
918   char buf[16];
919   WriteData *wd;
920
921   blo_split_main(&mainlist, mainvar);
922
923   wd = mywrite_begin(ww, compare, current);
924   BlendWriter writer = {wd};
925
926   sprintf(buf,
927           "BLENDER%c%c%.3d",
928           (sizeof(void *) == 8) ? '-' : '_',
929           (ENDIAN_ORDER == B_ENDIAN) ? 'V' : 'v',
930           BLENDER_FILE_VERSION);
931
932   mywrite(wd, buf, 12);
933
934   write_renderinfo(wd, mainvar);
935   write_thumb(wd, thumb);
936   write_global(wd, write_flags, mainvar);
937
938   /* The window-manager and screen often change,
939    * avoid thumbnail detecting changes because of this. */
940   mywrite_flush(wd);
941
942   OverrideLibraryStorage *override_storage = wd->use_memfile ?
943                                                  NULL :
944                                                  BKE_lib_override_library_operations_store_init();
945
946 #define ID_BUFFER_STATIC_SIZE 8192
947   /* This outer loop allows to save first data-blocks from real mainvar,
948    * then the temp ones from override process,
949    * if needed, without duplicating whole code. */
950   Main *bmain = mainvar;
951   do {
952     ListBase *lbarray[MAX_LIBARRAY];
953     int a = set_listbasepointers(bmain, lbarray);
954     while (a--) {
955       ID *id = lbarray[a]->first;
956
957       if (id == NULL || GS(id->name) == ID_LI) {
958         continue; /* Libraries are handled separately below. */
959       }
960
961       char id_buffer_static[ID_BUFFER_STATIC_SIZE];
962       void *id_buffer = id_buffer_static;
963       const size_t idtype_struct_size = BKE_idtype_get_info_from_id(id)->struct_size;
964       if (idtype_struct_size > ID_BUFFER_STATIC_SIZE) {
965         BLI_assert(0);
966         id_buffer = MEM_mallocN(idtype_struct_size, __func__);
967       }
968
969       for (; id; id = id->next) {
970         /* We should never attempt to write non-regular IDs
971          * (i.e. all kind of temp/runtime ones). */
972         BLI_assert(
973             (id->tag & (LIB_TAG_NO_MAIN | LIB_TAG_NO_USER_REFCOUNT | LIB_TAG_NOT_ALLOCATED)) == 0);
974
975         const bool do_override = !ELEM(override_storage, NULL, bmain) &&
976                                  ID_IS_OVERRIDE_LIBRARY_REAL(id);
977
978         if (do_override) {
979           BKE_lib_override_library_operations_store_start(bmain, override_storage, id);
980         }
981
982         if (wd->use_memfile) {
983           /* Record the changes that happened up to this undo push in
984            * recalc_up_to_undo_push, and clear recalc_after_undo_push again
985            * to start accumulating for the next undo push. */
986           id->recalc_up_to_undo_push = id->recalc_after_undo_push;
987           id->recalc_after_undo_push = 0;
988
989           bNodeTree *nodetree = ntreeFromID(id);
990           if (nodetree != NULL) {
991             nodetree->id.recalc_up_to_undo_push = nodetree->id.recalc_after_undo_push;
992             nodetree->id.recalc_after_undo_push = 0;
993           }
994           if (GS(id->name) == ID_SCE) {
995             Scene *scene = (Scene *)id;
996             if (scene->master_collection != NULL) {
997               scene->master_collection->id.recalc_up_to_undo_push =
998                   scene->master_collection->id.recalc_after_undo_push;
999               scene->master_collection->id.recalc_after_undo_push = 0;
1000             }
1001           }
1002         }
1003
1004         mywrite_id_begin(wd, id);
1005
1006         memcpy(id_buffer, id, idtype_struct_size);
1007
1008         ((ID *)id_buffer)->tag = 0;
1009         /* Those listbase data change every time we add/remove an ID, and also often when
1010          * renaming one (due to re-sorting). This avoids generating a lot of false 'is changed'
1011          * detections between undo steps. */
1012         ((ID *)id_buffer)->prev = NULL;
1013         ((ID *)id_buffer)->next = NULL;
1014
1015         const IDTypeInfo *id_type = BKE_idtype_get_info_from_id(id);
1016         if (id_type->blend_write != NULL) {
1017           id_type->blend_write(&writer, (ID *)id_buffer, id);
1018         }
1019
1020         if (do_override) {
1021           BKE_lib_override_library_operations_store_end(override_storage, id);
1022         }
1023
1024         mywrite_id_end(wd, id);
1025       }
1026
1027       if (id_buffer != id_buffer_static) {
1028         MEM_SAFE_FREE(id_buffer);
1029       }
1030
1031       mywrite_flush(wd);
1032     }
1033   } while ((bmain != override_storage) && (bmain = override_storage));
1034
1035   if (override_storage) {
1036     BKE_lib_override_library_operations_store_finalize(override_storage);
1037     override_storage = NULL;
1038   }
1039
1040   /* Special handling, operating over split Mains... */
1041   write_libraries(wd, mainvar->next);
1042
1043   /* So changes above don't cause a 'DNA1' to be detected as changed on undo. */
1044   mywrite_flush(wd);
1045
1046   if (use_userdef) {
1047     write_userdef(&writer, &U);
1048   }
1049
1050   /* Write DNA last, because (to be implemented) test for which structs are written.
1051    *
1052    * Note that we *borrow* the pointer to 'DNAstr',
1053    * so writing each time uses the same address and doesn't cause unnecessary undo overhead. */
1054   writedata(wd, DNA1, (size_t)wd->sdna->data_len, wd->sdna->data);
1055
1056   /* end of file */
1057   memset(&bhead, 0, sizeof(BHead));
1058   bhead.code = ENDB;
1059   mywrite(wd, &bhead, sizeof(BHead));
1060
1061   blo_join_main(&mainlist);
1062
1063   return mywrite_end(wd);
1064 }
1065
1066 /* do reverse file history: .blend1 -> .blend2, .blend -> .blend1 */
1067 /* return: success(0), failure(1) */
1068 static bool do_history(const char *name, ReportList *reports)
1069 {
1070   char tempname1[FILE_MAX], tempname2[FILE_MAX];
1071   int hisnr = U.versions;
1072
1073   if (U.versions == 0) {
1074     return 0;
1075   }
1076
1077   if (strlen(name) < 2) {
1078     BKE_report(reports, RPT_ERROR, "Unable to make version backup: filename too short");
1079     return 1;
1080   }
1081
1082   while (hisnr > 1) {
1083     BLI_snprintf(tempname1, sizeof(tempname1), "%s%d", name, hisnr - 1);
1084     if (BLI_exists(tempname1)) {
1085       BLI_snprintf(tempname2, sizeof(tempname2), "%s%d", name, hisnr);
1086
1087       if (BLI_rename(tempname1, tempname2)) {
1088         BKE_report(reports, RPT_ERROR, "Unable to make version backup");
1089         return true;
1090       }
1091     }
1092     hisnr--;
1093   }
1094
1095   /* is needed when hisnr==1 */
1096   if (BLI_exists(name)) {
1097     BLI_snprintf(tempname1, sizeof(tempname1), "%s%d", name, hisnr);
1098
1099     if (BLI_rename(name, tempname1)) {
1100       BKE_report(reports, RPT_ERROR, "Unable to make version backup");
1101       return true;
1102     }
1103   }
1104
1105   return 0;
1106 }
1107
1108 /** \} */
1109
1110 /* -------------------------------------------------------------------- */
1111 /** \name File Writing (Public)
1112  * \{ */
1113
1114 /**
1115  * \return Success.
1116  */
1117 bool BLO_write_file(Main *mainvar,
1118                     const char *filepath,
1119                     const int write_flags,
1120                     const struct BlendFileWriteParams *params,
1121                     ReportList *reports)
1122 {
1123   char tempname[FILE_MAX + 1];
1124   eWriteWrapType ww_type;
1125   WriteWrap ww;
1126
1127   eBLO_WritePathRemap remap_mode = params->remap_mode;
1128   const bool use_save_versions = params->use_save_versions;
1129   const bool use_save_as_copy = params->use_save_as_copy;
1130   const bool use_userdef = params->use_userdef;
1131   const BlendThumbnail *thumb = params->thumb;
1132
1133   /* path backup/restore */
1134   void *path_list_backup = NULL;
1135   const int path_list_flag = (BKE_BPATH_TRAVERSE_SKIP_LIBRARY | BKE_BPATH_TRAVERSE_SKIP_MULTIFILE);
1136
1137   if (G.debug & G_DEBUG_IO && mainvar->lock != NULL) {
1138     BKE_report(reports, RPT_INFO, "Checking sanity of current .blend file *BEFORE* save to disk");
1139     BLO_main_validate_libraries(mainvar, reports);
1140     BLO_main_validate_shapekeys(mainvar, reports);
1141   }
1142
1143   /* open temporary file, so we preserve the original in case we crash */
1144   BLI_snprintf(tempname, sizeof(tempname), "%s@", filepath);
1145
1146   if (write_flags & G_FILE_COMPRESS) {
1147     ww_type = WW_WRAP_ZLIB;
1148   }
1149   else {
1150     ww_type = WW_WRAP_NONE;
1151   }
1152
1153   ww_handle_init(ww_type, &ww);
1154
1155   if (ww.open(&ww, tempname) == false) {
1156     BKE_reportf(
1157         reports, RPT_ERROR, "Cannot open file %s for writing: %s", tempname, strerror(errno));
1158     return 0;
1159   }
1160
1161   /* Remapping of relative paths to new file location. */
1162   if (remap_mode != BLO_WRITE_PATH_REMAP_NONE) {
1163
1164     if (remap_mode == BLO_WRITE_PATH_REMAP_RELATIVE) {
1165       /* Make all relative as none of the existing paths can be relative in an unsaved document.
1166        */
1167       if (G.relbase_valid == false) {
1168         remap_mode = BLO_WRITE_PATH_REMAP_RELATIVE_ALL;
1169       }
1170     }
1171
1172     char dir_src[FILE_MAX];
1173     char dir_dst[FILE_MAX];
1174     BLI_split_dir_part(mainvar->name, dir_src, sizeof(dir_src));
1175     BLI_split_dir_part(filepath, dir_dst, sizeof(dir_dst));
1176
1177     /* Just in case there is some subtle difference. */
1178     BLI_path_normalize(mainvar->name, dir_dst);
1179     BLI_path_normalize(mainvar->name, dir_src);
1180
1181     /* Only for relative, not relative-all, as this means making existing paths relative. */
1182     if (remap_mode == BLO_WRITE_PATH_REMAP_RELATIVE) {
1183       if (G.relbase_valid && (BLI_path_cmp(dir_dst, dir_src) == 0)) {
1184         /* Saved to same path. Nothing to do. */
1185         remap_mode = BLO_WRITE_PATH_REMAP_NONE;
1186       }
1187     }
1188     else if (remap_mode == BLO_WRITE_PATH_REMAP_ABSOLUTE) {
1189       if (G.relbase_valid == false) {
1190         /* Unsaved, all paths are absolute.Even if the user manages to set a relative path,
1191          * there is no base-path that can be used to make it absolute. */
1192         remap_mode = BLO_WRITE_PATH_REMAP_NONE;
1193       }
1194     }
1195
1196     if (remap_mode != BLO_WRITE_PATH_REMAP_NONE) {
1197       /* Check if we need to backup and restore paths. */
1198       if (UNLIKELY(use_save_as_copy)) {
1199         path_list_backup = BKE_bpath_list_backup(mainvar, path_list_flag);
1200       }
1201
1202       switch (remap_mode) {
1203         case BLO_WRITE_PATH_REMAP_RELATIVE:
1204           /* Saved, make relative paths relative to new location (if possible). */
1205           BKE_bpath_relative_rebase(mainvar, dir_src, dir_dst, NULL);
1206           break;
1207         case BLO_WRITE_PATH_REMAP_RELATIVE_ALL:
1208           /* Make all relative (when requested or unsaved). */
1209           BKE_bpath_relative_convert(mainvar, dir_dst, NULL);
1210           break;
1211         case BLO_WRITE_PATH_REMAP_ABSOLUTE:
1212           /* Make all absolute (when requested or unsaved). */
1213           BKE_bpath_absolute_convert(mainvar, dir_src, NULL);
1214           break;
1215         case BLO_WRITE_PATH_REMAP_NONE:
1216           BLI_assert(0); /* Unreachable. */
1217           break;
1218       }
1219     }
1220   }
1221
1222   /* actual file writing */
1223   const bool err = write_file_handle(mainvar, &ww, NULL, NULL, write_flags, use_userdef, thumb);
1224
1225   ww.close(&ww);
1226
1227   if (UNLIKELY(path_list_backup)) {
1228     BKE_bpath_list_restore(mainvar, path_list_flag, path_list_backup);
1229     BKE_bpath_list_free(path_list_backup);
1230   }
1231
1232   if (err) {
1233     BKE_report(reports, RPT_ERROR, strerror(errno));
1234     remove(tempname);
1235
1236     return 0;
1237   }
1238
1239   /* file save to temporary file was successful */
1240   /* now do reverse file history (move .blend1 -> .blend2, .blend -> .blend1) */
1241   if (use_save_versions) {
1242     const bool err_hist = do_history(filepath, reports);
1243     if (err_hist) {
1244       BKE_report(reports, RPT_ERROR, "Version backup failed (file saved with @)");
1245       return 0;
1246     }
1247   }
1248
1249   if (BLI_rename(tempname, filepath) != 0) {
1250     BKE_report(reports, RPT_ERROR, "Cannot change old file (file saved with @)");
1251     return 0;
1252   }
1253
1254   if (G.debug & G_DEBUG_IO && mainvar->lock != NULL) {
1255     BKE_report(reports, RPT_INFO, "Checking sanity of current .blend file *AFTER* save to disk");
1256     BLO_main_validate_libraries(mainvar, reports);
1257   }
1258
1259   return 1;
1260 }
1261
1262 /**
1263  * \return Success.
1264  */
1265 bool BLO_write_file_mem(Main *mainvar, MemFile *compare, MemFile *current, int write_flags)
1266 {
1267   bool use_userdef = false;
1268
1269   const bool err = write_file_handle(
1270       mainvar, NULL, compare, current, write_flags, use_userdef, NULL);
1271
1272   return (err == 0);
1273 }
1274
1275 void BLO_write_raw(BlendWriter *writer, size_t size_in_bytes, const void *data_ptr)
1276 {
1277   writedata(writer->wd, DATA, size_in_bytes, data_ptr);
1278 }
1279
1280 void BLO_write_struct_by_name(BlendWriter *writer, const char *struct_name, const void *data_ptr)
1281 {
1282   BLO_write_struct_array_by_name(writer, struct_name, 1, data_ptr);
1283 }
1284
1285 void BLO_write_struct_array_by_name(BlendWriter *writer,
1286                                     const char *struct_name,
1287                                     int array_size,
1288                                     const void *data_ptr)
1289 {
1290   int struct_id = BLO_get_struct_id_by_name(writer, struct_name);
1291   if (UNLIKELY(struct_id == -1)) {
1292     printf("error: can't find SDNA code <%s>\n", struct_name);
1293     return;
1294   }
1295   BLO_write_struct_array_by_id(writer, struct_id, array_size, data_ptr);
1296 }
1297
1298 void BLO_write_struct_by_id(BlendWriter *writer, int struct_id, const void *data_ptr)
1299 {
1300   writestruct_nr(writer->wd, DATA, struct_id, 1, data_ptr);
1301 }
1302
1303 void BLO_write_struct_at_address_by_id(BlendWriter *writer,
1304                                        int struct_id,
1305                                        const void *address,
1306                                        const void *data_ptr)
1307 {
1308   BLO_write_struct_at_address_by_id_with_filecode(writer, DATA, struct_id, address, data_ptr);
1309 }
1310
1311 void BLO_write_struct_at_address_by_id_with_filecode(
1312     BlendWriter *writer, int filecode, int struct_id, const void *address, const void *data_ptr)
1313 {
1314   writestruct_at_address_nr(writer->wd, filecode, struct_id, 1, address, data_ptr);
1315 }
1316
1317 void BLO_write_struct_array_by_id(BlendWriter *writer,
1318                                   int struct_id,
1319                                   int array_size,
1320                                   const void *data_ptr)
1321 {
1322   writestruct_nr(writer->wd, DATA, struct_id, array_size, data_ptr);
1323 }
1324
1325 void BLO_write_struct_array_at_address_by_id(
1326     BlendWriter *writer, int struct_id, int array_size, const void *address, const void *data_ptr)
1327 {
1328   writestruct_at_address_nr(writer->wd, DATA, struct_id, array_size, address, data_ptr);
1329 }
1330
1331 void BLO_write_struct_list_by_id(BlendWriter *writer, int struct_id, ListBase *list)
1332 {
1333   writelist_nr(writer->wd, DATA, struct_id, list);
1334 }
1335
1336 void BLO_write_struct_list_by_name(BlendWriter *writer, const char *struct_name, ListBase *list)
1337 {
1338   int struct_id = BLO_get_struct_id_by_name(writer, struct_name);
1339   if (UNLIKELY(struct_id == -1)) {
1340     printf("error: can't find SDNA code <%s>\n", struct_name);
1341     return;
1342   }
1343   BLO_write_struct_list_by_id(writer, struct_id, list);
1344 }
1345
1346 void blo_write_id_struct(BlendWriter *writer, int struct_id, const void *id_address, const ID *id)
1347 {
1348   writestruct_at_address_nr(writer->wd, GS(id->name), struct_id, 1, id_address, id);
1349 }
1350
1351 int BLO_get_struct_id_by_name(BlendWriter *writer, const char *struct_name)
1352 {
1353   int struct_id = DNA_struct_find_nr(writer->wd->sdna, struct_name);
1354   return struct_id;
1355 }
1356
1357 void BLO_write_int32_array(BlendWriter *writer, uint num, const int32_t *data_ptr)
1358 {
1359   BLO_write_raw(writer, sizeof(int32_t) * (size_t)num, data_ptr);
1360 }
1361
1362 void BLO_write_uint32_array(BlendWriter *writer, uint num, const uint32_t *data_ptr)
1363 {
1364   BLO_write_raw(writer, sizeof(uint32_t) * (size_t)num, data_ptr);
1365 }
1366
1367 void BLO_write_float_array(BlendWriter *writer, uint num, const float *data_ptr)
1368 {
1369   BLO_write_raw(writer, sizeof(float) * (size_t)num, data_ptr);
1370 }
1371
1372 void BLO_write_pointer_array(BlendWriter *writer, uint num, const void *data_ptr)
1373 {
1374   BLO_write_raw(writer, sizeof(void *) * (size_t)num, data_ptr);
1375 }
1376
1377 void BLO_write_float3_array(BlendWriter *writer, uint num, const float *data_ptr)
1378 {
1379   BLO_write_raw(writer, sizeof(float[3]) * (size_t)num, data_ptr);
1380 }
1381
1382 /**
1383  * Write a null terminated string.
1384  */
1385 void BLO_write_string(BlendWriter *writer, const char *data_ptr)
1386 {
1387   if (data_ptr != NULL) {
1388     BLO_write_raw(writer, strlen(data_ptr) + 1, data_ptr);
1389   }
1390 }
1391
1392 /**
1393  * Sometimes different data is written depending on whether the file is saved to disk or used for
1394  * undo. This function returns true when the current file-writing is done for undo.
1395  */
1396 bool BLO_write_is_undo(BlendWriter *writer)
1397 {
1398   return writer->wd->use_memfile;
1399 }
1400
1401 /** \} */