Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesdna / DNA_genfile.h
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  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_genfile.h
29  *  \ingroup DNA
30  *  \brief blenloader genfile private function prototypes
31  */
32
33 #ifndef __DNA_GENFILE_H__
34 #define __DNA_GENFILE_H__
35
36 struct SDNA;
37
38 /* DNAstr contains the prebuilt SDNA structure defining the layouts of the types
39  * used by this version of Blender. It is defined in a file dna.c, which is
40  * generated by the makesdna program during the build process (see makesdna.c). */
41 extern const unsigned char DNAstr[];
42 extern const int DNAlen; /* length of DNAstr */
43
44 /**
45  * Primitive (non-struct, non-pointer/function/array) types,
46  * \warning Don't change these values!
47  * Currently changes here here will work on native endianness,
48  * however #DNA_struct_switch_endian currently checks these
49  * hard-coded values against those from old files.
50  */
51 typedef enum eSDNA_Type {
52         SDNA_TYPE_CHAR     = 0,
53         SDNA_TYPE_UCHAR    = 1,
54         SDNA_TYPE_SHORT    = 2,
55         SDNA_TYPE_USHORT   = 3,
56         SDNA_TYPE_INT      = 4,
57         /* SDNA_TYPE_LONG     = 5, */  /* deprecated (use as int) */
58         /* SDNA_TYPE_ULONG    = 6, */  /* deprecated (use as int) */
59         SDNA_TYPE_FLOAT    = 7,
60         SDNA_TYPE_DOUBLE   = 8,
61         /* ,SDNA_TYPE_VOID = 9 */
62 /* define so switch statements don't complain */
63 #define SDNA_TYPE_VOID 9
64         SDNA_TYPE_INT64    = 10,
65         SDNA_TYPE_UINT64   = 11
66 } eSDNA_Type;
67
68 /**
69  * For use with #DNA_struct_reconstruct & #DNA_struct_get_compareflags
70  */
71 enum eSDNA_StructCompare {
72         SDNA_CMP_REMOVED    = 0,
73         SDNA_CMP_EQUAL      = 1,
74         SDNA_CMP_NOT_EQUAL  = 2,
75 };
76
77 struct SDNA *DNA_sdna_from_data(
78         const void *data, const int datalen,
79         bool do_endian_swap, bool data_alloc,
80         const char **r_error_message);
81 void DNA_sdna_free(struct SDNA *sdna);
82
83 /* Access for current Blender versions SDNA*/
84 void               DNA_sdna_current_init(void);
85 /* borrowed reference */
86 const struct SDNA *DNA_sdna_current_get(void);
87 void               DNA_sdna_current_free(void);
88
89 int DNA_struct_find_nr_ex(const struct SDNA *sdna, const char *str, unsigned int *index_last);
90 int DNA_struct_find_nr(const struct SDNA *sdna, const char *str);
91 void DNA_struct_switch_endian(const struct SDNA *oldsdna, int oldSDNAnr, char *data);
92 char *DNA_struct_get_compareflags(const struct SDNA *sdna, const struct SDNA *newsdna);
93 void *DNA_struct_reconstruct(
94         const struct SDNA *newsdna, const struct SDNA *oldsdna,
95         char *compflags, int oldSDNAnr, int blocks, void *data);
96
97 int DNA_elem_array_size(const char *str);
98 int DNA_elem_offset(struct SDNA *sdna, const char *stype, const char *vartype, const char *name);
99
100 bool DNA_struct_elem_find(struct SDNA *sdna, const char *stype, const char *vartype, const char *name);
101
102
103 int DNA_elem_type_size(const eSDNA_Type elem_nr);
104
105 #endif /* __DNA_GENFILE_H__ */