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

Investigate why the COOKED_READ_DATA ctor takes a string_view for wchar_t data? #7766

New Issue
Closed
opened 2026-01-31 01:12:08 +00:00 by claunia · 3 comments
claunia commented 2026-01-31 01:12:08 +00:00
Owner
Copy Link

Originally created by @zadjii-msft on GitHub (Apr 28, 2020).

COOKED_READ_DATA takes an initialData parameter of a string_view
d6cae40d26/src/host/readDataCooked.cpp (L46-L54)

However, when it memcpy's it, it copies it as a wchar_t buffer:
d6cae40d26/src/host/readDataCooked.cpp (L97-L103)

As you can see here, _bufPtr is a wchar_t* which is initialized to _bufPtr = reinterpret_cast<wchar_t*>(_buffer.get())
d6cae40d26/src/host/readDataCooked.hpp (L124-L136)

As I'm writing tests that use some cooked read data for #1856, I'm finding that the string I'm initializing the cooked read with is getting horribly mangled, because I'm passing a char buffer in.

Why is it like this? Does this magically just normally work when users call ReadConsole with wchar_t data in the buffer? I couldn't really figure it out in just a morning, so I'm filing this to make sure to follow up.

The test in question is ConptyRoundtripTests::TestResizeWithCookedRead.

Originally created by @zadjii-msft on GitHub (Apr 28, 2020). `COOKED_READ_DATA` takes an `initialData` parameter of a `string_view` https://github.com/microsoft/terminal/blob/d6cae40d26d2f4ba249d3960e8478c04681c8e1e/src/host/readDataCooked.cpp#L46-L54 However, when it `memcpy`'s it, it copies it as a `wchar_t` buffer: https://github.com/microsoft/terminal/blob/d6cae40d26d2f4ba249d3960e8478c04681c8e1e/src/host/readDataCooked.cpp#L97-L103 As you can see here, `_bufPtr` is a `wchar_t*` which is initialized to `_bufPtr = reinterpret_cast<wchar_t*>(_buffer.get())` https://github.com/microsoft/terminal/blob/d6cae40d26d2f4ba249d3960e8478c04681c8e1e/src/host/readDataCooked.hpp#L124-L136 As I'm writing tests that use some cooked read data for #1856, I'm finding that the string I'm initializing the cooked read with is getting horribly mangled, because I'm passing a `char` buffer in. Why is it like this? Does this magically just normally work when users call `ReadConsole` with `wchar_t` data in the buffer? I couldn't really figure it out in just a morning, so I'm filing this to make sure to follow up. The test in question is `ConptyRoundtripTests::TestResizeWithCookedRead`.
claunia commented 2026-01-31 01:12:10 +00:00
Author
Owner
Copy Link

@DHowett-MSFT commented on GitHub (Apr 28, 2020):

AFAIK this is related to how we share cooked read between A and W APIs?

@DHowett-MSFT commented on GitHub (Apr 28, 2020): AFAIK this is related to how we share cooked read between A and W APIs?
claunia commented 2026-01-31 01:12:10 +00:00
Author
Owner
Copy Link

@DHowett-MSFT commented on GitHub (Apr 29, 2020):

Actually, yeah, that doesn't make sense.

@DHowett-MSFT commented on GitHub (Apr 29, 2020): Actually, yeah, that doesn't make sense.
claunia commented 2026-01-31 01:12:10 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Aug 1, 2023):

IT TURNS OUT

That this was because initialData was explicitly documented as being broken for ReadConsoleA, and only worked for ReadConsoleW. We didn't need to support the ANSI version, so we were just being weirdos using string_view to pass around a pointer+length.

@DHowett commented on GitHub (Aug 1, 2023): IT TURNS OUT That this was because `initialData` was explicitly documented as being broken for `ReadConsoleA`, and only worked for `ReadConsoleW`. We didn't _need_ to support the ANSI version, so we were just being weirdos using `string_view` to pass around a pointer+length.
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-CookedRead Area-Server In-PR Issue-Bug Priority-3 Product-Conhost
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#7766
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?