Fix line number reporting in Visual Studio by LeonarddeR · Pull Request #13604 · nvaccess/nvda

LeonarddeR · 2022-04-13T08:24:39Z

Link to issue number:

Summary of the issue:

In Visual Studio, when line number reporting is enabled in VS itself, line numbers are part of the text. Therefore they are reported regardless of NVDA's line reporting settings. This also causes indentation reporting to fail.

Description of how this pull request fixes the issue:

This pr isolates the line number from the text and ensures that it is reported appropriately when line number reporting in NVDA is on.

Testing strategy:

With line reporting enabled in Visual studio

Ensure that line numbers are reported when enabled in NVDA
Ensure that line numbers are not reported when disabled in NVDA

Known issues with pull request:

Line number reporting does not work when line numbers are disabled in Visual Studio.

Change log entries:

Bug fixes

When Visual Studio is set up to show line numbers in the editor, NVDA's setting to report line numbers is now respected.
This also fixes line indentation not being reported correctly. (Indentation is not reported by NVDA in Visual Studio 2022 #13574)
- Note that for line number reporting to work, showing line numbers must still be enabled in Visual Studio.

Code Review Checklist:

Pull Request description:
- description is up to date
- change log entries
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
API is compatible with existing add-ons.
Documentation:
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English

AppVeyorBot · 2022-04-13T08:59:31Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests. See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/5b3womow7m1ex7y9/artifacts/output/nvda_snapshot_pr13604-25227,7afececd.exe

See test results for failed build of commit 7afececdbb

CyrilleB79 · 2022-04-13T11:03:11Z

Testing strategy:
With line reporting enabled in Visual studio

Would it be also worth testing with line number not displayed in Visual studio and not reported by NVDA?
Especially for lines beginning with a number followed by spaces or tabs.

Change log entries:
Bug fixes

When Visual Studio is set up to show line numbers in the editor, NVDA"s setting to report line numbers is now reported.

Could you rephrase this? It's not the setting that is reported but the line numbers.

This also fixes line indentation not being reported correctly. (Indentation is not reported by NVDA in Visual Studio 2022 #13574)

Note that for line number reporting to work, showing line numbers must still be enabled in Visual Studio.

I think that these two points should be a sub-list and not separated items of the change log. Separated items do not make sense.

Thanks

LeonarddeR · 2022-04-13T13:28:42Z

Would it be also worth testing with line number not displayed in Visual studio and not reported by NVDA?

Sure, good catch, though this behaviour is implicitly tested with text ranges that are positioned somewhere else than the start of a line.

Especially for lines beginning with a number followed by spaces or tabs.

This is not necessary, as the UIA implementation returns the line number for a collapsed text range. That's also a reason why I consider this water proof. If a line starts with a number followed by a space, a collapsed range at the start of the line will be empty when line number reporting is turned of.

akash07k · 2022-04-13T20:04:28Z

@LeonarddeR
Any try build please? I want to test this PR

LeonarddeR · 2022-04-14T05:29:30Z

@akash07k see https://ci.appveyor.com/api/buildjobs/5b3womow7m1ex7y9/artifacts/output%2Fnvda_snapshot_pr13604-25227%2C7afececd.exe

akash07k · 2022-04-14T08:54:11Z

Sadly now it doesn't even report the line numbers.
For making it announce the line numbers we need to turn on the line numbers from NVDA document formatting settings explicitly along with turning on the line numbers on from Visual Studio Text Editor settings.
Then too, strangely now it announces like: "line 1, line 2, line 3" instead of "1, 2, 3" etc.
Also, it doesn't report the indentation at all.
For making it announce the indentation, we are required to turn off the line numbers from both of the sides.
@LeonarddeR

LeonarddeR · 2022-04-14T09:03:22Z

I'll have a look here.
What version of Visual Studio are you using?

LeonarddeR · 2022-04-14T09:10:05Z

Sadly now it doesn't even report the line numbers. For making it announce the line numbers we need to turn on the line numbers from NVDA document formatting settings explicitly along with turning on the line numbers on from Visual Studio Text Editor settings.

This is is as expected. See the changes log entry. We simply can't report line numbers when they are hidden in Visual Studio.

Then too, strangely now it announces like: "line 1, line 2, line 3" instead of "1, 2, 3" etc.

This isn't a bug as well. This is how line reporting works in NVDA. You will notice that it will work equally in other text editors.

Also, it doesn't report the indentation at all. For making it announce the indentation, we are required to turn off the line numbers from both of the sides. @LeonarddeR

Good catch, I should have tested that more thoroughly. Just pushed a fix for this.

akash07k · 2022-04-14T09:26:46Z

17.2 Preview 3

On 4/14/2022 2:33 PM, Leonard de Ruijter wrote: I'll have a look here. What version of Visual Studio are you using? — Reply to this email directly, view it on GitHub <#13604 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABQWBMY42EB67FSOGQCS7XDVE7NOLANCNFSM5TJ3TCQQ>. You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Signature “Innovation is the outcome of a habit, not a random act.” “The power of the Tech is in its universality. Access by everyone regardless of disability is an essential aspect.” --- With Regards, Akash Kakkar (He/His/Him) Software Developer & Accessibility subject matter expert | Ping me on WhatsApp <https://wa.me/919716286389> | Follow me on Twitter <https://bit.ly/37cioC4> | Connect with me on Facebook <https://bit.ly/3u74ZEh> | Follow me on Linkedin <https://bit.ly/37fqJop> | Follow me on Github <https://bit.ly/3r29zBW>

akash07k · 2022-04-14T09:27:52Z

So will it keep on reporting "line 1, line 2" etc? any way to shorten it? it would be too verbose.

On 4/14/2022 2:40 PM, Leonard de Ruijter wrote: Sadly now it doesn't even report the line numbers. For making it announce the line numbers we need to turn on the line numbers from NVDA document formatting settings explicitly along with turning on the line numbers on from Visual Studio Text Editor settings. This is is as expected. See the changes log entry. We simply can't report line numbers when they are hidden in Visual Studio. Then too, strangely now it announces like: "line 1, line 2, line 3" instead of "1, 2, 3" etc. This isn't a bug as well. This is how line reporting works in NVDA. You will notice that it will work equally in other text editors. Also, it doesn't report the indentation at all. For making it announce the indentation, we are required to turn off the line numbers from both of the sides. @LeonarddeR <https://github.com/leonardder> Good catch, I should have tested that more thoroughly. Just pushed a fix for this. — Reply to this email directly, view it on GitHub <#13604 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABQWBMYXY2FXJUWWNAX3BA3VE7OHPANCNFSM5TJ3TCQQ>. You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Signature “Innovation is the outcome of a habit, not a random act.” “The power of the Tech is in its universality. Access by everyone regardless of disability is an essential aspect.” --- With Regards, Akash Kakkar (He/His/Him) Software Developer & Accessibility subject matter expert | Ping me on WhatsApp <https://wa.me/919716286389> | Follow me on Twitter <https://bit.ly/37cioC4> | Connect with me on Facebook <https://bit.ly/3u74ZEh> | Follow me on Linkedin <https://bit.ly/37fqJop> | Follow me on Github <https://bit.ly/3r29zBW>

AppVeyorBot · 2022-04-14T10:07:58Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
Build execution time has reached the maximum allowed time for your plan (60 minutes).

See test results for failed build of commit ce35702962

LeonarddeR · 2022-04-14T10:18:33Z

So will it keep on reporting "line 1, line 2" etc?

Correct. Changing this is a different question that falls beyond the scope of this issue.

cary-rowen · 2022-04-14T10:32:50Z

@akash07k
The reporting method of line numbers is defined in nvda's interface language translation file nvda.po.

akash07k · 2022-04-14T19:36:41Z

@cary-rowen So can we modify this translation via addon or we'll have to modify the source itself?

XLTechie · 2022-04-14T20:24:23Z

So will it keep on reporting "line 1, line 2" etc? any way to shorten it? it would be too verbose.

It is a separate issue that NVDA is too verbose when reporting line numbers. I agree about that, and if you file an issue you'll get my support at least. If you turn on line numbers, you expect the first thing you hear to be a line number; you don't need to be told it's a line.

cary-rowen · 2022-04-14T20:35:38Z

@akash07k
We could simplify the way line numbers are reported by modifying nvda.po, but that's not necessarily the most correct solution, and we could create a separate issue to discuss this.

akash07k · 2022-04-14T20:36:14Z

Absolutely, Announcing the string "Line" before every line is quite verbose. I'll try filing the issue for it for sure. I don't know how much consideration will it get though.

On 4/15/2022 1:54 AM, Luke Davis wrote: > So will it keep on reporting "line 1, line 2" etc? any way to shorten > it? it would be too verbose. It is a separate issue that NVDA is too verbose when reporting line numbers. I agree about that, and if you file an issue you'll get my support at least. If you turn on line numbers, you expect the first thing you hear to be a line number; you don't need to be told it's a line. — Reply to this email directly, view it on GitHub <#13604 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABQWBMYBOR6TGIULGAEKYVLVFB5IFANCNFSM5TJ3TCQQ>. You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Signature “Innovation is the outcome of a habit, not a random act.” “The power of the Tech is in its universality. Access by everyone regardless of disability is an essential aspect.” --- With Regards, Akash Kakkar (He/His/Him) Software Developer & Accessibility subject matter expert | Ping me on WhatsApp <https://wa.me/919716286389> | Follow me on Twitter <https://bit.ly/37cioC4> | Connect with me on Facebook <https://bit.ly/3u74ZEh> | Follow me on Linkedin <https://bit.ly/37fqJop> | Follow me on Github <https://bit.ly/3r29zBW>

akash07k · 2022-04-14T20:37:23Z

@cary-rowen very true. I'll create the separate issue for it in morning.

LeonarddeR · 2022-04-19T10:38:53Z

I just pushed a somewhat different approach that ensures the line number is not reported when copying, selecting or deleting text. This also removes the need to tweak _getTextWithFields, which is certainly a good thing.

AppVeyorBot · 2022-04-19T11:07:45Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests. See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/deppewj4vwh4jlj4/artifacts/output/nvda_snapshot_pr13604-25244,fe7e42ee.exe

See test results for failed build of commit fe7e42eef8

akash07k · 2022-04-19T12:59:28Z

That's great. so does it completely fix the issue?

…

On 4/19/22, AppVeyorBot ***@***.***> wrote: - PASS: Translation comments check. - PASS: Unit tests. - PASS: Lint check. - FAIL: System tests. See test results for more information. - Build (for testing PR): https://ci.appveyor.com/api/buildjobs/deppewj4vwh4jlj4/artifacts/output/nvda_snapshot_pr13604-25244,fe7e42ee.exe See [test results](https://ci.appveyor.com/project/NVAccess/nvda/builds/43274326/tests) for [failed build](https://ci.appveyor.com/project/NVAccess/nvda/builds/43274326) of [commit fe7e42e](fe7e42eef8) -- Reply to this email directly or view it on GitHub: #13604 (comment) You are receiving this because you were mentioned. Message ID: ***@***.***>

LeonarddeR · 2022-04-19T14:21:59Z

It should yes, apart from the verbose line number reporting introduced when line number reporting is on in NVDA's document formatting settings.

seanbudd · 2022-04-20T02:59:27Z

+			try:
+				formatField.field['line-number'] = int(lineNumberStr)
+			except ValueError:
+				pass


should this log something? in what cases is lineNumberStr not an integer?

I don't expect this to fail, though it certainly makes sense to log something.

AppVeyorBot · 2022-04-21T02:00:15Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests. See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/p2oev855rsunbl06/artifacts/output/nvda_snapshot_pr13604-25267,4452b742.exe

See test results for failed build of commit 4452b74205

akash07k · 2022-04-23T17:32:41Z

@LeonarddeR
I tested it today, however, even though if line numbers are off in NVDA's settings, still it reports the line numbers, and if we turn on the line number reporting from NVDA's settings along with the indentation, then too it doesn't report any indentation.
It seems that something is still broken up here.
Help please?

LeonarddeR · 2022-04-23T17:34:49Z

Have you tested with all add-ons disabled and are you on the most recent alpha?

akash07k · 2022-04-23T17:44:09Z

@LeonarddeR ya buddy. I've tested and indeed, I'm on latest alpha.
NVDA version alpha-25262,a55f9a62

lukaszgo1 · 2022-04-23T17:54:14Z

@akash07k Please note that while this fix has been merged to Alpha, due to failing system tests (unrelated to this PR) it failed to build, therefore this is not yet included in a binary version. You need to wait for the next Alpha.

akash07k · 2022-04-23T17:55:20Z

@lukaszgo1 Ah, got it. I'll wait then. thanks!

LeonarddeR · 2022-04-28T11:27:36Z

I just tried this with latest Alpha and all works like a charm here.

Fix line number reporting in Visual Studio

aaa15df

LeonarddeR requested a review from a team as a code owner April 13, 2022 08:24

LeonarddeR requested a review from seanbudd April 13, 2022 08:24

LeonarddeR mentioned this pull request Apr 13, 2022

Indentation is not reported by NVDA in Visual Studio 2022 #13574

Closed

Catch ValueError

6c6980e

LeonarddeR added 2 commits April 14, 2022 11:03

Merge remote-tracking branch 'origin/master' into vsIndent

38cac9b

Fix indentation reporting

43982a7

seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Apr 19, 2022

LeonarddeR added 2 commits April 19, 2022 12:35

Merge remote-tracking branch 'origin/master' into vsIndent

0ec8ea6

Changed approach using _getTextFromUIARange

4c076b0

seanbudd reviewed Apr 20, 2022

View reviewed changes

Add a debug warning

26b12a5

seanbudd reviewed Apr 21, 2022

View reviewed changes

Comment thread source/appModules/devenv.py Outdated

remove redundant pass

de94141

seanbudd approved these changes Apr 21, 2022

View reviewed changes

seanbudd added 3 commits April 21, 2022 10:30

Merge branch 'master' into vsIndent

9e0be97

update changes

20c6b63

Merge branch 'master' into vsIndent

150be44

seanbudd merged commit ef31b1d into nvaccess:master Apr 21, 2022

nvaccessAuto added this to the 2022.2 milestone Apr 21, 2022

seanbudd mentioned this pull request Sep 15, 2022

NVDA does not read line numbers in Visual Studio #14141

Closed

LeonarddeR deleted the vsIndent branch August 23, 2025 06:28

Uh oh!

Conversation

LeonarddeR commented Apr 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Testing strategy:

Known issues with pull request:

Change log entries:

Code Review Checklist:

Uh oh!

AppVeyorBot commented Apr 13, 2022

Uh oh!

CyrilleB79 commented Apr 13, 2022

Uh oh!

LeonarddeR commented Apr 13, 2022

Uh oh!

akash07k commented Apr 13, 2022

Uh oh!

LeonarddeR commented Apr 14, 2022

Uh oh!

akash07k commented Apr 14, 2022

Uh oh!

LeonarddeR commented Apr 14, 2022

Uh oh!

LeonarddeR commented Apr 14, 2022

Uh oh!

akash07k commented Apr 14, 2022 via email

Uh oh!

akash07k commented Apr 14, 2022 via email

Uh oh!

AppVeyorBot commented Apr 14, 2022

Uh oh!

LeonarddeR commented Apr 14, 2022

Uh oh!

cary-rowen commented Apr 14, 2022

Uh oh!

akash07k commented Apr 14, 2022

Uh oh!

XLTechie commented Apr 14, 2022 via email

Uh oh!

cary-rowen commented Apr 14, 2022

Uh oh!

akash07k commented Apr 14, 2022 via email

Uh oh!

akash07k commented Apr 14, 2022

Uh oh!

LeonarddeR commented Apr 19, 2022

Uh oh!

AppVeyorBot commented Apr 19, 2022

Uh oh!

akash07k commented Apr 19, 2022 via email

Uh oh!

LeonarddeR commented Apr 19, 2022 via email

Uh oh!

seanbudd Apr 20, 2022

Choose a reason for hiding this comment

Uh oh!

LeonarddeR Apr 20, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AppVeyorBot commented Apr 21, 2022

Uh oh!

akash07k commented Apr 23, 2022

Uh oh!

LeonarddeR commented Apr 23, 2022 via email

Uh oh!

akash07k commented Apr 23, 2022

Uh oh!

lukaszgo1 commented Apr 23, 2022

Uh oh!

akash07k commented Apr 23, 2022

Uh oh!

LeonarddeR commented Apr 28, 2022

Uh oh!

Reviewers

Assignees

Labels

LeonarddeR commented Apr 13, 2022 •

edited

Loading