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

Rectangle, Point, and Size need concerted structure #5644

New Issue
Closed
opened 2026-01-31 00:18:10 +00:00 by claunia · 2 comments
claunia commented 2026-01-31 00:18:10 +00:00
Owner
Copy Link

Originally created by @miniksa on GitHub (Dec 18, 2019).

Originally assigned to: @lhecker on GitHub.

OK, as I'm refactoring, there's a few problems:

  1. There's a lot of conversion on interface boundaries between size_t, long, and SHORT based versions of representations of rectangles, points, and sizes.
  2. There's a bunch of places where we pass a line,column pair as two size_ts because there isn't a size_t version of SIZE. It should probably be passed as one sensible struct because the ordering of these parameters keeps getting reversed too.
  3. Many of our conversions use an assorted mix of either C-cast, static_cast, gsl::narrow, gsl::narrow_cast, or intsafe.h.
  4. We don't distinguish points from sizes in console code. They're both COORD. x is width and y is height for size usage.

We're also going to want to be able to expand most of our values to reach an "infinite" scrollback.

My proposal here would be:

  • In the types library, we should create:
  1. Point
  • Contains x and y like Windows SDK 'POINT' but is size_t.
  • Has conversions to Windows SDK POINT safely.
  • Has conversions to Console's COORD safely.
  1. Size
  • Contains 'cx' and 'cy' like Windows SDK 'SIZE' but is size_t.
  • Has conversions to Windows SDK SIZE safely.
  • Has conversions to Console's COORD safely.
  1. Rectangle
  • Contains a Point and a Size.
  • Has conversions to Windows SDK RECT safely.
  • Has conversions to Console's SMALL_RECT safely.
  1. Viewport
  • Update this guy to be happy with conversions in and out of the above 3.

Then walk through the code and update to use these things.

Originally created by @miniksa on GitHub (Dec 18, 2019). Originally assigned to: @lhecker on GitHub. OK, as I'm refactoring, there's a few problems: 1. There's a lot of conversion on interface boundaries between `size_t`, `long`, and `SHORT` based versions of representations of rectangles, points, and sizes. 2. There's a bunch of places where we pass a line,column pair as two size_ts because there isn't a size_t version of `SIZE`. It should probably be passed as one sensible struct because the ordering of these parameters keeps getting reversed too. 3. Many of our conversions use an assorted mix of either C-cast, static_cast, gsl::narrow, gsl::narrow_cast, or intsafe.h. 4. We don't distinguish points from sizes in console code. They're both `COORD`. x is width and y is height for size usage. We're also going to want to be able to expand most of our values to reach an "infinite" scrollback. My proposal here would be: - In the `types` library, we should create: 1. Point - Contains `x` and `y` like Windows SDK 'POINT' but is `size_t`. - Has conversions to Windows SDK `POINT` safely. - Has conversions to Console's `COORD` safely. 2. Size - Contains 'cx' and 'cy' like Windows SDK 'SIZE' but is `size_t`. - Has conversions to Windows SDK `SIZE` safely. - Has conversions to Console's `COORD` safely. 3. Rectangle - Contains a `Point` and a `Size`. - Has conversions to Windows SDK `RECT` safely. - Has conversions to Console's `SMALL_RECT` safely. 4. Viewport - Update this guy to be happy with conversions in and out of the above 3. Then walk through the code and update to use these things.
claunia commented 2026-01-31 00:18:11 +00:00
Author
Owner
Copy Link

@carlos-zamora commented on GitHub (Jan 30, 2020):

Specific reference from UiaTextRange refactor (PR #4018):
https://github.com/microsoft/terminal/pull/4018/files#r372678719

@carlos-zamora commented on GitHub (Jan 30, 2020): Specific reference from UiaTextRange refactor (PR #4018): https://github.com/microsoft/terminal/pull/4018/files#r372678719
claunia commented 2026-01-31 00:18:11 +00:00
Author
Owner
Copy Link

@miniksa commented on GitHub (Mar 13, 2020):

til::size was implemented in #4850.
til::point was implemented in #4897.
til::rectangle was implemented in #4912.

To replace Viewport, we will still require...

  • Translation of til::rectangle
  • Scaling of til::rectangle
  • Iteration in "walk" directions
  • Move helpers that will translate the contents of a buffer that is analogous to a til::rectangle representation and move it in-place using the "walk" directions for maximum efficiency. (For Scrolling data in storage or rendering buffers.)

This issue also stays open to track the replacements:

  • Of Viewport usages with til::rectangle usages
  • Of RECT and SMALL_RECT usages with til::rectangle except declarations on API boundaries
  • Of COORD and POINT with til::point except declarations on API boundaries
  • Of COORD and SIZE with til::size except declarations on API boundaries
@miniksa commented on GitHub (Mar 13, 2020): `til::size` was implemented in #4850. `til::point` was implemented in #4897. `til::rectangle` was implemented in #4912. To replace `Viewport`, we will still require... - Translation of `til::rectangle` - Scaling of `til::rectangle` - Iteration in "walk" directions - Move helpers that will translate the contents of a buffer that is analogous to a `til::rectangle` representation and move it in-place using the "walk" directions for maximum efficiency. (For Scrolling data in storage or rendering buffers.) This issue also stays open to track the replacements: - Of `Viewport` usages with `til::rectangle` usages - Of `RECT` and `SMALL_RECT` usages with `til::rectangle` except declarations on API boundaries - Of `COORD` and `POINT` with `til::point` except declarations on API boundaries - Of `COORD` and `SIZE` with `til::size` except declarations on API boundaries
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 Product-Conhost Product-Terminal 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#5644
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?