Refactor: Use typed functions for blend file data reading #120994

Merged
Brecht Van Lommel merged 2 commits from brecht/blender:refactor-typed-read into main 2024-04-24 17:01:34 +02:00

This makes the read and write API functions match more closely, and adds
asserts to check that the data size is as expected.

There are still a few places remaining that use BLO_read_data_address
and similar generic functions, these should eventually be replaced as well.

See BLO_read_write.hh and readfile.c for the main changes.
The rest is using the new API functions throughout the code.

This makes the read and write API functions match more closely, and adds asserts to check that the data size is as expected. There are still a few places remaining that use `BLO_read_data_address` and similar generic functions, these should eventually be replaced as well. See `BLO_read_write.hh` and `readfile.c` for the main changes. The rest is using the new API functions throughout the code.
Brecht Van Lommel added 1 commit 2024-04-23 19:51:14 +02:00
buildbot/vexp-code-patch-lint Build done. Details
buildbot/vexp-code-patch-linux-x86_64 Build done. Details
buildbot/vexp-code-patch-darwin-x86_64 Build done. Details
buildbot/vexp-code-patch-darwin-arm64 Build done. Details
buildbot/vexp-code-patch-windows-amd64 Build done. Details
buildbot/vexp-code-patch-coordinator Build done. Details
63d08931d8
Refactor: Use typed functions for blend file data reading
This makes the read and write API functions match more closely, and adds
asserts to check that the data size is as expected.

There are still a few places remaining that use BLO_read_data_address
and similar, these should eventually be replaced as well.
Author
Owner

@blender-bot build

@blender-bot build
Brecht Van Lommel requested review from Bastien Montagne 2024-04-23 20:39:05 +02:00
Bastien Montagne approved these changes 2024-04-24 15:35:36 +02:00
Bastien Montagne left a comment
Owner

In general this change in the public readfile API makes sense to me, it's definitively better to allign it with the writefile code, and having the type info available is a good thing for the future. And it improves the readability of the data reading code.

Not really convinced with the assert on struct size tbh, this will only catch a small subset of the potential issues, and completely miss any case where the given type size is smaller than the actually read one. But it should not hurt either, and as discussed with @brecht IRL, improvement (like some form of RTTI check) can easily be added later if needed.

In general this change in the public readfile API makes sense to me, it's definitively better to allign it with the writefile code, and having the type info available is a good thing for the future. And it improves the readability of the data reading code. Not really convinced with the assert on struct size tbh, this will only catch a small subset of the potential issues, and completely miss any case where the given type size is smaller than the actually read one. But it should not hurt either, and as discussed with @brecht IRL, improvement (like some form of RTTI check) can easily be added later if needed.
Brecht Van Lommel added 1 commit 2024-04-24 16:27:00 +02:00
buildbot/vexp-code-patch-lint Build done. Details
buildbot/vexp-code-patch-darwin-x86_64 Build done. Details
buildbot/vexp-code-patch-linux-x86_64 Build done. Details
buildbot/vexp-code-patch-darwin-arm64 Build done. Details
buildbot/vexp-code-patch-windows-amd64 Build done. Details
buildbot/vexp-code-patch-coordinator Build done. Details
4ed7038caa
Merge branch 'main' into refactor-typed-read
Author
Owner

@blender-bot build

@blender-bot build
Brecht Van Lommel merged commit 15b9ae5436 into main 2024-04-24 17:01:34 +02:00
Brecht Van Lommel deleted branch refactor-typed-read 2024-04-24 17:01:37 +02:00
Sign in to join this conversation.
No reviewers
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Reference: blender/blender#120994
No description provided.