22fd06e19b
This entirely removes `KeyMapping` from the settings model, and builds on the work done in #9543 to consolidate all actions (key bindings and commands) into a unified data structure (`ActionMap`). ## References #9428 - Spec #6900 - Actions page Closes #7441 ## Detailed Description of the Pull Request / Additional comments The important thing here is to remember that we're shifting our philosophy of how to interact/represent actions. Prior to this, the actions arrays in the JSON would be deserialized twice: once for key bindings, and again for commands. By thinking of every entry in the relevant JSON as a `Command`, we can remove a lot of the context switching between working with a key binding vs a command palette item. #9543 allows us to make that shift. Given the work in that PR, we can now deserialize all of the relevant information from each JSON action item. This allows us to simplify `ActionMap::FromJson` to simply iterate over each JSON action item, deserialize it, and add it to our `ActionMap`. Internally, our `ActionMap` operates as discussed in #9428 by maintaining a `_KeyMap` that points to an action ID, and using that action ID to retrieve the `Command` from the `_ActionMap`. Adding actions to the `ActionMap` automatically accounts for name/key-chord collisions. A `NameMap` can be constructed when requested; this is for the Command Palette. Querying the `ActionMap` is fairly straightforward. Helper functions were needed to be able to distinguish an explicit unbinding vs the command not being found in the current layer. Internally, we store explicitly unbound names/key-chords as `ShortcutAction::Invalid` commands. However, we return `nullptr` when a query points to an unbound command. This is done to hide this complexity away from any caller. The command palette still needs special handling for nested and iterable commands. Thankfully, the expansion of iterable commands is performed on an `IMapView`, so we can just expose `NameMap` as a consolidation of `ActionMap`'s `NameMap` with its parents. The same can be said for exposing key chords in nested commands. ## Validation Steps Performed All local tests pass.
247 lines
12 KiB
XML
247 lines
12 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<Project DefaultTargets="Build" ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||
<PropertyGroup Label="Globals">
|
||
<ProjectGuid>{CA5CAD1A-d7ec-4107-b7c6-79cb77ae2907}</ProjectGuid>
|
||
<Keyword>Win32Proj</Keyword>
|
||
<ProjectName>Microsoft.Terminal.Settings.Model.Lib</ProjectName>
|
||
<RootNamespace>Microsoft.Terminal.Settings.Model</RootNamespace>
|
||
<TargetName>Microsoft.Terminal.Settings.Model.Lib</TargetName>
|
||
<WindowsTargetPlatformMinVersion>10.0.17763.0</WindowsTargetPlatformMinVersion>
|
||
<ConfigurationType>StaticLibrary</ConfigurationType>
|
||
<SubSystem>Console</SubSystem>
|
||
<OpenConsoleUniversalApp>true</OpenConsoleUniversalApp>
|
||
</PropertyGroup>
|
||
<Import Project="..\..\..\common.openconsole.props" Condition="'$(OpenConsoleDir)'==''" />
|
||
<Import Project="$(OpenConsoleDir)src\cppwinrt.build.pre.props" />
|
||
|
||
<!-- ========================= Headers ======================== -->
|
||
<ItemGroup>
|
||
<ClInclude Include="DefaultTerminal.h" >
|
||
<DependentUpon>DefaultTerminal.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="IconPathConverter.h">
|
||
<DependentUpon>IconPathConverter.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="pch.h" />
|
||
<ClInclude Include="ActionArgs.h">
|
||
<DependentUpon>ActionArgs.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="ActionAndArgs.h">
|
||
<DependentUpon>ActionArgs.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="ActionMap.h">
|
||
<DependentUpon>ActionMap.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="AzureCloudShellGenerator.h" />
|
||
<ClInclude Include="CascadiaSettings.h">
|
||
<DependentUpon>CascadiaSettings.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="ColorScheme.h">
|
||
<DependentUpon>ColorScheme.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="Command.h">
|
||
<DependentUpon>Command.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="DefaultProfileUtils.h" />
|
||
<ClInclude Include="GlobalAppSettings.h">
|
||
<DependentUpon>GlobalAppSettings.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="IInheritable.h" />
|
||
<ClInclude Include="IDynamicProfileGenerator.h" />
|
||
<ClInclude Include="JsonUtils.h" />
|
||
<ClInclude Include="HashUtils.h" />
|
||
<ClInclude Include="KeyChordSerialization.h">
|
||
<DependentUpon>KeyChordSerialization.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="PowershellCoreProfileGenerator.h" />
|
||
<ClInclude Include="Profile.h">
|
||
<DependentUpon>Profile.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="AppearanceConfig.h">
|
||
<DependentUpon>AppearanceConfig.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="EnumMappings.h">
|
||
<DependentUpon>EnumMappings.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="SettingsTypes.h" />
|
||
<ClInclude Include="TerminalSettings.h">
|
||
<DependentUpon>TerminalSettings.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="TerminalSettingsSerializationHelpers.h" />
|
||
<ClInclude Include="TerminalWarnings.h">
|
||
<DependentUpon>TerminalWarnings.idl</DependentUpon>
|
||
</ClInclude>
|
||
<ClInclude Include="WslDistroGenerator.h" />
|
||
</ItemGroup>
|
||
<!-- ========================= Cpp Files ======================== -->
|
||
<ItemGroup>
|
||
<ClCompile Include="DefaultTerminal.cpp">
|
||
<DependentUpon>DefaultTerminal.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="IconPathConverter.cpp">
|
||
<DependentUpon>IconPathConverter.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="init.cpp" />
|
||
<ClCompile Include="pch.cpp">
|
||
<PrecompiledHeader>Create</PrecompiledHeader>
|
||
</ClCompile>
|
||
<ClCompile Include="ActionAndArgs.cpp">
|
||
<DependentUpon>ActionArgs.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="ActionArgs.cpp">
|
||
<DependentUpon>ActionArgs.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="ActionMap.cpp">
|
||
<DependentUpon>ActionMap.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="ActionMapSerialization.cpp">
|
||
<DependentUpon>ActionMap.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="AzureCloudShellGenerator.cpp" />
|
||
<ClCompile Include="CascadiaSettings.cpp">
|
||
<DependentUpon>CascadiaSettings.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="CascadiaSettingsSerialization.cpp">
|
||
<DependentUpon>CascadiaSettings.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="ColorScheme.cpp">
|
||
<DependentUpon>ColorScheme.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="Command.cpp">
|
||
<DependentUpon>Command.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="DefaultProfileUtils.cpp" />
|
||
<ClCompile Include="GlobalAppSettings.cpp">
|
||
<DependentUpon>GlobalAppSettings.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="KeyChordSerialization.cpp">
|
||
<DependentUpon>KeyChordSerialization.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="PowershellCoreProfileGenerator.cpp" />
|
||
<ClCompile Include="Profile.cpp">
|
||
<DependentUpon>Profile.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="AppearanceConfig.cpp">
|
||
<DependentUpon>AppearanceConfig.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="TerminalSettings.cpp">
|
||
<DependentUpon>TerminalSettings.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="EnumMappings.cpp">
|
||
<DependentUpon>EnumMappings.idl</DependentUpon>
|
||
</ClCompile>
|
||
<ClCompile Include="WslDistroGenerator.cpp" />
|
||
<!-- You _NEED_ to include this file and the jsoncpp IncludePath (below) if
|
||
you want to use jsoncpp -->
|
||
<ClCompile Include="$(OpenConsoleDir)\dep\jsoncpp\jsoncpp.cpp">
|
||
<PrecompiledHeader>NotUsing</PrecompiledHeader>
|
||
</ClCompile>
|
||
<ClCompile Include="$(GeneratedFilesDir)module.g.cpp" />
|
||
</ItemGroup>
|
||
<!-- ========================= idl Files ======================== -->
|
||
<ItemGroup>
|
||
<Midl Include="ActionArgs.idl" />
|
||
<Midl Include="ActionMap.idl" />
|
||
<Midl Include="CascadiaSettings.idl" />
|
||
<Midl Include="ColorScheme.idl" />
|
||
<Midl Include="Command.idl" />
|
||
<Midl Include="DefaultTerminal.idl" />
|
||
<Midl Include="GlobalAppSettings.idl" />
|
||
<Midl Include="IconPathConverter.idl" />
|
||
<Midl Include="Profile.idl" />
|
||
<Midl Include="EnumMappings.idl" />
|
||
<Midl Include="TerminalSettings.idl" />
|
||
<Midl Include="TerminalWarnings.idl" />
|
||
<Midl Include="KeyChordSerialization.idl" />
|
||
<Midl Include="AppearanceConfig.idl" />
|
||
<Midl Include="IAppearanceConfig.idl" />
|
||
</ItemGroup>
|
||
<!-- ========================= Misc Files ======================== -->
|
||
<ItemGroup>
|
||
<PRIResource Include="Resources\en-US\Resources.resw" />
|
||
<OCResourceDirectory Include="Resources" />
|
||
<None Include="packages.config" />
|
||
</ItemGroup>
|
||
<!-- ========================= Project References ======================== -->
|
||
<ItemGroup>
|
||
<!--
|
||
the packaging project won't recurse through our dependencies, you have to
|
||
make sure that if you add a cppwinrt dependency to any of these projects,
|
||
you also update all the consumers
|
||
-->
|
||
<ProjectReference Include="$(OpenConsoleDir)src\types\lib\types.vcxproj" />
|
||
<ProjectReference Include="$(OpenConsoleDir)src\cascadia\WinRTUtils\WinRTUtils.vcxproj">
|
||
<Project>{CA5CAD1A-039A-4929-BA2A-8BEB2E4106FE}</Project>
|
||
<ReferenceOutputAssembly>false</ReferenceOutputAssembly>
|
||
</ProjectReference>
|
||
<!-- For whatever reason, we can't include the TerminalControl and
|
||
TerminalSettings projects' winmds via project references. So we'll have to
|
||
manually include the winmds as References below -->
|
||
</ItemGroup>
|
||
<ItemGroup>
|
||
<!-- Manually add references to each of our dependent winmds. Mark them as
|
||
private=false and CopyLocalSatelliteAssemblies=false, so that we don't
|
||
propagate them upwards (which can make referencing this project result in
|
||
duplicate type definitions)-->
|
||
<Reference Include="Microsoft.Terminal.TerminalConnection">
|
||
<HintPath>$(OpenConsoleCommonOutDir)TerminalConnection\Microsoft.Terminal.TerminalConnection.winmd</HintPath>
|
||
<IsWinMDFile>true</IsWinMDFile>
|
||
<Private>false</Private>
|
||
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
|
||
</Reference>
|
||
<Reference Include="Microsoft.Terminal.Control">
|
||
<HintPath>$(OpenConsoleCommonOutDir)Microsoft.Terminal.Control\Microsoft.Terminal.Control.winmd</HintPath>
|
||
<IsWinMDFile>true</IsWinMDFile>
|
||
<Private>false</Private>
|
||
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
|
||
</Reference>
|
||
<Reference Include="Microsoft.Terminal.Core">
|
||
<HintPath>$(OpenConsoleCommonOutDir)TerminalCore\Microsoft.Terminal.Core.winmd</HintPath>
|
||
<IsWinMDFile>true</IsWinMDFile>
|
||
<Private>false</Private>
|
||
<CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
|
||
</Reference>
|
||
</ItemGroup>
|
||
<!-- ====================== Compiler & Linker Flags ===================== -->
|
||
<ItemDefinitionGroup>
|
||
<ClCompile>
|
||
<PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
|
||
<AdditionalIncludeDirectories>..;$(OpenConsoleDir)\dep\jsoncpp\json;%(AdditionalIncludeDirectories);</AdditionalIncludeDirectories>
|
||
<!-- Manually disable unreachable code warning, because jconcpp has a ton of that. -->
|
||
<DisableSpecificWarnings>4702;%(DisableSpecificWarnings)</DisableSpecificWarnings>
|
||
</ClCompile>
|
||
<Link>
|
||
<AdditionalDependencies>WindowsApp.lib;user32.lib;shell32.lib;%(AdditionalDependencies)</AdditionalDependencies>
|
||
</Link>
|
||
<Reference>
|
||
<Private>false</Private>
|
||
</Reference>
|
||
</ItemDefinitionGroup>
|
||
<!-- ========================= Globals ======================== -->
|
||
<Import Project="$(OpenConsoleDir)src\cppwinrt.build.post.props" />
|
||
|
||
<Import Project="..\..\..\packages\Microsoft.UI.Xaml.2.5.0-prerelease.201202003\build\native\Microsoft.UI.Xaml.targets" Condition="Exists('..\..\..\packages\Microsoft.UI.Xaml.2.5.0-prerelease.201202003\build\native\Microsoft.UI.Xaml.targets')" />
|
||
<Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
|
||
<PropertyGroup>
|
||
<ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
|
||
</PropertyGroup>
|
||
<Error Condition="!Exists('$(OpenConsoleDir)\packages\Microsoft.UI.Xaml.2.5.0-prerelease.201202003\build\native\Microsoft.UI.Xaml.targets')" Text="$([System.String]::Format('$(ErrorText)', '$(OpenConsoleDir)\packages\Microsoft.UI.Xaml.2.5.0-prerelease.201202003\build\native\Microsoft.UI.Xaml.targets'))" />
|
||
</Target>
|
||
<!-- This target will take our defaults.json and stamp it into a .h file that
|
||
we can include in the code directly. This way, we don't need to worry about
|
||
failing to load the default settings at runtime. -->
|
||
<Target Name="_TerminalAppGenerateDefaultsH" Inputs="defaults.json" Outputs="Generated Files\defaults.h" BeforeTargets="BeforeClCompile">
|
||
<Exec Command="powershell.exe -noprofile –ExecutionPolicy Unrestricted $(OpenConsoleDir)\tools\GenerateHeaderForJson.ps1 -JsonFile defaults.json -OutPath '"Generated Files\defaults.h"' -VariableName DefaultJson" />
|
||
</Target>
|
||
<!-- A different set of defaults for Universal variant -->
|
||
<Target Name="_TerminalAppGenerateDefaultsUniversalH" Inputs="defaults-universal.json" Outputs="Generated Files\defaults-universal.h" BeforeTargets="BeforeClCompile">
|
||
<Exec Command="powershell.exe -noprofile –ExecutionPolicy Unrestricted $(OpenConsoleDir)\tools\GenerateHeaderForJson.ps1 -JsonFile defaults-universal.json -OutPath '"Generated Files\defaults-universal.h"' -VariableName DefaultUniversalJson" />
|
||
</Target>
|
||
<!-- Same as above, but for the default settings.json template -->
|
||
<Target Name="_TerminalAppGenerateUserSettingsH" Inputs="userDefaults.json" Outputs="Generated Files\userDefaults.h" BeforeTargets="BeforeClCompile">
|
||
<Exec Command="powershell.exe -noprofile –ExecutionPolicy Unrestricted $(OpenConsoleDir)\tools\GenerateHeaderForJson.ps1 -JsonFile userDefaults.json -OutPath '"Generated Files\userDefaults.h"' -VariableName UserSettingsJson" />
|
||
</Target>
|
||
|
||
<Import Project="$(SolutionDir)build\rules\CollectWildcardResources.targets" />
|
||
</Project>
|