starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Automatically generate ShortcutAction code from ~JSON Schema~ X-Macros #4858

New Issue
Closed
opened 2026-01-30 23:58:18 +00:00 by claunia · 2 comments
claunia commented 2026-01-30 23:58:18 +00:00
Owner
Copy Link

Originally created by @zadjii-msft on GitHub (Nov 7, 2019).

Originally assigned to: @zadjii-msft on GitHub.

While working on #3391, I felt like there was a ton of boilerplate that was needed for each and every keybindings. The thought crossed my mind that we could do better, but I wasn't sure how. In my mind, I imagined a single file that described each of the ShortcutActions and their possible args, and a small script that just automatically generated all the necessary code to parse them, their args, and hook them up to the TerminalApp.

Now that I've thought on it more, here are some of the steps that'll be needed:

  • Take code from my command palette branch for ShortcutActionDispatch. This is a class that just handles the dispatching of actions. In that branch, I needed it because both keybindings and commands needed to be able to dispatch ShortcutActions, but only AppKeyBindings needed to do a KeyChord lookup. This code being encapsulated will be necessary for a future step.
  • #2550 Add more templated json utils. We'll need this to be able to automagically generate the code to parse a given type from a Json::Value
  • Move the code around so that anything having to do with the entirety of the list of ShortcutActions is in single files by themselves:
    • AppKeybindingSerialization should only deal with parsing keychords. Lets put the ShortcutActions and their keys in another file
    • Add a IShortcutActionHandler interface, with _Handle{{SomeShortcutAction}}(auto&& sender, ActionArgs args) methods for each ShortcutAction. It should declare all the event handlers, but not the definitions.
    • Make TerminalPage extend IShortcutActionHandler. This will be necessary to make sure TerminalPage implements each of them.
    • That one method that hooks up the TerminalPage to the ShortcutActionDispatch. Pull that into it's own file as well.
  • Write a script that parses profiles.schema.json for each of the "*ShortcutAction" definitions, and turns them into code in all the necessary files
    • ShortcutActionKeys.h
    • ActionAndArgs.idl/.h/.cpp
    • ShortcutActionDispatch.idl/.h/.cpp
    • IShortcutActionHandler.h
    • For actions that are listed in ShortcutActions but don't have a proper Args type, then make sure that they're still dispatched correctly
    • When the number of args changes, write the above files, and display a message that the developer needs to update AppActionHandlers.cpp to add implementations for the new types.
    • Validate that all "*ShortcutAction"s listed in the schema actually show up in the onOf schema for Keybinding

Each top-level box could be it's own task here.

In the end, the developer should be able to modify the schema for add their new argument or ShortcutAction, and run a script, and the script should automatically write all the modifications necessary.

I'll probably need to do this in powershell. cmd would be impossible, and as much as I love python, I don't think that's really a part of our toolchain at all currently.

Originally created by @zadjii-msft on GitHub (Nov 7, 2019). Originally assigned to: @zadjii-msft on GitHub. While working on #3391, I felt like there was a ton of boilerplate that was needed for each and every keybindings. The thought crossed my mind that we could do better, but I wasn't sure how. In my mind, I imagined a single file that described each of the `ShortcutAction`s and their possible args, and a small script that just automatically generated all the necessary code to parse them, their args, and hook them up to the `TerminalApp`. Now that I've thought on it more, here are some of the steps that'll be needed: * [ ] Take code from my command palette branch for `ShortcutActionDispatch`. This is a class that just handles the dispatching of actions. In that branch, I needed it because both keybindings and commands needed to be able to dispatch `ShortcutAction`s, but only `AppKeyBindings` needed to do a `KeyChord` lookup. This code being encapsulated will be necessary for a future step. * [ ] #2550 Add more templated json utils. We'll need this to be able to automagically generate the code to parse a given type from a `Json::Value` * [ ] Move the code around so that anything having to do with the entirety of the list of `ShortcutAction`s is in single files by themselves: - [ ] AppKeybindingSerialization should only deal with parsing keychords. Lets put the `ShortcutAction`s and their keys in another file - [ ] Add a `IShortcutActionHandler` interface, with `_Handle{{SomeShortcutAction}}(auto&& sender, ActionArgs args)` methods for each `ShortcutAction`. It should declare all the event handlers, but not the definitions. - [ ] Make `TerminalPage` extend `IShortcutActionHandler`. This will be necessary to make sure TerminalPage implements each of them. - [ ] That one method that hooks up the `TerminalPage` to the `ShortcutActionDispatch`. Pull that into it's own file as well. * [ ] Write a script that parses `profiles.schema.json` for each of the "*ShortcutAction" definitions, and turns them into code in all the necessary files - [ ] `ShortcutActionKeys.h` - [ ] `ActionAndArgs.idl`/`.h`/`.cpp` - [ ] `ShortcutActionDispatch.idl`/`.h`/`.cpp` - [ ] `IShortcutActionHandler.h` - [ ] For actions that are listed in `ShortcutAction`s but don't have a proper `Args` type, then make sure that they're still dispatched correctly - [ ] When the number of args _changes_, write the above files, and display a message that the developer needs to update `AppActionHandlers.cpp` to add implementations for the new types. - [ ] Validate that all "*ShortcutAction"s listed in the schema actually show up in the `onOf` schema for `Keybinding` Each top-level box could be it's own task here. In the end, the developer should be able to modify the schema for add their new argument or `ShortcutAction`, and run a script, and the script should automatically write all the modifications necessary. I'll probably need to do this in powershell. `cmd` would be impossible, and as much as I love `python`, I don't think that's really a part of our toolchain at all currently.
claunia commented 2026-01-30 23:58:19 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Nov 7, 2019):

(discussed with @DHowett-MSFT, so yanking triage)

@zadjii-msft commented on GitHub (Nov 7, 2019): (discussed with @DHowett-MSFT, so yanking triage)
claunia commented 2026-01-30 23:58:19 +00:00
Author
Owner
Copy Link

@carlos-zamora commented on GitHub (May 13, 2020):

There's a lot in here. @zadjii-msft since you created this issue, think it's worth throwing in the v2 milestone?

@carlos-zamora commented on GitHub (May 13, 2020): There's a lot in here. @zadjii-msft since you created this issue, think it's worth throwing in the v2 milestone?
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-CodeHealth Issue-Task Product-Terminal Resolution-Fix-Committed
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#4858
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?