Refactor: BLF API Function Overloading #120029

Closed
Harley Acheson wants to merge 1 commits from Harley/blender:BLFOverloading into main

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.
Member

Simplify some BLF functions by using overloading where possible. For
example "BLF_load" with two signatures for loading from files versus
memory. One "BLF_display_name" takes a name, the other an ID.
"BLF_unload" that works with filenames or IDs, etc.

Simplify some BLF functions by using overloading where possible. For example "BLF_load" with two signatures for loading from files versus memory. One "BLF_display_name" takes a name, the other an ID. "BLF_unload" that works with filenames or IDs, etc.
Harley Acheson added 1 commit 2024-03-28 18:53:09 +01:00
bac19eb83a Refactor: BLF API Function Overloading
Simplify some BLF functions by using overloading where possible. For
example "BLF_load" with two signatures for loading from files versus
memory. One "BLF_display_name" takes a name, the other an ID.
"BLF_unload" that works with filenames or IDs, etc.
Harley Acheson requested review from Hans Goudey 2024-03-28 18:53:21 +01:00
Hans Goudey reviewed 2024-03-28 19:01:31 +01:00
Hans Goudey left a comment
Member

Sorry to be negative, but I'm not really sure this an improvement. To me it looks like the code is losing detail that's helpful to the reader like "this function is expecting a file" or "this function wants raw memory rather than an id".

This is so subjective, and if it was new code maybe I wouldn't question it-- I wouldn't be surprised if people's preferences aren't completely self consistent. But I don't see an obvious improvement here honestly.

Sorry to be negative, but I'm not really sure this an improvement. To me it looks like the code is losing detail that's helpful to the reader like "this function is expecting a file" or "this function wants raw memory rather than an id". This is so subjective, and if it was new code maybe I wouldn't question it-- I wouldn't be surprised if people's preferences aren't completely self consistent. But I don't see an obvious improvement here honestly.
Author
Member

Sorry to be negative...

Don't be sorry at all. I honestly had no idea if this would be considered an improvement at all.

There are times when I wished we had overloading, like with rcti/rctf or color conversions maybe? But I certainly understand your point. But I had this diff laying around so I thought this would be a great way to ask about it.

Thanks!

> Sorry to be negative... Don't be sorry at all. I honestly had no idea if this would be considered an improvement at all. There are times when I wished we had overloading, like with rcti/rctf or color conversions maybe? But I certainly understand your point. But I had this diff laying around so I thought this would be a great way to ask about it. Thanks!
Harley Acheson closed this pull request 2024-03-28 19:05:32 +01:00
Member

Yeah, there are definitely lots of places where overloading is helpful. Practically required even! But maybe it's more useful when it's the same operation on different types. Or maybe the trouble is the lack of semantically meaningful types in this whole API (i.e. FontFile and FontID might be much more meaningful than const char * and int).

Yeah, there are definitely lots of places where overloading is helpful. Practically required even! But maybe it's more useful when it's the same operation on different types. Or maybe the trouble is the lack of semantically meaningful types in this whole API (i.e. `FontFile` and `FontID` might be much more meaningful than `const char *` and `int`).

Pull request closed

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.

Dependencies

No dependencies set.

Reference: blender/blender#120029
No description provided.