starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Consider introducing an enum-compatible bitset class #14240

New Issue
Closed
opened 2026-01-31 04:04:48 +00:00 by claunia · 1 comment
claunia commented 2026-01-31 04:04:48 +00:00
Owner
Copy Link

Originally created by @j4james on GitHub (Jun 15, 2021).

Description of the new feature/enhancement

I'm working on something at the moment where I need to manipulate various flag values. Typically we do this with an enum and a bunch of macro helper functions like WI_SetFlag, and WI_IsFlagSet. However, I found some scenarios that didn't work very well with this approach, and I was wondering if it might be better achieved with a std::bitset. Unfortunately a std::bitset isn't that great when working with enum values either, but I figured we could perhaps create a lightweight til template class that extends std::bitset with better enum support.

Proposed technical implementation details (optional)

The main things I want to achieve with this class are:

  1. Being able to use enum class values as parameters without having to cast them to a size_t first. This would require extended versions of set, reset, flip, and test which accept the enum type for the pos parameter.
  2. Being able to initialize the bitset with one or more enum values instead of an integer with the appropriate bits set. This can be achieved with a variadic template constructor.
  3. Being able to set or reset multiple values at the same time. This would require additional methods named something like set_all and reset_all, again using a variadic template to support multiple parameters.
  4. Being able to easily test multiple values at the same time. Something like test_any or just any to test if any of the given values are set, and test_all or all to test if all values are set.

I've got a WIP implementation which I've been using in my own code and also tested as a replacement for the current GridLines implementation in the renderer, and I think it does make the code slightly more readable. Would you be interested in a PR for this?

Originally created by @j4james on GitHub (Jun 15, 2021). # Description of the new feature/enhancement I'm working on something at the moment where I need to manipulate various flag values. Typically we do this with an enum and a bunch of macro helper functions like `WI_SetFlag`, and `WI_IsFlagSet`. However, I found some scenarios that didn't work very well with this approach, and I was wondering if it might be better achieved with a `std::bitset`. Unfortunately a `std::bitset` isn't that great when working with enum values either, but I figured we could perhaps create a lightweight `til` template class that extends `std::bitset` with better enum support. # Proposed technical implementation details (optional) The main things I want to achieve with this class are: 1. Being able to use `enum class` values as parameters without having to cast them to a `size_t` first. This would require extended versions of `set`, `reset`, `flip`, and `test` which accept the enum type for the _pos_ parameter. 2. Being able to initialize the bitset with one or more enum values instead of an integer with the appropriate bits set. This can be achieved with a variadic template constructor. 3. Being able to set or reset multiple values at the same time. This would require additional methods named something like `set_all` and `reset_all`, again using a variadic template to support multiple parameters. 4. Being able to easily test multiple values at the same time. Something like `test_any` or just `any` to test if any of the given values are set, and `test_all` or `all` to test if all values are set. I've got a WIP implementation which I've been using in my own code and also tested as a replacement for the current `GridLines` implementation in the renderer, and I think it does make the code slightly more readable. Would you be interested in a PR for this?
claunia commented 2026-01-31 04:04:49 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Jun 15, 2021):

I'm 100% on board for this. To channel @miniksa, "put as much crap in til as will reasonably fit."

@DHowett commented on GitHub (Jun 15, 2021): I'm 100% on board for this. To channel @miniksa, "put as much crap in `til` as will reasonably fit."
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-CodeHealth Issue-Task Priority-2 Product-Meta Resolution-Fix-Committed
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#14240
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?