Global commands: replace gestures map with script decorator by josephsl · Pull Request #11974 · nvaccess/nvda

josephsl · 2020-12-26T00:26:35Z

Hi,

Targetting 2021.1 and to encourage usage of script decorator throughout nVDA Core and add-ons:

Link to issue number:

Closes #11964

Summary of the issue:

NVDA 2018.3 introduced scriptHandler.script decorator to ease definition of scripts. one of the places where it is used is global commands where a mixture of script decorator and gestures map is used. To encourage usage of script decorator, standardize around it, beginning with global commands.

Description of how this pull request fixes the issue:

Replace gestures map with script decorator. One exception is sleep mode command where the script uses an attribute that isn't accepted by script decorator yet.

Testing performed:

Tested in source code form (with script decorator applied in global commands).

Known issues with pull request:

None

Change log entry:

None (not really needed)

Considerations:

If this approach is successful, I expect people will file pull requests to convert other parts of NVDA to use script decorator, which will result in more add-ons adopting script decorator approach. This change is significant enough to target 2021.1.

Thanks.

…vaccess#11964. The following commands were edited to use scriptHandler.script decorator: NVDA+N (show NVDA menu), NVDA+1 (toggle input help), NVDA+Q (quit NVDA), NVDA+F2 (pass next key through), NVDA+Shift+S/Z (toggle sleep mode), as well as unassigned restart NVDA command. For sleep mode toggle command, allow sleep mode flag is kept, and for NVDA menu and sleep mode toggle commands, gestures tuple is used (gestures order: keyboard (desktop and laptop), braille (including braille input and emulated keys), touch).

…r. Re nvaccess#11964. Convert the following scripts: NVDA+F12 (time and date), NVDA+C (clipboard data announcement), NVDA+Shift+B (battery status).

… decorator. Re nvaccess#11964. Convert the following commands: NVDA+up arrow/L (read current line), NVDA+Tab (current focus), NVDA+End/Shift+End (read status line), NVDA+down arrow/A (say all), NVDA+Shift+up arrow/Shift+S (say selection), NVDA+T (say title), NVDA+B (read foreground window).

…rator. Re nvaccess#11964. Converted object navigation scripts: NVDA+Numpad 5/4/6/8/2, NVDA+Shift+O/right/left/up/down arrows, object touch mode flicks (announce current object/move to next/previous/parent/first child) and friends.

nvaccess#11964. Convert review cursor commands: Shift+Numpad 7/9, Control+NvDA+Home/End on laptop layout (top/bottom), Numpad 7/8/9 (previous/current/next line)m Numpad 4/5/6 (previous/current/next word), Numpad 1/2/3 (previous/current/next character), Shift+Numpad 1/3 (start/end of line) and touch equivalents in text mode, along with review mark/copy commands.

…decorator. Re nvaccess#11964. Convert the following commands: left/right mouse click/lock, move navigator object to mouse and mouse to navigator object, focus/browse mode toggle, parent tree interceptor.

… decorator. Re nvaccess#11964. Convert settings dialogs/panels opener commands to use script decorator, including ones iwthout a set gesture such as dictionary dialogs and review cursor panel.

…rator. Re nvaccess#11964. Convert the following configuration management scripts: Control+NVDA+C (save configuration), Control+NVDA+R (revert/reset configuration), Control+NVDA+P (open config profiles dialog), and an unassigned command to toggle profile triggers.

…vaccess#11964. Convert various settings scripts to use script decorator, including NVDA+2 (toggle speak typed characters), NVDA+U (probress bar output) and others.

…corator. Re nvaccess#11964. Convert synth settings ring scripts: Control+NVDA+arrows/Control+NVDA+Shift+arrows (next/previous setting, increase/decrease current setting).

…script decorator. Re nvaccess#11964. Convert document formatting scripts to use script decorator, all of them unassigned.

…tor. Re nvaccess#11964. Convert unassigned settings scripts such as braille focus presentation, change braille cursor/shape, mouse text resolution, all unassigned.

…access#11964. Convert tools scripts to script decorator, including app module info, UWP OCR, speech viewer, and others, some of them with gestures unassigned.

…tor. Re 311964. Converted braille input and outpu scripts (except keyboard emulation) to use script decorator (tested with a HumanWare BrailleNote Touch Plus).

…vaccess#11964. Convert touch-specific scripts to use script decorator, including touch hover, right click, and touch mode toggle.

…orator. Re nvaccess#11964. Convert keyboard emulation scripts for Control, Alt, Windows, Shift, and NVDA keys to use script decorator.

…s of function argument definitions. Re nvaccess#11964.

…d description.

…nvaccess#11964. Replace gestures map found in global commands with script decorator.

…pt. Re nvaccess#11964.

michaelDCurran · 2021-01-11T23:57:31Z

@josephsl I notice that many of the translated descriptions have their translator comment within the gettext function brackets rather than above E.g.

description = _(
# Translators: blahblah
"Turns input help mode on or off"
)

Are you sure that these comments are successfully included in pot files when written this way?
Apologies if other parts of NVDA may already do it this way... I just have not personally seen it written this way before so thought I'd check.

josephsl · 2021-01-12T00:14:19Z

Hi, yes, translator comments are included, and it was written that way due to Flake8 complaining about line length. Thanks.

josephsl added 22 commits December 22, 2020 12:15

Global commands: convert system status scripts to use script decorato…

84287a8

…r. Re nvaccess#11964. Convert the following scripts: NVDA+F12 (time and date), NVDA+C (clipboard data announcement), NVDA+Shift+B (battery status).

Global commands: convert mouse and browse mode scripts to use script …

7633be1

…decorator. Re nvaccess#11964. Convert the following commands: left/right mouse click/lock, move navigator object to mouse and mouse to navigator object, focus/browse mode toggle, parent tree interceptor.

Global commands: convert config dialogs/panels commands to use script…

ec30873

… decorator. Re nvaccess#11964. Convert settings dialogs/panels opener commands to use script decorator, including ones iwthout a set gesture such as dictionary dialogs and review cursor panel.

Global commands: convert settings scripts to use script decorator. Re n…

bcfc677

…vaccess#11964. Convert various settings scripts to use script decorator, including NVDA+2 (toggle speak typed characters), NVDA+U (probress bar output) and others.

Global commands: convert synth settings ring scripts to use script de…

26cf97f

…corator. Re nvaccess#11964. Convert synth settings ring scripts: Control+NVDA+arrows/Control+NVDA+Shift+arrows (next/previous setting, increase/decrease current setting).

Global commands: convert document formatting settings scripts to use …

9fa0909

…script decorator. Re nvaccess#11964. Convert document formatting scripts to use script decorator, all of them unassigned.

Global commands: convert unassigned settings scripts to script decora…

9e2f252

…tor. Re nvaccess#11964. Convert unassigned settings scripts such as braille focus presentation, change braille cursor/shape, mouse text resolution, all unassigned.

Global commands: convert tools scripts to use script decorator. Re nv…

512eb24

…access#11964. Convert tools scripts to script decorator, including app module info, UWP OCR, speech viewer, and others, some of them with gestures unassigned.

Global commands: convert braille display scripts to use script decora…

9d3a214

…tor. Re 311964. Converted braille input and outpu scripts (except keyboard emulation) to use script decorator (tested with a HumanWare BrailleNote Touch Plus).

Global commands: convert touch gestures to use script decorator. Re n…

192f14b

…vaccess#11964. Convert touch-specific scripts to use script decorator, including touch hover, right click, and touch mode toggle.

Global commands: convert keyboard emulation scripts to use script dec…

99b6123

…orator. Re nvaccess#11964. Convert keyboard emulation scripts for Control, Alt, Windows, Shift, and NVDA keys to use script decorator.

Global commands: rearrange bypassInputHelp and remove commas from end…

6d0fc6c

…s of function argument definitions. Re nvaccess#11964.

Global commands: lint (Flake8 E203, E251)

92971b4

Global commands: lint (Flake8 E501)

d5cb8ea

Global commands: fix spelling - 'wil' -> 'will' in speech mode comman…

178197a

…d description.

Global commands: scriptHandler.script -> script

a1fa109

Global commands: remove gestures map, replaced by script decorator. Re …

33d9936

…nvaccess#11964. Replace gestures map found in global commands with script decorator.

lukaszgo1 mentioned this pull request Dec 29, 2020

Script decorator: add ability to specify that given script should be active in sleep mode. #11979

Merged

josephsl added 3 commits January 10, 2021 22:36

Merge branch 'master' into i11964globalCommandsScriptDecorator

813dc66

Global commands: update copyright year

3ee557e

Global commands: use allowInSleepMode flag for sleep mode toggle scri…

dd7a417

…pt. Re nvaccess#11964.

michaelDCurran approved these changes Jan 12, 2021

View reviewed changes

michaelDCurran merged commit c4d6fb5 into nvaccess:master Jan 12, 2021

nvaccessAuto added this to the 2021.1 milestone Jan 12, 2021

josephsl deleted the i11964globalCommandsScriptDecorator branch January 12, 2021 03:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Global commands: replace gestures map with script decorator#11974

Global commands: replace gestures map with script decorator#11974
michaelDCurran merged 25 commits into
nvaccess:masterfrom
josephsl:i11964globalCommandsScriptDecorator

josephsl commented Dec 26, 2020

Uh oh!

michaelDCurran commented Jan 11, 2021

Uh oh!

josephsl commented Jan 12, 2021 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

josephsl commented Dec 26, 2020

Link to issue number:

Summary of the issue:

Description of how this pull request fixes the issue:

Testing performed:

Known issues with pull request:

Change log entry:

Considerations:

Uh oh!

michaelDCurran commented Jan 11, 2021

Uh oh!

josephsl commented Jan 12, 2021 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants