Blender V5.3
BLO_read_write.hh File Reference
#include <type_traits>
#include "DNA_ID.h"
#include "DNA_listBase.h"
#include "DNA_sdna_type_ids.hh"
#include "BLI_dynamic_stack_buffer.hh"
#include "BLI_function_ref.hh"
#include "BLI_implicit_sharing.hh"
#include "BLI_map.hh"
#include "BLO_core_bhead.hh"

Go to the source code of this file.

Classes

class  blender::BlendStructWriterVoid
class  blender::BlendStructWriter< T >
struct  blender::BlendWriter
struct  blender::BlendDataReader
struct  blender::BlendLibReader
struct  blender::BLO_Write_IDBuffer

Namespaces

namespace  blender
 BMesh Iterators.

Macros

#define blo_blend_struct_writer_fn_typed(T, fn)

Typedefs

using blender::BlendStructWriterFn = FunctionRef<void(BlendStructWriterVoid &struct_writer)>
template<typename T>
using blender::BlendStructWriterTypedFn

Functions

Blend Read Lib API

This API does almost the same as the Blend Read Data API. However, now only pointers to ID data blocks are updated.

ID * blender::BLO_read_get_new_id_address (BlendLibReader *reader, ID *self_id, const bool is_linked_only, ID *id) ATTR_NONNULL(2)
ID * blender::BLO_read_get_new_id_address_from_session_uid (BlendLibReader *reader, uint session_uid) ATTR_NONNULL(1)
bool blender::BLO_read_lib_is_undo (BlendLibReader *reader)
Main * blender::BLO_read_lib_get_main (BlendLibReader *reader)
BlendFileReadReport * blender::BLO_read_lib_reports (BlendLibReader *reader)
Report API
void blender::BLO_reportf_wrap (BlendFileReadReport *reports, eReportType type, const char *format,...) ATTR_PRINTF_FORMAT(3

Blend Read Data API

Generally, for every BLO_write_* call there should be a corresponding BLO_read_* call.

Most BLO_read_* functions get a pointer to a pointer as argument. That allows the function to update the pointer to its new value.

When the given pointer points to a memory buffer that was not stored in the file, the pointer is updated to be NULL. When it was pointing to NULL before, it will stay that way.

Examples of matching calls:

writer->write_struct(clmd->sim_parms);
BLO_read_struct(reader, ClothSimSettings, &clmd->sim_parms);
writer->write_struct_list(&action->markers);
BLO_read_struct_list(reader, TimeMarker, &action->markers);
writer->write_int32_array(hmd->totindex, hmd->indexar);
if (!BLO_read_array(reader, &hmd->indexar, hmd->totindex)) {
hmd->totindex = 0;
}
#define BLO_read_struct_list(reader, struct_name, list)
#define BLO_read_struct(reader, struct_name, ptr_p)

Avoid using the generic BLO_read_raw_address when possible, use the typed functions instead. Only data written with #BlendWriter::write_raw should typically be read with BLO_read_raw_address.

#define BLO_read_raw_address(reader, ptr_p)
#define BLO_read_struct(reader, struct_name, ptr_p)
#define BLO_read_struct_nonnull(reader, struct_name, ptr_p)
#define BLO_read_struct_no_us(reader, struct_name, ptr_p)
#define BLO_read_struct_array_no_us(reader, struct_name, ptr_p, array_size)
#define BLO_read_struct_no_us_nonnull(reader, struct_name, ptr_p)
#define BLO_read_struct_list(reader, struct_name, list)
void * blender::blo_read_raw_address_impl (BlendDataReader *reader, const void *old_address)
void * blender::blo_read_struct_impl (BlendDataReader *reader, const void *old_address, size_t expected_size)
void * blender::blo_read_struct_nonnull_impl (BlendDataReader *reader, const void *old_address, size_t expected_size)
void * blender::blo_read_struct_no_us_impl (BlendDataReader *reader, const void *old_address, size_t expected_size)
void * blender::blo_read_struct_no_us_nonnull_impl (BlendDataReader *reader, const void *old_address, size_t expected_size)
void * blender::BLO_read_struct_by_name_array (BlendDataReader *reader, StringRef struct_name, int64_t items_num, const void *old_address)
void blender::BLO_read_struct_list_with_size (BlendDataReader *reader, size_t expected_elem_size, ListBase *list)
void blender::BLO_read_struct_list_with_type_size (BlendDataReader *reader, size_t base_size, ListBase *list, FunctionRef< size_t(const void *data)> type_size_fn)
void * blender::blo_read_struct_with_type_size_impl (BlendDataReader *reader, const void *old_address, size_t base_size, FunctionRef< size_t(const void *data)> type_size_fn)
template<typename T>
void blender::BLO_read_struct_list_with_type_size (BlendDataReader *reader, ListBaseT< T > *list, FunctionRef< size_t(const T &data)> type_size_fn)
template<typename T>
void blender::BLO_read_struct_with_type_size (BlendDataReader *reader, T **ptr_p, FunctionRef< size_t(const T &data)> type_size_fn)
bool blender::blo_read_array_impl (BlendDataReader *reader, int64_t array_size, int elems, size_t elem_size, void **ptr_p)
template<typename T, typename SizeT>
requires (!std::is_void_v<T> && !std::is_pointer_v<T>)
bool blender::BLO_read_array (BlendDataReader *reader, T **ptr_p, const SizeT array_size, const int elems=1)
template<typename T, typename SizeT>
requires (!std::is_void_v<T> && !std::is_pointer_v<T>)
void blender::BLO_read_array_and_validate_size (BlendDataReader *reader, T **ptr_p, SizeT *array_size, const int elems=1)
bool blender::blo_read_pointer_array_impl (BlendDataReader *reader, int64_t array_size, void **ptr_p)
template<typename T, typename SizeT>
requires (std::is_pointer_v<T> || std::is_void_v<T>)
bool blender::BLO_read_pointer_array (BlendDataReader *reader, T **ptr_p, const SizeT array_size)
template<typename T, typename SizeT>
requires (std::is_pointer_v<T> || std::is_void_v<T>)
void blender::BLO_read_pointer_array_and_validate_size (BlendDataReader *reader, T **ptr_p, SizeT *array_size)
void blender::BLO_read_string (BlendDataReader *reader, char **ptr_p)
void blender::BLO_read_string (BlendDataReader *reader, char *const *ptr_p)
ImplicitSharingInfoAndData blender::blo_read_shared_impl (BlendDataReader *reader, const void **ptr_p, FunctionRef< const ImplicitSharingInfo *()> read_fn)
template<typename T>
const ImplicitSharingInfo * blender::BLO_read_shared (BlendDataReader *reader, T **data_ptr, FunctionRef< const ImplicitSharingInfo *()> read_fn)
int blender::BLO_read_fileversion_get (BlendDataReader *reader)
bool blender::BLO_read_data_is_undo (BlendDataReader *reader)
void blender::BLO_read_data_globmap_add (BlendDataReader *reader, void *oldaddr, void *newaddr)
void blender::BLO_read_glob_list (BlendDataReader *reader, ListBase *list)
BlendFileReadReport * blender::BLO_read_data_reports (BlendDataReader *reader)
void blender::BLO_read_data_invalidate (BlendDataReader *reader, const char *message)
struct Library * blender::BLO_read_data_current_library (BlendDataReader *reader)
void blender::BLO_read_data_set_need_preview_render_restart (BlendDataReader *reader)

Detailed Description

This file contains an API that allows different parts of Blender to define what data is stored in .blend files.

Four callbacks have to be provided to fully implement .blend I/O for a piece of data. One of those is related to file writing and three for file reading. Reading requires multiple callbacks, due to the way linking between files works.

Brief description of the individual callbacks:

  • Blend Write: Define which structs and memory buffers are saved.
  • Blend Read Data: Loads structs and memory buffers from file and updates pointers them.
  • Blend Read Lib: Updates pointers to ID data blocks.
  • Blend Expand: Defines which other data blocks should be loaded (possibly from other files). Note, this is now handled as part of the foreach-id iteration. This needs to be implemented for DNA data that has references to data-blocks.

Each of these callbacks uses a different API functions.

Some parts of Blender, e.g. modifiers, don't require you to implement all four callbacks. Instead only the first two are necessary. The other two are handled by general ID management. In the future, we might want to get rid of those two callbacks entirely, but for now they are necessary.

Definition in file BLO_read_write.hh.

Macro Definition Documentation

◆ blo_blend_struct_writer_fn_typed

#define blo_blend_struct_writer_fn_typed ( T,
fn )
Value:
((fn) ? BlendStructWriterFn([fn](BlendStructWriterVoid &struct_writer) { \
BlendStructWriter<T> typed_writer(struct_writer); \
fn(typed_writer); \
}) : \
nullptr)

Utility to convert either wrap the function or pass through none.

Definition at line 125 of file BLO_read_write.hh.

Referenced by blender::BlendWriter::write_struct(), blender::BlendWriter::write_struct_array(), blender::BlendWriter::write_struct_array_at_address(), blender::BlendWriter::write_struct_array_cast(), blender::BlendWriter::write_struct_at_address(), blender::BlendWriter::write_struct_at_address_cast(), blender::BlendWriter::write_struct_cast(), and blender::BlendWriter::write_struct_list().

◆ BLO_read_raw_address

#define BLO_read_raw_address ( reader,
ptr_p )

◆ BLO_read_struct

#define BLO_read_struct ( reader,
struct_name,
ptr_p )
Value:
(*((void **)ptr_p) = blo_read_struct_impl(reader, *((void **)ptr_p), sizeof(struct_name)))

Definition at line 477 of file BLO_read_write.hh.

Referenced by blender::bke::action_blend_read_data(), blender::armature_blend_read_data(), blender::BKE_animdata_blend_read_data(), blender::BKE_annotations_blend_read_data(), blender::BKE_asset_metadata_read(), blender::BKE_collection_blend_read_data(), blender::BKE_color_managed_view_settings_blend_read_data(), blender::BKE_fcurve_blend_read_data(), blender::BKE_grease_pencil_modifier_blend_read_data(), blender::BKE_lightprobe_cache_blend_read(), blender::BKE_modifier_blend_read_data(), blender::BKE_packedfile_blend_read(), blender::BKE_paint_blend_read_data(), blender::BKE_particle_system_blend_read_data(), blender::BKE_pose_blend_read_data(), blender::BKE_screen_area_map_blend_read_data(), blender::BKE_screen_blend_read_data(), blender::BKE_screen_view3d_shading_blend_read_data(), blender::BKE_time_markers_blend_read(), blender::BKE_view_layer_blend_read_data(), blender::blend_read(), blender::blo_read_asset_data_block(), blender::brush_blend_read_data(), blender::curve_blend_read_data(), blender::CustomData_blend_read(), blender::direct_link_area(), blender::direct_link_bone_collection(), blender::direct_link_bones(), blender::direct_link_id_common(), blender::direct_link_id_embedded_id(), blender::direct_link_keymapitem(), blender::direct_link_layer_collections(), blender::direct_link_linestyle_alpha_modifier(), blender::direct_link_linestyle_color_modifier(), blender::direct_link_linestyle_thickness_modifier(), blender::direct_link_moviePlaneTracks(), blender::bke::direct_link_node_socket(), blender::bke::direct_link_node_socket_default_value(), blender::bke::direct_link_node_socket_storage(), blender::direct_link_paint_helper(), blender::direct_link_region(), blender::file_space_blend_read_data(), blender::graph_space_blend_read_data(), blender::image_blend_read_data(), blender::bke::node_interface::item_types::item_read_data(), blender::light_blend_read_data(), blender::linestyle_blend_read_data(), blender::mask_blend_read_data(), blender::material_blend_read_data(), blender::seq::modifier_blend_read_data(), blender::movieclip_blend_read_data(), blender::nla_space_blend_read_data(), blender::ed::space_node::node_space_blend_read_data(), blender::bke::node_tree_blend_read_data(), blender::object_blend_read_data(), blender::particle_settings_blend_read_data(), blender::bke::read_attr_data(), blender::bke::read_channelbag(), blender::bke::compositor::read_effects(), blender::modifier::greasepencil::read_influence_data(), blender::read_layer_tree(), blender::bke::read_layers(), blender::bke::read_slots(), blender::bke::read_strip_keyframe_data(), blender::bke::read_strip_keyframe_data_array(), blender::read_ui_data(), blender::read_userdef(), blender::scene_blend_read_data(), blender::shapekey_blend_read_data(), blender::bke::node_interface::socket_types::socket_data_read_data_impl(), blender::bke::node_interface::socket_types::socket_data_read_data_impl(), blender::ed::spreadsheet::spreadsheet_blend_read_data(), blender::ed::spreadsheet::spreadsheet_column_blend_read(), blender::ed::spreadsheet::spreadsheet_table_blend_read(), blender::seq::strip_read_data_cb(), blender::text_blend_read_data(), blender::texture_blend_read_data(), blender::view3d_space_blend_read_data(), blender::window_manager_blend_read_data(), blender::workspace_blend_read_data(), and blender::world_blend_read_data().

◆ BLO_read_struct_array_no_us

#define BLO_read_struct_array_no_us ( reader,
struct_name,
ptr_p,
array_size )
Value:
(*((void **)ptr_p) = blo_read_struct_no_us_impl( \
reader, *((void **)ptr_p), sizeof(struct_name) * size_t(array_size)))

Definition at line 507 of file BLO_read_write.hh.

Referenced by blender::ed::outliner::outliner_space_blend_read_data().

◆ BLO_read_struct_list

#define BLO_read_struct_list ( reader,
struct_name,
list )
Value:
BLO_read_struct_list_with_size(reader, sizeof(struct_name), list)

Definition at line 542 of file BLO_read_write.hh.

Referenced by blender::bke::action_blend_read_data(), blender::armature_blend_read_data(), blender::BKE_animdata_blend_read_data(), blender::BKE_annotations_blend_read_data(), blender::BKE_asset_catalog_path_list_blend_read_data(), blender::BKE_asset_metadata_read(), blender::BKE_collection_blend_read_data(), blender::BKE_constraint_blend_read_data(), blender::BKE_fcurve_blend_read_data(), blender::BKE_keyingsets_blend_read_data(), blender::BKE_modifier_blend_read_data(), blender::BKE_nla_blend_read_data(), blender::BKE_paint_blend_read_data(), blender::BKE_particle_system_blend_read_data(), blender::BKE_pose_blend_read_data(), blender::BKE_ptcache_blend_read_data(), blender::BKE_screen_area_map_blend_read_data(), blender::BKE_time_markers_blend_read(), blender::BKE_view_layer_blend_read_data(), blender::blend_data_read_nla_strips(), blender::bke::CurvesGeometry::blend_read(), blender::cache_file_blend_read_data(), blender::camera_blend_read_data(), blender::console_blend_read_data(), blender::curve_blend_read_data(), blender::direct_link_area(), blender::direct_link_bone_collection(), blender::direct_link_bones(), blender::direct_link_id_common(), blender::direct_link_id_override_property(), blender::direct_link_layer_collections(), blender::direct_link_moviePlaneTracks(), blender::direct_link_movieTracks(), blender::direct_link_panel_list(), blender::direct_link_pointcache(), blender::direct_link_pointcache_mem(), blender::direct_link_region(), blender::grease_pencil_blend_read_data(), blender::IDP_DirectLinkGroup(), blender::image_blend_read_data(), blender::lattice_blend_read_data(), blender::link_recurs_seq(), blender::mask_blend_read_data(), blender::mesh_blend_read_data(), blender::metaball_blend_read_data(), blender::movieclip_blend_read_data(), blender::bke::node_blend_read_data_storage(), blender::ed::space_node::node_space_blend_read_data(), blender::bke::node_tree_blend_read_data(), blender::object_blend_read_data(), blender::palette_blend_read_data(), blender::particle_settings_blend_read_data(), blender::read_bone_collections(), blender::bke::compositor::read_effects(), blender::read_layer(), blender::read_userdef(), blender::ed::asset::shelf::regiondata_blend_read_data(), blender::scene_blend_read_data(), blender::shapekey_blend_read_data(), blender::seq::sound_equalizermodifier_read(), blender::ed::spreadsheet::spreadsheet_blend_read_data(), blender::seq::strip_read_data_cb(), blender::text_blend_read_data(), blender::window_manager_blend_read_data(), and blender::workspace_blend_read_data().

◆ BLO_read_struct_no_us

#define BLO_read_struct_no_us ( reader,
struct_name,
ptr_p )
Value:
(*((void **)ptr_p) = blo_read_struct_no_us_impl(reader, *((void **)ptr_p), sizeof(struct_name)))

Definition at line 504 of file BLO_read_write.hh.

Referenced by blender::modifier_replace_with_fluid(), blender::ed::outliner::outliner_space_blend_read_data(), and blender::scene_blend_read_data().

◆ BLO_read_struct_no_us_nonnull

#define BLO_read_struct_no_us_nonnull ( reader,
struct_name,
ptr_p )
Value:
(*((void **)ptr_p) = blo_read_struct_no_us_nonnull_impl( \
reader, *((void **)ptr_p), sizeof(struct_name)))

Definition at line 518 of file BLO_read_write.hh.

Referenced by blender::BKE_modifier_blend_read_data().

◆ BLO_read_struct_nonnull

#define BLO_read_struct_nonnull ( reader,
struct_name,
ptr_p )
Value:
(*((void **)ptr_p) = blo_read_struct_nonnull_impl( \
reader, *((void **)ptr_p), sizeof(struct_name)))

Definition at line 487 of file BLO_read_write.hh.

Referenced by blender::BKE_modifier_blend_read_data(), blender::BKE_ptcache_blend_read_data(), blender::ed::asset::shelf::regiondata_blend_read_data(), blender::seq::strip_read_data_cb(), and blender::view3d_space_blend_read_data().