Prefer use of interpolated strings in PresentationCore #8616

halgab · 2023-12-30T19:45:11Z

Follow-up to #8519

Description

We replace as many manual string concatenations and string.Format with interpolated strings. This saves allocations in many instances, and makes for a more readable code.

Customer Impact

Less allocations

Regression

No

Testing

CI

Risk

Low. Most changes are automated using the IDE

Microsoft Reviewers: Open in CodeFlow

src/Microsoft.DotNet.Wpf/src/PresentationCore/MS/internal/AppModel/SiteOfOriginContainer.cs

rchauhan18 · 2024-01-29T10:16:14Z

src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/Media/Color.cs

@halgab A DRT(test) is failing on this PR: DrtColorAPI
You can find this test on our public repo: https://github.com/dotnet/wpf-test

I think so the test is failing due to some missing elements in this file after change.

After having another read, the difference between the current version and mine is that when nativeColorValue is empty, the current version still appends a separator value, which is not the case with my version. I feel like my version is more correct.
Tell me if you prefer that I maintain the current behaviour.

Your changes are functionally different. Floats were formatted using format previously but are now always formatted using R. Also, the loop in your changes always prepends the separator instead of prepending the separator only when between items: ",A,B,C" vs "A,B,C". Also, there should be a space here between {uriString} and {scRgbColor.a:R}, it was there before your changes.

I would recommend testing your changes because by looking at the code I don't see how your changes returns the same result as the existing code.

Those are valid points. I'll rollback the functional changes. I'd like to keep the constant format though, as format is always set to R before this loop, and that's what makes it possible to use interpolated strings. What do you think?

dipeshmsft · 2024-08-27T08:18:30Z

src/Microsoft.DotNet.Wpf/src/PresentationCore/MS/internal/Ink/StrokeIntersection.cs

-                        + StrokeFIndices.GetStringRepresentation(_inSegment.BeginFIndex)  + ","
-                        + StrokeFIndices.GetStringRepresentation(_inSegment.EndFIndex)    + ","
-                        + StrokeFIndices.GetStringRepresentation(_hitSegment.EndFIndex)   + "}";
+            return $"{{{StrokeFIndices.GetStringRepresentation(_hitSegment.BeginFIndex)},{StrokeFIndices.GetStringRepresentation(_inSegment.BeginFIndex)},{StrokeFIndices.GetStringRepresentation(_inSegment.EndFIndex)},{StrokeFIndices.GetStringRepresentation(_hitSegment.EndFIndex)}}}";


@halgab IMO, this change makes it a bit harder to understand what's happening here. Maybe we can use string.Format here ?

@dipeshmsft We can just use regular interpolation and space it out, like this:

return $"{Int32.Parse("1")}," + $"{Int32.Parse("1")}";

It will produce the following:

DefaultInterpolatedStringHandler defaultInterpolatedStringHandler = new DefaultInterpolatedStringHandler(1, 2); defaultInterpolatedStringHandler.AppendFormatted<int>(int.Parse("1")); defaultInterpolatedStringHandler.AppendLiteral(","); defaultInterpolatedStringHandler.AppendFormatted<int>(int.Parse("1")); defaultInterpolatedStringHandler.ToStringAndClear();

So the change like this:

return $"{{{StrokeFIndices.GetStringRepresentation(_hitSegment.BeginFIndex)}," + $"{StrokeFIndices.GetStringRepresentation(_inSegment.BeginFIndex)}," + $"{StrokeFIndices.GetStringRepresentation(_inSegment.EndFIndex)}," + $"{StrokeFIndices.GetStringRepresentation(_hitSegment.EndFIndex)}}}";

@h3xds1nz, I was just going through DefaultInterpolatedStringHandler in your PR and your suggestion sounds good.

dipeshmsft · 2024-08-27T08:28:18Z

src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/Media/PathFigure.cs

-                ((IFormattable)StartPoint).ToString(format, provider) + 
-                (segments != null ? segments.ConvertToString(format, provider) : "") +
-                (IsClosed ? "z" : "");
+            return $"M{((IFormattable)StartPoint).ToString(format, provider)}{(segments != null ? segments.ConvertToString(format, provider) : "")}{(IsClosed ? "z" : "")}";


Again, this seems hard to be understood. Maybe consider using string.Concat / string.Format here.

Same here, we can just use regular string interpolation and space it out over multiple lines, no need for string.Format ugliness.

src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/Media/Color.cs

dipeshmsft · 2025-02-04T08:38:12Z

@halgab, can you take a look at the above PR and make the necessary changes ?

halgab · 2025-02-25T21:48:10Z

Hi. I'm sorry, I'm not sure when I'll have time to get back to this...

dipeshmsft · 2025-02-26T04:30:08Z

@halgab, is it okay we take this up ?

halgab · 2025-02-26T22:14:11Z

Yes, of course

codecov · 2025-03-18T07:31:26Z

Codecov Report

Attention: Patch coverage is 1.11732% with 177 lines in your changes missing coverage. Please review.

Project coverage is 11.45626%. Comparing base (a354bec) to head (cde707c).
Report is 82 commits behind head on main.

Additional details and impacted files

@@                 Coverage Diff                 @@
##                main       #8616         +/-   ##
===================================================
- Coverage   11.54183%   11.45626%   -0.08557%     
===================================================
  Files           3214        3214                 
  Lines         648502      648353        -149     
  Branches       71510       71552         +42     
===================================================
- Hits           74849       74277        -572     
- Misses        572401      572912        +511     
+ Partials        1252        1164         -88

Flag	Coverage Δ
Debug	`11.35262% <1.11732%> (-0.08662%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- Made change to CollectionHelper generator. - Regenerated the collection files.

himgoyalmicro · 2025-04-14T10:15:16Z

src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/Media/Color.cs

-                sb.AppendFormat(provider, "{0}{1} ", Parsers.s_ContextColor, uriString);
-                sb.AppendFormat(provider,"{1:" + format + "}{0}",separator,scRgbColor.a);
-                for (int i = 0; i < nativeColorValue.Length; ++i )
+                sb.Append(provider, $"{Parsers.s_ContextColor}{uriString} {scRgbColor.a:R}{separator}");


We should use the variable format here.

ghost assigned halgab Dec 30, 2023

ghost added the PR metadata: Label to tag PRs, to facilitate with triage label Dec 30, 2023

ghost requested review from dipeshmsft and singhashish-wpf December 30, 2023 19:45

ghost added the Community Contribution A label for all community Contributions label Dec 30, 2023

halgab commented Dec 30, 2023

View reviewed changes

src/Microsoft.DotNet.Wpf/src/PresentationCore/MS/internal/AppModel/SiteOfOriginContainer.cs Show resolved Hide resolved

ghost added the draft label Dec 30, 2023

halgab marked this pull request as ready for review December 30, 2023 21:33

halgab requested a review from a team as a code owner December 30, 2023 21:33

halgab force-pushed the interpolated-string-core branch from 429535a to 4dd05ab Compare December 30, 2023 21:50

halgab changed the title ~~Prefer use interpolated strings in PresentationCore~~ Prefer use of interpolated strings in PresentationCore Dec 30, 2023

ghost removed the draft label Dec 31, 2023

rchauhan18 added the Queue for test pass label Jan 18, 2024

halgab force-pushed the interpolated-string-core branch from 4dd05ab to 4ea7631 Compare January 18, 2024 21:08

halgab mentioned this pull request Jan 18, 2024

Introducing Trace helper methods in PresentationCore #8702

Draft

rchauhan18 reviewed Jan 29, 2024

View reviewed changes

halgab force-pushed the interpolated-string-core branch from b63dd61 to e7de550 Compare January 31, 2024 21:21

halgab requested a review from rchauhan18 January 31, 2024 21:23

anjali-wpf removed the Queue for test pass label Jun 12, 2024

dipeshmsft reviewed Aug 27, 2024

View reviewed changes

halgab added 4 commits March 13, 2025 15:16

use interpolated strings in PresentationCore

c5f9279

manual followups

5b6dc6e

StringBuilder.AppendFormat refactos

ab58897

fix Media.Color

412880e

dipeshmsft force-pushed the interpolated-string-core branch from e7de550 to 412880e Compare March 18, 2025 07:09

dipeshmsft requested a review from a team as a code owner March 18, 2025 07:09

dipeshmsft self-assigned this Mar 18, 2025

Changes: Resolved PR Comments

cde707c

- Made change to CollectionHelper generator. - Regenerated the collection files.

himgoyalmicro added Included in test pass Status:InProgress Status:Proposed Status:Completed and removed Status:InProgress labels Apr 1, 2025

himgoyalmicro reviewed Apr 14, 2025

View reviewed changes

Prefer use of interpolated strings in PresentationCore #8616

Are you sure you want to change the base?

Prefer use of interpolated strings in PresentationCore #8616

Uh oh!

Conversation

halgab commented Dec 30, 2023 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Customer Impact

Regression

Testing

Risk

Microsoft Reviewers: Open in CodeFlow

Uh oh!

Uh oh!

rchauhan18 Jan 29, 2024

Choose a reason for hiding this comment

Uh oh!

halgab Jan 29, 2024

Choose a reason for hiding this comment

Uh oh!

ThomasGoulet73 Jan 29, 2024

Choose a reason for hiding this comment

Uh oh!

halgab Jan 29, 2024

Choose a reason for hiding this comment

Uh oh!

dipeshmsft Aug 27, 2024

Choose a reason for hiding this comment

Uh oh!

h3xds1nz Aug 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dipeshmsft Aug 27, 2024

Choose a reason for hiding this comment

Uh oh!

dipeshmsft Aug 27, 2024

Choose a reason for hiding this comment

Uh oh!

h3xds1nz Aug 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dipeshmsft commented Feb 4, 2025

Uh oh!

halgab commented Feb 25, 2025

Uh oh!

dipeshmsft commented Feb 26, 2025

Uh oh!

halgab commented Feb 26, 2025

Uh oh!

codecov bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

himgoyalmicro Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

halgab commented Dec 30, 2023 •

edited by ghost

Loading

h3xds1nz Aug 27, 2024 •

edited

Loading

h3xds1nz Aug 27, 2024 •

edited

Loading

codecov bot commented Mar 18, 2025 •

edited

Loading

himgoyalmicro Apr 14, 2025 •

edited

Loading