DNA_genfile.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "intern/dna_utils.h"
 
struct SDNA;

extern const unsigned char DNAstr[];
extern const int DNAlen;

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, */ /* deprecated (use as int) */
  /* SDNA_TYPE_ULONG    = 6, */ /* deprecated (use as int) */
  SDNA_TYPE_FLOAT = 7,
  SDNA_TYPE_DOUBLE = 8,
/* ,SDNA_TYPE_VOID = 9 */
/* define so switch statements don't complain */
#define SDNA_TYPE_VOID 9
  SDNA_TYPE_INT64 = 10,
  SDNA_TYPE_UINT64 = 11,
  SDNA_TYPE_INT8 = 12,
  SDNA_TYPE_RAW_DATA = 13,
} eSDNA_Type;

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,
  /* This is only used temporarily by #DNA_struct_get_compareflags. */
  SDNA_CMP_UNKNOWN = 3,
};

struct SDNA *DNA_sdna_from_data(const void *data,
                                int data_len,
                                bool do_endian_swap,
                                bool data_alloc,
                                bool do_alias,
                                const char **r_error_message);
void DNA_sdna_free(struct SDNA *sdna);
 
/* 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);
 
struct DNA_ReconstructInfo;
struct DNA_ReconstructInfo *DNA_reconstruct_info_create(const struct SDNA *oldsdna,
                                                        const struct SDNA *newsdna,
                                                        const char *compare_flags);
void DNA_reconstruct_info_free(struct DNA_ReconstructInfo *reconstruct_info);

int DNA_struct_find_index_with_alias_ex(const struct SDNA *sdna,
                                        const char *str,
                                        unsigned int *struct_index_last);
int DNA_struct_find_index_without_alias_ex(const struct SDNA *sdna,
                                           const char *str,
                                           unsigned int *struct_index_last);
int DNA_struct_find_with_alias(const struct SDNA *sdna, const char *str);
int DNA_struct_find_index_without_alias(const struct SDNA *sdna, const char *str);

bool DNA_struct_exists_with_alias(const struct SDNA *sdna, const char *str);
bool DNA_struct_exists_without_alias(const struct SDNA *sdna, const char *stype);
bool DNA_struct_member_exists_with_alias(const struct SDNA *sdna,
                                         const char *stype,
                                         const char *vartype,
                                         const char *name);
bool DNA_struct_member_exists_without_alias(const struct SDNA *sdna,
                                            const char *stype,
                                            const char *vartype,
                                            const char *name);

void DNA_struct_switch_endian(const struct SDNA *sdna, int struct_index, char *data);
const char *DNA_struct_get_compareflags(const struct SDNA *oldsdna, const struct SDNA *newsdna);
void *DNA_struct_reconstruct(const struct DNA_ReconstructInfo *reconstruct_info,
                             int old_struct_index,
                             int blocks,
                             const void *old_blocks,
                             const char *alloc_name);

int DNA_struct_member_offset_by_name_without_alias(const struct SDNA *sdna,
                                                   const char *stype,
                                                   const char *vartype,
                                                   const char *name);
int DNA_struct_member_offset_by_name_with_alias(const struct SDNA *sdna,
                                                const char *stype,
                                                const char *vartype,
                                                const char *name);

int DNA_struct_member_size(const struct SDNA *sdna, short type, short member_index);

int DNA_elem_type_size(eSDNA_Type elem_nr);

int DNA_struct_size(const struct SDNA *sdna, int struct_index);

int DNA_struct_alignment(const struct SDNA *sdna, int struct_index);

const char *DNA_struct_identifier(struct SDNA *sdna, int struct_index);

bool DNA_sdna_patch_struct_by_name(struct SDNA *sdna,
                                   const char *old_type_name,
                                   const char *new_type_name);
bool DNA_sdna_patch_struct_member_by_name(struct SDNA *sdna,
                                          const char *type_name,
                                          const char *old_member_name,
                                          const char *new_member_name);
 
void DNA_sdna_alias_data_ensure(struct SDNA *sdna);

void DNA_sdna_alias_data_ensure_structs_map(struct SDNA *sdna);
 
/* For versioning, avoid verbosity selecting between with/without alias versions of functions. */
#ifdef DNA_GENFILE_VERSIONING_MACROS
#  define DNA_struct_exists(sdna, str) DNA_struct_exists_with_alias(sdna, str)
#  define DNA_struct_member_exists(sdna, stype, vartype, name) \
    DNA_struct_member_exists_with_alias(sdna, stype, vartype, name)
#endif