Merge remote-tracking branch 'origin/master' into blender2.8
[blender.git] / source / blender / makesdna / DNA_genfile.h
index 2264e82b36325cad789bc94c6793cd09425bb7b7..9e9ab974b01cf145981dce71cf7ee4159368bbd8 100644 (file)
  *  \brief blenloader genfile private function prototypes
  */
 
-#ifndef DNA_GENFILE_H
-#define DNA_GENFILE_H
+#ifndef __DNA_GENFILE_H__
+#define __DNA_GENFILE_H__
 
 struct SDNA;
 
-extern unsigned char DNAstr[];  /* DNA.c */
-extern int DNAlen;
+/* DNAstr contains the prebuilt SDNA structure defining the layouts of the types
+ * used by this version of Blender. It is defined in a file dna.c, which is
+ * generated by the makesdna program during the build process (see makesdna.c). */
+extern const unsigned char DNAstr[];
+extern const int DNAlen; /* length of DNAstr */
 
+/**
+ * Primitive (non-struct, non-pointer/function/array) types,
+ * \warning Don't change these values!
+ * Currently changes here here will work on native endianness,
+ * however #DNA_struct_switch_endian currently checks these
+ * hard-coded values against those from old files.
+ */
 typedef enum eSDNA_Type {
        SDNA_TYPE_CHAR     = 0,
        SDNA_TYPE_UCHAR    = 1,
        SDNA_TYPE_SHORT    = 2,
        SDNA_TYPE_USHORT   = 3,
        SDNA_TYPE_INT      = 4,
-       SDNA_TYPE_LONG     = 5,
-       SDNA_TYPE_ULONG    = 6,
+       /* SDNA_TYPE_LONG     = 5, */  /* deprecated (use as int) */
+       /* SDNA_TYPE_ULONG    = 6, */  /* deprecated (use as int) */
        SDNA_TYPE_FLOAT    = 7,
        SDNA_TYPE_DOUBLE   = 8,
-       /* ,SDNA_TYPE_VOID = 9 */ /* nothing uses yet */
+       /* ,SDNA_TYPE_VOID = 9 */
+/* define so switch statements don't complain */
+#define SDNA_TYPE_VOID 9
        SDNA_TYPE_INT64    = 10,
        SDNA_TYPE_UINT64   = 11
 } eSDNA_Type;
 
-/* define so switch statements don't complain */
-#define SDNA_TYPE_VOID 9
+/**
+ * For use with #DNA_struct_reconstruct & #DNA_struct_get_compareflags
+ */
+enum eSDNA_StructCompare {
+       /* Struct has disappeared (values of this struct type will not be loaded by the current Blender) */
+       SDNA_CMP_REMOVED    = 0,
+       /* Struct is the same (can be loaded with straight memory copy after any necessary endian conversion) */
+       SDNA_CMP_EQUAL      = 1,
+       /* Struct is different in some way (needs to be copied/converted field by field) */
+       SDNA_CMP_NOT_EQUAL  = 2,
+};
 
-struct SDNA *DNA_sdna_from_data(void *data, int datalen, int do_endian_swap);
+struct SDNA *DNA_sdna_from_data(
+        const void *data, const int datalen,
+        bool do_endian_swap, bool data_alloc,
+        const char **r_error_message);
 void DNA_sdna_free(struct SDNA *sdna);
 
-int DNA_struct_find_nr(struct SDNA *sdna, const char *str);
-void DNA_struct_switch_endian(struct SDNA *oldsdna, int oldSDNAnr, char *data);
-char *DNA_struct_get_compareflags(struct SDNA *sdna, struct SDNA *newsdna);
-void *DNA_struct_reconstruct(struct SDNA *newsdna, struct SDNA *oldsdna, char *compflags, int oldSDNAnr, int blocks, void *data);
+/* Access for current Blender versions SDNA*/
+void               DNA_sdna_current_init(void);
+/* borrowed reference */
+const struct SDNA *DNA_sdna_current_get(void);
+void               DNA_sdna_current_free(void);
 
-int DNA_elem_array_size(const char *astr, int len);
+int DNA_struct_find_nr_ex(const struct SDNA *sdna, const char *str, unsigned int *index_last);
+int DNA_struct_find_nr(const struct SDNA *sdna, const char *str);
+void DNA_struct_switch_endian(const struct SDNA *oldsdna, int oldSDNAnr, char *data);
+const char *DNA_struct_get_compareflags(const struct SDNA *sdna, const struct SDNA *newsdna);
+void *DNA_struct_reconstruct(
+        const struct SDNA *newsdna, const struct SDNA *oldsdna,
+        const char *compflags, int oldSDNAnr, int blocks, const void *data);
+
+int DNA_elem_array_size(const char *str);
 int DNA_elem_offset(struct SDNA *sdna, const char *stype, const char *vartype, const char *name);
 
+bool DNA_struct_find(const struct SDNA *sdna, const char *stype);
+bool DNA_struct_elem_find(const struct SDNA *sdna, const char *stype, const char *vartype, const char *name);
+
 
 int DNA_elem_type_size(const eSDNA_Type elem_nr);
 
-#endif
+#endif /* __DNA_GENFILE_H__ */