Cleanup: Remove debugging change, add comments
[blender.git] / source / blender / blenloader / BLO_undofile.h
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) 2004 Blender Foundation.
17  * All rights reserved.
18  * external writefile function prototypes
19  */
20
21 #pragma once
22
23 /** \file
24  * \ingroup blenloader
25  */
26
27 #include "BLI_filereader.h"
28
29 struct GHash;
30 struct Scene;
31
32 typedef struct {
33   void *next, *prev;
34   const char *buf;
35   /** Size in bytes. */
36   size_t size;
37   /** When true, this chunk doesn't own the memory, it's shared with a previous #MemFileChunk */
38   bool is_identical;
39   /** When true, this chunk is also identical to the one in the next step (used by undo code to
40    * detect unchanged IDs).
41    * Defined when writing the next step (i.e. last undo step has those always false). */
42   bool is_identical_future;
43   /** Session UUID of the ID being currently written (MAIN_ID_SESSION_UUID_UNSET when not writing
44    * ID-related data). Used to find matching chunks in previous memundo step. */
45   uint id_session_uuid;
46 } MemFileChunk;
47
48 typedef struct MemFile {
49   ListBase chunks;
50   size_t size;
51 } MemFile;
52
53 typedef struct MemFileWriteData {
54   MemFile *written_memfile;
55   MemFile *reference_memfile;
56
57   uint current_id_session_uuid;
58   MemFileChunk *reference_current_chunk;
59
60   /** Maps an ID session uuid to its first reference MemFileChunk, if existing. */
61   struct GHash *id_session_uuid_mapping;
62 } MemFileWriteData;
63
64 typedef struct MemFileUndoData {
65   char filename[1024]; /* FILE_MAX */
66   MemFile memfile;
67   size_t undo_size;
68 } MemFileUndoData;
69
70 /* FileReader-compatible wrapper for reading MemFiles */
71 typedef struct {
72   FileReader reader;
73
74   MemFile *memfile;
75   int undo_direction;
76
77   bool memchunk_identical;
78 } UndoReader;
79
80 /* actually only used writefile.c */
81
82 void BLO_memfile_write_init(MemFileWriteData *mem_data,
83                             MemFile *written_memfile,
84                             MemFile *reference_memfile);
85 void BLO_memfile_write_finalize(MemFileWriteData *mem_data);
86
87 void BLO_memfile_chunk_add(MemFileWriteData *mem_data, const char *buf, size_t size);
88
89 /* exports */
90 extern void BLO_memfile_free(MemFile *memfile);
91 extern void BLO_memfile_merge(MemFile *first, MemFile *second);
92 extern void BLO_memfile_clear_future(MemFile *memfile);
93
94 /* utilities */
95 extern struct Main *BLO_memfile_main_get(struct MemFile *memfile,
96                                          struct Main *bmain,
97                                          struct Scene **r_scene);
98 extern bool BLO_memfile_write_file(struct MemFile *memfile, const char *filename);
99
100 FileReader *BLO_memfile_new_filereader(MemFile *memfile, int undo_direction);