microsoft/Terminal

Don't printf wstring_views by copying them into wstrings; use `%.*s`!

Open

#4,027 opened on Dec 19, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (3,212 forks)batch import
Area-CodeHealthHelp WantedIssue-TaskProduct-ConhostProduct-Terminal

Repository metrics

Stars
 (35,764 stars)
PR merge metrics
 (Avg merge 27d 19h) (24 merged PRs in 30d)

Description

StringCchPrintf and--since C99--printf support a specifier that indicates that a string is counted:

auto size = /* ... */;
auto data = /* ... */;
printf("%.*s", size, data);

The .* suggests that printf should consume one register-width argument to determine how many characters the string that follows contains instead of waiting for a null terminator.

Contributor guide

Research direction
Find all locations in the codebase where wstring view is copied into wstring before being passed to printf family functions, and replace with `%.*s` using the view's size and data.
Tech stack
None
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75