…rallel builds (#13367)

Fixes #13290
Related to this thread on nvda-devel by @MarcoZehe

Summary of the issue:
PR #13226 started building nVDA in parallel. While this offers significant speed improvements the way in which we were generating COMInterfaces was not thread safe. The issue was caused by the fileinput module which redirects stdout to a given file and this cannot be done in multiple threads at the same time. Also, as discovered by @MarcoZehe in the thread linked above when stdout is redirected to a file some other build step which is executing in a separate thread can write to it and the text which should be shown on screen ends up in the COMInterface file.

Description of how this pull request fixes the issue:
Were not using fileinput anymore - the IDE friendly content is generated in memory and then written to the file afterwards.

#13277)

Fixes #13276

Summary of the issue:
In case a single child is selected, IAccessible::get_accSelection can either return the child ID of a selected simple element or an IDispatch for a selected accessible object, s.
https://docs.microsoft.com/en-us/windows/win32/api/oleacc/nf-oleacc-iaccessible-get_accselection
and
https://docs.microsoft.com/en-us/windows/win32/winauto/how-servers-implement-child-ids .
Previously, only positive child IDs were considered in NVDA, while LibreOffice was returning negative child IDs for Calc cells, which does not fit the MSAA spec.
NVDA did not yet support the case where an IDispatch is returned.

Description of how this pull request fixes the issue:
This PR implements the missing handling for an IDispatch returned as accSelection in NVDA.
LibreOffice was adapted to return such a one from LibreOffice 7.4 on, corresponding LibreOffice commit:
https://git.libreoffice.org/core/commit/00c0ee8cf0fac0c933c5ae600e99a64b1c7d4397
In addition, negative child IDs are now also accepted.
As pointed out by James Teh in the discussion on the
initial version of the pull request:
The use of negative child ids doesn't fit well into the IAccessible spec, but
it has been done by IAccessible2 for a very long time and should be considered
standard for all intents and purposes. A negative child id should be treated as
a unique id, while a positive child id should be treated as a child index.
Supporting negative child IDs fixes the issue for LibreOffice 7.3.

Update version and changes for 2022.2

Fixes #10644

Summary:
On the web, widgets with `role="progressbar"` and no `aria-valuenow` were reported by NVDA as "progress bar  half checked  zero".

These widgets are exposed by the browser with:
- IAccessible accRole `ROLE_SYSTEM_PROGRESSBAR`
- IAccessible accState `STATE_SYSTEM_MIXED, STATE_SYSTEM_INDETERMINATE`.

In chrome accValue is always "0" in this case.
Note, in firefox, if `aria-valuetext` is provided, `STATE_SYSTEM_INDETERMINATE` is not set and `accValue` has the `aria-valuetext`.

Changes:
An 'indeterminate' progress bar has no value attribute, it can not convey progress, only activity.
Rather than reporting as a progress bar it is given a new NVDA role of "busy indicator" and its value ("zero") is no longer reported.

Technical details.
- Code to convert decode the bit flags (integer) supplied by IA / IA2 into a set of NVDA States was repeated, this has been extracted to a function, centralized in IAccessibleHandler, and optimized.
- accValue was used as the text node in the virtual buffer, now for this case , " " (space) is used.

While working with installNVDA.ps1, I noticed that the variable:
$installerLogFilePathToUpload
was being spelled:
$installlerLogFilePathToUpload
Since I was fixing that, I also corrected a typo in a comment.

Description of how this pull request fixes the issue:
Corrected the spelling of the variable name in all three uses, by removing the first "l".

Fixes #13270, #9134

May fix #13329, #13222

NSIS 2.51 has been removed from miscDeps in Remove old version of NSIS to be moved to separate submodule nvda-misc-deps#24
NSIS 3.08 has been added to a new submodule in Add NSIS 3.08 distribution NSIS-build#2
Steps for updating NSIS have been added in Add process for updating NSIS NSIS-build#1
Summary of the issue:
NSIS is outdated (version 2.51 is from 2016).
A variety of issues have been coming up with the installer:

If special characters are in the path, the NSIS fails to run the installer
Installer is failing to start on certain builds of Windows (Windows 7 SP1, Windows 11 ARM, Windows 10 21H2)
Description of how this pull request fixes the issue:
NSIS has been moved to its own submodule (currently private while reviewing the repository settings).
this includes adding steps for updating in the future
NSIS has been updated to 3.08.
The UAC plugin has been removed, as it is now redundant.
NSIS elevates the uninstaller automatically now, rather than needing the UAC plugin. This has been confirmed with testing.
Minor build warnings have been fixed.
Testing strategy:
Follow the testing strategy in the NSIS submodule readme

Commit history:

* use latest nsis

* remove redundant plugin code

* Update NSIS link

* Fix build warnings for the installer and uninstaller

Fixes the following build warnings

For the installer:
    warning: !warning: MUI_LANGUAGE[EX] should be inserted after the MUI_[UN]PAGE_* macros (macro:MUI_LANGUAGEEX:6)

For the uninstaller:
    9100: Generating version information for language "1033-English" without standard key "FileVersion"

* add zh-hk information

* Update submodule commits

* update changes

Co-authored-by: Łukasz Golonka <lukasz.golonka@mailbox.org>

… class UIABrowseModeDocumentTextInfo comparable (#13396)

PR #13345 fixes navigating over merged cells in tables by caching the last column/row. Testing showed that it doesn't work in MS Word while in browse mode (focus mode works fine). This was tracked down to class UIABrowseModeDocumentTextInfo not implementing eq method.

Description of how this pull request fixes the issue:
Fixing that by implementing eq and hash functions in parent class RootProxyTextInfo.

Merge beta to master

Beta to master merge

Closes #6549

Summary of the issue:
Some UI messages are missing when an action cannot be performed.
If a user should be notified if they cannot perform an action due to being in secure mode, using the windows store version or a modal dialog is blocking.

Description of how this pull request fixes the issue:
The following ui messages have been added and implemented:
- Not available in Windows Store version
- Not available in secure context
- Not available while dialog response required

These were found by searching for usages of config.isAppX, globalVars.appArgs.secure and isModalMessageBoxActive, respectively.

Co-authored-by: Łukasz Golonka <lukasz.golonka@mailbox.org>

Summary of the issue:
When working on #13488, the exitDialog was lengthened, and probably should be moved to its own submodule file.

Description of how this pull request fixes the issue:
Moves and lints ExitDialog and _ExitAction from gui.__init__ into gui.exit.

Fix-up of #13387
Fixes #13033

Summary of the issue:
Pr #13387 introduced support for custom UIA extensions, there by using the Microsoft UIA Automation remote operations library. This pr disabled building support for Visual Studio 2022. This has now been solved.

Description of how this pull request fixes the issue:
Fixes build on Visual Studio 2022 by ensuring that the windir environment variable is available. This should eventually be fixed in scons itself, though there's a note in their source code stating that adding environment variables to the basic set that's imported from os.environ should be considered very carefully.

…lumn/row index (#13345)

Follow up on the work done by @mltony in #11923

Fixes #7278, #11919

Summary of the issue:
When issuing table navigation commands repeatedly, e.g. pressing Control+Alt+Down several times in a row, the original column index is currently not preserved. Thus, if there happens to be a merged cell on the way, the column index will be reset to the minimal column index of merged cell.

Description of how this pull request fixes the issue:
This PR caches original column index for vertical table navigation and original row index for horizontal table navigation.

Merge security fix from 2021.3.5 and translations to master

…ode when trying to open the symbol dialog. (#13539)

Fix-up of #13535
Follow-up of #13500

Summary of the issue:
In #13500 a decorator has been introduced to speak a message when an action is unavailable in secure mode.
In parallel an NVDA 2021.3.5 patch release has been produced; this release contains a fix preventing to open the symbol dialog in secure mode. The 2021.3.5 (rc) branch has then been merged into master to get this fix in master.
This led to the fact that no message was reported when trying to use a script to open the symbol dialog in secure mode.

Description of how this pull request fixes the issue:
Added the blockAction.when decorator where it was missing.

This PR introduces Control+Alt+Home/End/PageUp/PageDown commands in ListViews and TreeViews  to jump to the beginning/end  of the current row/column - implemented in class RowWithFakeNavigation.

)

Fixes #13102

Summary of the issue:
NVDA was incorrectly stripping text from Java widgets if the text looked like an XML tag. According to the Oracle Java docs, when using HTML in a Java widget you should start the text with the <html> tag.

Description of how this pull request fixes the issue:
This change gets NVDA to check if the text starts with <html> and only then will remove any text which appears to be XML tags.

…e PDFs (#13546)

Fixes #13285

Summary of the issue:
Non-interactive PDFs can contain form fields such as checkboxes and radio buttons. however, NVDA does not report any meaningful type or state for them at all.
This is due to the fact that NVDA specifically maps the PDF stdName (tag) of 'Form' to NVDA's Form role. Thereby completely overriding any more detailed MSAA role Adobe has provided.
This was most likely due to a mis-understanding of the PDF spec. The <form> tag means form field, not form.

Description of how this pull request fixes the issue:
Remove the mapping of Form stdName to NVDA's Form role. so that NVDA will fall back to using the MSAA role / states provided by Adobe Acrobat.

Summary of the issue:
Certain mainFrame commands `gui.mainFrame.ExampleCommand` are only exposed via the NVDA menu not in secure mode.
In the future, input gestures might be created for these commands, exposing them in secure mode.

Additionally, the log viewer is disable in secure mode, so script_navigatorObject_devInfo should be blocked, as it is misleading. The logs should not be accessible when running in secure mode.
Debug logging in secure screens can be configured with the serviceDebug parameter.

Description of how this pull request fixes the issue:
Adds secure mode decorators to commands that are currently inaccessible in secure mode.

Testing strategy:
The decorator has been tested in #13539 and other PRs.
Other than script_navigatorObject_devInfo, these messages should be currently inaccessible to the user.

Summary of the issue:
Currently a user can temporarily reset to factory defaults in secure mode by pressing the default input gesture NVDA+control+r 3 times.
A user using NVDA in a shared kiosk may find this command helpful to temporarily use NVDA with factory settings, so that they can log in and then use their own settings profile.

This is safe, as resetting to factory defaults doesn't save the settings profile to disk. Users can revert to the saved configuration for secure screens by:
- using the menu
- NVDA+control+r
- restarting NVDA

The feature "reset configuration to factory defaults" is hidden from the NVDA menu in secure mode, even though it is exposed through a default input gesture.

Description of how this pull request fixes the issue:
Show "reset configuration to factory defaults" as a menu item in secure mode

Testing strategy:

Change a preference in NVDA preferences
Copy your configuration to secure screens
From a secure screen
- Note that the menu item is visible
- Close the preference dialog
- Reset configuration to factory defaults using the menu item
- Confirm that the changed preference has been reset to the factory default
Restart the machine
on the sign-in screen, confirm that the preference has been restored to the saved config - not the factory default

Summary of the issue:
As raised in comments on #13488, the technical design overview could be clarified to be more clear and add more information.
Using the serviceDebug parameter to prevent secure mode on secure screens is a more universal solution than patching source code.

Users have been unclear on what secure mode and secure screens are when reading about recent security fixes.

Description of how this pull request fixes the issue:
Improves the documentation based on the discussion on #13488.

Adds definitions of secure mode and secure screens to the user guide.

1. `@blockAction.when` now checks and reports first secure mode, then modal.
2. Add secure mode decorators to future-proof `onCheckForUpdateCommand`.
3. Use secure mode decorator for `onSaveConfigurationCommand`.

…fication event (#13625)

Link to issue number:
Fixes #13383

Summary of the issue:
With the initial version of Windows 10/11 Calculator app module, only a select number of keys were defined to announce results. However it turns out there are commands that should be announced such as equals (=) and scientific calculator commands such as s (sign).

Description of how this pull request fixes the issue:
Refactor UIA notification event handler with use of a new flag specifying gestures that should not announce results. If this flag is on (for now when number keys are pressed), NVDA will not announce results. Also, existing result announcement commands will not announce results in Calculator version 10.1908 as notification event will announce result.

* appModules/calculator: explain the fact that Windows 10 Calculator is the base app module for Windows 11 Calculator (calculatorapp) as well.

* Calculator: introduce a 'no result gestures' flag. Re #13383.

In recent Calculator releases (prominently from 10.1908 but exact version unknown), UIA notification event is used to anounce results. Back when Calculator used name change and live region events, it was necessary to define result announcement keys such as Enter key that will cause NVDA to announce results. With the introduction of UIA notification event, the new event is used to announce results. This resulted in NVDA announcing repeats when numbers were entered, more so if speak typed characters is on.
In the initial version of Windows 10 Calculator app module (2020) and subsequently amended in 2021, only a select number of keyboard commands (gestures) were defined to announce results. This however led to NVDA not announcing Calculator display when additional result keys such as equals (=) and scientific calculator commands such as S for sine were pressed, requiring users to perform read current line/focused object to obtain results. To resolve this and to respond to UIA notification events properly while keeping the number entry bug fix intact, a new flag is used to preventNVDA from handling notification event if number row and/or numpad keys with num lock on are pressed. This flag is set if number keys are indeed entered and cleared from notification event (next set of commits). In addition, existing result announcement commands wil be tweaked to do nothing if using later Calculator releases since notification event is used to announce resuts anyway (this means verbosity changes such as NVDA not announcing display content if Escape key is pressed multiple times, for example). Note that the new flag (no result gestures) should not be confused with existing 'should announce results' flag as the existing flag is used to handle old Calculator releases with no support for notification event.

* Calculator: do not announce Calculator display content if no result gestures are pressed. Re #13383.

Do not handle UIA notification event if no result gestures flag is set in order to avoid repetitions. As the flag is set from a script (see next commit), have a copy of this flag before clearing the flag from notification event. The event handler copy of the no results flag will be used later when handling 'DisplayUpdated' activity Id (results display), and if set, return from the event handler.

* Calculator: add a script identifying no result announcement gestures. Re #13383.

In addition to notification event handler tweak, add a script that defines gestures for which NVDA should not announce Calculator results. For now number row and numpad keys with num lock turned on are defined specifically to keep no repetition announcement bug fix intact (where NVDA will repeat things if speak typed characters is on).

* Calculator: return from announcing results if this is Calculator version 10.1908 and later. Re #13383.

Bonus: becasue UIA notification event is used to announce results, there is no need for NVDA to check focus in app version 10.1908 and later. Therefore return early from existing results announcement script if running on later Calculator releases (version string comparison will work).

* Calculator: use integer comparisons for versions. Re #13383.

Comment from Sean Budd (NV Access): better not to use string comparisons (what if comparisons fail for odd Calculator version strings that does not necessarily fit what humans think of newer releases versus what Python gives). Therefore obtain integers for major and minor Calculator releases and compare versions accordingly (integer list comparison).

* update changes

Co-authored-by: Sean Budd <sean@nvaccess.org>

Merge beta back to alpha

Link to issue number:
Closes #12542

Summary of the issue:
In mozilla applications when pasting certain HTML into rich edit controls it can lead to errors when navigating through the text. One such example is in the thunderbird compose message edit area.

Description of how this pull request fixes the issue:
The function _getEmbedded in ia2TextMozilla.py returns Optional, however the return value is never checked to be not None and this assumption leads to errors later on when the value is used. This pull request adds a check for None being returned from _getEmbedded and skips it if None is found.

Summary of the issue:
When developing #13657, logging NVDAObject.appModule.helperLocalBindingHandle was helpful.
NVDAObject._get_devInfo is considered too complex, and should aim to be shortened.

Description of how this pull request fixes the issue:
Moves the appModule devInfo logging out of NVDAObject._get_devInfo into AppModule.get_devInfo.
Adds appModule.helperLocalBindingHandle to the log info for an NVDAObject.

Testing strategy:
Test with NVDA+F1 on various NVDAObjects.

#13618)

Summary of the issue:
When accessing a RichEdit control with the ITextDocument object interface, hidden text was not ignored
I.E. hidden text was announced, and could be navigated through with the review cursor.
Example: The hidden text included at the start of hyperlinks in RichEdit controls, like:
HYPERLINK "<URL>"

So therefore for a link for NV access, NVDA announces:
link HYPERLINK "https://www.nvaccess.org" NV access out of link

Instead this should be:
link NV Access out of link

Description of change:
- No longer observe the 'Fetch Formatting after the cursor' option in the 'document formatting' settings for RichEdit controls. This process is no longer as slow as it was in Windows XP. This is required to split on the boundaries of hidden text. Allowing reporting the start and end of links within a line.

- Skip over hidden text, not producing a formatField or str.
when moving by text unit (character, word etc), skip over hidden text to ensure the review cursor does not land on or report any hidden text. This is is done by checking after the move if the range is marked as hidden, if so, keep moving by the unit until outside the hidden text.

Co-authored-by: Reef Turner <reef@nvaccess.org>

Fix up of #13560, #13271

Summary of the issue:

When out-of-process failed, an empty array was returned instead of None.
This could have led to incorrect reporting of list items.
For example, trying to get the contents of the second column of the list/table/report, the array is initialized with all values of zero, if used without being filled with valid data all columns will report the same thing.

#13271 notes:
>How likely are cases where injection doesn't work and the outproc variants succeed? I guess this is pretty unlikely, unless we're running under Windows Store.

- If injection doesn't work there will be no `helperLocalBindingHandle`, out of process approach will be tried.
- If an application like StartIsBack/StartAllBack doesn't handle the Windows Message properly then it doesn't matter if the message is sent in-process or out-of-process.

Description of how this pull request fixes the issue:

- When possible, use in process approach to get the column order array. It should be possible if there is a `helperLocalBindingHandle`
- Don't return an array filled with zeros, return None when out-of-process fails.

Fixes #10253

Summary of the issue:
A gesture is missing to control automatic language switching and automatic dialect switching options.

Description of how this pull request fixes the issue:
Add an unassigned script that cycles through the 3 following automatic language and dialect switching modes:
- Language and dialect switching off
- Language switching on, dialect switching off
- Language and dialect switching on

Note that the 4th possible state (language switching off and dialect switching on) does not make sense.

…Version for consistency. (#13696)

Follow-up to #13383

Summary of the issue:
Cosmetics: focus.appModule.productVersion -> self.productVersion for consistency.

Description of how this pull request fixes the issue:
Changes focus.appModule.productVersion to self.productVersion in Calculator results script. No changes to functionality whatsoever.

Fixes #13688

Summary of the issue:
With the redesigned Windows 11 Notepad, users cannot obtain statsu bar information.

Description of how this pull request fixes the issue:
Introduce a new Windows 11 Notepad app module (notepad.exe). With the new UI design, status bar cannot be obtained as in prior Notepad releases. Thankfully it is possible to traverse the UIA tree to obtain the status bar object from a specific child element position (this is because child elements have the same UIA class name). Also, status bar is shown if focused on the document window (rich edit) and enabled from view menu.

* appModules/Notepad (Windows 11): add a new Notepad module for Windows 11 that allows NVDA to announce status bar text if shown. Re #13688.

Introduce a new Windows 11 Notepad app module (notepad.exe). With the new UI design, status bar cannot be obtained as in prior Notepad releases. Thankfully it is possible to traverse the UIA tree to obtain the status bar object from a specific child element positiion (this is because child elements have the same UIA class name). Also, statsu bar is shown if focused on the document window (rich edit) and enabled from view menu.

* appModules/notepad: add an explanation about status bar index. Re #13688.

Advised by Sean Budd (NV Access): add an explanation and a variable about Notepad 11 status bar (look for a specific UIA element (child of the foreground window) that hosts status bar text if visible).

* appModules/notepad: add docstring for status bar method. Re #13688.

Advised by Sean Budd (NV Access): add a docstring for status bar retrieval method to highlight:
* The need for this routine
* Needing to check status bar child position whenver Notepad is updated (Windows 11 NOtepad is updated through Microsoft Store as opposed to being tied to a specific Windows release).

* appModules/notepad: add a note about api.getStatusBar behavior. Re #13688.

Advised by Sean Budd (NV Access): should the app module method fail (and raise NotImplementedError), api.getStatusBar will resort to position lookup, therefore document this aspect.

* update changes

Co-authored-by: Sean Budd <sean@nvaccess.org>

Beta to master merge

Closes #13674

Summary of the issue:
The following entries exist in the Output Table and Input Table combo boxe in the NVDA Braille Settings panel:

Chinese (China, Mandarin) grade 1
Chinese (China, Mandarin) grade 2
According to the definition in the Chinese National Standard GB/T 15720-2008, sections 2.13 and 2.14:

"Chinese (China, Mandarin) grade 1" should be changed to "Chinese (China) Current Braille System"
"Chinese (China, Mandarin) grade 2" should be changed to "Chinese (China) Double-phonic Braille System"
Due to copyright reasons, the text in the above "GB/T 15720-2008" link cannot be read by visually impaired users, but it can be previewed in image form.

Closes #13692

Summary of the issue:
In a Java swing application NVDA does not announce a read only text control as being read only.

Description of how this pull request fixes the issue:
Java Access Bridge does not apply the editable state to read only controls. So when mapping JAB states to NVDA states check whether the control is a text control and whether it lacks the editable state, applying the read only state accordingly.

…IA to allow mouse and touch navigation to work while interacting with shell elements (#13691)

#13506 (partial)

Summary of the issue:
Windows 11 UI (shell) elements such as taskbar, notification area, TaskView, Snap layouts, and buttons such as Search and Chat cannot be navigated to and interacted with mosue and touchscreens.

Description of how this pull request fixes the issue:
Reclassifies the following windows as UIA windows:

Shell_TrayWnd: Start, Search, Widgets, other shell elements nadi s the rot shell elements window (not to be conrused with desktop window)
Shell_InputSwitchTopLevelWindow: language switcher
XamlExplorerHostIslandWindow: Task View and Snap Layouts
Most of these have the label of "DesktopWindowXamlSource". The "isGoodUIAWindow" in File Explorer app module was edited to treat these windows as UIA elements provided that they are the ancestors (top-level windows) of windows passed into that method. This is more so for the first window class name (shell root) whereas others can go through just a class name check, but cal winUser.getAncestor with GA_ROOT (2) flag for all windows for consistency.


* appModules/explorer: reclassify Windows 11 UI (shell) elements as UIA windows to allow mouse and ouch navigation to work. Re #13506.

When using the mouse and/or touch to navigate Windows 11 shell elements such as tskbar and other buttons, NVDA says 'DesktopWindowXamlSource'. This window title is employed from desktop (Win32) apps hosting XAML controls. Reclasifying these controls as well as some top-level windows from IAccessible to UIA does allow mouse and touch interaction to work. Because DesktopWindowXamlSource class label is seen in apps such as Notepad and Windows Terminal (in addition to File Explorer), a comment was added to indicate that a more global solution would be better. But for now at least shell elements can be navigated with mosue and/or touch.

* appModules/explorer: check ancestors instead of window class name alone when checking Windows 11 shell elements. Re #13506.

Turns out checking just the class name is not enough for shell root window (Shell_TrayWnd) - one needs to check ancestors. Because other windows are top-level windows (such as Task View), class name check will work, but for consistency, call winUser.getAncestor with root (winUser.GA_ROOT (2)) flag. Also add an explanation as to why.

* appModules/explorer: use a dedicated variable to store current Windows release. Re #13506.

Small optimization: winVersion.getWinVer() can be called up to two times (if running on Windows 11), therefore use a variable to store current Windows release and use it throughout the method.

* update changes

Co-authored-by: Sean Budd <sean@nvaccess.org>

Closes #13643

Summary of the issue:
In a Java swing application NVDA was not announcing function keys in the shortcut keys. I also suspect it was not announcing other special keys like backspace, delete, cursor keys, etc.

Description of how this pull request fixes the issue:
java access bridge defines modifier bits for function keys and control code keys and then uses specific values in the character field. This pull request checks for these bits and handles the shortcut key accordingly.

…13711)

Fixes #10993

Summary of the issue:
Controls in Java applications which do not have the enabled state are not being spoken as unavailable by NVDA.

Description of how this pull request fixes the issue:
Java accessibility API states that controls lacking the enabled state cannot be manipulated and normally are shown as greyed out. I understand lacking the enabled state to map to unavailable in NVDA and so this pull request checks if enabled is not present and sets the unavailable state accordingly.
In the (java documentation at https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/accessibility/AccessibleState.html it says the following for the enabled state:
public static final AccessibleState ENABLED
Indicates this object is enabled. The absence of this state from an object's state set indicates this object is not enabled. An object that is not enabled cannot be manipulated by the user. In a graphical display, it is usually grayed out.

Update translations on master