Blender
V3.3
|
Struct muncher for making SDNA. More...
#include <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "MEM_guardedalloc.h"
#include "BLI_alloca.h"
#include "BLI_ghash.h"
#include "BLI_memarena.h"
#include "BLI_sys_types.h"
#include "BLI_system.h"
#include "BLI_utildefines.h"
#include "dna_utils.h"
#include "dna_includes_as_strings.h"
#include "dna_includes_all.h"
#include "dna_rename_defs.h"
Go to the source code of this file.
Macros | |
#define | DNA_DEPRECATED_ALLOW |
#define | SDNA_MAX_FILENAME_LENGTH 255 |
#define | FORCE_ALIGN_4 " " |
#define | DNA_STRUCT_RENAME(old, new) (void)sizeof(new); |
#define | DNA_STRUCT_RENAME_ELEM(struct_name, old, new) (void)offsetof(struct_name, new); |
Functions | |
Function Declarations | |
static int | add_type (const char *str, int size) |
static int | add_name (const char *str) |
static short * | add_struct (int namecode) |
static int | preprocess_include (char *maindata, const int maindata_len) |
static int | convert_include (const char *filepath) |
static int | calculate_struct_sizes (int firststruct, FILE *file_verify, const char *base_directory) |
static void | dna_write (FILE *file, const void *pntr, const int size) |
void | print_struct_sizes (void) |
DNA Renaming Sanity Check | |
Disable types:
Only valid use would be as a runtime variable if an API expected a long, but so far we don't have this happening. Without this it's possible to reference struct members that don't exist, breaking backward & forward compatibility. | |
static void UNUSED_FUNCTION() | dna_rename_defs_ensure (void) |
Variables | |
static const char * | includefiles [] |
Variables | |
#define | DEBUG_PRINTF(debug_level, ...) |
static MemArena * | mem_arena = NULL |
static int | max_data_size = 500000 |
static int | max_array_len = 50000 |
static int | names_len = 0 |
static int | types_len = 0 |
static int | structs_len = 0 |
static char ** | names |
static char ** | types |
static short * | types_size_native |
static short * | types_align_32 |
static short * | types_align_64 |
static short * | types_size_32 |
static short * | types_size_64 |
static short ** | structs |
static short * | structdata |
struct { | |
GHash * struct_map_alias_from_static | |
GHash * struct_map_static_from_alias | |
GHash * elem_map_alias_from_static | |
GHash * elem_map_static_from_alias | |
} | g_version_data = {NULL} |
static int | debugSDNA = 0 |
static int | additional_slen_offset |
void | BLI_system_backtrace (FILE *fp) |
Implementation | |
#define | MAX_DNA_LINE_LENGTH 20 |
static bool | match_identifier_with_len (const char *str, const char *identifier, const size_t identifier_len) |
static bool | match_identifier (const char *str, const char *identifier) |
static bool | match_identifier_and_advance (char **str_ptr, const char *identifier) |
static const char * | version_struct_static_from_alias (const char *str) |
static const char * | version_struct_alias_from_static (const char *str) |
static const char * | version_elem_static_from_alias (const int strct, const char *elem_alias_full) |
static bool | is_name_legal (const char *name) |
static void * | read_file_data (const char *filepath, int *r_len) |
static bool | check_field_alignment (int firststruct, int structtype, int type, int len, const char *name, const char *detail) |
static int | make_structDNA (const char *base_directory, FILE *file, FILE *file_offsets, FILE *file_verify) |
Main Function | |
#define | BASE_HEADER "../" |
static void | make_bad_file (const char *file, int line) |
int | main (int argc, char **argv) |
Struct muncher for making SDNA.
makesdna
creates a .c file with a long string of numbers that encode the Blender file format. It is fast, because it is basically a binary dump. There are some details to mind when reconstructing the file (endianness and byte-alignment).
This little program scans all structs that need to be serialized, and determined the names and types of all members. It calculates how much memory (on disk or in ram) is needed to store that struct, and the offsets for reaching a particular one.
There is a facility to get verbose output from sdna
. Search for debugSDNA. This int can be set to 0 (no output) to some int. Higher numbers give more output.
Definition in file makesdna.c.
#define BASE_HEADER "../" |
Definition at line 1436 of file makesdna.c.
#define DEBUG_PRINTF | ( | debug_level, | |
... | |||
) |
Definition at line 105 of file makesdna.c.
#define DNA_DEPRECATED_ALLOW |
Definition at line 26 of file makesdna.c.
#define FORCE_ALIGN_4 " " |
#define MAX_DNA_LINE_LENGTH 20 |
Definition at line 1127 of file makesdna.c.
#define SDNA_MAX_FILENAME_LENGTH 255 |
Definition at line 44 of file makesdna.c.
|
static |
Ensure str
is int the names array.
str | Struct member name which may include pointer prefix & array size. |
Because of the weird way of tokenizing, we have to 'cast' function pointers to ... (*f)(), whatever the original signature. In fact, we add name and type at the same time... There are two special cases, unfortunately. These are explicitly checked.
Definition at line 347 of file makesdna.c.
References additional_slen_offset, BLI_memarena_alloc(), DEBUG_PRINTF, is_name_legal(), max_array_len, mem_arena, names, names_len, NULL, str, and STREQ.
Referenced by convert_include().
|
static |
Search whether this structure type was already found, and if not, add it.
Definition at line 486 of file makesdna.c.
References len, max_array_len, structdata, structs, and structs_len.
Referenced by convert_include().
|
static |
Ensure type str
to is in the types array.
str | Struct name without any qualifiers. |
size | The struct size in bytes. |
Definition at line 294 of file makesdna.c.
References BLI_memarena_alloc(), max_array_len, mem_arena, size(), str, STREQ, types, types_align_32, types_align_64, types_len, types_size_32, types_size_64, types_size_native, and version_struct_static_from_alias().
Referenced by convert_include(), and make_structDNA().
void BLI_system_backtrace | ( | FILE * | fp | ) |
Write a backtrace into a file for systems which support it.
Definition at line 115 of file makesdna.c.
References void.
|
static |
Determine how many bytes are needed for each struct.
Definition at line 853 of file makesdna.c.
References Freestyle::a, usdtokens::b(), BLI_assert, BLI_ghash_lookup(), check_field_alignment(), debugSDNA, DNA_elem_array_size(), DNA_elem_id_strip_copy(), ELEM, g_version_data, includefiles, MAX2, mul(), names, structs, structs_len, type, types, types_align_32, types_align_64, types_size_32, types_size_64, types_size_native, and version_struct_alias_from_static().
Referenced by make_structDNA().
|
static |
Definition at line 819 of file makesdna.c.
References len, result, type, types, and types_size_native.
Referenced by calculate_struct_sizes().
|
static |
Scan this file for serializable types.
Definition at line 633 of file makesdna.c.
References add_name(), add_struct(), add_type(), additional_slen_offset, count, DEBUG_PRINTF, ELEM, match_identifier(), match_identifier_and_advance(), MEM_freeN, names, NULL, preprocess_include(), read_file_data(), type, types, UNLIKELY, and version_elem_static_from_alias().
Referenced by make_structDNA().
|
static |
Definition at line 1555 of file makesdna.c.
Construct the DNA.c file
Definition at line 1129 of file makesdna.c.
References data, file, MAX_DNA_LINE_LENGTH, and size().
Referenced by make_structDNA().
|
static |
Enforce '_pad123' naming convention, disallow 'pad123' or 'pad_123', special exception for [a-z] after since there is a 'pad_rot_angle' preference.
Definition at line 255 of file makesdna.c.
References Freestyle::c, and DNA_elem_id_strip_copy().
Referenced by add_name().
int main | ( | int | argc, |
char ** | argv | ||
) |
Definition at line 1439 of file makesdna.c.
References BASE_HEADER, ELEM, FORCE_ALIGN_4, make_bad_file(), make_structDNA(), and NULL.
|
static |
|
static |
Insertion of all known types.
Definition at line 1163 of file makesdna.c.
References Freestyle::a, add_type(), usdtokens::b(), BLI_ghash_free(), BLI_gset_add(), BLI_gset_clear(), BLI_gset_free(), BLI_gset_str_new_ex(), BLI_memarena_free(), BLI_memarena_new(), BLI_MEMARENA_STD_BUFSIZE, calculate_struct_sizes(), convert_include(), DEBUG_PRINTF, debugSDNA, DNA_alias_maps(), DNA_elem_id_strip(), DNA_RENAME_ALIAS_FROM_STATIC, DNA_RENAME_STATIC_FROM_ALIAS, dna_write(), file, g_version_data, includefiles, len, max_array_len, max_data_size, mem_arena, MEM_callocN, MEM_freeN, names, names_len, NULL, SDNA_MAX_FILENAME_LENGTH, str, structdata, structs, structs_len, types, types_align_32, types_align_64, types_len, types_size_32, types_size_64, types_size_native, and version_struct_alias_from_static().
Referenced by main().
|
static |
Definition at line 197 of file makesdna.c.
References match_identifier_with_len(), and str.
Referenced by convert_include(), and preprocess_include().
|
static |
Definition at line 203 of file makesdna.c.
References match_identifier_with_len().
Referenced by convert_include().
|
static |
Definition at line 182 of file makesdna.c.
References str.
Referenced by match_identifier(), and match_identifier_and_advance().
|
static |
Remove comments from this buffer. Assumes that the buffer refers to ascii-code text.
Definition at line 509 of file makesdna.c.
References Freestyle::a, match_identifier(), MEM_freeN, and MEM_mallocN.
Referenced by convert_include().
Report all structures found so far, and print their lengths.
Definition at line 1144 of file makesdna.c.
References Freestyle::a, structs, structs_len, types, and types_size_native.
|
static |
Definition at line 592 of file makesdna.c.
References data, L, MEM_freeN, MEM_mallocN, and NULL.
Referenced by convert_include().
|
static |
Definition at line 231 of file makesdna.c.
References BLI_ghash_lookup(), DNA_elem_id_offset_start(), DNA_elem_id_rename(), DNA_elem_id_strip_copy(), g_version_data, mem_arena, NULL, and types.
Referenced by convert_include().
|
static |
Definition at line 222 of file makesdna.c.
References BLI_ghash_lookup(), g_version_data, NULL, and str.
Referenced by calculate_struct_sizes(), and make_structDNA().
|
static |
Definition at line 213 of file makesdna.c.
References BLI_ghash_lookup(), g_version_data, NULL, and str.
Referenced by add_type().
|
static |
Definition at line 103 of file makesdna.c.
Referenced by add_name(), and convert_include().
|
static |
Variable to control debug output of makesdna. debugSDNA:
Definition at line 102 of file makesdna.c.
Referenced by calculate_struct_sizes(), and make_structDNA().
GHash* elem_map_alias_from_static |
Definition at line 90 of file makesdna.c.
Referenced by DNA_sdna_alias_data_ensure(), and dna_sdna_alias_from_static_elem_full().
GHash* elem_map_static_from_alias |
Definition at line 91 of file makesdna.c.
struct { ... } g_version_data |
Versioning data
Referenced by calculate_struct_sizes(), make_structDNA(), version_elem_static_from_alias(), version_struct_alias_from_static(), and version_struct_static_from_alias().
|
static |
Definition at line 48 of file makesdna.c.
Referenced by calculate_struct_sizes(), and make_structDNA().
|
static |
Definition at line 60 of file makesdna.c.
Referenced by add_name(), add_struct(), add_type(), and make_structDNA().
|
static |
Definition at line 60 of file makesdna.c.
Referenced by make_structDNA().
Definition at line 58 of file makesdna.c.
Referenced by add_name(), add_new_bound_vert(), add_type(), adj_vmesh(), BM_face_split_edgenet_connect_islands(), build_boundary(), build_boundary_terminal_edge(), DNA_elem_id_rename(), edbm_face_split_by_edges_exec(), ghash_insert_face_edge_link(), ghash_insert_link(), make_cube_corner_adj_vmesh(), make_cube_corner_square(), make_cube_corner_square_in(), make_structDNA(), new_adj_vmesh(), and version_elem_static_from_alias().
|
static |
At address names[a]
is string a
.
Definition at line 65 of file makesdna.c.
Referenced by _bpy_names(), add_name(), BKE_image_add_generated(), BKE_image_render_write(), BKE_sound_get_device_names(), BLO_blendhandle_get_datablock_names(), BLO_blendhandle_get_linkable_groups(), BLO_main_validate_libraries(), bpy_pydriver_create_dict(), calculate_struct_sizes(), convert_include(), blender::compositor::OutputStereoOperation::deinit_execution(), driver_compile_simple_expr_impl(), elem_exists_impl(), blender::nodes::geometry_nodes_eval_log::GeometryValueLog::GeometryValueLog(), blender::ed::space_node::get_attribute_info_from_context(), blender::compositor::OutputStereoOperation::get_handle(), image_save_single(), image_update_views_format(), blender::nodes::geometry_nodes_eval_log::NodeLog::lookup_available_attributes(), make_structDNA(), blender::nodes::node_shader_tex_environment_cc::node_shader_gpu_tex_environment(), parse_for_eval(), RE_WriteRenderViewsMovie(), sequencer_draw_preview(), TEST(), SocketType::type_name(), uilist_filter_items_default(), and view3d_stereo3d_setup().
|
static |
Definition at line 61 of file makesdna.c.
Referenced by add_name(), driver_compile_simple_expr_impl(), and make_structDNA().
GHash* struct_map_alias_from_static |
Definition at line 88 of file makesdna.c.
Referenced by DNA_sdna_alias_data_ensure().
GHash* struct_map_static_from_alias |
Definition at line 89 of file makesdna.c.
|
static |
Definition at line 84 of file makesdna.c.
Referenced by add_struct(), and make_structDNA().
|
static |
At sp = structs[a]
is the first address of a struct definition:
sp[0]
is type number.sp[1]
is the length of the element array (next).sp[2]
sp[3] is [(type_index, name_index), ..] (number of pairs is defined by sp[1]
), Definition at line 84 of file makesdna.c.
Referenced by add_struct(), calculate_struct_sizes(), dna_struct_find_nr_ex_impl(), make_structDNA(), and print_struct_sizes().
|
static |
Definition at line 63 of file makesdna.c.
Referenced by add_struct(), calculate_struct_sizes(), dna_struct_find_nr_ex_impl(), make_structDNA(), and print_struct_sizes().
|
static |
At address types[a]
is string a
.
Definition at line 67 of file makesdna.c.
Referenced by add_type(), Device::available_types(), BKE_sculpt_color_layer_create_if_needed(), BLI_filelist_entry_mode_to_string(), blender::bke::CurvesGeometry::calculate_bezier_auto_handles(), blender::bke::calculate_evaluated_offsets(), calculate_struct_sizes(), blender::bke::calculate_type_counts(), check_field_alignment(), blender::nodes::node_geo_input_tangent_cc::construct_curve_tangent_gvarray(), convert_include(), blender::bke::curve_legacy_to_curves(), blender::nodes::node_geo_curve_spline_parameter_cc::curve_length_point_domain(), blender::bke::curve_normal_point_domain(), blender::bke::curve_normals_varray(), curve_render_data_create(), blender::nodes::node_geo_input_tangent_cc::curve_tangent_point_domain(), data_offer_handle_offer(), dna_struct_find_nr_ex_impl(), dt_add_vcol_layers(), elem_exists_impl(), blender::bke::CurvesGeometry::evaluated_normals(), blender::bke::CurvesGeometry::evaluated_positions(), blender::bke::curves::foreach_curve_by_type(), GeometrySet::gather_component_types(), AnimationImporter::get_animation_type(), blender::bke::CurvesGeometry::has_curve_with_type(), blender::bke::curves::indices_for_type(), blender::bke::CurvesGeometry::interpolate_to_evaluated(), lattice_render_data_create(), lineart_gpencil_generate(), make_structDNA(), blender::nodes::node_geo_attribute_capture_cc::node_geo_exec(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), options_parse(), print_struct_sizes(), AnimationImporter::setAnimType(), sort_bmelem_flag(), blender::tests::TEST(), DocumentImporter::translate_anim_recursive(), and version_elem_static_from_alias().
|
static |
Contains align requirements for a struct on 32 bit systems.
Definition at line 71 of file makesdna.c.
Referenced by add_type(), calculate_struct_sizes(), and make_structDNA().
|
static |
Contains align requirements for a struct on 64 bit systems.
Definition at line 73 of file makesdna.c.
Referenced by add_type(), calculate_struct_sizes(), and make_structDNA().
|
static |
Definition at line 62 of file makesdna.c.
Referenced by add_type(), and make_structDNA().
|
static |
Contains sizes as they are calculated on 32 bit systems.
Definition at line 75 of file makesdna.c.
Referenced by add_type(), calculate_struct_sizes(), and make_structDNA().
|
static |
Contains sizes as they are calculated on 64 bit systems.
Definition at line 77 of file makesdna.c.
Referenced by add_type(), calculate_struct_sizes(), and make_structDNA().
|
static |
At types_size[a]
is the size of type a
on this systems bitness (32 or 64).
Definition at line 69 of file makesdna.c.
Referenced by add_type(), calculate_struct_sizes(), check_field_alignment(), make_structDNA(), and print_struct_sizes().