[PTRun]Fix crash when plugins have the same name (#15456)

* [PT Run] Add scheme verfication for application URI

* Add test

.gitattributes

@@ -1 +1,15 @@
+###############################################################################
+# Set default behavior to automatically normalize line endings.
+###############################################################################
+* text=auto
+
+*.cs text eol=crlf
+
+###############################################################################
+# diff behavior for common document formats
+# 
+# Convert binary document formats to text before diffing them. This feature
+# is only available from the command line. Turn it on by uncommenting the 
+# entries below.
+###############################################################################
 *.rc diff

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,37 +0,0 @@
----
-name: Bug report
-about: Report errors or unexpected behavior
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!--
-**Important: When reporting BSODs or security issues, DO NOT attach memory dumps, logs, or traces to Github issues**.
-Instead, send dumps/traces to secure@microsoft.com, referencing this GitHub issue.
--->
-
-# Environment
-
-```
-Windows build number: [run "ver" at a command prompt]
-PowerToys version: 
-PowerToy module for which you are reporting the bug (if applicable):
-```
-
-# Steps to reproduce
-
-<!-- A description of how to trigger this bug. -->
-
-# Expected behavior
-
-<!-- A description of what you're expecting, possibly containing screenshots or reference material. -->
-
-# Actual behavior
-
-<!-- What's actually happening? -->
-
-# Screenshots
-
-<!-- If applicable, add screenshots to help explain your problem. -->

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,91 @@
+name: "🐛 Bug report"
+description: Report errors or unexpected behavior
+labels: 
+- Issue-Bug
+- Needs-Triage
+body:
+- type: markdown
+  attributes:
+    value: |
+      Please make sure to [search for existing issues](https://github.com/microsoft/PowerToys/issues) before filing a new one!
+- type: input
+  attributes:
+    label: Microsoft PowerToys version
+    placeholder: |
+      "0.33.1"
+    description: |
+      Hover over system tray icon or look at Settings
+  validations:
+    required: true
+
+- type: checkboxes
+  attributes:
+    label: Running as admin
+    description: Are you running PowerToys as Admin?
+    options:
+      - label: "Yes"
+
+- type: dropdown
+  attributes:
+    label: Area(s) with issue?
+    description: What things had an issue?  Check all that apply.
+    multiple: true
+    options:
+      - General
+      - Awake
+      - ColorPicker
+      - FancyZones
+      - FancyZones Editor 
+      - Image Resizer
+      - Keyboard Manager
+      - MD Preview
+      - Mouse Utilities
+      - PDF Preview
+      - PDF Thumbnail
+      - G-code Preview
+      - G-code Thumbnail
+      - PowerRename
+      - PowerToys Run
+      - Shortcut Guide
+      - SVG Preview
+      - SVG Thumbnail
+      - Settings
+      - Video Conference Mute
+      - Welcome / PowerToys Tour window
+      - System tray interaction
+      - Installer
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Steps to reproduce
+    description: We highly suggest including a screenshots and a bug report log (System tray->Report bug).
+    placeholder: Tell us the steps required to trigger your bug.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: ✔️ Expected Behavior
+    placeholder: What were you expecting?
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: ❌ Actual Behavior
+    placeholder: What happened instead?
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Other Software
+    description: If you're reporting a bug about our interaction with other software, what software? What versions?
+    placeholder: |
+      vim 8.2 (inside WSL)
+      OpenSSH_for_Windows_8.1p1
+      My Cool Application v0.3 (include a code snippet if it would help!)
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,12 @@
+blank_issues_enabled: false
+contact_links:
+  - name: "\U0001F6A8 Microsoft Security Response Center (MSRC)"
+    url: https://msrc.microsoft.com/create-report
+    about: Report security bugs
+  - name: "\U0001F4DA PowerToys user documentation"
+    url: https://aka.ms/powertoys-docs
+    about: Documentation for users of PowerToys utilities
+  - name: "\U0001F4DA PowerToys dev documentation"
+    url: https://github.com/microsoft/PowerToys/tree/main/doc/devdocs
+    about: Documentation for people interested in developing and contributing for PowerToys
+ 

.github/ISSUE_TEMPLATE/documentation-issue.md

@@ -1,10 +0,0 @@
----
-name: Documentation Issue
-about: Report issues in our documentation
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!-- Briefly describe which document needs to be corrected and why. -->

.github/ISSUE_TEMPLATE/documentation-issue.yml

@@ -0,0 +1,12 @@
+name: "📚 Documentation Issue"
+description: Report issues in our documentation
+labels: 
+- Issue-Docs
+- Needs-Triage 
+body:
+- type: textarea
+  attributes: 
+    label: Provide a description of requested docs changes
+    placeholder: Briefly describe which document needs to be corrected and why.
+  validations:
+    required: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,21 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-# Summary of the new feature/enhancement
-
-<!-- 
-A clear and concise description of what the problem is that the new feature would solve.
-Describe why and how a user would use this new functionality (if applicable).
--->
-
-# Proposed technical implementation details (optional)
-
-<!-- 
-A clear and concise description of what you want to happen.
--->

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,30 @@
+name: "⭐ Feature / enhancement request"
+description: Propose something new.
+labels: 
+- Needs-Triage 
+body:
+- type: textarea
+  attributes: 
+    label: Description of the new feature / enhancement
+    placeholder: |
+      What is the expected behavior of the proposed feature?
+  validations:
+    required: true
+- type: textarea
+  attributes: 
+    label: Scenario when this would be used? 
+    placeholder: |
+      What is the scenario this would be used?  Why is this important to your workflow as a power user?
+  validations:
+    required: true
+- type: textarea
+  attributes: 
+    label: Supporting information
+    placeholder: |
+      Having additional evidence, data, tweets, blog posts, research, ... anything is extremely helpful. This information provides context to the scenario that may otherwise be lost.
+  validations:
+    required: false
+- type: markdown
+  attributes:
+    value: |
+      Please limit one request per issue.

.github/ISSUE_TEMPLATE/translation_issue.yml

@@ -0,0 +1,68 @@
+name: "🌐 Localization/Translation issue"
+description: Report incorrect translations.
+labels: 
+- Issue-Bug
+- Area-Localization
+- Issue-Translation
+- Needs-Triage 
+body:
+- type: markdown
+  attributes:
+    value: |
+      Please make sure to [search for existing issues](https://github.com/microsoft/PowerToys/issues) before filing a new one!
+- type: input
+  attributes:
+    label: Microsoft PowerToys version
+    placeholder: "0.35.0"
+    description: |
+      Hover over system tray icon or look at Settings
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: Utility with translation issue
+    options:
+      - General
+      - PowerToys Awake
+      - ColorPicker
+      - FancyZones
+      - FancyZones Editor 
+      - Image Resizer
+      - Keyboard Manager
+      - MD Preview
+      - Mouse Utilities
+      - PowerRename
+      - PowerToys Run
+      - Shortcut Guide
+      - SVG Preview
+      - SVG Thumbnail
+      - Settings
+      - Welcome / PowerToys Tour window
+      - System tray interaction
+      - Installer
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: 🌐 Language affected
+    placeholder: "German"
+  validations:
+    required: true
+- type: textarea
+  attributes: 
+    label: ❌ Actual phrase(s)
+    placeholder: What is there?  Please include a screenshot as that is extremely helpful. 
+  validations:
+    required: true
+- type: textarea
+  attributes: 
+    label: ✔️ Expected phrase(s)
+    placeholder: What was expected?
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: ℹ Why is the current translation wrong
+    placeholder: Why do you feel this is incorrect?
+  validations:
+    required: true

.github/actions/spell-check/advice.md

@@ -0,0 +1,25 @@
+<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
+<details><summary>If the flagged items do not appear to be text</summary>
+
+If items relate to a ...
+* well-formed pattern.
+
+  If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
+  try adding it to the `patterns.txt` file.
+
+  Patterns are Perl 5 Regular Expressions - you can [test](
+https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
+
+  Note that patterns can't match multiline strings.
+
+* binary file.
+
+  Please add a file path to the `excludes.txt` file matching the containing file.
+
+  File paths are Perl 5 Regular Expressions - you can [test](
+https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
+
+  `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
+../tree/HEAD/README.md) (on whichever branch you're using).
+
+</details>

.github/actions/spell-check/excludes.txt

@@ -0,0 +1,47 @@
+# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
+(?:^|/)(?i)COPYRIGHT
+(?:^|/)(?i)LICEN[CS]E
+(?:^|/)package(?:-lock)\.json$
+(?:^|/)vendor/
+(?:^|/)WindowsSettings\.json$
+/package(?:-lock|)\.json$
+/pinyindb/
+/settings-html/
+ignore$
+[/.][a-z]{2}(?:-[a-zA-Z]{2}|)\.
+\.ai$
+\.bmp$
+\.dat$
+\.dll$
+\.filters$
+\.gcode$
+\.gif$
+\.gitignore$
+\.ico$
+\.jpg$
+\.lcl$
+\.lock$
+\.min\.
+\.mod$
+\.pdf$
+\.PNG$
+\.png$
+\.woff$
+\.zip$
+^doc/devdocs/akaLinks\.md$
+^src/common/logger/logger\.vcxproj\.filters$
+^src/common/notifications/BackgroundActivatorDLL/BackgroundActivator\.vcxproj\.filters$
+^src/common/notifications/BackgroundActivatorDLL/cpp\.hint$
+^src/modules/colorPicker/ColorPickerUI/Resources/colorPicker\.cur$
+^src/modules/fancyzones/lib/FancyZonesWinHookEventIDs\.h$
+^src/modules/imageresizer/dll/ContextMenuHandler\.rgs$
+^src/modules/imageresizer/dll/ImageResizerExt\.rgs$
+^src/modules/powerrename/testapp/PowerRenameTest\.vcxproj\.filters$
+^src/modules/powerrename/UWPui/pch\.h$
+^src/modules/powerrename/UWPui/PowerRenameUWPUI\.vcxproj\.filters$
+^src/modules/previewpane/PreviewPaneUnitTests/HelperFiles/MarkdownWithHTMLImageTag\.txt$
+^src/modules/previewpane/UnitTests-MarkdownPreviewHandler/HelperFiles/MarkdownWithHTMLImageTag.txt$
+^tools/CleanUp_tool/CleanUp_tool\.vcxproj\.filters$
+^\.github/
+^\.github/actions/spell-check/
+^\.gitmodules$

.github/actions/spell-check/patterns.txt

@@ -0,0 +1,82 @@
+# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns
+https?://(?:(?:www\.|)youtube\.com|youtu.be)/[-a-zA-Z0-9?&=]*
+# GitHub SHAs
+\bapi.github\.com/repos/[^/]+/[^/]+/[^/]+/[0-9a-f]+\b
+://github\.(?:com|blog)/[^\w")]+
+(?:\[[0-9a-f]+\]\(https:/|)/github\.com/[^/]+/[^/]+/[^/]+/[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b
+# githubusercontent
+://githubusercontent\.com/[^\w")]+
+# gist github
+/gist\.github\.com/[^/]+/[0-9a-f]+
+
+# msdn
+\b(?:download\.visualstudio|docs|msdn)\.microsoft\.com/[-_a-zA-Z0-9()=./]*
+
+publicKeyToken=(['"]|)[0-9a-f]+\g{-1}
+\@sha256:[0-9a-f]{64}\b
+
+# data urls
+(['"])data:.*?\g{-1}
+data:[-a-zA-Z=;:/0-9+]*,\S*
+
+# uuid:
+L?(["']|[-<({>]|\b)[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}(?:\g{-1}|[<})>])
+
+# c99 hex digits (not the full format, just one I've seen)
+0x[0-9a-fA-F](?:\.[0-9a-fA-F]*|)[pP]
+
+# wregex
+std::wregex\(L"[^"]*"\)
+
+# hex digits including css/html color classes:
+(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23|L")[0-9a-fA-FgGrR_]{2,}(?:[uU]?[lL]{0,2}|u\d+)\b
+
+# ignore long runs of a single character:
+\b([A-Za-z])\g{-1}{3,}\b
+(?:L"[abAB]+", ){3}L"[abAB]+"
+"Lorem[^"]+?\."
+TestCase\("[^"]+"
+
+# Test line with hexadecimal colors
+\[DataRow\("[0-9A-F]{6}", \d{3}, \d{3}, \d{3}\)\]
+\[DataRow\("[0-9A-F]{6}", \d{3}.\d{1}, \d{3}.\d{1}, \d{3}.\d{1}\)\]
+\[DataRow\("[0-9A-F]{6}", "[BCGMRY]\d\d?", \d{3}, \d{3}\)\]
+
+# Windows paths
+\\native
+\\netcoreapp
+\\netstandard
+\\notifications
+\\recyclebin
+\\reinstall
+\\Resize
+\\resource
+\\Resources
+\\restart
+\\restore
+\\result
+\\runner
+\\runtimes
+\\Telemetry
+\\telemetry
+\\testapp
+\\tests
+\\tools
+
+# plugin.json
+^  "ID": "[0-9A-F]{32}",$
+
+# UnitTests
+\[DataRow\(.*\)\]
+
+# Id info inside markdown file (registry.md) 
+^\|\s+ID\s+\|\s*\`[0-9A-F]{32}\`
+
+# TestCase strings intentionally have non dictionary items
+\[TestCase\(new string.*\]
+
+# marker for ignoring a comment to the end of the line
+^.*/\* #no-spell-check-line \*/.*$
+// #no-spell-check.*$
+
+http://tes/

.github/pull_request_template.md

@@ -1,19 +1,23 @@
-<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? -->
 ## Summary of the Pull Request
 
-<!-- Other than the issue solved, is this relevant to any other issues/existing PRs? --> 
-## References
+**What is this about:**
 
-<!-- Please review the items on the PR checklist before submitting-->
-## PR Checklist
-* [ ] Closes #xxx
-* [ ] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/PowerToys) and sign the CLA
-* [ ] Tests added/passed
-* [ ] Requires documentation to be updated
-* [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx
+**What is included in the PR:** 
 
-<!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here -->
-## Detailed Description of the Pull Request / Additional comments
+**How does someone test / validate:** 
 
-<!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well -->
-## Validation Steps Performed
+## Quality Checklist
+
+- [ ] **Linked issue:** #xxx
+- [ ] **Communication:** I've discussed this with core contributors in the issue. 
+- [ ] **Tests:** Added/updated and all pass
+- [ ] **Installer:** Added/updated and all pass
+- [ ] **Localization:** All end user facing strings can be localized
+- [ ] **Docs:** Added/ updated
+- [ ] **Binaries:** Any new files are added to WXS / YML
+   - [ ] No new binaries
+   - [ ] [YML for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/pipeline.user.windows.yml#L68) for new binaries
+   - [ ] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries
+
+## Contributor License Agreement (CLA)
+A CLA must be signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/PowerToys) and sign the CLA.

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,44 @@
+name: "CodeQL"
+
+on:
+  # push:
+  # running on cron since this isn't running on our agent currently
+  schedule:
+    - cron: '0 0 * * *'
+    - cron: '0 12 * * *'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: windows-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'cpp', 'csharp', 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more: https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # these CMDs are being used on the Build farm signed instance, not the YML files for CI
+    - name: Manual build
+      run: | 
+        .\.pipelines\restore.cmd
+        .\.pipelines\build.cmd
+      if: ${{ matrix.language == 'cpp' || matrix.language == 'csharp' }}
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/spelling2.yml

@@ -0,0 +1,76 @@
+# spelling.yml is blocked per https://github.com/check-spelling/check-spelling/security/advisories/GHSA-g86g-chm8-7r2p
+name: Spell checking
+on:
+  pull_request_target:
+  push:
+    branches: ["**"]
+    tags-ignore: ["**"]
+
+jobs:
+  spelling:
+    name: Spell checking
+    permissions:
+      contents: read
+      pull-requests: read
+    outputs:
+      internal_state_directory: ${{ steps.spelling.outputs.internal_state_directory }}
+    runs-on: ubuntu-latest
+    if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'"
+    concurrency:
+      group: spelling-${{ github.event.pull_request.number || github.ref }}
+      # note: If you use only_check_changed_files, you do not want cancel-in-progress
+      cancel-in-progress: true
+    steps:
+    - name: checkout-merge
+      if: "contains(github.event_name, 'pull_request')"
+      uses: actions/checkout@v2
+      with:
+        ref: refs/pull/${{github.event.pull_request.number}}/merge
+    - name: checkout
+      if: github.event_name == 'push'
+      uses: actions/checkout@v2
+    - name: check-spelling
+      id: spelling
+      uses: check-spelling/check-spelling@v0.0.20-alpha3
+      with:
+        config: .github/actions/spell-check
+        suppress_push_for_open_pull_request: 1
+        post_comment: 0
+        extra_dictionaries:
+          cspell:filetypes/filetypes.txt
+          cspell:html/html.txt
+          cspell:css/css.txt
+        check_extra_dictionaries: ''
+    - name: store-comment
+      if: failure()
+      uses: actions/upload-artifact@v2
+      with:
+        retention-days: 1
+        name: "check-spelling-comment-${{ github.run_id }}"
+        path: |
+          ${{ steps.spelling.outputs.internal_state_directory }}
+
+  comment:
+    name: Comment
+    runs-on: ubuntu-latest
+    needs: spelling
+    permissions:
+      contents: write
+      pull-requests: write
+    if: always() && needs.spelling.result == 'failure' && needs.spelling.outputs.internal_state_directory
+    steps:
+    - name: checkout
+      uses: actions/checkout@v2
+    - name: set up
+      run: |
+        mkdir /tmp/data
+    - name: retrieve-comment
+      uses: actions/download-artifact@v2
+      with:
+        name: "check-spelling-comment-${{ github.run_id }}"
+        path: /tmp/data
+    - name: comment
+      uses: check-spelling/check-spelling@v0.0.20-alpha3
+      with:
+        custom_task: comment
+        internal_state_directory: /tmp/data

.gitignore

@@ -301,6 +301,8 @@ __pycache__/
 # Cake - Uncomment if you are using it
 # tools/**
 # !tools/packages.config
+ImageResizer/tools/**
+!ImageResizer/tools/packages.config
 
 # Tabs Studio
 *.tss
@@ -328,3 +330,17 @@ ASALocalRun/
 
 # MFractors (Xamarin productivity tool) working folder 
 .mfractor/
+
+# Temp build files
+src/settings/settings-html/200.html
+src/settings/settings-html/404.html
+
+# Temp telemetry files.
+src/common/Telemetry/*.etl
+
+# Don't ignore MergeModules
+!**/MergeModules/Release/
+!**/MergeModules/Debug/
+/src/modules/previewpane/SvgThumbnailProvider/$(SolutionDir)$(Platform)/$(Configuration)/modules/FileExplorerPreview/SvgThumbnailProvider.xml
+/src/modules/powerrename/ui/RCa24464
+/src/modules/powerrename/ui/RCb24464

.gitmodules

@@ -0,0 +1,12 @@
+[submodule "deps/spdlog"]
+	path = deps/spdlog
+	url = https://github.com/gabime/spdlog.git
+[submodule "deps/cxxopts"]
+	path = deps/cxxopts
+	url = https://github.com/jarro2783/cxxopts.git
+[submodule "deps/expected-lite"]
+	path = deps/expected-lite
+	url = https://github.com/martinmoene/expected-lite.git
+[submodule "deps/cziplib"]
+	path = deps/cziplib
+	url = https://github.com/kuba--/zip.git

.pipelines/CIPolicy.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<SiPolicy xmlns="urn:schemas-microsoft-com:sipolicy">
+  <VersionEx>10.0.0.0</VersionEx>
+  <PlatformID>{2E07F7E4-194C-4D20-B7C9-6F44A6C5A234}</PlatformID>
+  <Rules>
+    <Rule>
+      <Option>Enabled:Unsigned System Integrity Policy</Option>
+    </Rule>
+    <Rule>
+      <Option>Enabled:Audit Mode</Option>
+    </Rule>
+    <Rule>
+      <Option>Enabled:Advanced Boot Options Menu</Option>
+    </Rule>
+    <Rule>
+      <Option>Required:Enforce Store Applications</Option>
+    </Rule>
+    <Rule>
+      <Option>Disabled:Script Enforcement</Option>
+    </Rule>
+  </Rules>
+  <!--EKUS-->
+  <EKUs />
+  <!--File Rules-->
+  <FileRules />
+  <!--Signers-->
+  <Signers />
+  <!--Driver Signing Scenarios-->
+  <SigningScenarios>
+    <SigningScenario Value="131" ID="ID_SIGNINGSCENARIO_DRIVERS_1" FriendlyName="Auto generated policy on 01-26-2021">
+      <ProductSigners />
+    </SigningScenario>
+    <SigningScenario Value="12" ID="ID_SIGNINGSCENARIO_WINDOWS" FriendlyName="Auto generated policy on 01-26-2021">
+      <ProductSigners />
+    </SigningScenario>
+  </SigningScenarios>
+  <UpdatePolicySigners />
+  <CiSigners />
+  <HvciOptions>0</HvciOptions>
+  <PolicyTypeID>{A244370E-44C9-4C06-B551-F6016E563076}</PolicyTypeID>
+</SiPolicy>

.pipelines/ESRPSigning_core.json

@@ -0,0 +1,230 @@
+{
+    "Version": "1.0.0",
+    "UseMinimatch": false,
+    "SignBatches": [
+        {
+            "MatchedPath": [
+                "*.resources.dll",
+
+                "PowerToysSetupCustomActions.dll",
+
+                
+                "PowerToys.ActionRunner.exe",
+                "PowerToys.Update.exe",
+                "PowerToys.BackgroundActivatorDLL.dll",
+                "Notifications.dll",
+                "os-detection.dll",
+                "PowerToys.exe",
+                "PowerToys.Interop.dll",
+                "BugReportTool\\BugReportTool.exe",
+                "WebcamReportTool\\WebcamReportTool.exe",
+                "Telemetry.dll",
+                "PowerToys.ManagedTelemetry.dll",
+                "PowerToys.ManagedCommon.dll",
+                "PowerToys.Common.UI.dll",
+                "PowerToys.Settings.UI.Lib.dll",
+
+                "modules\\ColorPicker\\ColorPicker.dll",
+                "modules\\ColorPicker\\ColorPickerUI.dll",
+                "modules\\ColorPicker\\ColorPickerUI.exe",
+
+                "modules\\ColorPicker\\PowerToys.ColorPicker.dll",
+                "modules\\ColorPicker\\PowerToys.ColorPickerUI.dll",
+                "modules\\ColorPicker\\PowerToys.ColorPickerUI.exe",
+
+                "modules\\AlwaysOnTop\\PowerToys.AlwaysOnTop.exe",
+                "modules\\AlwaysOnTop\\PowerToys.AlwaysOnTopModuleInterface.dll",
+
+                "modules\\Awake\\PowerToys.AwakeModuleInterface.dll",
+                "modules\\Awake\\PowerToys.Awake.exe",
+                "modules\\Awake\\PowerToys.Awake.dll",
+
+                "modules\\FancyZones\\fancyzones.dll",
+                "modules\\FancyZones\\PowerToys.FancyZonesEditor.exe",
+                "modules\\FancyZones\\PowerToys.FancyZonesEditor.dll",
+                "modules\\FancyZones\\PowerToys.FancyZonesModuleInterface.dll",
+                "modules\\FancyZones\\PowerToys.FancyZones.exe",
+
+                "modules\\FileExplorerPreview\\PowerToys.GcodePreviewHandler.dll",
+                "modules\\FileExplorerPreview\\PowerToys.GcodePreviewHandler.comhost.dll",
+                "modules\\FileExplorerPreview\\PowerToys.GcodeThumbnailProvider.dll",
+                "modules\\FileExplorerPreview\\PowerToys.GcodeThumbnailProvider.comhost.dll",
+                "modules\\FileExplorerPreview\\PowerToys.ManagedTelemetry.dll",
+                "modules\\FileExplorerPreview\\PowerToys.MarkdownPreviewHandler.dll",
+                "modules\\FileExplorerPreview\\PowerToys.MarkdownPreviewHandler.comhost.dll",
+                "modules\\FileExplorerPreview\\PowerToys.PdfPreviewHandler.dll",
+                "modules\\FileExplorerPreview\\PowerToys.PdfPreviewHandler.comhost.dll",
+                "modules\\FileExplorerPreview\\PowerToys.PdfThumbnailProvider.dll",
+                "modules\\FileExplorerPreview\\PowerToys.PdfThumbnailProvider.comhost.dll",
+                "modules\\FileExplorerPreview\\PowerToys.powerpreview.dll",
+                "modules\\FileExplorerPreview\\PowerToys.PreviewHandlerCommon.dll",
+                "modules\\FileExplorerPreview\\PowerToys.SvgPreviewHandler.dll",
+                "modules\\FileExplorerPreview\\PowerToys.SvgPreviewHandler.comhost.dll",
+                "modules\\FileExplorerPreview\\PowerToys.SvgThumbnailProvider.dll",
+                "modules\\FileExplorerPreview\\PowerToys.SvgThumbnailProvider.comhost.dll",
+
+                "modules\\ImageResizer\\PowerToys.ImageResizer.exe",
+                "modules\\ImageResizer\\PowerToys.ImageResizer.dll",
+                "modules\\ImageResizer\\PowerToys.ImageResizerExt.dll",
+
+                "modules\\KeyboardManager\\PowerToys.KeyboardManager.dll",
+                "modules\\KeyboardManager\\KeyboardManagerEditor\\PowerToys.KeyboardManagerEditor.exe",
+                "modules\\KeyboardManager\\KeyboardManagerEngine\\PowerToys.KeyboardManagerEngine.exe",
+
+                "modules\\launcher\\PowerToys.Launcher.dll",
+                "modules\\launcher\\PowerToys.PowerLauncher.dll",
+                "modules\\launcher\\PowerToys.PowerLauncher.exe",
+                "modules\\launcher\\PowerToys.PowerLauncher.Telemetry.dll",
+                "modules\\launcher\\Wox.dll",
+                "modules\\launcher\\Wox.Infrastructure.dll",
+                "modules\\launcher\\Wox.Plugin.dll",
+                "modules\\launcher\\Plugins\\Calculator\\Microsoft.PowerToys.Run.Plugin.Calculator.dll",
+                "modules\\launcher\\Plugins\\Folder\\Microsoft.Plugin.Folder.dll",
+                "modules\\launcher\\Plugins\\Indexer\\Microsoft.Plugin.Indexer.dll",
+                "modules\\launcher\\Plugins\\Program\\Microsoft.Plugin.Program.dll",
+                "modules\\launcher\\Plugins\\Registry\\Microsoft.PowerToys.Run.Plugin.Registry.dll",
+                "modules\\launcher\\Plugins\\WindowsSettings\\Microsoft.PowerToys.Run.Plugin.WindowsSettings.dll",
+                "modules\\launcher\\Plugins\\Shell\\Microsoft.Plugin.Shell.dll",
+                "modules\\launcher\\Plugins\\Uri\\Microsoft.Plugin.Uri.dll",
+                "modules\\launcher\\Plugins\\WindowWalker\\Microsoft.Plugin.WindowWalker.dll",
+                "modules\\launcher\\Plugins\\UnitConverter\\Community.PowerToys.Run.Plugin.UnitConverter.dll",
+                "modules\\launcher\\Plugins\\VSCodeWorkspaces\\Community.PowerToys.Run.Plugin.VSCodeWorkspaces.dll",
+                "modules\\launcher\\Plugins\\Service\\Microsoft.PowerToys.Run.Plugin.Service.dll",
+                "modules\\launcher\\Plugins\\System\\Microsoft.PowerToys.Run.Plugin.System.dll",
+                "modules\\launcher\\Plugins\\WebSearch\\Community.PowerToys.Run.Plugin.WebSearch.dll",
+                "modules\\launcher\\Plugins\\WindowsTerminal\\Microsoft.PowerToys.Run.Plugin.WindowsTerminal.dll",
+                
+                "modules\\MouseUtils\\PowerToys.FindMyMouse.dll",
+                "modules\\MouseUtils\\PowerToys.MouseHighlighter.dll",
+
+                "modules\\PowerRename\\PowerToys.PowerRenameExt.dll",
+                "modules\\PowerRename\\PowerToys.PowerRenameUILib.dll",
+                "modules\\PowerRename\\PowerToys.PowerRename.exe",
+
+                "modules\\ShortcutGuide\\ShortcutGuide\\PowerToys.ShortcutGuide.exe",
+                "modules\\ShortcutGuide\\ShortcutGuideModuleInterface\\PowerToys.ShortcutGuideModuleInterface.dll",
+
+                "modules\\VideoConference\\PowerToys.VideoConferenceModule.dll",
+                "modules\\VideoConference\\PowerToys.VideoConferenceProxyFilter_x86.dll",
+                "modules\\VideoConference\\PowerToys.VideoConferenceProxyFilter_x64.dll",
+
+                "Settings\\PowerToys.Settings.UI.exe",
+                "Settings\\PowerToys.Settings.dll",
+                "Settings\\PowerToys.Settings.exe"
+            ],
+            "SigningInfo": {
+                "Operations": [
+                    {
+                        "KeyCode": "CP-230012",
+                        "OperationSetCode": "SigntoolSign",
+                        "Parameters": [
+                            {
+                                "parameterName": "OpusName",
+                                "parameterValue": "Microsoft"
+                            },
+                            {
+                                "parameterName": "OpusInfo",
+                                "parameterValue": "http://www.microsoft.com"
+                            },
+                            {
+                                "parameterName": "FileDigest",
+                                "parameterValue": "/fd \"SHA256\""
+                            },
+                            {
+                                "parameterName": "PageHash",
+                                "parameterValue": "/NPH"
+                            },
+                            {
+                                "parameterName": "TimeStamp",
+                                "parameterValue": "/tr \"http://rfc3161.gtm.corp.microsoft.com/TSS/HttpTspServer\" /td sha256"
+                            }
+                        ],
+                        "ToolName": "sign",
+                        "ToolVersion": "1.0"
+                    },
+                    {
+                        "KeyCode": "CP-230012",
+                        "OperationSetCode": "SigntoolVerify",
+                        "Parameters": [],
+                        "ToolName": "sign",
+                        "ToolVersion": "1.0"
+                    }
+                ]
+            }
+        },
+        {
+            "MatchedPath": [
+                "Microsoft.Search.Interop.dll",
+                "ModernWpf.dll",
+                "ModernWpf.Controls.dll", 
+                "System.IO.Abstractions.dll", 
+                "Mono.Cecil.dll",
+                "Mono.Cecil.Mdb.dll",
+                "Mono.Cecil.Pdb.dll",
+                "Mono.Cecil.Rocks.dll",
+                "NLog.dll",
+                "HtmlAgilityPack.dll",
+                "Markdig.Signed.dll",
+                "Mages.Core.dll",
+                "JetBrains.Annotations.dll",
+                "ICSharpCode.SharpZipLib.dll",
+                "NLog.Extensions.Logging.dll", 
+                "concrt140_app.dll",
+                "msvcp140_1_app.dll",
+                "msvcp140_2_app.dll",
+                "msvcp140_app.dll",
+                "vcamp140_app.dll",
+                "vccorlib140_app.dll",
+                "vcomp140_app.dll",
+                "vcruntime140_1_app.dll",
+                "vcruntime140_app.dll", 
+                "ColorCode.Core.dll", 
+                "ColorCode.UWP.dll",
+                "UnitsNet.dll"
+            ],
+            "SigningInfo": {
+                "Operations": [
+                    {
+                        "KeyCode": "CP-231522",
+                        "OperationSetCode": "SigntoolSign",
+                        "Parameters": [
+                            {
+                                "parameterName": "OpusName",
+                                "parameterValue": "Microsoft"
+                            },
+                            {
+                                "parameterName": "OpusInfo",
+                                "parameterValue": "http://www.microsoft.com"
+                            },
+                            {
+                                "parameterName": "FileDigest",
+                                "parameterValue": "/fd \"SHA256\""
+                            },
+                            {
+                                "parameterName": "Append",
+                                "parameterValue": "/as"
+                            },
+                            {
+                                "parameterName": "PageHash",
+                                "parameterValue": "/NPH"
+                            },
+                            {
+                                "parameterName": "TimeStamp",
+                                "parameterValue": "/tr \"http://rfc3161.gtm.corp.microsoft.com/TSS/HttpTspServer\" /td sha256"
+                            }
+                        ],
+                        "ToolName": "sign",
+                        "ToolVersion": "1.0"
+                    },
+                    {
+                        "KeyCode": "CP-231522",
+                        "OperationSetCode": "SigntoolVerify",
+                        "Parameters": [],
+                        "ToolName": "sign",
+                        "ToolVersion": "1.0"
+                    }
+                ]
+            }
+        }
+    ]
+}

.pipelines/ESRPSigning_installer.json

@@ -0,0 +1,51 @@
+{
+    "Version": "1.0.0",
+    "UseMinimatch": false,
+    "SignBatches": [
+        {
+            "MatchedPath": [
+                "PowerToysSetup-*.exe",
+                "PowerToysSetup-*.msi"
+            ],
+            "SigningInfo": {
+                "Operations": [
+                    {
+                        "KeyCode": "CP-230012",
+                        "OperationSetCode": "SigntoolSign",
+                        "Parameters": [
+                            {
+                                "parameterName": "OpusName",
+                                "parameterValue": "Microsoft"
+                            },
+                            {
+                                "parameterName": "OpusInfo",
+                                "parameterValue": "http://www.microsoft.com"
+                            },
+                            {
+                                "parameterName": "FileDigest",
+                                "parameterValue": "/fd \"SHA256\""
+                            },
+                            {
+                                "parameterName": "PageHash",
+                                "parameterValue": "/NPH"
+                            },
+                            {
+                                "parameterName": "TimeStamp",
+                                "parameterValue": "/tr \"http://rfc3161.gtm.corp.microsoft.com/TSS/HttpTspServer\" /td sha256"
+                            }
+                        ],
+                        "ToolName": "sign",
+                        "ToolVersion": "1.0"
+                    },
+                    {
+                        "KeyCode": "CP-230012",
+                        "OperationSetCode": "SigntoolVerify",
+                        "Parameters": [],
+                        "ToolName": "sign",
+                        "ToolVersion": "1.0"
+                    }
+                ]
+            }
+        }
+    ]
+}

.pipelines/ESRPSigning_vcm.json

@@ -0,0 +1,50 @@
+{
+    "Version": "1.0.0",
+    "UseMinimatch": false,
+    "SignBatches": [
+        {
+            "MatchedPath": [
+                "modules\\VideoConference\\PowerToys.VideoConferenceProxyFilter_x86.dll"
+            ],
+            "SigningInfo": {
+                "Operations": [
+                    {
+                        "KeyCode": "CP-230012",
+                        "OperationSetCode": "SigntoolSign",
+                        "Parameters": [
+                            {
+                                "parameterName": "OpusName",
+                                "parameterValue": "Microsoft"
+                            },
+                            {
+                                "parameterName": "OpusInfo",
+                                "parameterValue": "http://www.microsoft.com"
+                            },
+                            {
+                                "parameterName": "FileDigest",
+                                "parameterValue": "/fd \"SHA256\""
+                            },
+                            {
+                                "parameterName": "PageHash",
+                                "parameterValue": "/NPH"
+                            },
+                            {
+                                "parameterName": "TimeStamp",
+                                "parameterValue": "/tr \"http://rfc3161.gtm.corp.microsoft.com/TSS/HttpTspServer\" /td sha256"
+                            }
+                        ],
+                        "ToolName": "sign",
+                        "ToolVersion": "1.0"
+                    },
+                    {
+                        "KeyCode": "CP-230012",
+                        "OperationSetCode": "SigntoolVerify",
+                        "Parameters": [],
+                        "ToolName": "sign",
+                        "ToolVersion": "1.0"
+                    }
+                ]
+            }
+        }
+    ]
+}

.pipelines/build-installer-MSI.cmd

@@ -0,0 +1,5 @@
+cd /D "%~dp0"
+
+call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\Common7\Tools\VsDevCmd.bat" -arch=amd64 -host_arch=amd64 -winsdk=10.0.18362.0
+SET IsPipeline=1
+call msbuild ../installer/PowerToysSetup.sln /target:PowerToysInstaller /p:Configuration=Release /p:Platform=x64 /p:CIBuild=true || exit /b 1

.pipelines/build-installer.cmd

@@ -1,4 +0,0 @@
-cd /D "%~dp0"
-
-call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\Common7\Tools\VsDevCmd.bat" -arch=amd64 -host_arch=amd64 -winsdk=10.0.16299.0
-call msbuild ../installer/PowerToysSetup.sln /p:Configuration=Release /p:Platform=x64 || exit /b 1

.pipelines/build.cmd

@@ -1,4 +0,0 @@
-cd /D "%~dp0"
-
-call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\Common7\Tools\VsDevCmd.bat" -arch=amd64 -host_arch=amd64 -winsdk=10.0.16299.0
-call msbuild ../PowerToys.sln /p:Configuration=Release /p:Platform=x64 || exit /b 1

.pipelines/ci/ci.yml

@@ -2,7 +2,8 @@ trigger:
   batch: true
   branches:
     include:
-      - master
+      - main
+      - stable
   paths:
     exclude:
       - doc/*
@@ -12,7 +13,8 @@ trigger:
 pr:
   branches:
     include:
-      - master
+      - main
+      - stable
 
 #     0.0.yyMM.dd##
 #     0.0.1904.0900

.pipelines/ci/templates/build-powertoys-ci.yml

@@ -1,7 +1,7 @@
 parameters:
   configuration: 'Release'
   platform: ''
-  additionalBuildArguments: ''
+  additionalBuildArguments: '-m'
 
 jobs:
 - job: Build${{ parameters.platform }}${{ parameters.configuration }}
@@ -9,9 +9,15 @@ jobs:
   variables:
     BuildConfiguration: ${{ parameters.configuration }}
     BuildPlatform: ${{ parameters.platform }}
-  pool: { vmImage: windows-2019 }
-
+  pool:
+    ${{ if eq(variables['System.CollectionUri'], 'https://dev.azure.com/ms/') }}:
+      name: WinDevPoolOSS-L
+    ${{ if ne(variables['System.CollectionUri'], 'https://dev.azure.com/ms/') }}:
+      name: WinDevPool-L
+  timeoutInMinutes: 120
+  strategy:
+    maxParallel: 10
   steps:
   - template: build-powertoys-steps.yml
     parameters:
-      additionalBuildArguments: ${{ parameters.additionalBuildArguments }}
+      additionalBuildArguments: ${{ parameters.additionalBuildArguments }}

.pipelines/ci/templates/build-powertoys-installer.yml

@@ -0,0 +1,20 @@
+parameters:
+  configuration: 'Release'
+  platform: ''
+  additionalBuildArguments: '-m'
+
+jobs:
+- job: Build${{ parameters.platform }}${{ parameters.configuration }}
+  displayName: Build ${{ parameters.platform }} ${{ parameters.configuration }}
+  variables:
+    BuildConfiguration: ${{ parameters.configuration }}
+    BuildPlatform: ${{ parameters.platform }}
+  pool:
+      name: WinDevPool-L
+  timeoutInMinutes: 120
+  strategy:
+    maxParallel: 10
+  steps:
+  - template: build-powertoys-steps.yml
+    parameters:
+      additionalBuildArguments: ${{ parameters.additionalBuildArguments }}

.pipelines/ci/templates/build-powertoys-steps.yml

@@ -3,19 +3,22 @@ parameters:
 
 steps:
 - checkout: self
+  fetchDepth: 1
   submodules: true
   clean: true
 
 - task: NuGetToolInstaller@0
-  displayName: Ensure NuGet 4.8.1
+  displayName: Ensure NuGet 5.8.0
   inputs:
-    versionSpec: 4.8.1
+    versionSpec: 5.8.0
+
+#- template: .\..\..\..\restore-dependencies.yml
 
 - task: VisualStudioTestPlatformInstaller@1
   displayName: Ensure VSTest Platform
 
 - task: NuGetCommand@2
-  displayName: Restore NuGet packages
+  displayName: Restore NuGet packages for PowerToys.sln
   inputs:
     command: restore
     feedsToUse: config
@@ -24,12 +27,115 @@ steps:
     restoreDirectory: '$(Build.SourcesDirectory)\packages'
 
 - task: VSBuild@1
-  displayName: 'Build solution **\PowerToys.sln'
+  displayName: 'Build PowerToys.sln'
   inputs:
     solution: '**\PowerToys.sln'
     vsVersion: 16.0
     platform: '$(BuildPlatform)'
     configuration: '$(BuildConfiguration)'
     msbuildArgs: ${{ parameters.additionalBuildArguments }}
-    clean: true
     maximumCpuCount: true
+
+- task: NuGetCommand@2
+  displayName: Restore NuGet packages for BugReportTool.sln
+  inputs:
+    command: restore
+    feedsToUse: config
+    configPath: NuGet.config
+    restoreSolution: tools\BugReportTool\BugReportTool.sln
+    restoreDirectory: '$(Build.SourcesDirectory)\tools\BugReportTool\packages'
+
+- task: VSBuild@1
+  displayName: 'Build BugReportTool.sln'
+  inputs:
+    solution: '**\BugReportTool.sln'
+    vsVersion: 16.0
+    platform: '$(BuildPlatform)'
+    configuration: '$(BuildConfiguration)'
+    msbuildArgs: ${{ parameters.additionalBuildArguments }}
+    maximumCpuCount: true
+
+- task: NuGetCommand@2
+  displayName: Restore NuGet packages for WebcamReportTool.sln
+  inputs:
+    command: restore
+    feedsToUse: config
+    configPath: NuGet.config
+    restoreSolution: tools\WebcamReportTool\WebcamReportTool.sln
+    restoreDirectory: '$(Build.SourcesDirectory)\tools\WebcamReportTool\packages'
+
+- task: VSBuild@1
+  displayName: 'Build WebcamReportTool.sln'
+  inputs:
+    solution: '**\WebcamReportTool.sln'
+    vsVersion: 16.0
+    platform: '$(BuildPlatform)'
+    configuration: '$(BuildConfiguration)'
+    msbuildArgs: ${{ parameters.additionalBuildArguments }}
+    maximumCpuCount: true
+
+- task: NuGetCommand@2
+  displayName: Restore NuGet packages for PowerToysSetup.sln
+  inputs:
+    command: restore
+    feedsToUse: config
+    configPath: NuGet.config
+    restoreSolution: installer\PowerToysSetup.sln
+    restoreDirectory: '$(Build.SourcesDirectory)\installer\packages'
+
+- task: VSBuild@1
+  displayName: 'Build PowerToysSetup.sln'
+  inputs:
+    solution: '**\installer\PowerToysSetup.sln'
+    vsVersion: 16.0
+    platform: '$(BuildPlatform)'
+    configuration: '$(BuildConfiguration)'
+    msbuildArgs: ${{ parameters.additionalBuildArguments }}
+    maximumCpuCount: true
+
+# directly not doing WinAppDriver testing
+- task: VSTest@2
+  displayName: 'MS Tests'
+  inputs:
+    platform: '$(BuildPlatform)'
+    configuration: '$(BuildConfiguration)'
+    testSelector: 'testAssemblies'
+    testAssemblyVer2: |
+      **\UnitTests-GcodeThumbnailProvider.dll
+      **\UnitTests-SvgThumbnailProvider.dll
+      **\UnitTests-PdfThumbnailProvider.dll
+      **\Settings.UI.UnitTests.dll
+      **\UnitTests-MarkdownPreviewHandler.dll
+      **\UnitTests-GcodePreviewHandler.dll
+      **\UnitTests-PdfPreviewHandler.dll
+      **\UnitTests-SvgPreviewHandler.dll
+      **\UnitTests-PreviewHandlerCommon.dll
+      **\PreviewPaneUnitTests.dll
+      **\Microsoft.PowerToys.Run.Plugin.Registry.UnitTests.dll
+      **\UnitTest-ColorPickerUI.dll
+      **\Microsoft.Interop.Tests.dll
+      **\ImageResizer.Test.dll
+      **\Community.PowerToys.Run.Plugin.UnitConverter.UnitTest.dll
+      **\Microsoft.Plugin.Folder.UnitTests.dll
+      **\Microsoft.Plugin.Program.UnitTests.dll
+      **\Microsoft.PowerToys.Run.Plugin.Calculator.UnitTest.dll
+      **\Microsoft.Plugin.Uri.UnitTests.dll
+      **\Wox.Test.dll
+      **\Microsoft.PowerToys.Run.Plugin.System.UnitTests.dll     
+      **\Microsoft.PowerToys.Run.Plugin.WindowsTerminal.UnitTests.dll
+      !**\obj\**
+
+# Native dlls
+- task: VSTest@2
+  displayName: 'Native Tests'
+  inputs:
+    platform: '$(BuildPlatform)'
+    configuration: '$(BuildConfiguration)'
+    testSelector: 'testAssemblies'
+    testAssemblyVer2: |
+      **\KeyboardManagerEngineTest.dll
+      **\KeyboardManagerEditorTest.dll
+      **\UnitTests-CommonLib.dll
+      **\PowerRenameUnitTests.dll
+      **\powerpreviewTest.dll
+      !**\obj\**

.pipelines/loc/loc.yml

@@ -0,0 +1,52 @@
+trigger: none
+pr: none
+schedules:
+  - cron: "0 3 * * 2-6" # Run at 03:00 UTC Tuesday through Saturday (After the work day in Pacific, Mon-Fri)
+    displayName: "Nightly Localization Build"
+    branches:
+      include:
+        - main
+    always: false # only run if there's code changes!
+
+pool:
+  vmImage: windows-2019
+
+resources:
+  repositories:
+  - repository: self
+    type: git
+    ref: master
+
+steps:
+
+- checkout: self
+  clean: true
+  submodules: false
+  fetchDepth: 1 # Don't need a deep checkout for loc files!
+  persistCredentials: true
+
+- task: MicrosoftTDBuild.tdbuild-task.tdbuild-task.TouchdownBuildTask@1
+  displayName: 'Touchdown Build - 37400, PRODEXT'
+  inputs:
+    teamId: 37400
+    authId: '$(TouchdownApplicationID)'
+    authKey: '$(TouchdownApplicationKey)'
+    resourceFilePath: |
+     **\Resources.resx
+     **\Resource.resx
+     **\Resources.resw
+    outputDirectoryRoot: LocOutput
+    appendRelativeDir: true
+    pseudoSetting: Included
+
+# Saving one of these makes it really easy to inspect the loc output...
+- powershell: 'tar czf LocOutput.tar.gz LocOutput'
+  displayName: 'PowerShell Script'
+
+- task: PublishBuildArtifacts@1
+  displayName: 'Publish Artifact: LocOutput'
+  inputs:
+    PathtoPublish: LocOutput.tar.gz
+    ArtifactName: LocOutput
+
+

.pipelines/packages.config

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<packages>
+  <package id="Microsoft.PowerToys.Telemetry" version="2.0"  />
+</packages>

.pipelines/pipeline.user.windows.buddy.yml

@@ -1,21 +0,0 @@
-static_analysis_options:
-  fxcop_options:  
-    disable_tool_scan: false            
-  policheck_options:           
-    fail_on_error: true     
-  moderncop_options:           
-    fail_on_error: true
-    files_to_scan:
-      - from: 'src'          
-        exclude:                           
-        - '**/just.config.js'
-        - '**/webpack.config.js'
-        - '**/webpack.serve.config.js'
-        - '**/dist/bundle.js'               
-  binskim_options:
-    disable_tool_scan: false
-    files_to_scan:
-      - from: 'installer/packages'
-        exclude:
-        - 'WiX.3.11.1/**/*.dll'
-        - 'Wix.3.11.1/**/*.exe'

.pipelines/pipeline.user.windows.yml

@@ -1,81 +0,0 @@
-environment:
-  host:
-    os: 'windows'
-    flavor: 'server'
-    version: '2016'
-  runtime:
-    provider: 'appcontainer'
-    image: 'cdpxwin.azurecr.io/user/powertoys/vs2019:3.0'
-    source_mode: 'map'
-
-version:
-  name: 'PowerToys'
-  major: 1
-  minor: 0
-
-signing_options:
-  profile: 'external_distribution'
-
-package_sources:
-  nuget:
-    feeds:
-      'Nuget': 'https://api.nuget.org/v3/index.json'
-      'PipelineBuildSupplement': 'https://msazure.pkgs.visualstudio.com/_packaging/PipelineBuildSupplement/nuget/v3/index.json'
-
-restore:
-  commands:
-    - !!defaultcommand
-      name: 'Restore Power Toys Telemetry'
-      command: '.pipelines\restore-telemetry.cmd'  
-    - !!defaultcommand
-      name: 'Restore Power Toys'
-      command: '.pipelines\restore.cmd'
-    - !!defaultcommand
-      name: 'Restore Installer'
-      command: '.pipelines\restore-installer.cmd'
-
-
-build:
-  commands:
-    - !!buildcommand
-      name: 'Build Power Toys'
-      command: '.pipelines\build.cmd'
-      artifacts:
-        - from: 'x64/Release'
-          to: 'Build_Output'
-          include:
-          - 'PowerToys.exe'
-          - 'PowerToysSettings.exe'
-          - 'modules\FancyZonesEditor.exe'
-          - 'modules\fancyzones.dll'
-          - 'modules\shortcut_guide.dll'
-          signing_options:
-            sign_inline: true  # This does signing a soon as this command completes
-    - !!buildcommand
-      name: 'Build Power Toys Installer'
-      command: '.pipelines\build-installer.cmd'
-      artifacts:
-        - from: 'installer\PowerToysSetup\x64\Release'
-          to: 'Build_Installer_Output'
-          include:
-            - 'PowerToysSetup.msi'
-          signing_options:
-            sign_inline: true  # This does signing a soon as this command completes
-
-static_analysis_options:                             
-  binskim_options:  
-    files_to_scan:
-      - from: 'installer/packages'
-        exclude:
-        exclude:
-        - 'WiX.3.11.1/**/*.dll'
-        - 'Wix.3.11.1/**/*.exe'
-  moderncop_options:           
-    files_to_scan:
-      - from: 'src'          
-        exclude:                           
-        - '**/just.config.js'
-        - '**/webpack.config.js'
-        - '**/webpack.serve.config.js'
-        - '**/dist/bundle.js' 
-        

.pipelines/release-nuget.config

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+    <packageSources>
+        <clear />
+	<add key="PowerToysCDPX_Feed" value="https://github-private.pkgs.visualstudio.com/microsoft/_packaging/PowerToysCDPX_Feed/nuget/v3/index.json" />
+    </packageSources>
+    <disabledPackageSources>
+        <clear />
+    </disabledPackageSources>
+</configuration>

.pipelines/release.yml

@@ -0,0 +1,317 @@
+# This build should never run as CI or against a pull request.
+trigger: none
+pr: none
+
+pool: 
+  name: WinDevPool-L
+  demands: ImageOverride -equals WinDevVS16-latest
+
+parameters:
+  - name: buildConfigurations
+    type: object
+    default:
+      - Release
+  - name: buildPlatforms
+    type: object
+    default:
+      - x64
+  - name: versionNumber
+    type: string
+    default: '0.0.1'
+
+variables:
+  IsPipeline: 1 # The installer uses this to detect whether it should pick up localizations
+
+name: $(BuildDefinitionName)_$(date:yyMM).$(date:dd)$(rev:rrr)
+resources:
+  repositories:
+  - repository: self
+    type: git
+    ref: main
+jobs:
+- job: Build
+  strategy:
+    matrix:
+      ${{ each config in parameters.buildConfigurations }}:
+        ${{ each platform in parameters.buildPlatforms }}:
+          ${{ config }}_${{ platform }}:
+            BuildConfiguration: ${{ config }}
+            BuildPlatform: ${{ platform }}
+  displayName: Build
+  timeoutInMinutes: 120 # Some of the loc stuff adds quite a bit of time.
+  cancelTimeoutInMinutes: 1
+  steps:
+  - checkout: self
+    clean: true
+    submodules: true
+    persistCredentials: True
+
+# Sets versions for all PowerToy created DLLs
+  - task: PowerShell@1
+    displayName: Set Versions.Prop
+    inputs:
+      scriptName: .pipelines/versionSetting.ps1
+      arguments: -versionNumber '${{ parameters.versionNumber }}' -DevEnvironment ''
+
+  - task: MicrosoftTDBuild.tdbuild-task.tdbuild-task.TouchdownBuildTask@1
+    displayName: 'Download Localization Files -- PowerToys 37400'
+    inputs:
+      teamId: 37400
+      authId: '$(TouchdownApplicationID)'
+      authKey: '$(TouchdownApplicationKey)'
+      resourceFilePath: |
+       **\Resources.resx
+       **\Resource.resx
+       **\Resources.resw
+      appendRelativeDir: true
+      localizationTarget: false
+      pseudoSetting: Included
+  - task: PowerShell@2
+    displayName: Move Loc files into correct locations
+    inputs:
+      targetType: inline
+      script: >-
+        $VerbosePreference = "Continue"
+
+        ./tools/build/move-and-rename-resx.ps1
+
+        ./tools/build/move-uwp-resw.ps1
+      pwsh: true
+  - task: NuGetAuthenticate@0
+    inputs:
+      nuGetServiceConnections: PowerToysCDPxFeed
+  - task: NuGetToolInstaller@1
+    displayName: Use NuGet 5.10
+    inputs:
+      versionSpec: 5.10
+# this will restore the following nugets:
+# - main solution
+# - Bug report tool
+# - Webcam report tool
+# - Installer
+# - Bootstrapper Installer
+  - task: NuGetCommand@2
+    displayName: NuGet restore solutions dependencies
+    inputs:
+      command: restore
+      restoreSolution: '**/*.sln'
+      selectOrConfig: config
+      nugetConfigPath: .pipelines/release-nuget.config
+      
+  - task: CmdLine@2
+    displayName: Moving telem files
+    inputs:
+      script: |
+        call nuget.exe restore -configFile .pipelines/release-nuget.config -PackagesDirectory . .pipelines/packages.config || exit /b 1
+        move /Y "Microsoft.PowerToys.Telemetry.2.0.0\build\include\TraceLoggingDefines.h" "src\common\Telemetry\TraceLoggingDefines.h" || exit /b 1
+        move /Y "Microsoft.PowerToys.Telemetry.2.0.0\build\include\TelemetryBase.cs" "src\common\Telemetry\TelemetryBase.cs" || exit /b 1
+
+## ALL BUT INSTALLER BUILDING
+  - task: VSBuild@1
+    displayName: Build PowerToys main project
+    inputs:
+      solution: '**\PowerToys.sln'
+      vsVersion: 16.0
+      msbuildArgs: /p:CIBuild=true /bl:$(Build.SourcesDirectory)\msbuild.binlog
+      platform: $(BuildPlatform)
+      configuration: $(BuildConfiguration)
+      clean: true
+      maximumCpuCount: true
+
+  - task: VSBuild@1
+    displayName: Build BugReportTool
+    inputs:
+      solution: '**/tools/BugReportTool/BugReportTool.sln'
+      vsVersion: 16.0
+      msbuildArgs: /p:CIBuild=true /bl:$(Build.SourcesDirectory)\msbuild.binlog
+      platform: $(BuildPlatform)
+      configuration: $(BuildConfiguration)
+      clean: true
+      maximumCpuCount: true
+
+  - task: VSBuild@1
+    displayName: Build WebcamReportTool
+    inputs:
+      solution: '**/tools/WebcamReportTool/WebcamReportTool.sln'
+      vsVersion: 16.0
+      msbuildArgs: /p:CIBuild=true /bl:$(Build.SourcesDirectory)\msbuild.binlog
+      platform: $(BuildPlatform)
+      configuration: $(BuildConfiguration)
+      clean: true
+      maximumCpuCount: true
+
+  - task: VSBuild@1
+    displayName: Build PowerToysSetupCustomActions
+    inputs:
+      solution: '**/installer/PowerToysSetup.sln'
+      vsVersion: 16.0
+      msbuildArgs: /target:PowerToysSetupCustomActions /p:CIBuild=true /bl:$(Build.SourcesDirectory)\msbuild.binlog
+      platform: $(BuildPlatform)
+      configuration: $(BuildConfiguration)
+      clean: true
+      maximumCpuCount: true
+
+  - task: VSBuild@1
+    displayName: Publish Settings for Packaging
+    inputs:
+      solution: 'src/settings-ui/PowerToys.Settings/PowerToys.Settings.csproj'
+      vsVersion: 16.0
+      msbuildArgs: >-
+        /target:Publish
+        /p:Configuration=$(BuildConfiguration);Platform=$(BuildPlatform);AppxBundle=Never
+        /p:VCRTForwarders-IncludeDebugCRT=false
+        /p:PowerToysRoot=$(Build.SourcesDirectory)
+        /p:PublishProfile=InstallationPublishProfile.pubxml
+      platform: $(BuildPlatform)
+      configuration: $(BuildConfiguration)
+      maximumCpuCount: true
+
+  - task: VSBuild@1
+    displayName: Publish Launcher for Packaging
+    inputs:
+      solution: 'src/modules/launcher/PowerLauncher/PowerLauncher.csproj'
+      vsVersion: 16.0
+      # The arguments should be the same as the ones for Settings; make sure they are.
+      msbuildArgs: >-
+        /target:Publish
+        /p:Configuration=$(BuildConfiguration);Platform=$(BuildPlatform);AppxBundle=Never
+        /p:VCRTForwarders-IncludeDebugCRT=false
+        /p:PowerToysRoot=$(Build.SourcesDirectory)
+        /p:PublishProfile=InstallationPublishProfile.pubxml
+      platform: $(BuildPlatform)
+      configuration: $(BuildConfiguration)
+      maximumCpuCount: true
+
+#### MAIN SIGNING AREA
+# reference https://dev.azure.com/microsoft/Dart/_git/AppDriver?path=/ESRPSigning.json&version=GBarm64-netcore&_a=contents for winappdriver
+# https://dev.azure.com/microsoft/Dart/_git/AppDriver?path=/CIPolicy.xml&version=GBarm64-netcore&_a=contents
+  - task: SFP.build-tasks.custom-build-task-1.EsrpCodeSigning@1
+    displayName: Sign Core PT
+    inputs:
+      ConnectedServiceName: 'Terminal/Console/WinAppDriver Team Code Signing Connection'
+      FolderPath: '$(BuildPlatform)/$(BuildConfiguration)' # Video conf uses x86 and x64.  This path will also work for PowerToysSetupCustomActions which is in a different root dir
+      signType: batchSigning
+      batchSignPolicyFile: '$(build.sourcesdirectory)\.pipelines\ESRPSigning_core.json'
+      ciPolicyFile: '$(build.sourcesdirectory)\.pipelines\CIPolicy.xml'
+  - task: SFP.build-tasks.custom-build-task-1.EsrpCodeSigning@1
+    displayName: Sign x86 directshow VCM
+    inputs:
+      ConnectedServiceName: 'Terminal/Console/WinAppDriver Team Code Signing Connection'
+      FolderPath: 'x86/$(BuildConfiguration)' # Video conf uses x86 and x64.  This path will also work for PowerToysSetupCustomActions which is in a different root dir
+      signType: batchSigning
+      batchSignPolicyFile: '$(build.sourcesdirectory)\.pipelines\ESRPSigning_vcm.json'
+      ciPolicyFile: '$(build.sourcesdirectory)\.pipelines\CIPolicy.xml'
+#### END SIGNING 
+## END MAIN
+
+## INSTALLER START
+#### MSI BUILDING AND SIGNING
+  - task: VSBuild@1
+    displayName: Build MSI
+    inputs:
+      solution: '**/installer/PowerToysSetup.sln'
+      vsVersion: 16.0
+      msbuildArgs: /p:CIBuild=true /target:PowerToysInstaller /bl:$(Build.SourcesDirectory)\msbuild.binlog
+      platform: $(BuildPlatform)
+      configuration: $(BuildConfiguration)
+      clean: true
+      maximumCpuCount: true
+
+  - task: SFP.build-tasks.custom-build-task-1.EsrpCodeSigning@1
+    displayName: Sign MSI
+    inputs:
+      ConnectedServiceName: 'Terminal/Console/WinAppDriver Team Code Signing Connection'
+      FolderPath: 'installer/PowerToysSetup/$(BuildPlatform)\$(BuildConfiguration)'
+      signType: batchSigning
+      batchSignPolicyFile: '$(build.sourcesdirectory)\.pipelines\ESRPSigning_installer.json'
+      ciPolicyFile: '$(build.sourcesdirectory)\.pipelines\CIPolicy.xml'
+#### END MSI
+
+#### BOOTSTRAP BUILDING AND SIGNING
+  - task: VSBuild@1
+    displayName: Build Bootstrapper
+    inputs:
+      solution: '**/installer/PowerToysSetup.sln'
+      vsVersion: 16.0
+      msbuildArgs: /p:CIBuild=true /bl:$(Build.SourcesDirectory)\msbuild.binlog
+      platform: $(BuildPlatform)
+      configuration: $(BuildConfiguration)
+      clean: true
+      maximumCpuCount: true
+
+  - task: CmdLine@2
+    displayName: 'Insignia: Extract Engine from Bundle'
+    inputs:
+      script: '.\installer\packages\WiX.3.11.2\tools\insignia.exe -ib installer\PowerToysSetup\$(BuildPlatform)\$(BuildConfiguration)\PowerToysSetup-${{ parameters.versionNumber }}-$(BuildPlatform).exe -o installer\engine.exe'
+
+
+  - task: SFP.build-tasks.custom-build-task-1.EsrpCodeSigning@1
+    displayName: 'ESRP CodeSigning (Engine)'
+    inputs:
+      ConnectedServiceName: 'Terminal/Console/WinAppDriver Team Code Signing Connection'
+      FolderPath: 'installer'
+      Pattern: engine.exe
+      signConfigType: inlineSignParams
+      inlineOperation: |
+       [
+           {
+               "KeyCode": "CP-230012",
+               "OperationCode": "SigntoolSign",
+               "Parameters": {
+                   "OpusName": "Microsoft",
+                   "OpusInfo": "http://www.microsoft.com",
+                   "FileDigest": "/fd \"SHA256\"",
+                   "PageHash": "/NPH",
+                   "TimeStamp": "/tr \"http://rfc3161.gtm.corp.microsoft.com/TSS/HttpTspServer\" /td sha256"
+               },
+               "ToolName": "sign",
+               "ToolVersion": "1.0"
+           },
+           {
+               "KeyCode": "CP-230012",
+               "OperationCode": "SigntoolVerify",
+               "Parameters": {},
+               "ToolName": "sign",
+               "ToolVersion": "1.0"
+           }
+       ]
+
+  - task: CmdLine@2
+    displayName: 'Insignia: Merge Engine into Bundle'
+    inputs:
+      script: '.\installer\packages\WiX.3.11.2\tools\insignia.exe -ab installer\engine.exe installer\PowerToysSetup\$(BuildPlatform)\$(BuildConfiguration)\PowerToysSetup-${{ parameters.versionNumber }}-$(BuildPlatform).exe -o installer\PowerToysSetup\$(BuildPlatform)\$(BuildConfiguration)\PowerToysSetup-${{ parameters.versionNumber }}-$(BuildPlatform).exe'
+
+  - task: SFP.build-tasks.custom-build-task-1.EsrpCodeSigning@1
+    displayName: Sign Boostrapper
+    inputs:
+      ConnectedServiceName: 'Terminal/Console/WinAppDriver Team Code Signing Connection'
+      FolderPath: 'installer/PowerToysSetup/$(BuildPlatform)\$(BuildConfiguration)'
+      signType: batchSigning
+      batchSignPolicyFile: '$(build.sourcesdirectory)\.pipelines\ESRPSigning_installer.json'
+      ciPolicyFile: '$(build.sourcesdirectory)\.pipelines\CIPolicy.xml'
+#### END BOOTSTRAP
+## END INSTALLER
+
+  - task: PublishBuildArtifacts@1
+    displayName: 'Publish Artifact: binlog'
+    condition: failed()
+    continueOnError: True
+    inputs:
+      PathtoPublish: $(Build.SourcesDirectory)\msbuild.binlog
+      ArtifactName: binlog-$(BuildPlatform)
+
+  - task: ComponentGovernanceComponentDetection@0
+    displayName: Component Detection
+
+  - task: CopyFiles@2
+    inputs:
+      contents: '**/PowerToysSetup-*.exe'
+      flattenFolders: True
+      targetFolder: $(Build.ArtifactStagingDirectory)
+
+  - task: PublishBuildArtifacts@1
+    displayName: 'Publish Artifact: PowerToySetup'
+    inputs:
+      PathtoPublish: $(System.ArtifactsDirectory)
+      ArtifactName: BuildArtifacts
+...

.pipelines/restore-installer.cmd

@@ -1,3 +0,0 @@
-cd /D "%~dp0"
-
-nuget restore ../installer/PowerToysSetup.sln || exit /b 1

.pipelines/restore-telemetry.cmd

@@ -1,6 +0,0 @@
-cd /D "%~dp0"
-
-set PROJECT="..\src\modules\fancyzones\editor\FancyZonesEditor\FancyZonesEditor.csproj"
-set TELEMETRY_PKG="Microsoft.PowerToys.Telemetry"
-
-dotnet add %PROJECT% package %TELEMETRY_PKG%

.pipelines/restore.cmd

@@ -1,3 +0,0 @@
-cd /D "%~dp0"
-
-nuget restore ../PowerToys.sln || exit /b 1

.pipelines/versionSetting.ps1

@@ -0,0 +1,42 @@
+[CmdletBinding()]
+Param(
+  [Parameter(Mandatory=$True,Position=1)]
+  [string]$versionNumber = "0.0.1",
+
+  [Parameter(Mandatory=$True,Position=2)]
+  [AllowEmptyString()]
+  [string]$DevEnvironment = "Local"
+)
+
+Write-Host $PSScriptRoot
+$versionRegex = "(\d+)\.(\d+)\.(\d+)"
+
+if($versionNumber -match $versionRegEx)
+{
+  #$buildDayOfYear = (Get-Date).DayofYear;
+  #$buildTime = Get-Date -Format HH;
+  #$buildTime = Get-Date -Format HHmmss;
+  #$buildYear = Get-Date -Format yy;
+  #$revision = [string]::Format("{0}{1}{2}", $buildYear, $buildDayOfYear, $buildTime )
+
+  # max UInt16, 65535
+  #$revision = [string]::Format("{0}{1}", $buildDayOfYear, $buildTime )
+  #Write-Host "Revision" $revision
+
+  $versionNumber = [int]::Parse($matches[1]).ToString() + "." + [int]::Parse($matches[2]).ToString() + "." + [int]::Parse($matches[3]).ToString() # + "." + $revision
+  Write-Host "Version Number" $versionNumber
+}
+else
+{
+  throw "Build format does not match the expected pattern (buildName_w.x.y.z)"
+}
+
+$verPropWriteFileLocation = $PSScriptRoot + '/../src/Version.props';
+$verPropReadFileLocation = $verPropWriteFileLocation;
+
+[XML]$verProps = Get-Content $verPropReadFileLocation
+$verProps.Project.PropertyGroup.Version = $versionNumber;
+$verProps.Project.PropertyGroup.DevEnvironment = $DevEnvironment;
+
+Write-Host "xml" $verProps.Project.PropertyGroup.Version 
+$verProps.Save($verPropWriteFileLocation);

.vsconfig

@@ -0,0 +1,15 @@
+{
+  "version": "1.0",
+  "components": [  
+    "Microsoft.VisualStudio.Component.CoreEditor",
+    "Microsoft.VisualStudio.Workload.CoreEditor",
+    "Microsoft.VisualStudio.Workload.NativeDesktop",
+    "Microsoft.VisualStudio.Workload.ManagedDesktop",
+    "Microsoft.VisualStudio.Workload.Universal",
+    "Microsoft.VisualStudio.Component.Windows10SDK.17134",
+    "Microsoft.VisualStudio.Component.Windows10SDK.18362",
+    "Microsoft.VisualStudio.ComponentGroup.UWP.VC",
+    "Microsoft.VisualStudio.Component.VC.Runtimes.x86.x64.Spectre", 
+    "Microsoft.VisualStudio.Component.VC.ATL.Spectre"
+  ]
+} 

CODE_OF_CONDUCT.md

@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns

COMMUNITY.md

@@ -0,0 +1,81 @@
+# Community
+
+The PowerToys team is extremely grateful to have the support of an amazing active community.  The work you do is incredibly important.  PowerToys wouldn’t be near what it is without your help filing bugs, updating documentation, guiding the design, or writing features.  We want to say thanks and to recognize your work.  This is a living document dedicated to highlighting the high impact community members and their contributions.
+
+Names are in alphabetical order based on first name.
+
+## High impact community members
+
+### [@davidegiacometti](https://github.com/davidegiacometti) - [Davide Giacometti](https://www.linkedin.com/in/davidegiacometti/)
+Davide has helped fix multiple bugs, added new features, as well as help us with the ARM64 effort by porting applications to .NET Core.
+
+### [@htcfreek](https://github.com/htcfreek) - Heiko
+Heiko has helped triaging, discussing, and creating a substantial number of issues and contributed features/fixes to PowerToys Run.
+
+### [@jsoref](https://github.com/jsoref) - [Josh Soref](https://check-spelling.dev/)
+Helping keep our spelling correct :)
+
+### [@Niels9001](https://github.com/niels9001/) - [Niels Laute](https://nielslaute.com/)
+
+Niels has helped drive large sums of our update toward a new [consistent and modern UX](https://github.com/microsoft/PowerToys/issues/891). This includes the [launcher work](https://github.com/microsoft/PowerToys/issues/44), color picker UX update and [icon design](https://github.com/microsoft/PowerToys/issues/1118).
+
+### [@riverar](https://github.com/riverar) - [Rafael Rivera](https://withinrafael.com/)
+
+Rafael has helped do the [upgrade from CppWinRT 1.x to 2.0](https://github.com/microsoft/PowerToys/issues/1907).  He directly provided feedback to the CppWinRT team for bugs from this migration as well.
+
+### [@royvou](https://github.com/royvou)
+Roy has helped out contributing multiple features to PowerToys Run
+
+### [@TobiasSekan](https://github.com/TobiasSekan) - Tobias Sekan
+Tobias Sekan has helped out contributing features to PowerToys Run such as Settings plugin, Registry plugin
+
+### [@ThiefZero](https://github.com/ThiefZero)
+ThiefZero has helped out contributing a features to PowerToys Run such as the unit converter plugin
+
+## Open source projects
+
+As PowerToys creates new utilities, some will be based off existing technology. We'll continue to do our best to contribute back to these projects but their efforts were the base of some of our projects. We want to be sure their work is directly recognized.
+
+### [@jjw24](https://github.com/jjw24/) - Jeremy Wu
+
+Their fork of Wox was the base of PowerToys Run.
+
+### [WoX Launcher](https://github.com/Wox-launcher/Wox/)
+
+Initial base of jjw24's fork, which makes it the base of PowerToys Run.
+
+## Microsoft community members
+
+We would like to also directly call out some extremely helpful Microsoft employees that have directly contributed to PowerToys. This isn't their day job and was work they did out of passion. We want to say thank you and recognize your work.
+
+### [@betsegaw](https://github.com/betsegaw/) - [Betsegaw Tadele](http://www.dreamsofameaningfullife.com/)
+
+Window Walker, inside PowerToys Run, is from Beta.  
+
+### [@TheMrJukes](https://github.com/TheMrJukes/) - Bret Anderson
+
+The base of FancyZones and a lot of performance adjustments are from the hard work of Bret.
+
+### [@bricelam](https://github.com/bricelam/) - [Brice Lambson](https://bricelam.net/)
+
+Image Resizer is from Brice.
+
+### [@chrdavis](https://github.com/chrdavis/) - Chris Davis
+
+PowerRename is from Chris's SmartRename and icon rendering for SVGs in File Explorer
+
+### [@dend](https://github.com/dend/) - Den Delimarsky
+
+PowerToys Awake is a tool to keep your computer awake.
+
+### [@martinchrzan](https://github.com/martinchrzan/) - Martin Chrzan
+
+Color Picker is from Martin.
+
+### [@oldnewthing](https://github.com/oldnewthing) - Raymond Chen
+
+Find My Mouse is based on Raymond Chen's SuperSonar.
+
+### Microsoft InVEST team
+
+This amazing team helped PowerToys develop PowerToys Run and Keyboard manager as well as update our Settings to v2.  @alekhyareddy28, @arjunbalgovind, @jyuwono @laviusmotileng-ms, @ryanbodrug-microsoft, @saahmedm, @somil55, @traies, @udit3333

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# PowerToys Contributor's Guide
+
+Below is our guidance for how to report issues, propose new features, and submit contributions via Pull Requests (PRs). Our philosophy is heavily based around understanding the problem and scenarios first, this is why we follow this pattern before work has started.
+
+1. There is an issue
+2. There has been a conversation
+3. There is agreement on the problem, the fit for PowerToys, and the solution to the problem (implementation)
+
+## Filing an issue
+
+Please follow this simple rule to help us eliminate any unnecessary wasted effort & frustration, and ensure an efficient and effective use of everyone's time - yours, ours, and other community members':
+
+> 👉 If you have a question, think you've discovered an issue, would like to propose a new feature, etc., then find/file an issue **BEFORE** starting work to fix/implement it.
+
+When requesting new features / enhancements, understanding problem and scenario around it is extremely important. Having additional evidence, data, tweets, blog posts, research, ... anything is extremely helpful.  This information provides context to the scenario that may otherwise be lost.
+
+* Don't know whether you're reporting an issue or requesting a feature? File an issue
+* Have a question that you don't see answered in docs, videos, etc.? File an issue
+* Want to know if we're planning on building a particular feature? File an issue
+* Got a great idea for a new utility or feature? File an issue/request/idea
+* Don't understand how to do something? File an issue/Community Guidance Request
+* Found an existing issue that describes yours? Great - upvote and add additional commentary / info / repro-steps / etc.
+
+A quick search before filing an issue also could be helpful. It is likely someone else has found the problem you're seeing, and someone may be working on or have already contributed a fix!
+
+### How to tell the PowerToys team this is an interesting thing to focus on
+
+Upvote the original issue by clicking its [+😊] button and hitting 👍 (+1) icon or a different one. This way allows us to measure how impactful different issues are compared to others. The issue with comments like "+1", "me too", or similar is they actually make it harder to have a conversation and harder to quickly determine trending important requests.
+
+---
+
+## Contributing fixes / features
+
+Please comment on an issue to let us know you're interested in working on something before you start the work. Not only does this avoid multiple people unexpectedly working on the same thing at the same time but it enables us to make sure everyone is clear on what should be done to implement any new functionality. It's less work for everyone, in the long run, to establish this up front.
+
+### To Spec or not to Spec
+
+A key point is for everyone to understand the approach that will be taken. We want to be sure if anyone does work, we will accept it in. Items that are larger in scope we'll want some type of spec to understand what is being planned and have a discussion. Specs help collaborators discuss different approaches to solve a problem, describe how the feature will behave, how the feature will impact the user, what happens if something goes wrong, etc. Driving towards agreement in a spec, before any code is written, often results in simpler code, and less wasted effort in the long run.
+
+For such scenarios, once a team member has agreed with your approach, skip ahead to the section headed "Development" section below.
+
+Team members will be happy to help review specs and guide them to completion.
+
+### Help Wanted
+
+Once the team has approved an issue/spec approach to solving, development can proceed. If no developers are immediately available, the spec can be parked ready for a developer to get started. Parked specs' issues will be labeled "Help Wanted". To find a list of development opportunities waiting for developer involvement, visit the Issues and filter on [the Help-Wanted label](https://github.com/microsoft/PowerToys/labels/Help%20Wanted).
+
+---
+
+## Development
+
+Follow the [development guidelines](https://github.com/microsoft/PowerToys/blob/main/doc/devdocs/readme.md).
+
+### Naming of features and functionality
+
+Naming should be descriptive and straight forward.  We want names to be clear about functionality and usefulness moving forward. 
+
+### How can I become a collaborator on the PowerToys team
+
+Be a great community member. Just help out a lot and make useful additions, filing bugs/suggestions, help develop fixes and features, code reviews, and always, docs. Lets continue to make the PowerToys repository a great spot to learn and make a great set of utilities.
+
+When the time comes, Microsoft will reach out and help make you a formal team member. Just make sure they can reach out to you :)
+
+---
+
+## Thank you
+
+Thank you in advance for your contribution! 

Cpp.Build.props

@@ -0,0 +1,100 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0"
+  xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+  <!-- Project configurations -->
+  <ItemGroup Label="ProjectConfigurations">
+    <ProjectConfiguration Include="Debug|x64">
+      <Configuration>Debug</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|x64">
+      <Configuration>Release</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+  </ItemGroup>
+
+  <!-- Props that should be disabled while building on CI server -->
+  <ItemDefinitionGroup Condition="'$(CIBuild)'!='true'">
+    <ClCompile>
+      <MultiProcessorCompilation>true</MultiProcessorCompilation>
+      <PrecompiledHeader>Use</PrecompiledHeader>
+    </ClCompile>
+  </ItemDefinitionGroup>
+
+  <!-- C++ source compile-specific things for all configurations -->
+  <PropertyGroup>
+    <ExternalIncludePath>$(MSBuildThisFileFullPath)\..\deps\;$(ExternalIncludePath)</ExternalIncludePath>
+  </PropertyGroup>
+  <ItemDefinitionGroup>
+    <ClCompile>
+      <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
+      <WarningLevel>Level3</WarningLevel>
+      <DisableAnalyzeExternal >true</DisableAnalyzeExternal>
+      <ExternalWarningLevel>TurnOffAllWarnings</ExternalWarningLevel>
+      <ConformanceMode>false</ConformanceMode>
+      <TreatWarningAsError>true</TreatWarningAsError>
+      <LanguageStandard>stdcpplatest</LanguageStandard>
+      <AdditionalOptions>/await %(AdditionalOptions)</AdditionalOptions>
+      <PreprocessorDefinitions>_UNICODE;UNICODE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+    </Link>
+    <Lib>
+      <TreatLibWarningAsErrors>true</TreatLibWarningAsErrors>
+    </Lib>
+  </ItemDefinitionGroup>
+
+  <!-- C++ source compile-specific things for Debug/Release configurations -->
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <ClCompile>
+      <PreprocessorDefinitions>_DEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <Optimization>Disabled</Optimization>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <ClCompile>
+      <PreprocessorDefinitions>NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <Optimization>MaxSpeed</Optimization>
+      <SDLCheck>false</SDLCheck>
+      <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+    </ClCompile>
+    <Link>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+    </Link>
+  </ItemDefinitionGroup>
+
+  <!-- Global props -->
+  <PropertyGroup Label="Globals" Condition="'$(OverrideWindowsTargetPlatformVersion)'!='True'">
+    <WindowsTargetPlatformVersion>10.0.18362.0</WindowsTargetPlatformVersion>
+  </PropertyGroup>
+
+  <!-- Props that are constant for both Debug and Release configurations -->
+  <PropertyGroup Label="Configuration">
+    <PlatformToolset Condition="'$(OverridePlatformToolset)'!='True'">v142</PlatformToolset>
+    <IntDir>$(SolutionDir)$(Platform)\$(Configuration)\obj\$(ProjectName)\</IntDir>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+
+  <!-- Debug/Release props -->
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <LinkIncremental>true</LinkIncremental>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <LinkIncremental>false</LinkIncremental>
+  </PropertyGroup>
+
+</Project>

Directory.Build.props

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+  <PropertyGroup>
+    <_PropertySheetDisplayName>PowerToys.Root.Props</_PropertySheetDisplayName>
+    <ForceImportBeforeCppProps>$(MsbuildThisFileDirectory)\Cpp.Build.props</ForceImportBeforeCppProps>
+  </PropertyGroup>
+</Project>

LICENSE

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+The MIT License
 
 Copyright (c) Microsoft Corporation. All rights reserved.
 

NOTICE.md

@@ -0,0 +1,240 @@
+# NOTICES AND INFORMATION
+This software incorporates material from third parties.
+
+## PowerToy: Color Picker
+
+### Martin Chrzan's Color Picker
+
+**Source**: https://github.com/martinchrzan/ColorPicker
+
+MIT License
+
+Copyright (c) 2020 martinchrzan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## PowerToy: ImageResizer
+
+### Brice Lams's Image Resizer License
+
+**Source**: https://github.com/bricelam/ImageResizer/
+
+The MIT License (MIT)
+
+Copyright (c) Brice Lambson. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+## PowerToy: Launcher
+
+### Wox License
+
+**Fork project source**: https://github.com/jjw24/Wox/
+**Base project source**: https://github.com/Wox-launcher/Wox
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Wox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+###  Beta Tadele's Window Walker License
+
+**Source**: https://github.com/betsegaw/windowwalker
+
+The MIT License (MIT)
+
+Copyright 2020 Betsegaw Tadele
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## PowerToy: PowerRename
+
+### Chris Davis's SmartRename License
+
+**Source**: https://github.com/chrdavis/SmartRename
+
+MIT License
+
+Copyright (c) 2017 Chris Davis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## PowerToy: Installer/Runner
+
+### spdlog
+**Source**: https://github.com/gabime/spdlog
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Gabi Melman.                                       
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+-- NOTE: Third party dependency used by this software --
+This software depends on the fmt lib (MIT License),
+and users must comply to its license: https://github.com/fmtlib/fmt/blob/master/LICENSE.rst
+
+
+### cxxopts
+**Source**: https://github.com/jarro2783
+
+Copyright (c) 2014 Jarryd Beck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+### expected-lite
+**Source**: https://github.com/martinmoene/expected-lite
+
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+### zip
+**Source**: https://github.com/kuba--/zip
+
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>
+

README.md

@@ -1,136 +1,194 @@
-# Overview
+# Microsoft PowerToys
 
-PowerToys is a set of utilities for power users to tune and streamline their Windows experience for greater productivity.  
+![Hero image for Microsoft PowerToys](doc/images/overview/PT_hero_image.png)
 
-Inspired by the [Windows 95 era PowerToys project](https://en.wikipedia.org/wiki/Microsoft_PowerToys), this reboot provides power users with ways to squeeze more efficiency out of the Windows 10 shell and customize it for individual workflows.  A great overview of the Windows 95 PowerToys can be found [here](https://socket3.wordpress.com/2016/10/22/using-windows-95-powertoys/).
+[How to use PowerToys][usingPowerToys-docs-link] | [Downloads & Release notes][github-release-link] | [Contributing to PowerToys](#contributing) | [What's Happening](#whats-happening) | [Roadmap](#powertoys-roadmap)
 
-![logo](doc/images/Logo.jpg)
+## Build status
 
-## Installation
+| Architecture | Solution (Main) | Solution (Stable) | Installer (Main)<br/>Existing pipeline | Installer (Main)<br/>New pipeline |
+|--------------|-----------------|-------------------|-----------------------|-------------------------------|
+| x64 | [![Build Status for Main](https://dev.azure.com/ms/PowerToys/_apis/build/status/microsoft.PowerToys?branchName=main)](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=main) | [![Build Status for Stable](https://dev.azure.com/ms/PowerToys/_apis/build/status/microsoft.PowerToys?branchName=stable)](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=stable) | [![Build Status for Installer](https://github-private.visualstudio.com/microsoft/_apis/build/status/CDPX/powertoys/powertoys-Windows-Official-master-Test?branchName=main)](https://github-private.visualstudio.com/microsoft/_build/latest?definitionId=61&branchName=main) | [![Build Status for New Installer pipeline](https://dev.azure.com/microsoft/Dart/_apis/build/status/microsoft.PowerToys?branchName=main)](https://dev.azure.com/microsoft/Dart/_build/latest?definitionId=76541&branchName=main) |
+| ARM64 | Currently investigating | [Issue #490](https://github.com/microsoft/PowerToys/issues/490) |  |  |
 
-_(Note: in order to run PowerToys, you'll need to be running at least Windows build 17134 or higher.  Also, PowerToys does not currently support Windows ARM machines)_
+## About
 
-### GitHub
+Microsoft PowerToys is a set of utilities for power users to tune and streamline their Windows experience for greater productivity. For more info on [PowerToys overviews and how to use the utilities][usingPowerToys-docs-link], or any other tools and resources for [Windows development environments](https://docs.microsoft.com/windows/dev-environment/overview), head over to [docs.microsoft.com][usingPowerToys-docs-link]! 
 
-The first preview of these utilities can be installed from the [PowerToys GitHub releases page](https://github.com/Microsoft/powertoys/releases).
+|              | Current utilities: |              |
+|--------------|--------------------|--------------|
+| [PowerToys Awake](https://aka.ms/PowerToysOverview_Awake) | [Color Picker](https://aka.ms/PowerToysOverview_ColorPicker) | [FancyZones](https://aka.ms/PowerToysOverview_FancyZones) |
+| [File Explorer Add-ons](https://aka.ms/PowerToysOverview_FileExplorerAddOns) | [Image Resizer](https://aka.ms/PowerToysOverview_ImageResizer) | [Keyboard Manager](https://aka.ms/PowerToysOverview_KeyboardManager) | 
+| [Mouse utilities](https://aka.ms/PowerToysOverview_MouseUtilities) | [PowerRename](https://aka.ms/PowerToysOverview_PowerRename) | [PowerToys Run](https://aka.ms/PowerToysOverview_PowerToysRun) | 
+| [Shortcut Guide](https://aka.ms/PowerToysOverview_ShortcutGuide) | [Video Conference Mute](https://aka.ms/PowerToysOverview_VideoConference) |  |
 
-### Chocolatey (Unofficial)
+## Installing and running Microsoft PowerToys
 
-Download and upgrade PowerToys from [Chocolatey](https://chocolatey.org).
+### Requirements
+
+- Windows 11 or Windows 10 v1903 (18362) or newer.
+- [.NET Core 3.1.20 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-desktop-3.1.20-windows-x64-installer) or a newer 3.1.x runtime. The installer will handle this if not present.
+
+### Via GitHub with EXE [Recommended]
+
+ [Microsoft PowerToys GitHub releases page][github-release-link], click on `Assets` at the bottom to show the files available in the release and then click on `PowerToysSetup-0.51.1-x64.exe` to download the PowerToys installer.
+
+This is our preferred method.
+
+### Via Microsoft Store
+
+Install from the [Microsoft Store's PowerToys page][microsoft-store-link]. You must be using the [new Microsoft Store](https://blogs.windows.com/windowsExperience/2021/06/24/building-a-new-open-microsoft-store-on-windows-11/) which will be available for both Windows 11 and Windows 10.
+
+### Via WinGet (Preview)
+Download PowerToys from [WinGet][winget-link]. To install PowerToys, run the following command from the command line / PowerShell:
 
-To install PowerToys, run the following command from the command line or from PowerShell:
 ```powershell
-choco install powertoys
+winget install Microsoft.PowerToys -s winget
 ```
 
-To upgrade PowerToys, run the following command from the command line or from PowerShell:
-```powershell
-choco upgrade powertoys
-```
+### Other install methods
 
-If you have any issues when installing/upgrading the package please go to the [package page](https://chocolatey.org/packages/powertoys) and follow the [Chocolatey triage process](https://chocolatey.org/docs/package-triage-process)
+There are [community driven install methods](./doc/unofficialInstallMethods.md) such as Chocolatey and Scoop.  If these are your preferred install solutions, this will have the install instructions.
 
-### Build Status
+## Contributing
 
-[![Build Status](https://dev.azure.com/ms/PowerToys/_apis/build/status/microsoft.PowerToys?branchName=master)](https://dev.azure.com/ms/PowerToys/_build?definitionId=35096)
+This project welcomes contributions of all types. Help spec'ing, design, documentation, finding bugs are ways everyone can help on top of coding features / bug fixes. We are excited to work with the power user community to build a set of tools for helping you get the most out of Windows.
 
-# What's Happening
+We ask that **before you start work on a feature that you would like to contribute**, please read our [Contributor's Guide](CONTRIBUTING.md). We will be happy to work with you to figure out the best approach, provide guidance and mentorship throughout feature development, and help avoid any wasted or duplicate effort.
 
-## October Update
-A big thanks to everyone who has downloaded and started using the first PowerToys preview.  There's been over 150K downloads so far.  An even bigger thanks to everyone who has provided feedback and suggestions in the issues.  The community engagement has been really awesome to see.  
+Most contributions require you to agree to a [Contributor License Agreement (CLA)][oss-CLA] declaring that you have the right to, and actually do, grant us the rights to use your contribution.
 
-The team has been hard at working fixing bugs, addressing issues and implementing feature suggestions.  If you've downloaded the code and built the latest on your machine recently you've seen many of these improvements (dark mode!).  We're hoping to have a new official build out shortly with all these improvements and will also be signed by Microsoft.  A new utility is also coming soon: Chris Davis is working to integrate his [SmartRename tool](https://github.com/chrdavis/SmartRename) into PowerToys!
+For guidance on developing for PowerToys, please read the [developer docs](/doc/devdocs) for a detailed breakdown. This includes how to setup your computer to compile.
 
-![SmartRename](https://github.com/chrdavis/SmartRename/raw/master/Images/SmartRenameDemo.gif)
+## What's Happening
 
-1. [FancyZones](/src/modules/fancyzones/) - FancyZones is a window manager that makes it easy to create complex window layouts and quickly position windows into those layouts.  The FancyZones backlog can be found [here](https://github.com/Microsoft/PowerToys/tree/master/doc/planning/FancyZonesBacklog.md)
+### PowerToys Roadmap
 
-![FancyZones](src/modules/fancyzones/FancyZones.png)
+Our [prioritized roadmap][roadmap] of features and utilities that the core team is focusing on.
 
-FancyZones Video Tutorial
-[![FancyZones Video Tutorial](doc/images/FZTutorial.jpg)](https://www.youtube.com/watch?v=rTtGzZYAXgY)
+### 0.51 - November 2021 Update
 
-2. [Windows key shortcut guide](/src/modules/shortcut_guide) - The shortcut guide appears when a user holds the Windows key down for more than one second and shows the available shortcuts for the current state of the desktop.  The shortcut guide backlog can be found [here](https://github.com/Microsoft/PowerToys/tree/master/doc/planning/ShortcutGuideBacklog.md)
+The [v0.51 release cycle][github-current-release-work] introduces some new things regarding our mouse utilities. First is we've added in a presentation mode helper to highlight your mouse when you click. We've also added additional settings toward Find my mouse to enable more customization.
 
-![Windows key shortcut guide](doc/images/WindowsKeyShortcutGuide.jpg)
+Next we've been focusing work on "Always on Top" system to help make any window you want to be the top most. A lot of thought is currently going into interaction models to make sure it 'feels' right for toggling as well as visualizing.
 
-Additional utilities in the pipeline are:
+Last, we've been working on our engineering systems this month and into next. This work will improve our localization integration and our 'build farm' match our CI system far more. Behind the scene work but very important work for working faster. 
 
-* Maximize to new desktop widget - The MTND widget shows a pop-up button when a user hovers over the maximize / restore button on any window.  Clicking it creates a new desktop, sends the app to that desktop and maximizes the app on the new desktop.
-* [Process terminate tool](https://github.com/indierawk2k2/PowerToys-1/blob/master/specs/Terminate%20Spec.md)
-* [Animated gif screen recorder](https://github.com/indierawk2k2/PowerToys-1/blob/master/specs/GIF%20Maker%20Spec.md)
+#### Highlights from v0.51
 
-# Backlog
+**Things to note**
+- We shifted our localization internal service and are working on adding automated integrations back in. 
 
-The full backlog of utilities can be found [here](https://github.com/Microsoft/PowerToys/tree/master/doc/planning/PowerToysBacklog.md)
+**PowerToys Awake**
+- System tray and settings use same language for turning things on.
 
-# Where to download PowerToys
+**Color Picker**
+- New formats added to copy colors as a float or decimal value.
+- Adjust color window now accepts lower-case HEX codes.
 
-  The latest release of PowerToys can be downloaded from https://github.com/microsoft/PowerToys/releases <br />
-  Click on `Assets` to show the files available in the release and then click on `PowerToysSetup.msi` to download the PowerToys installer. <br />
-  PDB symbols for the release are available in a separate zip file `PDB symbols.zip`.
+**FancyZones**
+- New window switching functionality! Now users can assign multiple windows to a zone and cycle between them using the <kbd>Win</kbd> + <kbd>PgDn/PgUp</kbd> commands by default. Thanks [@FLOAT4](https://github.com/FLOAT4)!
+- Added functionality for zones to adopt system accent color and theme. Thanks [@davidegiacometti](https://github.com/davidegiacometti)!
+- Added visual preview of zone appearance in settings menu. Thanks [@niels9001](https://github.com/niels9001)!
+- Fixed bug where FancyZones crashes on launch.
 
-# Developer Guidance
+**Image Resizer**
+- Fixed bug where resizing images creates empty folders.
+- Added option to remove non-essential metadata. Helps significantly reduce the size of files. Thanks [@CleanCodeDeveloper](https://github.com/CleanCodeDeveloper)!
+- Fixed bug caused by Image Resizer receiving an unexpected property type or value. Thanks [@CleanCodeDeveloper](https://github.com/CleanCodeDeveloper)!
 
-## Build Prerequisites
- * Windows 10 1803 (build 10.0.17134.0) or above to build and run PowerToys.
- * Visual Studio 2019 Community edition or higher, with the 'Desktop Development with C++' component and the Windows 10 SDK version 10.0.18362.0 or higher.
- 
-## Building the Code
- * Open `powertoys.sln` in Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` or `Debug`, from the `Build` menu choose `Build Solution`.
- * The PowerToys binaries will be in your repo under `x64\Release`.
- * If you want to copy the `PowerToys.exe` binary to a different location, you'll also need to copy the `modules` and the `svgs` folders.
+**Mouse utilities**
+- Find My Mouse: Improved functionality to activate when user double click time configuration is set above 100ms.
+- Find My Mouse: Fixed display on all virtual desktops as opposed to only the virtual desktop where it was created.
+- Find My Mouse: New settings to enable a lot more customization based on your feedback.
+- Minor UI tweaks for fluent icons, appearance, <kbd>Ctrl</kbd> usage, and utility descriptions. Thanks [@niels9001](https://github.com/niels9001)!
+- New Mouse Highlighter PowerToy! When enabled, activate mouse highlighting with <kbd>Win</kbd> + <kbd>Shift</kbd> + <kbd>H</kbd> by default to begin displaying visual cues on your display when either the left or right mouse buttons are clicked. There is a much more powerful tool called [SysInternal ZoomIt](https://docs.microsoft.com/en-us/sysinternals/downloads/zoomit) that is very helpful as well.
 
-## Prerequisites to Build the Installer
- * Install the [WiX Toolset Visual Studio 2019 Extension](https://marketplace.visualstudio.com/items?itemName=RobMensching.WiXToolset).
- * Install the [WiX Toolset build tools](https://wixtoolset.org/releases/).
- 
-## Building the .msi Installer
-  * From the `installer` folder open `PowerToysSetup.sln` in Visual Studio, in the `Solutions Configuration` drop-down menu select `Release` or `Debug`, from the `Build` menu choose `Build Solution`.
-  * The resulting `PowerToysSetup.msi` installer will be available in the `installer\PowerToysSetup\x64\Release\` folder.
+![highlighter turned on while dragging mouse](https://user-images.githubusercontent.com/9866362/142475413-77b00bae-bd28-42ae-a6c8-0dc4356e8525.gif)
 
-## Debugging
-  The following configuration issue only applies if the user is a member of the Administrators group.
-  
-  Some PowerToys modules require being run with the highest permission level if the current user is a member of the Administrators group. The highest permission level is required to be able to perform some actions when an elevated application (e.g. Task Manager) is in the foreground or is the target of an action. Without elevated privileges some PowerToys modules will still work but with some limitations:
- - the `FancyZones` module will be not be able to move an elevated window to a zone.
- - the `Shortcut Guide` module will not appear if the foreground window belongs to an elevated application.
- 
- To run and debug PowerToys from Visual Studio when the user is a member of the Administrators group, Visual Studio has to be started with elevated privileges. If you want to avoid running Visual Studio with elevated privileges and don't mind the limitations described above, you can do the following: open the `runner` project properties and navigate to the `Linker -> Manifest File` settings, edit the `UAC Execution Level` property and change it from `highestAvailable (/level='highestAvailable')` to `asInvoker (/level='asInvoker')`, save the changes.
- 
-## How to create new PowerToys
+**PowerRename**
+- Improved rename performance! This is now at parity (or better) with the prior version based on multiple tests.
+- Added keyboard accelerators with <kbd>Enter</kbd> and <kbd>Ctrl</kbd> + <kbd>Enter</kbd> to execute rename. Thanks [@niels9001](https://github.com/niels9001)!
+- UI tweaks to now add number of items selected, grid-lines for improved readability, reduced font sizes & margins, and improved window resizing.
+- Fixed UI focus issues. Thanks [@niels9001](https://github.com/niels9001)!
+- Added default window width and height. Thanks [@niels9001](https://github.com/niels9001)!
+- Added PowerRename event logging for BugReportTool
 
-See the instructions on [how to install the PowerToys Module project template](tools/project_template). <br />
-Specifications for the [PowerToys settings API](doc/specs/PowerToys-settings.md).
+**PowerToys Run**
+- New entries added for settings plugin. Thanks [@htcfreek](https://github.com/htcfreek)! 
+- Added support for application URI handling like `mailto:` and  `ms-settings:`. Thanks [@franky920920](https://github.com/franky920920)!
+- Added DevContainer workspaces to search results of the VSCode Workspaces Plugin. Thanks [@JacobDeuchert](https://github.com/JacobDeuchert)!
+- Fixes for crashing issues.
 
-## Coding Guidance
+**Shortcut Guide**
+- Added rounded corners to keys and tooltips, and system accent colors for desktop backdrop. Thanks [@niels9001](https://github.com/niels9001)!
 
-Please review these brief docs below relating to our coding standards etc.
+**Settings**
+- Fixed default settings window size to prevent it from opening offscreen. Thanks [@davidegiacometti](https://github.com/davidegiacometti)!
 
-> 👉 If you find something missing from these docs, feel free to contribute to any of our documentation files anywhere in the repository (or make some new ones\!)
+**Video Conference Mute**
+- Minor UI tweaks for icon, clear button, and overlay image selection [#14248](https://github.com/microsoft/PowerToys/issues/14248). Thanks [@niels9001](https://github.com/niels9001)!
 
-This is a work in progress as we learn what we'll need to provide people in order to be effective contributors to our project.
-- [Coding Style](doc/coding/style.md)
-- [Code Organization](doc/coding/organization.md)
+**Prototype work**
+- Always on top prototype of being actively worked on.  Right now you hit a key-combo and it enables it.  We are investigating ways to highlight the window in some form as well.
 
-# Contributing
-This project welcomes contributions and suggestions and we are excited to work with the power user community to build a set of tools for helping you get the most out of Windows.
+**Installer**
+- Investigated how to fully shift to WIX bootstrapper and remove custom boot strapper
+- Investigated how to fully shift to HKCU vs HKLM.
 
-We ask that **before you start work on a feature that you would like to contribute**, please read our [Contributor's Guide](contributing.md). We will be happy to work with you to figure out the best approach, provide guidance and mentorship throughout feature development, and help avoid any wasted or duplicate effort.
+**Random helping out**
+- Spell check fix - Thanks [@franky920920](https://github.com/franky920920)!
+- Fix a URL - Thanks [@JeffersonQin](https://github.com/JeffersonQin)!
 
-> ⚠ **Note**: PowerToys is still a nascent project and the team is actively working out of this repository.  We will be periodically re-structuring the code to make it easier to comprehend, navigate, build, test, and contribute to, so **DO expect significant changes to code layout on a regular basis**.
+**Development relevant**
+- Focusing on cleaning up backlog of issues and developing a method to aid in prioritizing. [@Dend](https://github.com/dend) and [@crutkas](https://github.com/crutkas) are partnering to see if we can develop one signal to see what we are calling ['centers of gravity'](https://gravity-issues.netlify.app/).
+- Our primary dev branch is now named `Main`.
+- Adjusting plugin folder structure for PT Run [#10796](https://github.com/microsoft/PowerToys/issues/10796)
+- Working on shifting our release pipeline onto same system that Windows Terminal uses.
+- Improvements to environment variable usage/update process in PT Run. Thanks [@htcfreek](https://github.com/htcfreek)!
+- Update .NET to 3.1.20.
+- Centralized process list in the BugReportTool.
+- Registry handling improvement for MSI and File Explorer add-ons.
 
-> ⚠ **License Info**: Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+**Community contributions**
 
-When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g. status check, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
+We'd like to directly mention certain contributors (in alphabetical order) for their continued community support this month and helping directly make PowerToys a better piece of software. 
 
-# Code of Conduct
+[@AnonymousWP](https://github.com/AnonymousWP), [@Aaron-Junker](https://github.com/Aaron-Junker), [@CleanCodeDeveloper](https://github.com/CleanCodeDeveloper), [@davidegiacometti](https://github.com/davidegiacometti), [@FLOAT4](https://github.com/FLOAT4), [@franky920920](https://github.com/franky920920), [@htcfreek](https://github.com/htcfreek), [@JacobDeuchert](https://github.com/JacobDeuchert), [@Jay-o-Way](https://github.com/jay-o-way) [@JeffersonQin](https://github.com/JeffersonQin), [@niels9001](https://github.com/niels9001), and [@rdeveen](https://github.com/rdeveen). 
 
-This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code]. <br />
-For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments.
+#### What is being planned for v0.53
 
-[conduct-code]: https://opensource.microsoft.com/codeofconduct/ 
-[conduct-FAQ]: https://opensource.microsoft.com/codeofconduct/faq/
-[conduct-email]: mailto:opencode@microsoft.com
+For [v0.53][github-next-release-work], due to holidays, we'll be in a maintenance sprint but here are some of the larger items:
+
+- Hope to add Always on Top into PowerToys. We currently have a proof of concept ready.
+- We are working to heavily reduce / remove the UAC prompt over the next few releases on install. This is a big shift so it is spanning multiple releases so we can isolate issues if they do occur. Work is tracked in [#10126](https://github.com/microsoft/PowerToys/issues/10126)
+- Update the PowerToys Build Pipeline to allow .NET 6 integration
+- Engineering Systems/Stability/Bug fixes
+
+## PowerToys Community
+
+The PowerToys team is extremely grateful to have the [support of an amazing active community][community-link]. The work you do is incredibly important. PowerToys wouldn’t be nearly what it is today without your help filing bugs, updating documentation, guiding the design, or writing features. We want to say thank you and take time to recognize your work.
+
+## Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct][oss-conduct-code].
+
+## Privacy Statement
+
+The application logs basic telemetry. Our Telemetry Data page (Coming Soon) has the trends from the telemetry. Please read the [Microsoft privacy statement][privacy-link] for more information.
+
+[oss-CLA]: https://cla.opensource.microsoft.com
+[oss-conduct-code]: CODE_OF_CONDUCT.md
+[community-link]: COMMUNITY.md
+[github-release-link]: https://aka.ms/installPowerToys
+[microsoft-store-link]: https://aka.ms/getPowertoys
+[winget-link]: https://github.com/microsoft/winget-cli#installing-the-client
+[roadmap]: https://github.com/microsoft/PowerToys/wiki/Roadmap
+[privacy-link]: http://go.microsoft.com/fwlink/?LinkId=521839
+[vidConfOverview]: https://aka.ms/PowerToysOverview_VideoConference
+[loc-bug]: https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=&template=translation_issue.md&title=
+[usingPowerToys-docs-link]: https://aka.ms/powertoys-docs
+
+<!-- items that need to be updated release to release -->
+[github-next-release-work]: https://github.com/microsoft/PowerToys/issues?q=is%3Aopen+is%3Aissue+project%3Amicrosoft%2FPowerToys%2F27
+[github-current-release-work]: https://github.com/microsoft/PowerToys/issues?q=is%3Aopen+is%3Aissue+project%3Amicrosoft%2FPowerToys%2F26

SECURITY.md

@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.2 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)) of a security vulnerability, please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

SUPPORT.md

@@ -0,0 +1,24 @@
+# Support
+
+
+## How to use Microsoft PowerToys 
+
+For more info on [PowerToys overviews and how to use the utilities][usingPowerToys-docs-link], or any other tools and resources for [Windows development environments](https://docs.microsoft.com/windows/dev-environment/overview), head over to [docs.microsoft.com][usingPowerToys-docs-link]! 
+
+## How to file issues and get help  
+
+This project uses [GitHub Issues][gh-issue] to [track bugs][gh-bug] and [feature requests][gh-feature]. Please search the existing issues before filing new issues to avoid duplicates.  For new issues, file your bug or 
+feature request as a new Issue.
+
+For help and questions about using this project, please look at our Wiki for using PowerToys and our [Contributor's Guide][contributor] if you want to work on PowerToys.
+
+## Microsoft Support Policy  
+
+Support for PowerToys is limited to the resources listed above.
+
+[gh-issue]: https://github.com/microsoft/PowerToys/issues/new/choose
+[gh-bug]: https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=Issue-Bug&template=bug_report.md&title=
+[gh-feature]: https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=&template=feature_request.md&title=
+[wiki]: https://github.com/microsoft/PowerToys/wiki
+[contributor]: https://github.com/microsoft/PowerToys/blob/main/CONTRIBUTING.md
+[usingPowerToys-docs-link]: https://aka.ms/powertoys-docs

Solution.props

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <GeneratedFilesDir>$(IntDir)Generated Files\</GeneratedFilesDir>
+  </PropertyGroup>
+</Project>

contributing.md

@@ -1,128 +0,0 @@
-# Power Toys Contributor's Guide
-
-Below is our guidance for how to report issues, propose new features, and submit contributions via Pull Requests (PRs).
-
-## Before you start, file an issue
-
-Please follow this simple rule to help us eliminate any unnecessary wasted effort & frustration, and ensure an efficient and effective use of everyone's time - yours, ours, and other community members':
-
-> 👉 If you have a question, think you've discovered an issue, would like to propose a new feature, etc., then find/file an issue **BEFORE** starting work to fix/implement it.
-
-### Search existing issues first
-
-Before filing a new issue, search existing open and closed issues first: It is likely someone else has found the problem you're seeing, and someone may be working on or have already contributed a fix!
-
-If no existing item describes your issue/feature, great - please file a new issue:
-
-### File a new Issue
-
-* Don't know whether you're reporting an issue or requesting a feature? File an issue
-* Have a question that you don't see answered in docs, videos, etc.? File an issue
-* Want to know if we're planning on building a particular feature? File an issue
-* Got a great idea for a new utility or feature? File an issue/request/idea
-* Don't understand how to do something? File an issue/Community Guidance Request
-* Found an existing issue that describes yours? Great - upvote and add additional commentary / info / repro-steps / etc.
-
-### Complete the template
-
-**Please include as much information as possible in your issue**. The more information you provide, the more likely your issue/ask will be understood and implemented. Helpful information includes:
-
-* What device you're running (inc. CPU type, memory, disk, etc.)
-* What build of Windows your device is running
-
-  👉 Tip: Run the following in PowerShell Core
-
-  ```powershell
-  C:\> $PSVersionTable.OS
-  Microsoft Windows 10.0.18909
-  ```
-
-  ... or in Windows PowerShell
-
-  ```powershell
-  C:\> $PSVersionTable.BuildVersion
-
-  Major  Minor  Build  Revision
-  -----  -----  -----  --------
-  10     0      18912  1001
-  ```
-
-  ... or Cmd:
-
-  ```cmd
-  C:\> ver
-
-  Microsoft Windows [Version 10.0.18900.1001]
-  ```
-
-* What tools and apps you're using (e.g. VS 2019, VSCode, etc.)
-* Don't assume we're experts in setting up YOUR environment and don't assume we are experts in YOUR workflow. Teach us to help you!
-* **We LOVE detailed repro steps!** What steps do we need to take to reproduce the issue? Assume we love to read repro steps. As much detail as you can stand is probably _barely_ enough detail for us!
-* Prefer error message text where possible or screenshots of errors if text cannot be captured
-* **If you intend to implement the fix/feature yourself then say so!** If you do not indicate otherwise we will assume that the issue is our to solve, or may label the issue as `Help-Wanted`.
-
-### DO NOT post "+1" comments
-
-> ⚠ DO NOT post "+1", "me too", or similar comments - they just add noise to an issue.
-
-If you don't have any additional info/context to add but would like to indicate that you're affected by the issue, upvote the original issue by clicking its [+😊] button and hitting 👍 (+1) icon. This way we can actually measure how impactful an issue is.
-
----
-
-## Contributing fixes / features
-
-For those able & willing to help fix issues and/or implement features ...
-
-### To Spec or not to Spec
-
-Some issues/features may be quick and simple to describe and understand. For such scenarios, once a team member has agreed with your approach, skip ahead to the section headed "Fork, Branch, and Create your PR", below.
-
-Small issues that do not require a spec will be labelled Issue-Bug or Issue-Task.
-
-However, some issues/features will require careful thought & formal design before implementation. For these scenarios, we'll request that a spec is written and the associated issue will be labeled Issue-Feature.
-
-Specs help collaborators discuss different approaches to solve a problem, describe how the feature will behave, how the feature will impact the user, what happens if something goes wrong, etc. Driving towards agreement in a spec, before any code is written, often results in simpler code, and less wasted effort in the long run.
-
-Specs will be managed in a very similar manner as code contributions so please follow the "Fork, Branch and Create your PR" below.
-
-### Writing / Contributing-to a Spec
-
-To write/contribute to a spec: fork, branch and commit via PRs, as you would with any code changes.
-
-Specs are written in markdown, stored under the `doc/specs` folder and named `[issue id] - [spec description].md`.
-
-👉 **It is important to follow the spec templates and complete the requested information**. The available spec templates will help ensure that specs contain the minimum information & decisions necessary to permit development to begin. In particular, specs require you to confirm that you've already discussed the issue/idea with the team in an issue and that you provide the issue ID for reference.
-
-Team members will be happy to help review specs and guide them to completion.
-
-### Help Wanted
-
-Once the team have approved an issue/spec, development can proceed. If no developers are immediately available, the spec can be parked ready for a developer to get started. Parked specs' issues will be labeled "Help Wanted". To find a list of development opportunities waiting for developer involvement, visit the Issues and filter on [the Help-Wanted label](https://github.com/microsoft/PowerToys/labels/Help-Wanted).
-
----
-
-## Development
-
-### Fork, Clone, Branch and Create your PR
-
-Once you've discussed your proposed feature/fix/etc. with a team member, and you've agreed an approach or a spec has been written and approved, it's time to start development:
-
-1. Fork the repo if you haven't already
-1. Clone your fork locally
-1. Create & push a feature branch
-1. Create a [Draft Pull Request (PR)](https://github.blog/2019-02-14-introducing-draft-pull-requests/)
-1. Work on your changes
-
-### Code Review
-
-When you'd like the team to take a look, (even if the work is not yet fully-complete), mark the PR as 'Ready For Review' so that the team can review your work and provide comments, suggestions, and request changes. It may take several cycles, but the end result will be solid, testable, conformant code that is safe for us to merge.
-
-### Merge
-
-Once your code has been reviewed and approved by the requisite number of team members, it will be merged into the master branch. Once merged, your PR will be automatically closed.
-
----
-
-## Thank you
-
-Thank you in advance for your contribution! 

deps/cpprestsdk/README.md

@@ -1,12 +0,0 @@
-# C++ Rest SDK - JSON library
-
-This JSON library is taken from the C++ REST SDK in https://github.com/microsoft/cpprestsdk
-
-Based in the [v2.10.13 release](https://github.com/microsoft/cpprestsdk/tree/v2.10.13/Release), it consists of the needed files to build and use the JSON classes described in `include/cpprest/json.h`.
-
-Changes made to the files in order to build in the PowerToys project:
-- Removal of `#include` references to files that are not needed.
-- `#include "pch.h"` instead of `#include "stdafx.h"` to use the PowerToys pre-compiled header.
-- `#define _NO_ASYNCRTIMP` in [`include/cpprest/details/cpprest_compat.h`](./include/cpprest/details/cpprest_compat.h) since this class will be statically linked.
-
-The contents of the C++ Rest SDK license are included in [license.txt](./license.txt).

deps/cpprestsdk/include/cpprest/asyncrt_utils.h

@@ -1,697 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * Various common utilities.
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-
-#pragma once
-
-#include "cpprest/details/basic_types.h"
-//#include "pplx/pplxtasks.h"
-#include <chrono>
-#include <cstdint>
-#include <limits.h>
-#include <locale.h>
-#include <random>
-#include <string>
-#include <system_error>
-#include <vector>
-
-#ifndef _WIN32
-#include <sys/time.h>
-#if !defined(ANDROID) && !defined(__ANDROID__) && defined(HAVE_XLOCALE_H) // CodePlex 269
-/* Systems using glibc: xlocale.h has been removed from glibc 2.26
-   The above include of locale.h is sufficient
-   Further details: https://sourceware.org/git/?p=glibc.git;a=commit;h=f0be25b6336db7492e47d2e8e72eb8af53b5506d */
-#include <xlocale.h>
-#endif
-#endif
-
-/// Various utilities for string conversions and date and time manipulation.
-namespace utility
-{
-// Left over from VS2010 support, remains to avoid breaking.
-typedef std::chrono::seconds seconds;
-
-/// Functions for converting to/from std::chrono::seconds to xml string.
-namespace timespan
-{
-/// <summary>
-/// Converts a timespan/interval in seconds to xml duration string as specified by
-/// http://www.w3.org/TR/xmlschema-2/#duration
-/// </summary>
-_ASYNCRTIMP utility::string_t __cdecl seconds_to_xml_duration(utility::seconds numSecs);
-
-/// <summary>
-/// Converts an xml duration to timespan/interval in seconds
-/// http://www.w3.org/TR/xmlschema-2/#duration
-/// </summary>
-_ASYNCRTIMP utility::seconds __cdecl xml_duration_to_seconds(const utility::string_t& timespanString);
-} // namespace timespan
-
-/// Functions for Unicode string conversions.
-namespace conversions
-{
-/// <summary>
-/// Converts a UTF-16 string to a UTF-8 string.
-/// </summary>
-/// <param name="w">A two byte character UTF-16 string.</param>
-/// <returns>A single byte character UTF-8 string.</returns>
-_ASYNCRTIMP std::string __cdecl utf16_to_utf8(const utf16string& w);
-
-/// <summary>
-/// Converts a UTF-8 string to a UTF-16
-/// </summary>
-/// <param name="s">A single byte character UTF-8 string.</param>
-/// <returns>A two byte character UTF-16 string.</returns>
-_ASYNCRTIMP utf16string __cdecl utf8_to_utf16(const std::string& s);
-
-/// <summary>
-/// Converts a ASCII (us-ascii) string to a UTF-16 string.
-/// </summary>
-/// <param name="s">A single byte character us-ascii string.</param>
-/// <returns>A two byte character UTF-16 string.</returns>
-_ASYNCRTIMP utf16string __cdecl usascii_to_utf16(const std::string& s);
-
-/// <summary>
-/// Converts a Latin1 (iso-8859-1) string to a UTF-16 string.
-/// </summary>
-/// <param name="s">A single byte character UTF-8 string.</param>
-/// <returns>A two byte character UTF-16 string.</returns>
-_ASYNCRTIMP utf16string __cdecl latin1_to_utf16(const std::string& s);
-
-/// <summary>
-/// Converts a Latin1 (iso-8859-1) string to a UTF-8 string.
-/// </summary>
-/// <param name="s">A single byte character UTF-8 string.</param>
-/// <returns>A single byte character UTF-8 string.</returns>
-_ASYNCRTIMP utf8string __cdecl latin1_to_utf8(const std::string& s);
-
-/// <summary>
-/// Converts to a platform dependent Unicode string type.
-/// </summary>
-/// <param name="s">A single byte character UTF-8 string.</param>
-/// <returns>A platform dependent string type.</returns>
-#ifdef _UTF16_STRINGS
-_ASYNCRTIMP utility::string_t __cdecl to_string_t(std::string&& s);
-#else
-inline utility::string_t&& to_string_t(std::string&& s) { return std::move(s); }
-#endif
-
-/// <summary>
-/// Converts to a platform dependent Unicode string type.
-/// </summary>
-/// <param name="s">A two byte character UTF-16 string.</param>
-/// <returns>A platform dependent string type.</returns>
-#ifdef _UTF16_STRINGS
-inline utility::string_t&& to_string_t(utf16string&& s) { return std::move(s); }
-#else
-_ASYNCRTIMP utility::string_t __cdecl to_string_t(utf16string&& s);
-#endif
-/// <summary>
-/// Converts to a platform dependent Unicode string type.
-/// </summary>
-/// <param name="s">A single byte character UTF-8 string.</param>
-/// <returns>A platform dependent string type.</returns>
-#ifdef _UTF16_STRINGS
-_ASYNCRTIMP utility::string_t __cdecl to_string_t(const std::string& s);
-#else
-inline const utility::string_t& to_string_t(const std::string& s) { return s; }
-#endif
-
-/// <summary>
-/// Converts to a platform dependent Unicode string type.
-/// </summary>
-/// <param name="s">A two byte character UTF-16 string.</param>
-/// <returns>A platform dependent string type.</returns>
-#ifdef _UTF16_STRINGS
-inline const utility::string_t& to_string_t(const utf16string& s) { return s; }
-#else
-_ASYNCRTIMP utility::string_t __cdecl to_string_t(const utf16string& s);
-#endif
-
-/// <summary>
-/// Converts to a UTF-16 from string.
-/// </summary>
-/// <param name="value">A single byte character UTF-8 string.</param>
-/// <returns>A two byte character UTF-16 string.</returns>
-_ASYNCRTIMP utf16string __cdecl to_utf16string(const std::string& value);
-
-/// <summary>
-/// Converts to a UTF-16 from string.
-/// </summary>
-/// <param name="value">A two byte character UTF-16 string.</param>
-/// <returns>A two byte character UTF-16 string.</returns>
-inline const utf16string& to_utf16string(const utf16string& value) { return value; }
-/// <summary>
-/// Converts to a UTF-16 from string.
-/// </summary>
-/// <param name="value">A two byte character UTF-16 string.</param>
-/// <returns>A two byte character UTF-16 string.</returns>
-inline utf16string&& to_utf16string(utf16string&& value) { return std::move(value); }
-
-/// <summary>
-/// Converts to a UTF-8 string.
-/// </summary>
-/// <param name="value">A single byte character UTF-8 string.</param>
-/// <returns>A single byte character UTF-8 string.</returns>
-inline std::string&& to_utf8string(std::string&& value) { return std::move(value); }
-
-/// <summary>
-/// Converts to a UTF-8 string.
-/// </summary>
-/// <param name="value">A single byte character UTF-8 string.</param>
-/// <returns>A single byte character UTF-8 string.</returns>
-inline const std::string& to_utf8string(const std::string& value) { return value; }
-
-/// <summary>
-/// Converts to a UTF-8 string.
-/// </summary>
-/// <param name="value">A two byte character UTF-16 string.</param>
-/// <returns>A single byte character UTF-8 string.</returns>
-_ASYNCRTIMP std::string __cdecl to_utf8string(const utf16string& value);
-
-/// <summary>
-/// Encode the given byte array into a base64 string
-/// </summary>
-_ASYNCRTIMP utility::string_t __cdecl to_base64(const std::vector<unsigned char>& data);
-
-/// <summary>
-/// Encode the given 8-byte integer into a base64 string
-/// </summary>
-_ASYNCRTIMP utility::string_t __cdecl to_base64(uint64_t data);
-
-/// <summary>
-/// Decode the given base64 string to a byte array
-/// </summary>
-_ASYNCRTIMP std::vector<unsigned char> __cdecl from_base64(const utility::string_t& str);
-
-template<typename Source>
-CASABLANCA_DEPRECATED("All locale-sensitive APIs will be removed in a future update. Use stringstreams directly if "
-                      "locale support is required.")
-utility::string_t print_string(const Source& val, const std::locale& loc = std::locale())
-{
-    utility::ostringstream_t oss;
-    oss.imbue(loc);
-    oss << val;
-    if (oss.bad())
-    {
-        throw std::bad_cast();
-    }
-    return oss.str();
-}
-
-CASABLANCA_DEPRECATED("All locale-sensitive APIs will be removed in a future update. Use stringstreams directly if "
-                      "locale support is required.")
-inline utility::string_t print_string(const utility::string_t& val) { return val; }
-
-namespace details
-{
-#if defined(__ANDROID__)
-template<class T>
-inline std::string to_string(const T t)
-{
-    std::ostringstream os;
-    os.imbue(std::locale::classic());
-    os << t;
-    return os.str();
-}
-#endif
-
-template<class T>
-inline utility::string_t to_string_t(const T t)
-{
-#ifdef _UTF16_STRINGS
-    using std::to_wstring;
-    return to_wstring(t);
-#else
-#if !defined(__ANDROID__)
-    using std::to_string;
-#endif
-    return to_string(t);
-#endif
-}
-
-template<typename Source>
-utility::string_t print_string(const Source& val)
-{
-    utility::ostringstream_t oss;
-    oss.imbue(std::locale::classic());
-    oss << val;
-    if (oss.bad())
-    {
-        throw std::bad_cast();
-    }
-    return oss.str();
-}
-
-inline const utility::string_t& print_string(const utility::string_t& val) { return val; }
-
-template<typename Source>
-utf8string print_utf8string(const Source& val)
-{
-    return conversions::to_utf8string(print_string(val));
-}
-inline const utf8string& print_utf8string(const utf8string& val) { return val; }
-
-template<typename Target>
-Target scan_string(const utility::string_t& str)
-{
-    Target t;
-    utility::istringstream_t iss(str);
-    iss.imbue(std::locale::classic());
-    iss >> t;
-    if (iss.bad())
-    {
-        throw std::bad_cast();
-    }
-    return t;
-}
-
-inline const utility::string_t& scan_string(const utility::string_t& str) { return str; }
-} // namespace details
-
-template<typename Target>
-CASABLANCA_DEPRECATED("All locale-sensitive APIs will be removed in a future update. Use stringstreams directly if "
-                      "locale support is required.")
-Target scan_string(const utility::string_t& str, const std::locale& loc = std::locale())
-{
-    Target t;
-    utility::istringstream_t iss(str);
-    iss.imbue(loc);
-    iss >> t;
-    if (iss.bad())
-    {
-        throw std::bad_cast();
-    }
-    return t;
-}
-
-CASABLANCA_DEPRECATED("All locale-sensitive APIs will be removed in a future update. Use stringstreams directly if "
-                      "locale support is required.")
-inline utility::string_t scan_string(const utility::string_t& str) { return str; }
-} // namespace conversions
-
-namespace details
-{
-/// <summary>
-/// Cross platform RAII container for setting thread local locale.
-/// </summary>
-class scoped_c_thread_locale
-{
-public:
-    _ASYNCRTIMP scoped_c_thread_locale();
-    _ASYNCRTIMP ~scoped_c_thread_locale();
-
-#if !defined(ANDROID) && !defined(__ANDROID__) // CodePlex 269
-#ifdef _WIN32
-    typedef _locale_t xplat_locale;
-#else
-    typedef locale_t xplat_locale;
-#endif
-
-    static _ASYNCRTIMP xplat_locale __cdecl c_locale();
-#endif
-private:
-#ifdef _WIN32
-    std::string m_prevLocale;
-    int m_prevThreadSetting;
-#elif !(defined(ANDROID) || defined(__ANDROID__))
-    locale_t m_prevLocale;
-#endif
-    scoped_c_thread_locale(const scoped_c_thread_locale&);
-    scoped_c_thread_locale& operator=(const scoped_c_thread_locale&);
-};
-
-/// <summary>
-/// Our own implementation of alpha numeric instead of std::isalnum to avoid
-/// taking global lock for performance reasons.
-/// </summary>
-inline bool __cdecl is_alnum(const unsigned char uch) CPPREST_NOEXCEPT
-{ // test if uch is an alnum character
-    // special casing char to avoid branches
-    // clang-format off
-    static CPPREST_CONSTEXPR bool is_alnum_table[UCHAR_MAX + 1] = {
-        /*        X0 X1 X2 X3 X4 X5 X6 X7 X8 X9 XA XB XC XD XE XF */
-        /* 0X */   0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-        /* 1X */   0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-        /* 2X */   0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-        /* 3X */   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 0-9 */
-        /* 4X */   0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* A-Z */
-        /* 5X */   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0,
-        /* 6X */   0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* a-z */
-        /* 7X */   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0
-        /* non-ASCII values initialized to 0 */
-    };
-    // clang-format on
-    return (is_alnum_table[uch]);
-}
-
-/// <summary>
-/// Our own implementation of alpha numeric instead of std::isalnum to avoid
-/// taking global lock for performance reasons.
-/// </summary>
-inline bool __cdecl is_alnum(const char ch) CPPREST_NOEXCEPT { return (is_alnum(static_cast<unsigned char>(ch))); }
-
-/// <summary>
-/// Our own implementation of alpha numeric instead of std::isalnum to avoid
-/// taking global lock for performance reasons.
-/// </summary>
-template<class Elem>
-inline bool __cdecl is_alnum(Elem ch) CPPREST_NOEXCEPT
-{
-    // assumes 'x' == L'x' for the ASCII range
-    typedef typename std::make_unsigned<Elem>::type UElem;
-    const auto uch = static_cast<UElem>(ch);
-    return (uch <= static_cast<UElem>('z') && is_alnum(static_cast<unsigned char>(uch)));
-}
-
-/// <summary>
-/// Simplistic implementation of make_unique. A better implementation would be based on variadic templates
-/// and therefore not be compatible with Dev10.
-/// </summary>
-template<typename _Type>
-std::unique_ptr<_Type> make_unique()
-{
-    return std::unique_ptr<_Type>(new _Type());
-}
-
-template<typename _Type, typename _Arg1>
-std::unique_ptr<_Type> make_unique(_Arg1&& arg1)
-{
-    return std::unique_ptr<_Type>(new _Type(std::forward<_Arg1>(arg1)));
-}
-
-template<typename _Type, typename _Arg1, typename _Arg2>
-std::unique_ptr<_Type> make_unique(_Arg1&& arg1, _Arg2&& arg2)
-{
-    return std::unique_ptr<_Type>(new _Type(std::forward<_Arg1>(arg1), std::forward<_Arg2>(arg2)));
-}
-
-template<typename _Type, typename _Arg1, typename _Arg2, typename _Arg3>
-std::unique_ptr<_Type> make_unique(_Arg1&& arg1, _Arg2&& arg2, _Arg3&& arg3)
-{
-    return std::unique_ptr<_Type>(
-        new _Type(std::forward<_Arg1>(arg1), std::forward<_Arg2>(arg2), std::forward<_Arg3>(arg3)));
-}
-
-template<typename _Type, typename _Arg1, typename _Arg2, typename _Arg3, typename _Arg4>
-std::unique_ptr<_Type> make_unique(_Arg1&& arg1, _Arg2&& arg2, _Arg3&& arg3, _Arg4&& arg4)
-{
-    return std::unique_ptr<_Type>(new _Type(
-        std::forward<_Arg1>(arg1), std::forward<_Arg2>(arg2), std::forward<_Arg3>(arg3), std::forward<_Arg4>(arg4)));
-}
-
-template<typename _Type, typename _Arg1, typename _Arg2, typename _Arg3, typename _Arg4, typename _Arg5>
-std::unique_ptr<_Type> make_unique(_Arg1&& arg1, _Arg2&& arg2, _Arg3&& arg3, _Arg4&& arg4, _Arg5&& arg5)
-{
-    return std::unique_ptr<_Type>(new _Type(std::forward<_Arg1>(arg1),
-                                            std::forward<_Arg2>(arg2),
-                                            std::forward<_Arg3>(arg3),
-                                            std::forward<_Arg4>(arg4),
-                                            std::forward<_Arg5>(arg5)));
-}
-
-template<typename _Type, typename _Arg1, typename _Arg2, typename _Arg3, typename _Arg4, typename _Arg5, typename _Arg6>
-std::unique_ptr<_Type> make_unique(_Arg1&& arg1, _Arg2&& arg2, _Arg3&& arg3, _Arg4&& arg4, _Arg5&& arg5, _Arg6&& arg6)
-{
-    return std::unique_ptr<_Type>(new _Type(std::forward<_Arg1>(arg1),
-                                            std::forward<_Arg2>(arg2),
-                                            std::forward<_Arg3>(arg3),
-                                            std::forward<_Arg4>(arg4),
-                                            std::forward<_Arg5>(arg5),
-                                            std::forward<_Arg6>(arg6)));
-}
-
-/// <summary>
-/// Cross platform utility function for performing case insensitive string equality comparison.
-/// </summary>
-/// <param name="left">First string to compare.</param>
-/// <param name="right">Second strong to compare.</param>
-/// <returns>true if the strings are equivalent, false otherwise</returns>
-_ASYNCRTIMP bool __cdecl str_iequal(const std::string& left, const std::string& right) CPPREST_NOEXCEPT;
-
-/// <summary>
-/// Cross platform utility function for performing case insensitive string equality comparison.
-/// </summary>
-/// <param name="left">First string to compare.</param>
-/// <param name="right">Second strong to compare.</param>
-/// <returns>true if the strings are equivalent, false otherwise</returns>
-_ASYNCRTIMP bool __cdecl str_iequal(const std::wstring& left, const std::wstring& right) CPPREST_NOEXCEPT;
-
-/// <summary>
-/// Cross platform utility function for performing case insensitive string less-than comparison.
-/// </summary>
-/// <param name="left">First string to compare.</param>
-/// <param name="right">Second strong to compare.</param>
-/// <returns>true if a lowercase view of left is lexicographically less than a lowercase view of right; otherwise,
-/// false.</returns>
-_ASYNCRTIMP bool __cdecl str_iless(const std::string& left, const std::string& right) CPPREST_NOEXCEPT;
-
-/// <summary>
-/// Cross platform utility function for performing case insensitive string less-than comparison.
-/// </summary>
-/// <param name="left">First string to compare.</param>
-/// <param name="right">Second strong to compare.</param>
-/// <returns>true if a lowercase view of left is lexicographically less than a lowercase view of right; otherwise,
-/// false.</returns>
-_ASYNCRTIMP bool __cdecl str_iless(const std::wstring& left, const std::wstring& right) CPPREST_NOEXCEPT;
-
-/// <summary>
-/// Convert a string to lowercase in place.
-/// </summary>
-/// <param name="target">The string to convert to lowercase.</param>
-_ASYNCRTIMP void __cdecl inplace_tolower(std::string& target) CPPREST_NOEXCEPT;
-
-/// <summary>
-/// Convert a string to lowercase in place.
-/// </summary>
-/// <param name="target">The string to convert to lowercase.</param>
-_ASYNCRTIMP void __cdecl inplace_tolower(std::wstring& target) CPPREST_NOEXCEPT;
-
-#ifdef _WIN32
-
-/// <summary>
-/// Category error type for Windows OS errors.
-/// </summary>
-class windows_category_impl : public std::error_category
-{
-public:
-    virtual const char* name() const CPPREST_NOEXCEPT { return "windows"; }
-
-    virtual std::string message(int errorCode) const CPPREST_NOEXCEPT;
-
-    virtual std::error_condition default_error_condition(int errorCode) const CPPREST_NOEXCEPT;
-};
-
-/// <summary>
-/// Gets the one global instance of the windows error category.
-/// </summary>
-/// </returns>An error category instance.</returns>
-_ASYNCRTIMP const std::error_category& __cdecl windows_category();
-
-#else
-
-/// <summary>
-/// Gets the one global instance of the linux error category.
-/// </summary>
-/// </returns>An error category instance.</returns>
-_ASYNCRTIMP const std::error_category& __cdecl linux_category();
-
-#endif
-
-/// <summary>
-/// Gets the one global instance of the current platform's error category.
-/// </summary>
-_ASYNCRTIMP const std::error_category& __cdecl platform_category();
-
-/// <summary>
-/// Creates an instance of std::system_error from a OS error code.
-/// </summary>
-inline std::system_error __cdecl create_system_error(unsigned long errorCode)
-{
-    std::error_code code((int)errorCode, platform_category());
-    return std::system_error(code, code.message());
-}
-
-/// <summary>
-/// Creates a std::error_code from a OS error code.
-/// </summary>
-inline std::error_code __cdecl create_error_code(unsigned long errorCode)
-{
-    return std::error_code((int)errorCode, platform_category());
-}
-
-/// <summary>
-/// Creates the corresponding error message from a OS error code.
-/// </summary>
-inline utility::string_t __cdecl create_error_message(unsigned long errorCode)
-{
-    return utility::conversions::to_string_t(create_error_code(errorCode).message());
-}
-
-} // namespace details
-
-class datetime
-{
-public:
-    typedef uint64_t interval_type;
-
-    /// <summary>
-    /// Defines the supported date and time string formats.
-    /// </summary>
-    enum date_format
-    {
-        RFC_1123,
-        ISO_8601
-    };
-
-    /// <summary>
-    /// Returns the current UTC time.
-    /// </summary>
-    static _ASYNCRTIMP datetime __cdecl utc_now();
-
-    /// <summary>
-    /// An invalid UTC timestamp value.
-    /// </summary>
-    enum : interval_type
-    {
-        utc_timestamp_invalid = static_cast<interval_type>(-1)
-    };
-
-    /// <summary>
-    /// Returns seconds since Unix/POSIX time epoch at 01-01-1970 00:00:00.
-    /// If time is before epoch, utc_timestamp_invalid is returned.
-    /// </summary>
-    static interval_type utc_timestamp()
-    {
-        const auto seconds = utc_now().to_interval() / _secondTicks;
-        if (seconds >= 11644473600LL)
-        {
-            return seconds - 11644473600LL;
-        }
-        else
-        {
-            return utc_timestamp_invalid;
-        }
-    }
-
-    datetime() : m_interval(0) {}
-
-    /// <summary>
-    /// Creates <c>datetime</c> from a string representing time in UTC in RFC 1123 format.
-    /// </summary>
-    /// <returns>Returns a <c>datetime</c> of zero if not successful.</returns>
-    static _ASYNCRTIMP datetime __cdecl from_string(const utility::string_t& timestring, date_format format = RFC_1123);
-
-    /// <summary>
-    /// Returns a string representation of the <c>datetime</c>.
-    /// </summary>
-    _ASYNCRTIMP utility::string_t to_string(date_format format = RFC_1123) const;
-
-    /// <summary>
-    /// Returns the integral time value.
-    /// </summary>
-    interval_type to_interval() const { return m_interval; }
-
-    datetime operator-(interval_type value) const { return datetime(m_interval - value); }
-
-    datetime operator+(interval_type value) const { return datetime(m_interval + value); }
-
-    bool operator==(datetime dt) const { return m_interval == dt.m_interval; }
-
-    bool operator!=(const datetime& dt) const { return !(*this == dt); }
-
-    static interval_type from_milliseconds(unsigned int milliseconds) { return milliseconds * _msTicks; }
-
-    static interval_type from_seconds(unsigned int seconds) { return seconds * _secondTicks; }
-
-    static interval_type from_minutes(unsigned int minutes) { return minutes * _minuteTicks; }
-
-    static interval_type from_hours(unsigned int hours) { return hours * _hourTicks; }
-
-    static interval_type from_days(unsigned int days) { return days * _dayTicks; }
-
-    bool is_initialized() const { return m_interval != 0; }
-
-private:
-    friend int operator-(datetime t1, datetime t2);
-
-    static const interval_type _msTicks = static_cast<interval_type>(10000);
-    static const interval_type _secondTicks = 1000 * _msTicks;
-    static const interval_type _minuteTicks = 60 * _secondTicks;
-    static const interval_type _hourTicks = 60 * 60 * _secondTicks;
-    static const interval_type _dayTicks = 24 * 60 * 60 * _secondTicks;
-
-    // Private constructor. Use static methods to create an instance.
-    datetime(interval_type interval) : m_interval(interval) {}
-
-    // Storing as hundreds of nanoseconds 10e-7, i.e. 1 here equals 100ns.
-    interval_type m_interval;
-};
-
-inline int operator-(datetime t1, datetime t2)
-{
-    auto diff = (t1.m_interval - t2.m_interval);
-
-    // Round it down to seconds
-    diff /= 10 * 1000 * 1000;
-
-    return static_cast<int>(diff);
-}
-
-/// <summary>
-/// Nonce string generator class.
-/// </summary>
-class nonce_generator
-{
-public:
-    /// <summary>
-    /// Define default nonce length.
-    /// </summary>
-    enum
-    {
-        default_length = 32
-    };
-
-    /// <summary>
-    /// Nonce generator constructor.
-    /// </summary>
-    /// <param name="length">Length of the generated nonce string.</param>
-    nonce_generator(int length = default_length)
-        : m_random(static_cast<unsigned int>(utility::datetime::utc_timestamp())), m_length(length)
-    {
-    }
-
-    /// <summary>
-    /// Generate a nonce string containing random alphanumeric characters (A-Za-z0-9).
-    /// Length of the generated string is set by length().
-    /// </summary>
-    /// <returns>The generated nonce string.</returns>
-    _ASYNCRTIMP utility::string_t generate();
-
-    /// <summary>
-    /// Get length of generated nonce string.
-    /// </summary>
-    /// <returns>Nonce string length.</returns>
-    int length() const { return m_length; }
-
-    /// <summary>
-    /// Set length of the generated nonce string.
-    /// </summary>
-    /// <param name="length">Lenght of nonce string.</param>
-    void set_length(int length) { m_length = length; }
-
-private:
-    std::mt19937 m_random;
-    int m_length;
-};
-
-} // namespace utility

deps/cpprestsdk/include/cpprest/base_uri.h

@@ -1,391 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * Protocol independent support for URIs.
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-
-#pragma once
-
-#include "cpprest/asyncrt_utils.h"
-#include "cpprest/details/basic_types.h"
-#include <map>
-#include <string>
-#include <utility>
-#include <vector>
-
-namespace web
-{
-namespace details
-{
-struct uri_components
-{
-    uri_components() : m_path(_XPLATSTR("/")), m_port(-1) {}
-
-    uri_components(const uri_components&) = default;
-    uri_components& operator=(const uri_components&) = default;
-
-    // This is for VS2013 compatibility -- replace with '= default' when VS2013 is completely dropped.
-    uri_components(uri_components&& other) CPPREST_NOEXCEPT : m_scheme(std::move(other.m_scheme)),
-                                                              m_host(std::move(other.m_host)),
-                                                              m_user_info(std::move(other.m_user_info)),
-                                                              m_path(std::move(other.m_path)),
-                                                              m_query(std::move(other.m_query)),
-                                                              m_fragment(std::move(other.m_fragment)),
-                                                              m_port(other.m_port)
-    {
-    }
-
-    // This is for VS2013 compatibility -- replace with '= default' when VS2013 is completely dropped.
-    uri_components& operator=(uri_components&& other) CPPREST_NOEXCEPT
-    {
-        if (this != &other)
-        {
-            m_scheme = std::move(other.m_scheme);
-            m_host = std::move(other.m_host);
-            m_user_info = std::move(other.m_user_info);
-            m_path = std::move(other.m_path);
-            m_query = std::move(other.m_query);
-            m_fragment = std::move(other.m_fragment);
-            m_port = other.m_port;
-        }
-        return *this;
-    }
-
-    _ASYNCRTIMP utility::string_t join();
-
-    utility::string_t m_scheme;
-    utility::string_t m_host;
-    utility::string_t m_user_info;
-    utility::string_t m_path;
-    utility::string_t m_query;
-    utility::string_t m_fragment;
-    int m_port;
-};
-} // namespace details
-
-/// <summary>
-/// A single exception type to represent errors in parsing, encoding, and decoding URIs.
-/// </summary>
-class uri_exception : public std::exception
-{
-public:
-    uri_exception(std::string msg) : m_msg(std::move(msg)) {}
-
-    ~uri_exception() CPPREST_NOEXCEPT {}
-
-    const char* what() const CPPREST_NOEXCEPT { return m_msg.c_str(); }
-
-private:
-    std::string m_msg;
-};
-
-/// <summary>
-/// A flexible, protocol independent URI implementation.
-///
-/// URI instances are immutable. Querying the various fields on an empty URI will return empty strings. Querying
-/// various diagnostic members on an empty URI will return false.
-/// </summary>
-/// <remarks>
-/// This implementation accepts both URIs ('http://msn.com/path') and URI relative-references
-/// ('/path?query#frag').
-///
-/// This implementation does not provide any scheme-specific handling -- an example of this
-/// would be the following: 'http://path1/path'. This is a valid URI, but it's not a valid
-/// http-uri -- that is, it's syntactically correct but does not conform to the requirements
-/// of the http scheme (http requires a host).
-/// We could provide this by allowing a pluggable 'scheme' policy-class, which would provide
-/// extra capability for validating and canonicalizing a URI according to scheme, and would
-/// introduce a layer of type-safety for URIs of differing schemes, and thus differing semantics.
-///
-/// One issue with implementing a scheme-independent URI facility is that of comparing for equality.
-/// For instance, these URIs are considered equal 'http://msn.com', 'http://msn.com:80'. That is --
-/// the 'default' port can be either omitted or explicit. Since we don't have a way to map a scheme
-/// to it's default port, we don't have a way to know these are equal. This is just one of a class of
-/// issues with regard to scheme-specific behavior.
-/// </remarks>
-class uri
-{
-public:
-    /// <summary>
-    /// The various components of a URI. This enum is used to indicate which
-    /// URI component is being encoded to the encode_uri_component. This allows
-    /// specific encoding to be performed.
-    ///
-    /// Scheme and port don't allow '%' so they don't need to be encoded.
-    /// </summary>
-    class components
-    {
-    public:
-        enum component
-        {
-            user_info,
-            host,
-            path,
-            query,
-            fragment,
-            full_uri
-        };
-    };
-
-    /// <summary>
-    /// Encodes a URI component according to RFC 3986.
-    /// Note if a full URI is specified instead of an individual URI component all
-    /// characters not in the unreserved set are escaped.
-    /// </summary>
-    /// <param name="raw">The URI as a string.</param>
-    /// <returns>The encoded string.</returns>
-    _ASYNCRTIMP static utility::string_t __cdecl encode_uri(const utility::string_t& raw,
-                                                            uri::components::component = components::full_uri);
-
-    /// <summary>
-    /// Encodes a string by converting all characters except for RFC 3986 unreserved characters to their
-    /// hexadecimal representation.
-    /// </summary>
-    /// <returns>The encoded string.</returns>
-    _ASYNCRTIMP static utility::string_t __cdecl encode_data_string(const utility::string_t& data);
-
-    /// <summary>
-    /// Decodes an encoded string.
-    /// </summary>
-    /// <param name="encoded">The URI as a string.</param>
-    /// <returns>The decoded string.</returns>
-    _ASYNCRTIMP static utility::string_t __cdecl decode(const utility::string_t& encoded);
-
-    /// <summary>
-    /// Splits a path into its hierarchical components.
-    /// </summary>
-    /// <param name="path">The path as a string</param>
-    /// <returns>A <c>std::vector&lt;utility::string_t&gt;</c> containing the segments in the path.</returns>
-    _ASYNCRTIMP static std::vector<utility::string_t> __cdecl split_path(const utility::string_t& path);
-
-    /// <summary>
-    /// Splits a query into its key-value components.
-    /// </summary>
-    /// <param name="query">The query string</param>
-    /// <returns>A <c>std::map&lt;utility::string_t, utility::string_t&gt;</c> containing the key-value components of
-    /// the query.</returns>
-    _ASYNCRTIMP static std::map<utility::string_t, utility::string_t> __cdecl split_query(
-        const utility::string_t& query);
-
-    /// <summary>
-    /// Validates a string as a URI.
-    /// </summary>
-    /// <remarks>
-    /// This function accepts both uris ('http://msn.com') and uri relative-references ('path1/path2?query').
-    /// </remarks>
-    /// <param name="uri_string">The URI string to be validated.</param>
-    /// <returns><c>true</c> if the given string represents a valid URI, <c>false</c> otherwise.</returns>
-    _ASYNCRTIMP static bool __cdecl validate(const utility::string_t& uri_string);
-
-    /// <summary>
-    /// Creates an empty uri
-    /// </summary>
-    uri() : m_uri(_XPLATSTR("/")) {}
-
-    /// <summary>
-    /// Creates a URI from the given encoded string. This will throw an exception if the string
-    /// does not contain a valid URI. Use uri::validate if processing user-input.
-    /// </summary>
-    /// <param name="uri_string">A pointer to an encoded string to create the URI instance.</param>
-    _ASYNCRTIMP uri(const utility::char_t* uri_string);
-
-    /// <summary>
-    /// Creates a URI from the given encoded string. This will throw an exception if the string
-    /// does not contain a valid URI. Use uri::validate if processing user-input.
-    /// </summary>
-    /// <param name="uri_string">An encoded URI string to create the URI instance.</param>
-    _ASYNCRTIMP uri(const utility::string_t& uri_string);
-
-    /// <summary>
-    /// Copy constructor.
-    /// </summary>
-    uri(const uri&) = default;
-
-    /// <summary>
-    /// Copy assignment operator.
-    /// </summary>
-    uri& operator=(const uri&) = default;
-
-    /// <summary>
-    /// Move constructor.
-    /// </summary>
-    // This is for VS2013 compatibility -- replace with '= default' when VS2013 is completely dropped.
-    uri(uri&& other) CPPREST_NOEXCEPT : m_uri(std::move(other.m_uri)), m_components(std::move(other.m_components)) {}
-
-    /// <summary>
-    /// Move assignment operator
-    /// </summary>
-    // This is for VS2013 compatibility -- replace with '= default' when VS2013 is completely dropped.
-    uri& operator=(uri&& other) CPPREST_NOEXCEPT
-    {
-        if (this != &other)
-        {
-            m_uri = std::move(other.m_uri);
-            m_components = std::move(other.m_components);
-        }
-        return *this;
-    }
-
-    /// <summary>
-    /// Get the scheme component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI scheme as a string.</returns>
-    const utility::string_t& scheme() const { return m_components.m_scheme; }
-
-    /// <summary>
-    /// Get the user information component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI user information as a string.</returns>
-    const utility::string_t& user_info() const { return m_components.m_user_info; }
-
-    /// <summary>
-    /// Get the host component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI host as a string.</returns>
-    const utility::string_t& host() const { return m_components.m_host; }
-
-    /// <summary>
-    /// Get the port component of the URI. Returns -1 if no port is specified.
-    /// </summary>
-    /// <returns>The URI port as an integer.</returns>
-    int port() const { return m_components.m_port; }
-
-    /// <summary>
-    /// Get the path component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI path as a string.</returns>
-    const utility::string_t& path() const { return m_components.m_path; }
-
-    /// <summary>
-    /// Get the query component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI query as a string.</returns>
-    const utility::string_t& query() const { return m_components.m_query; }
-
-    /// <summary>
-    /// Get the fragment component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI fragment as a string.</returns>
-    const utility::string_t& fragment() const { return m_components.m_fragment; }
-
-    /// <summary>
-    /// Creates a new uri object with the same authority portion as this one, omitting the resource and query portions.
-    /// </summary>
-    /// <returns>The new uri object with the same authority.</returns>
-    _ASYNCRTIMP uri authority() const;
-
-    /// <summary>
-    /// Gets the path, query, and fragment portion of this uri, which may be empty.
-    /// </summary>
-    /// <returns>The new URI object with the path, query and fragment portion of this URI.</returns>
-    _ASYNCRTIMP uri resource() const;
-
-    /// <summary>
-    /// An empty URI specifies no components, and serves as a default value
-    /// </summary>
-    bool is_empty() const { return this->m_uri.empty() || this->m_uri == _XPLATSTR("/"); }
-
-    /// <summary>
-    /// A loopback URI is one which refers to a hostname or ip address with meaning only on the local machine.
-    /// </summary>
-    /// <remarks>
-    /// Examples include "localhost", or ip addresses in the loopback range (127.0.0.0/24).
-    /// </remarks>
-    /// <returns><c>true</c> if this URI references the local host, <c>false</c> otherwise.</returns>
-    bool is_host_loopback() const
-    {
-        return !is_empty() &&
-               ((host() == _XPLATSTR("localhost")) || (host().size() > 4 && host().substr(0, 4) == _XPLATSTR("127.")));
-    }
-
-    /// <summary>
-    /// A wildcard URI is one which refers to all hostnames that resolve to the local machine (using the * or +)
-    /// </summary>
-    /// <example>
-    /// http://*:80
-    /// </example>
-    bool is_host_wildcard() const
-    {
-        return !is_empty() && (this->host() == _XPLATSTR("*") || this->host() == _XPLATSTR("+"));
-    }
-
-    /// <summary>
-    /// A portable URI is one with a hostname that can be resolved globally (used from another machine).
-    /// </summary>
-    /// <returns><c>true</c> if this URI can be resolved globally (used from another machine), <c>false</c>
-    /// otherwise.</returns> <remarks> The hostname "localhost" is a reserved name that is guaranteed to resolve to the
-    /// local machine, and cannot be used for inter-machine communication. Likewise the hostnames "*" and "+" on Windows
-    /// represent wildcards, and do not map to a resolvable address.
-    /// </remarks>
-    bool is_host_portable() const { return !(is_empty() || is_host_loopback() || is_host_wildcard()); }
-
-    /// <summary>
-    /// A default port is one where the port is unspecified, and will be determined by the operating system.
-    /// The choice of default port may be dictated by the scheme (http -> 80) or not.
-    /// </summary>
-    /// <returns><c>true</c> if this URI instance has a default port, <c>false</c> otherwise.</returns>
-    bool is_port_default() const { return !is_empty() && this->port() == 0; }
-
-    /// <summary>
-    /// An "authority" URI is one with only a scheme, optional userinfo, hostname, and (optional) port.
-    /// </summary>
-    /// <returns><c>true</c> if this is an "authority" URI, <c>false</c> otherwise.</returns>
-    bool is_authority() const { return !is_empty() && is_path_empty() && query().empty() && fragment().empty(); }
-
-    /// <summary>
-    /// Returns whether the other URI has the same authority as this one
-    /// </summary>
-    /// <param name="other">The URI to compare the authority with.</param>
-    /// <returns><c>true</c> if both the URI's have the same authority, <c>false</c> otherwise.</returns>
-    bool has_same_authority(const uri& other) const { return !is_empty() && this->authority() == other.authority(); }
-
-    /// <summary>
-    /// Returns whether the path portion of this URI is empty
-    /// </summary>
-    /// <returns><c>true</c> if the path portion of this URI is empty, <c>false</c> otherwise.</returns>
-    bool is_path_empty() const { return path().empty() || path() == _XPLATSTR("/"); }
-
-    /// <summary>
-    /// Returns the full (encoded) URI as a string.
-    /// </summary>
-    /// <returns>The full encoded URI string.</returns>
-    utility::string_t to_string() const { return m_uri; }
-
-    /// <summary>
-    /// Returns an URI resolved against <c>this</c> as the base URI
-    /// according to RFC3986, Section 5 (https://tools.ietf.org/html/rfc3986#section-5).
-    /// </summary>
-    /// <param name="relativeUri">The relative URI to be resolved against <c>this</c> as base.</param>
-    /// <returns>The new resolved URI string.</returns>
-    _ASYNCRTIMP utility::string_t resolve_uri(const utility::string_t& relativeUri) const;
-
-    _ASYNCRTIMP bool operator==(const uri& other) const;
-
-    bool operator<(const uri& other) const { return m_uri < other.m_uri; }
-
-    bool operator!=(const uri& other) const { return !(this->operator==(other)); }
-
-private:
-    friend class uri_builder;
-
-    /// <summary>
-    /// Creates a URI from the given URI components.
-    /// </summary>
-    /// <param name="components">A URI components object to create the URI instance.</param>
-    _ASYNCRTIMP uri(const details::uri_components& components);
-
-    // Used by uri_builder
-    static utility::string_t __cdecl encode_query_impl(const utf8string& raw);
-
-    utility::string_t m_uri;
-    details::uri_components m_components;
-};
-
-} // namespace web

deps/cpprestsdk/include/cpprest/details/basic_types.h

@@ -1,131 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * Platform-dependent type definitions
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-
-#pragma once
-
-#include "cpprest/details/cpprest_compat.h"
-#include <fstream>
-#include <iostream>
-#include <sstream>
-#include <string>
-
-#ifndef _WIN32
-#ifndef __STDC_LIMIT_MACROS
-#define __STDC_LIMIT_MACROS
-#endif
-#include <stdint.h>
-#else
-#include <cstdint>
-#endif
-
-#include "cpprest/details/SafeInt3.hpp"
-
-namespace utility
-{
-#ifdef _WIN32
-#define _UTF16_STRINGS
-#endif
-
-// We should be using a 64-bit size type for most situations that do
-// not involve specifying the size of a memory allocation or buffer.
-typedef uint64_t size64_t;
-
-#ifndef _WIN32
-typedef uint32_t HRESULT; // Needed for PPLX
-#endif
-
-#ifdef _UTF16_STRINGS
-//
-// On Windows, all strings are wide
-//
-typedef wchar_t char_t;
-typedef std::wstring string_t;
-#define _XPLATSTR(x) L##x
-typedef std::wostringstream ostringstream_t;
-typedef std::wofstream ofstream_t;
-typedef std::wostream ostream_t;
-typedef std::wistream istream_t;
-typedef std::wifstream ifstream_t;
-typedef std::wistringstream istringstream_t;
-typedef std::wstringstream stringstream_t;
-#define ucout std::wcout
-#define ucin std::wcin
-#define ucerr std::wcerr
-#else
-//
-// On POSIX platforms, all strings are narrow
-//
-typedef char char_t;
-typedef std::string string_t;
-#define _XPLATSTR(x) x
-typedef std::ostringstream ostringstream_t;
-typedef std::ofstream ofstream_t;
-typedef std::ostream ostream_t;
-typedef std::istream istream_t;
-typedef std::ifstream ifstream_t;
-typedef std::istringstream istringstream_t;
-typedef std::stringstream stringstream_t;
-#define ucout std::cout
-#define ucin std::cin
-#define ucerr std::cerr
-#endif // endif _UTF16_STRINGS
-
-#ifndef _TURN_OFF_PLATFORM_STRING
-// The 'U' macro can be used to create a string or character literal of the platform type, i.e. utility::char_t.
-// If you are using a library causing conflicts with 'U' macro, it can be turned off by defining the macro
-// '_TURN_OFF_PLATFORM_STRING' before including the C++ REST SDK header files, and e.g. use '_XPLATSTR' instead.
-#define U(x) _XPLATSTR(x)
-#endif // !_TURN_OFF_PLATFORM_STRING
-
-} // namespace utility
-
-typedef char utf8char;
-typedef std::string utf8string;
-typedef std::stringstream utf8stringstream;
-typedef std::ostringstream utf8ostringstream;
-typedef std::ostream utf8ostream;
-typedef std::istream utf8istream;
-typedef std::istringstream utf8istringstream;
-
-#ifdef _UTF16_STRINGS
-typedef wchar_t utf16char;
-typedef std::wstring utf16string;
-typedef std::wstringstream utf16stringstream;
-typedef std::wostringstream utf16ostringstream;
-typedef std::wostream utf16ostream;
-typedef std::wistream utf16istream;
-typedef std::wistringstream utf16istringstream;
-#else
-typedef char16_t utf16char;
-typedef std::u16string utf16string;
-typedef std::basic_stringstream<utf16char> utf16stringstream;
-typedef std::basic_ostringstream<utf16char> utf16ostringstream;
-typedef std::basic_ostream<utf16char> utf16ostream;
-typedef std::basic_istream<utf16char> utf16istream;
-typedef std::basic_istringstream<utf16char> utf16istringstream;
-#endif
-
-#if defined(_WIN32)
-// Include on everything except Windows Desktop ARM, unless explicitly excluded.
-#if !defined(CPPREST_EXCLUDE_WEBSOCKETS)
-#if defined(WINAPI_FAMILY)
-#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) && defined(_M_ARM)
-#define CPPREST_EXCLUDE_WEBSOCKETS
-#endif
-#else
-#if defined(_M_ARM)
-#define CPPREST_EXCLUDE_WEBSOCKETS
-#endif
-#endif
-#endif
-#endif

deps/cpprestsdk/include/cpprest/details/cpprest_compat.h

@@ -1,91 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * Standard macros and definitions.
- * This header has minimal dependency on windows headers and is safe for use in the public API
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-
-#pragma once
-
-#if defined(_WIN32)
-
-#if _MSC_VER >= 1900
-#define CPPREST_NOEXCEPT noexcept
-#define CPPREST_CONSTEXPR constexpr
-#else
-#define CPPREST_NOEXCEPT
-#define CPPREST_CONSTEXPR const
-#endif // _MSC_VER >= 1900
-
-#define CASABLANCA_UNREFERENCED_PARAMETER(x) (x)
-
-#include <sal.h>
-
-#else // ^^^ _WIN32 ^^^ // vvv !_WIN32 vvv
-
-#define __declspec(x) __attribute__((x))
-#define dllimport
-#define novtable /* no novtable equivalent */
-#define __assume(x)                                                                                                    \
-    do                                                                                                                 \
-    {                                                                                                                  \
-        if (!(x)) __builtin_unreachable();                                                                             \
-    } while (false)
-#define CASABLANCA_UNREFERENCED_PARAMETER(x) (void)x
-#define CPPREST_NOEXCEPT noexcept
-#define CPPREST_CONSTEXPR constexpr
-
-#include <assert.h>
-#define _ASSERTE(x) assert(x)
-
-// No SAL on non Windows platforms
-#include "cpprest/details/nosal.h"
-
-#if !defined(__cdecl)
-#if defined(cdecl)
-#define __cdecl __attribute__((cdecl))
-#else // ^^^ defined cdecl ^^^ // vvv !defined cdecl vvv
-#define __cdecl
-#endif // defined cdecl
-#endif // not defined __cdecl
-
-#if defined(__ANDROID__)
-// This is needed to disable the use of __thread inside the boost library.
-// Android does not support thread local storage -- if boost is included
-// without this macro defined, it will create references to __tls_get_addr
-// which (while able to link) will not be available at runtime and prevent
-// the .so from loading.
-#if not defined BOOST_ASIO_DISABLE_THREAD_KEYWORD_EXTENSION
-#define BOOST_ASIO_DISABLE_THREAD_KEYWORD_EXTENSION
-#endif // not defined BOOST_ASIO_DISABLE_THREAD_KEYWORD_EXTENSION
-#endif // defined(__ANDROID__)
-
-#ifdef __clang__
-#include <cstdio>
-#endif // __clang__
-#endif // _WIN32
-
-#define _NO_ASYNCRTIMP
-
-#ifdef _NO_ASYNCRTIMP
-#define _ASYNCRTIMP
-#else // ^^^ _NO_ASYNCRTIMP ^^^ // vvv !_NO_ASYNCRTIMP vvv
-#ifdef _ASYNCRT_EXPORT
-#define _ASYNCRTIMP __declspec(dllexport)
-#else // ^^^ _ASYNCRT_EXPORT ^^^ // vvv !_ASYNCRT_EXPORT vvv
-#define _ASYNCRTIMP __declspec(dllimport)
-#endif // _ASYNCRT_EXPORT
-#endif // _NO_ASYNCRTIMP
-
-#ifdef CASABLANCA_DEPRECATION_NO_WARNINGS
-#define CASABLANCA_DEPRECATED(x)
-#else
-#define CASABLANCA_DEPRECATED(x) __declspec(deprecated(x))
-#endif // CASABLANCA_DEPRECATION_NO_WARNINGS

deps/cpprestsdk/include/cpprest/details/web_utilities.h

@@ -1,223 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * utility classes used by the different web:: clients
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-#pragma once
-
-#include "cpprest/asyncrt_utils.h"
-#include "cpprest/uri.h"
-
-namespace web
-{
-namespace details
-{
-class zero_memory_deleter
-{
-public:
-    _ASYNCRTIMP void operator()(::utility::string_t* data) const;
-};
-typedef std::unique_ptr<::utility::string_t, zero_memory_deleter> plaintext_string;
-
-#if defined(_WIN32) && !defined(CPPREST_TARGET_XP)
-#if defined(__cplusplus_winrt)
-class winrt_encryption
-{
-public:
-    winrt_encryption() {}
-    _ASYNCRTIMP winrt_encryption(const std::wstring& data);
-    _ASYNCRTIMP plaintext_string decrypt() const;
-
-private:
-    ::pplx::task<Windows::Storage::Streams::IBuffer ^> m_buffer;
-};
-#else
-class win32_encryption
-{
-public:
-    win32_encryption() {}
-    _ASYNCRTIMP win32_encryption(const std::wstring& data);
-    _ASYNCRTIMP ~win32_encryption();
-    _ASYNCRTIMP plaintext_string decrypt() const;
-
-private:
-    std::vector<char> m_buffer;
-    size_t m_numCharacters;
-};
-#endif
-#endif
-} // namespace details
-
-/// <summary>
-/// Represents a set of user credentials (user name and password) to be used
-/// for authentication.
-/// </summary>
-class credentials
-{
-public:
-    /// <summary>
-    /// Constructs an empty set of credentials without a user name or password.
-    /// </summary>
-    credentials() {}
-
-    /// <summary>
-    /// Constructs credentials from given user name and password.
-    /// </summary>
-    /// <param name="username">User name as a string.</param>
-    /// <param name="password">Password as a string.</param>
-    credentials(utility::string_t username, const utility::string_t& password)
-        : m_username(std::move(username)), m_password(password)
-    {
-    }
-
-    /// <summary>
-    /// The user name associated with the credentials.
-    /// </summary>
-    /// <returns>A string containing the user name.</returns>
-    const utility::string_t& username() const { return m_username; }
-
-    /// <summary>
-    /// The password for the user name associated with the credentials.
-    /// </summary>
-    /// <returns>A string containing the password.</returns>
-    CASABLANCA_DEPRECATED(
-        "This API is deprecated for security reasons to avoid unnecessary password copies stored in plaintext.")
-    utility::string_t password() const
-    {
-#if defined(_WIN32) && !defined(CPPREST_TARGET_XP)
-        return utility::string_t(*m_password.decrypt());
-#else
-        return m_password;
-#endif
-    }
-
-    /// <summary>
-    /// Checks if credentials have been set
-    /// </summary>
-    /// <returns><c>true</c> if user name and password is set, <c>false</c> otherwise.</returns>
-    bool is_set() const { return !m_username.empty(); }
-
-    details::plaintext_string _internal_decrypt() const
-    {
-        // Encryption APIs not supported on XP
-#if defined(_WIN32) && !defined(CPPREST_TARGET_XP)
-        return m_password.decrypt();
-#else
-        return details::plaintext_string(new ::utility::string_t(m_password));
-#endif
-    }
-
-private:
-    ::utility::string_t m_username;
-
-#if defined(_WIN32) && !defined(CPPREST_TARGET_XP)
-#if defined(__cplusplus_winrt)
-    details::winrt_encryption m_password;
-#else
-    details::win32_encryption m_password;
-#endif
-#else
-    ::utility::string_t m_password;
-#endif
-};
-
-/// <summary>
-/// web_proxy represents the concept of the web proxy, which can be auto-discovered,
-/// disabled, or specified explicitly by the user.
-/// </summary>
-class web_proxy
-{
-    enum web_proxy_mode_internal
-    {
-        use_default_,
-        use_auto_discovery_,
-        disabled_,
-        user_provided_
-    };
-
-public:
-    enum web_proxy_mode
-    {
-        use_default = use_default_,
-        use_auto_discovery = use_auto_discovery_,
-        disabled = disabled_
-    };
-
-    /// <summary>
-    /// Constructs a proxy with the default settings.
-    /// </summary>
-    web_proxy() : m_address(_XPLATSTR("")), m_mode(use_default_) {}
-
-    /// <summary>
-    /// Creates a proxy with specified mode.
-    /// </summary>
-    /// <param name="mode">Mode to use.</param>
-    web_proxy(web_proxy_mode mode) : m_address(_XPLATSTR("")), m_mode(static_cast<web_proxy_mode_internal>(mode)) {}
-
-    /// <summary>
-    /// Creates a proxy explicitly with provided address.
-    /// </summary>
-    /// <param name="address">Proxy URI to use.</param>
-    web_proxy(uri address) : m_address(address), m_mode(user_provided_) {}
-
-    /// <summary>
-    /// Gets this proxy's URI address. Returns an empty URI if not explicitly set by user.
-    /// </summary>
-    /// <returns>A reference to this proxy's URI.</returns>
-    const uri& address() const { return m_address; }
-
-    /// <summary>
-    /// Gets the credentials used for authentication with this proxy.
-    /// </summary>
-    /// <returns>Credentials to for this proxy.</returns>
-    const web::credentials& credentials() const { return m_credentials; }
-
-    /// <summary>
-    /// Sets the credentials to use for authentication with this proxy.
-    /// </summary>
-    /// <param name="cred">Credentials to use for this proxy.</param>
-    void set_credentials(web::credentials cred)
-    {
-        if (m_mode == disabled_)
-        {
-            throw std::invalid_argument("Cannot attach credentials to a disabled proxy");
-        }
-        m_credentials = std::move(cred);
-    }
-
-    /// <summary>
-    /// Checks if this proxy was constructed with default settings.
-    /// </summary>
-    /// <returns>True if default, false otherwise.</param>
-    bool is_default() const { return m_mode == use_default_; }
-
-    /// <summary>
-    /// Checks if using a proxy is disabled.
-    /// </summary>
-    /// <returns>True if disabled, false otherwise.</returns>
-    bool is_disabled() const { return m_mode == disabled_; }
-
-    /// <summary>
-    /// Checks if the auto discovery protocol, WPAD, is to be used.
-    /// </summary>
-    /// <returns>True if auto discovery enabled, false otherwise.</returns>
-    bool is_auto_discovery() const { return m_mode == use_auto_discovery_; }
-
-    /// <summary>
-    /// Checks if a proxy address is explicitly specified by the user.
-    /// </summary>
-    /// <returns>True if a proxy address was explicitly specified, false otherwise.</returns>
-    bool is_specified() const { return m_mode == user_provided_; }
-
-private:
-    web::uri m_address;
-    web_proxy_mode_internal m_mode;
-    web::credentials m_credentials;
-};
-
-} // namespace web

deps/cpprestsdk/include/cpprest/uri.h

@@ -1,21 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * Protocol independent support for URIs.
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-#pragma once
-
-#ifndef CASA_URI_H
-#define CASA_URI_H
-
-#include "cpprest/base_uri.h"
-#include "cpprest/uri_builder.h"
-
-#endif

deps/cpprestsdk/include/cpprest/uri_builder.h

@@ -1,295 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * Builder style class for creating URIs.
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-
-#pragma once
-
-#include "cpprest/base_uri.h"
-#include <string>
-
-namespace web
-{
-/// <summary>
-/// Builder for constructing URIs incrementally.
-/// </summary>
-class uri_builder
-{
-public:
-    /// <summary>
-    /// Creates a builder with an initially empty URI.
-    /// </summary>
-    uri_builder() = default;
-
-    /// <summary>
-    /// Creates a builder with a existing URI object.
-    /// </summary>
-    /// <param name="uri_str">Encoded string containing the URI.</param>
-    uri_builder(const uri& uri_str) : m_uri(uri_str.m_components) {}
-
-    /// <summary>
-    /// Get the scheme component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI scheme as a string.</returns>
-    const utility::string_t& scheme() const { return m_uri.m_scheme; }
-
-    /// <summary>
-    /// Get the user information component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI user information as a string.</returns>
-    const utility::string_t& user_info() const { return m_uri.m_user_info; }
-
-    /// <summary>
-    /// Get the host component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI host as a string.</returns>
-    const utility::string_t& host() const { return m_uri.m_host; }
-
-    /// <summary>
-    /// Get the port component of the URI. Returns -1 if no port is specified.
-    /// </summary>
-    /// <returns>The URI port as an integer.</returns>
-    int port() const { return m_uri.m_port; }
-
-    /// <summary>
-    /// Get the path component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI path as a string.</returns>
-    const utility::string_t& path() const { return m_uri.m_path; }
-
-    /// <summary>
-    /// Get the query component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI query as a string.</returns>
-    const utility::string_t& query() const { return m_uri.m_query; }
-
-    /// <summary>
-    /// Get the fragment component of the URI as an encoded string.
-    /// </summary>
-    /// <returns>The URI fragment as a string.</returns>
-    const utility::string_t& fragment() const { return m_uri.m_fragment; }
-
-    /// <summary>
-    /// Set the scheme of the URI.
-    /// </summary>
-    /// <param name="scheme">Uri scheme.</param>
-    /// <returns>A reference to this <c>uri_builder</c> to support chaining.</returns>
-    uri_builder& set_scheme(const utility::string_t& scheme)
-    {
-        m_uri.m_scheme = scheme;
-        return *this;
-    }
-
-    /// <summary>
-    /// Set the user info component of the URI.
-    /// </summary>
-    /// <param name="user_info">User info as a decoded string.</param>
-    /// <param name="do_encoding">Specify whether to apply URI encoding to the given string.</param>
-    /// <returns>A reference to this <c>uri_builder</c> to support chaining.</returns>
-    uri_builder& set_user_info(const utility::string_t& user_info, bool do_encoding = false)
-    {
-        if (do_encoding)
-        {
-            m_uri.m_user_info = uri::encode_uri(user_info, uri::components::user_info);
-        }
-        else
-        {
-            m_uri.m_user_info = user_info;
-        }
-
-        return *this;
-    }
-
-    /// <summary>
-    /// Set the host component of the URI.
-    /// </summary>
-    /// <param name="host">Host as a decoded string.</param>
-    /// <param name="do_encoding">Specify whether to apply URI encoding to the given string.</param>
-    /// <returns>A reference to this <c>uri_builder</c> to support chaining.</returns>
-    uri_builder& set_host(const utility::string_t& host, bool do_encoding = false)
-    {
-        if (do_encoding)
-        {
-            m_uri.m_host = uri::encode_uri(host, uri::components::host);
-        }
-        else
-        {
-            m_uri.m_host = host;
-        }
-
-        return *this;
-    }
-
-    /// <summary>
-    /// Set the port component of the URI.
-    /// </summary>
-    /// <param name="port">Port as an integer.</param>
-    /// <returns>A reference to this <c>uri_builder</c> to support chaining.</returns>
-    uri_builder& set_port(int port)
-    {
-        m_uri.m_port = port;
-        return *this;
-    }
-
-    /// <summary>
-    /// Set the port component of the URI.
-    /// </summary>
-    /// <param name="port">Port as a string.</param>
-    /// <returns>A reference to this <c>uri_builder</c> to support chaining.</returns>
-    /// <remarks>When string can't be converted to an integer the port is left unchanged.</remarks>
-    _ASYNCRTIMP uri_builder& set_port(const utility::string_t& port);
-
-    /// <summary>
-    /// Set the path component of the URI.
-    /// </summary>
-    /// <param name="path">Path as a decoded string.</param>
-    /// <param name="do_encoding">Specify whether to apply URI encoding to the given string.</param>
-    /// <returns>A reference to this <c>uri_builder</c> to support chaining.</returns>
-    uri_builder& set_path(const utility::string_t& path, bool do_encoding = false)
-    {
-        if (do_encoding)
-        {
-            m_uri.m_path = uri::encode_uri(path, uri::components::path);
-        }
-        else
-        {
-            m_uri.m_path = path;
-        }
-
-        return *this;
-    }
-
-    /// <summary>
-    /// Set the query component of the URI.
-    /// </summary>
-    /// <param name="query">Query as a decoded string.</param>
-    /// <param name="do_encoding">Specify whether apply URI encoding to the given string.</param>
-    /// <returns>A reference to this <c>uri_builder</c> to support chaining.</returns>
-    uri_builder& set_query(const utility::string_t& query, bool do_encoding = false)
-    {
-        if (do_encoding)
-        {
-            m_uri.m_query = uri::encode_uri(query, uri::components::query);
-        }
-        else
-        {
-            m_uri.m_query = query;
-        }
-
-        return *this;
-    }
-
-    /// <summary>
-    /// Set the fragment component of the URI.
-    /// </summary>
-    /// <param name="fragment">Fragment as a decoded string.</param>
-    /// <param name="do_encoding">Specify whether to apply URI encoding to the given string.</param>
-    /// <returns>A reference to this <c>uri_builder</c> to support chaining.</returns>
-    uri_builder& set_fragment(const utility::string_t& fragment, bool do_encoding = false)
-    {
-        if (do_encoding)
-        {
-            m_uri.m_fragment = uri::encode_uri(fragment, uri::components::fragment);
-        }
-        else
-        {
-            m_uri.m_fragment = fragment;
-        }
-
-        return *this;
-    }
-
-    /// <summary>
-    /// Clears all components of the underlying URI in this uri_builder.
-    /// </summary>
-    void clear() { m_uri = details::uri_components(); }
-
-    /// <summary>
-    /// Appends another path to the path of this uri_builder.
-    /// </summary>
-    /// <param name="path">Path to append as a already encoded string.</param>
-    /// <param name="do_encoding">Specify whether to apply URI encoding to the given string.</param>
-    /// <returns>A reference to this uri_builder to support chaining.</returns>
-    _ASYNCRTIMP uri_builder& append_path(const utility::string_t& path, bool do_encoding = false);
-
-    /// <summary>
-    /// Appends the raw contents of the path argument to the path of this uri_builder with no separator de-duplication.
-    /// </summary>
-    /// <remarks>
-    /// The path argument is appended after adding a '/' separator without regards to the contents of path. If an empty
-    /// string is provided, this function will immediately return without changes to the stored path value. For example:
-    /// if the current contents are "/abc" and path="/xyz", the result will be "/abc//xyz".
-    /// </remarks>
-    /// <param name="path">Path to append as a already encoded string.</param>
-    /// <param name="do_encoding">Specify whether to apply URI encoding to the given string.</param>
-    /// <returns>A reference to this uri_builder to support chaining.</returns>
-    _ASYNCRTIMP uri_builder& append_path_raw(const utility::string_t& path, bool do_encoding = false);
-
-    /// <summary>
-    /// Appends another query to the query of this uri_builder.
-    /// </summary>
-    /// <param name="query">Query to append as a decoded string.</param>
-    /// <param name="do_encoding">Specify whether to apply URI encoding to the given string.</param>
-    /// <returns>A reference to this uri_builder to support chaining.</returns>
-    _ASYNCRTIMP uri_builder& append_query(const utility::string_t& query, bool do_encoding = false);
-
-    /// <summary>
-    /// Appends an relative uri (Path, Query and fragment) at the end of the current uri.
-    /// </summary>
-    /// <param name="relative_uri">The relative uri to append.</param>
-    /// <returns>A reference to this uri_builder to support chaining.</returns>
-    _ASYNCRTIMP uri_builder& append(const uri& relative_uri);
-
-    /// <summary>
-    /// Appends another query to the query of this uri_builder, encoding it first. This overload is useful when building
-    /// a query segment of the form "element=10", where the right hand side of the query is stored as a type other than
-    /// a string, for instance, an integral type.
-    /// </summary>
-    /// <param name="name">The name portion of the query string</param>
-    /// <param name="value">The value portion of the query string</param>
-    /// <returns>A reference to this uri_builder to support chaining.</returns>
-    template<typename T>
-    uri_builder& append_query(const utility::string_t& name, const T& value, bool do_encoding = true)
-    {
-        if (do_encoding)
-            append_query_encode_impl(name, utility::conversions::details::print_utf8string(value));
-        else
-            append_query_no_encode_impl(name, utility::conversions::details::print_string(value));
-        return *this;
-    }
-
-    /// <summary>
-    /// Combine and validate the URI components into a encoded string. An exception will be thrown if the URI is
-    /// invalid.
-    /// </summary>
-    /// <returns>The created URI as a string.</returns>
-    _ASYNCRTIMP utility::string_t to_string() const;
-
-    /// <summary>
-    /// Combine and validate the URI components into a URI class instance. An exception will be thrown if the URI is
-    /// invalid.
-    /// </summary>
-    /// <returns>The create URI as a URI class instance.</returns>
-    _ASYNCRTIMP uri to_uri() const;
-
-    /// <summary>
-    /// Validate the generated URI from all existing components of this uri_builder.
-    /// </summary>
-    /// <returns>Whether the URI is valid.</returns>
-    _ASYNCRTIMP bool is_valid();
-
-private:
-    _ASYNCRTIMP void append_query_encode_impl(const utility::string_t& name, const utf8string& value);
-    _ASYNCRTIMP void append_query_no_encode_impl(const utility::string_t& name, const utility::string_t& value);
-
-    details::uri_components m_uri;
-};
-} // namespace web

deps/cpprestsdk/include/cpprest/version.h

@@ -1,10 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- */
-#define CPPREST_VERSION_MINOR 10
-#define CPPREST_VERSION_MAJOR 2
-#define CPPREST_VERSION_REVISION 13
-
-#define CPPREST_VERSION (CPPREST_VERSION_MAJOR * 100000 + CPPREST_VERSION_MINOR * 100 + CPPREST_VERSION_REVISION)

deps/cpprestsdk/pch.h

@@ -1,34 +0,0 @@
-#include <winrt/base.h>
-#include <Windows.h>
-#include <dxgi1_3.h>
-#include <d3d11_2.h>
-#include <d2d1_3.h>
-#include <d2d1_3helper.h>
-#include <d2d1helper.h>
-#include <dwrite.h>
-#include <dcomp.h>
-#include <dwmapi.h>
-#include <Shobjidl.h>
-#include <Shlwapi.h>
-#include <string>
-#include <algorithm>
-#include <chrono>
-#include <mutex>
-#include <thread>
-#include <functional>
-#include <condition_variable>
-#include <stdexcept>
-#include <tuple>
-#include <unordered_set>
-#include <string>
-#include <vector>
-
-// cpprestsdk headers
-#include "cpprest/details/basic_types.h"
-#include "cpprest/details/cpprest_compat.h"
-#include "cpprest/version.h"
-// json
-#include "cpprest/json.h"
-// utilities
-#include "cpprest/asyncrt_utils.h"
-#include "cpprest/details/web_utilities.h"

deps/cpprestsdk/src/json/json.cpp

@@ -1,475 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * HTTP Library: JSON parser and writer
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-
-#include "pch.h"
-
-using namespace web;
-
-bool json::details::g_keep_json_object_unsorted = false;
-void json::keep_object_element_order(bool keep_order) { json::details::g_keep_json_object_unsorted = keep_order; }
-
-utility::ostream_t& web::json::operator<<(utility::ostream_t& os, const web::json::value& val)
-{
-    val.serialize(os);
-    return os;
-}
-
-utility::istream_t& web::json::operator>>(utility::istream_t& is, json::value& val)
-{
-    val = json::value::parse(is);
-    return is;
-}
-
-web::json::value::value()
-    : m_value(utility::details::make_unique<web::json::details::_Null>())
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::Null)
-#endif
-{
-}
-
-web::json::value::value(int32_t value)
-    : m_value(utility::details::make_unique<web::json::details::_Number>(value))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::Number)
-#endif
-{
-}
-
-web::json::value::value(uint32_t value)
-    : m_value(utility::details::make_unique<web::json::details::_Number>(value))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::Number)
-#endif
-{
-}
-
-web::json::value::value(int64_t value)
-    : m_value(utility::details::make_unique<web::json::details::_Number>(value))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::Number)
-#endif
-{
-}
-
-web::json::value::value(uint64_t value)
-    : m_value(utility::details::make_unique<web::json::details::_Number>(value))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::Number)
-#endif
-{
-}
-
-web::json::value::value(double value)
-    : m_value(utility::details::make_unique<web::json::details::_Number>(value))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::Number)
-#endif
-{
-}
-
-web::json::value::value(bool value)
-    : m_value(utility::details::make_unique<web::json::details::_Boolean>(value))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::Boolean)
-#endif
-{
-}
-
-web::json::value::value(utility::string_t value)
-    : m_value(utility::details::make_unique<web::json::details::_String>(std::move(value)))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::String)
-#endif
-{
-}
-
-web::json::value::value(utility::string_t value, bool has_escape_chars)
-    : m_value(utility::details::make_unique<web::json::details::_String>(std::move(value), has_escape_chars))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::String)
-#endif
-{
-}
-
-web::json::value::value(const utility::char_t* value)
-    : m_value(utility::details::make_unique<web::json::details::_String>(value))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::String)
-#endif
-{
-}
-
-web::json::value::value(const utility::char_t* value, bool has_escape_chars)
-    : m_value(utility::details::make_unique<web::json::details::_String>(utility::string_t(value), has_escape_chars))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(value::String)
-#endif
-{
-}
-
-web::json::value::value(const value& other)
-    : m_value(other.m_value->_copy_value())
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    , m_kind(other.m_kind)
-#endif
-{
-}
-
-web::json::value& web::json::value::operator=(const value& other)
-{
-    if (this != &other)
-    {
-        m_value = std::unique_ptr<details::_Value>(other.m_value->_copy_value());
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-        m_kind = other.m_kind;
-#endif
-    }
-    return *this;
-}
-
-web::json::value::value(value&& other) CPPREST_NOEXCEPT : m_value(std::move(other.m_value))
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-    ,
-                                                          m_kind(other.m_kind)
-#endif
-{
-}
-
-web::json::value& web::json::value::operator=(web::json::value&& other) CPPREST_NOEXCEPT
-{
-    if (this != &other)
-    {
-        m_value.swap(other.m_value);
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-        m_kind = other.m_kind;
-#endif
-    }
-    return *this;
-}
-
-web::json::value web::json::value::null() { return web::json::value(); }
-
-web::json::value web::json::value::number(double value) { return web::json::value(value); }
-
-web::json::value web::json::value::number(int32_t value) { return web::json::value(value); }
-
-web::json::value web::json::value::number(uint32_t value) { return web::json::value(value); }
-
-web::json::value web::json::value::number(int64_t value) { return web::json::value(value); }
-
-web::json::value web::json::value::number(uint64_t value) { return web::json::value(value); }
-
-web::json::value web::json::value::boolean(bool value) { return web::json::value(value); }
-
-web::json::value web::json::value::string(utility::string_t value)
-{
-    std::unique_ptr<details::_Value> ptr = utility::details::make_unique<details::_String>(std::move(value));
-    return web::json::value(std::move(ptr)
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-                                ,
-                            value::String
-#endif
-    );
-}
-
-web::json::value web::json::value::string(utility::string_t value, bool has_escape_chars)
-{
-    std::unique_ptr<details::_Value> ptr =
-        utility::details::make_unique<details::_String>(std::move(value), has_escape_chars);
-    return web::json::value(std::move(ptr)
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-                                ,
-                            value::String
-#endif
-    );
-}
-
-#ifdef _WIN32
-web::json::value web::json::value::string(const std::string& value)
-{
-    std::unique_ptr<details::_Value> ptr =
-        utility::details::make_unique<details::_String>(utility::conversions::to_utf16string(value));
-    return web::json::value(std::move(ptr)
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-                                ,
-                            value::String
-#endif
-    );
-}
-#endif
-
-web::json::value web::json::value::object(bool keep_order)
-{
-    std::unique_ptr<details::_Value> ptr = utility::details::make_unique<details::_Object>(keep_order);
-    return web::json::value(std::move(ptr)
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-                                ,
-                            value::Object
-#endif
-    );
-}
-
-web::json::value web::json::value::object(std::vector<std::pair<::utility::string_t, value>> fields, bool keep_order)
-{
-    std::unique_ptr<details::_Value> ptr =
-        utility::details::make_unique<details::_Object>(std::move(fields), keep_order);
-    return web::json::value(std::move(ptr)
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-                                ,
-                            value::Object
-#endif
-    );
-}
-
-web::json::value web::json::value::array()
-{
-    std::unique_ptr<details::_Value> ptr = utility::details::make_unique<details::_Array>();
-    return web::json::value(std::move(ptr)
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-                                ,
-                            value::Array
-#endif
-    );
-}
-
-web::json::value web::json::value::array(size_t size)
-{
-    std::unique_ptr<details::_Value> ptr = utility::details::make_unique<details::_Array>(size);
-    return web::json::value(std::move(ptr)
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-                                ,
-                            value::Array
-#endif
-    );
-}
-
-web::json::value web::json::value::array(std::vector<value> elements)
-{
-    std::unique_ptr<details::_Value> ptr = utility::details::make_unique<details::_Array>(std::move(elements));
-    return web::json::value(std::move(ptr)
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-                                ,
-                            value::Array
-#endif
-    );
-}
-
-const web::json::number& web::json::value::as_number() const { return m_value->as_number(); }
-
-double web::json::value::as_double() const { return m_value->as_double(); }
-
-int web::json::value::as_integer() const { return m_value->as_integer(); }
-
-bool web::json::value::as_bool() const { return m_value->as_bool(); }
-
-json::array& web::json::value::as_array() { return m_value->as_array(); }
-
-const json::array& web::json::value::as_array() const { return m_value->as_array(); }
-
-json::object& web::json::value::as_object() { return m_value->as_object(); }
-
-const json::object& web::json::value::as_object() const { return m_value->as_object(); }
-
-bool web::json::number::is_int32() const
-{
-    switch (m_type)
-    {
-        case signed_type:
-            return m_intval >= (std::numeric_limits<int32_t>::min)() && m_intval <= (std::numeric_limits<int32_t>::max)();
-        case unsigned_type: return m_uintval <= (std::numeric_limits<int32_t>::max)();
-        case double_type:
-        default: return false;
-    }
-}
-
-bool web::json::number::is_uint32() const
-{
-    switch (m_type)
-    {
-    case signed_type: return m_intval >= 0 && m_intval <= (std::numeric_limits<uint32_t>::max)();
-        case unsigned_type: return m_uintval <= (std::numeric_limits<uint32_t>::max)();
-        case double_type:
-        default: return false;
-    }
-}
-
-bool web::json::number::is_int64() const
-{
-    switch (m_type)
-    {
-        case signed_type: return true;
-        case unsigned_type: return m_uintval <= static_cast<uint64_t>((std::numeric_limits<int64_t>::max)());
-        case double_type:
-        default: return false;
-    }
-}
-
-bool web::json::details::_String::has_escape_chars(const _String& str)
-{
-    return std::any_of(std::begin(str.m_string), std::end(str.m_string), [](utility::string_t::value_type const x) {
-        if (x <= 31)
-        {
-            return true;
-        }
-        if (x == '"')
-        {
-            return true;
-        }
-        if (x == '\\')
-        {
-            return true;
-        }
-        return false;
-    });
-}
-
-web::json::value::value_type json::value::type() const { return m_value->type(); }
-
-bool json::value::is_integer() const
-{
-    if (!is_number())
-    {
-        return false;
-    }
-    return m_value->is_integer();
-}
-
-bool json::value::is_double() const
-{
-    if (!is_number())
-    {
-        return false;
-    }
-    return m_value->is_double();
-}
-
-json::value& web::json::details::_Object::index(const utility::string_t& key) { return m_object[key]; }
-
-bool web::json::details::_Object::has_field(const utility::string_t& key) const
-{
-    return m_object.find(key) != m_object.end();
-}
-
-bool web::json::value::has_number_field(const utility::string_t& key) const
-{
-    return has_field(key) && at(key).is_number();
-}
-
-bool web::json::value::has_integer_field(const utility::string_t& key) const
-{
-    return has_field(key) && at(key).is_integer();
-}
-
-bool web::json::value::has_double_field(const utility::string_t& key) const
-{
-    return has_field(key) && at(key).is_double();
-}
-
-bool web::json::value::has_boolean_field(const utility::string_t& key) const
-{
-    return has_field(key) && at(key).is_boolean();
-}
-
-bool web::json::value::has_string_field(const utility::string_t& key) const
-{
-    return has_field(key) && at(key).is_string();
-}
-
-bool web::json::value::has_array_field(const utility::string_t& key) const
-{
-    return has_field(key) && at(key).is_array();
-}
-
-bool web::json::value::has_object_field(const utility::string_t& key) const
-{
-    return has_field(key) && at(key).is_object();
-}
-
-utility::string_t json::value::to_string() const
-{
-#ifndef _WIN32
-    utility::details::scoped_c_thread_locale locale;
-#endif
-    return m_value->to_string();
-}
-
-bool json::value::operator==(const json::value& other) const
-{
-    if (this->m_value.get() == other.m_value.get()) return true;
-    if (this->type() != other.type()) return false;
-
-    switch (this->type())
-    {
-        case Null: return true;
-        case Number: return this->as_number() == other.as_number();
-        case Boolean: return this->as_bool() == other.as_bool();
-        case String: return this->as_string() == other.as_string();
-        case Object:
-            return static_cast<const json::details::_Object*>(this->m_value.get())
-                ->is_equal(static_cast<const json::details::_Object*>(other.m_value.get()));
-        case Array:
-            return static_cast<const json::details::_Array*>(this->m_value.get())
-                ->is_equal(static_cast<const json::details::_Array*>(other.m_value.get()));
-    }
-    __assume(0);
-}
-
-void web::json::value::erase(size_t index) { return this->as_array().erase(index); }
-
-void web::json::value::erase(const utility::string_t& key) { return this->as_object().erase(key); }
-
-// at() overloads
-web::json::value& web::json::value::at(size_t index) { return this->as_array().at(index); }
-
-const web::json::value& web::json::value::at(size_t index) const { return this->as_array().at(index); }
-
-web::json::value& web::json::value::at(const utility::string_t& key) { return this->as_object().at(key); }
-
-const web::json::value& web::json::value::at(const utility::string_t& key) const { return this->as_object().at(key); }
-
-web::json::value& web::json::value::operator[](const utility::string_t& key)
-{
-    if (this->is_null())
-    {
-        m_value.reset(new web::json::details::_Object(details::g_keep_json_object_unsorted));
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-        m_kind = value::Object;
-#endif
-    }
-    return m_value->index(key);
-}
-
-web::json::value& web::json::value::operator[](size_t index)
-{
-    if (this->is_null())
-    {
-        m_value.reset(new web::json::details::_Array());
-#ifdef ENABLE_JSON_VALUE_VISUALIZER
-        m_kind = value::Array;
-#endif
-    }
-    return m_value->index(index);
-}
-
-// Remove once VS 2013 is no longer supported.
-#if defined(_WIN32) && _MSC_VER < 1900
-static web::json::details::json_error_category_impl instance;
-#endif
-const web::json::details::json_error_category_impl& web::json::details::json_error_category()
-{
-#if !defined(_WIN32) || _MSC_VER >= 1900
-    static web::json::details::json_error_category_impl instance;
-#endif
-    return instance;
-}

deps/cpprestsdk/src/json/json_serialization.cpp

@@ -1,254 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * HTTP Library: JSON parser and writer
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-
-#include "pch.h"
-
-#include <stdio.h>
-
-#ifndef _WIN32
-#define __STDC_FORMAT_MACROS
-#include <inttypes.h>
-#endif
-
-using namespace web;
-using namespace web::json;
-using namespace utility;
-using namespace utility::conversions;
-
-//
-// JSON Serialization
-//
-
-#ifdef _WIN32
-void web::json::value::serialize(std::ostream& stream) const
-{
-    // This has better performance than writing directly to stream.
-    std::string str;
-    m_value->serialize_impl(str);
-    stream << str;
-}
-void web::json::value::format(std::basic_string<wchar_t>& string) const { m_value->format(string); }
-#endif
-
-void web::json::value::serialize(utility::ostream_t& stream) const
-{
-#ifndef _WIN32
-    utility::details::scoped_c_thread_locale locale;
-#endif
-
-    // This has better performance than writing directly to stream.
-    utility::string_t str;
-    m_value->serialize_impl(str);
-    stream << str;
-}
-
-void web::json::value::format(std::basic_string<char>& string) const { m_value->format(string); }
-
-template<typename CharType>
-void web::json::details::append_escape_string(std::basic_string<CharType>& str,
-                                              const std::basic_string<CharType>& escaped)
-{
-    for (const auto& ch : escaped)
-    {
-        switch (ch)
-        {
-            case '\"':
-                str += '\\';
-                str += '\"';
-                break;
-            case '\\':
-                str += '\\';
-                str += '\\';
-                break;
-            case '\b':
-                str += '\\';
-                str += 'b';
-                break;
-            case '\f':
-                str += '\\';
-                str += 'f';
-                break;
-            case '\r':
-                str += '\\';
-                str += 'r';
-                break;
-            case '\n':
-                str += '\\';
-                str += 'n';
-                break;
-            case '\t':
-                str += '\\';
-                str += 't';
-                break;
-            default:
-
-                // If a control character then must unicode escaped.
-                if (ch >= 0 && ch <= 0x1F)
-                {
-                    static const std::array<CharType, 16> intToHex = {
-                        {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'}};
-                    str += '\\';
-                    str += 'u';
-                    str += '0';
-                    str += '0';
-                    str += intToHex[(ch & 0xF0) >> 4];
-                    str += intToHex[ch & 0x0F];
-                }
-                else
-                {
-                    str += ch;
-                }
-        }
-    }
-}
-
-void web::json::details::format_string(const utility::string_t& key, utility::string_t& str)
-{
-    str.push_back('"');
-    append_escape_string(str, key);
-    str.push_back('"');
-}
-
-#ifdef _WIN32
-void web::json::details::format_string(const utility::string_t& key, std::string& str)
-{
-    str.push_back('"');
-    append_escape_string(str, utility::conversions::to_utf8string(key));
-    str.push_back('"');
-}
-#endif
-
-void web::json::details::_String::format(std::basic_string<char>& str) const
-{
-    str.push_back('"');
-
-    if (m_has_escape_char)
-    {
-        append_escape_string(str, utility::conversions::to_utf8string(m_string));
-    }
-    else
-    {
-        str.append(utility::conversions::to_utf8string(m_string));
-    }
-
-    str.push_back('"');
-}
-
-void web::json::details::_Number::format(std::basic_string<char>& stream) const
-{
-    if (m_number.m_type != number::type::double_type)
-    {
-        // #digits + 1 to avoid loss + 1 for the sign + 1 for null terminator.
-        const size_t tempSize = std::numeric_limits<uint64_t>::digits10 + 3;
-        char tempBuffer[tempSize];
-
-#ifdef _WIN32
-        // This can be improved performance-wise if we implement our own routine
-        if (m_number.m_type == number::type::signed_type)
-            _i64toa_s(m_number.m_intval, tempBuffer, tempSize, 10);
-        else
-            _ui64toa_s(m_number.m_uintval, tempBuffer, tempSize, 10);
-
-        const auto numChars = strnlen_s(tempBuffer, tempSize);
-#else
-        int numChars;
-        if (m_number.m_type == number::type::signed_type)
-            numChars = snprintf(tempBuffer, tempSize, "%" PRId64, m_number.m_intval);
-        else
-            numChars = snprintf(tempBuffer, tempSize, "%" PRIu64, m_number.m_uintval);
-#endif
-        stream.append(tempBuffer, numChars);
-    }
-    else
-    {
-        // #digits + 2 to avoid loss + 1 for the sign + 1 for decimal point + 5 for exponent (e+xxx) + 1 for null
-        // terminator
-        const size_t tempSize = std::numeric_limits<double>::digits10 + 10;
-        char tempBuffer[tempSize];
-#ifdef _WIN32
-        const auto numChars = _sprintf_s_l(tempBuffer,
-                                           tempSize,
-                                           "%.*g",
-                                           utility::details::scoped_c_thread_locale::c_locale(),
-                                           std::numeric_limits<double>::digits10 + 2,
-                                           m_number.m_value);
-#else
-        const auto numChars =
-            snprintf(tempBuffer, tempSize, "%.*g", std::numeric_limits<double>::digits10 + 2, m_number.m_value);
-#endif
-        stream.append(tempBuffer, numChars);
-    }
-}
-
-#ifdef _WIN32
-
-void web::json::details::_String::format(std::basic_string<wchar_t>& str) const
-{
-    str.push_back(L'"');
-
-    if (m_has_escape_char)
-    {
-        append_escape_string(str, m_string);
-    }
-    else
-    {
-        str.append(m_string);
-    }
-
-    str.push_back(L'"');
-}
-
-void web::json::details::_Number::format(std::basic_string<wchar_t>& stream) const
-{
-    if (m_number.m_type != number::type::double_type)
-    {
-        // #digits + 1 to avoid loss + 1 for the sign + 1 for null terminator.
-        const size_t tempSize = std::numeric_limits<uint64_t>::digits10 + 3;
-        wchar_t tempBuffer[tempSize];
-
-        if (m_number.m_type == number::type::signed_type)
-            _i64tow_s(m_number.m_intval, tempBuffer, tempSize, 10);
-        else
-            _ui64tow_s(m_number.m_uintval, tempBuffer, tempSize, 10);
-
-        stream.append(tempBuffer, wcsnlen_s(tempBuffer, tempSize));
-    }
-    else
-    {
-        // #digits + 2 to avoid loss + 1 for the sign + 1 for decimal point + 5 for exponent (e+xxx) + 1 for null
-        // terminator
-        const size_t tempSize = std::numeric_limits<double>::digits10 + 10;
-        wchar_t tempBuffer[tempSize];
-        const int numChars = _swprintf_s_l(tempBuffer,
-                                           tempSize,
-                                           L"%.*g",
-                                           utility::details::scoped_c_thread_locale::c_locale(),
-                                           std::numeric_limits<double>::digits10 + 2,
-                                           m_number.m_value);
-        stream.append(tempBuffer, numChars);
-    }
-}
-
-#endif
-
-const utility::string_t& web::json::details::_String::as_string() const { return m_string; }
-
-const utility::string_t& web::json::value::as_string() const { return m_value->as_string(); }
-
-utility::string_t json::value::serialize() const
-{
-#ifndef _WIN32
-    utility::details::scoped_c_thread_locale locale;
-#endif
-    return m_value->to_string();
-}

deps/cpprestsdk/src/utilities/base64.cpp

@@ -1,260 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-#include "pch.h"
-
-using namespace web;
-using namespace utility;
-
-std::vector<unsigned char> _from_base64(const utility::string_t& str);
-utility::string_t _to_base64(const unsigned char* ptr, size_t size);
-
-std::vector<unsigned char> __cdecl conversions::from_base64(const utility::string_t& str) { return _from_base64(str); }
-
-utility::string_t __cdecl conversions::to_base64(const std::vector<unsigned char>& input)
-{
-    if (input.size() == 0)
-    {
-        // return empty string
-        return utility::string_t();
-    }
-
-    return _to_base64(&input[0], input.size());
-}
-
-utility::string_t __cdecl conversions::to_base64(uint64_t input)
-{
-    return _to_base64(reinterpret_cast<const unsigned char*>(&input), sizeof(input));
-}
-
-static const char* _base64_enctbl = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
-const std::array<unsigned char, 128> _base64_dectbl = {
-    {255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
-     255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 62,
-     255, 255, 255, 63,  52,  53,  54,  55,  56,  57,  58,  59,  60,  61,  255, 255, 255, 254, 255, 255, 255, 0,
-     1,   2,   3,   4,   5,   6,   7,   8,   9,   10,  11,  12,  13,  14,  15,  16,  17,  18,  19,  20,  21,  22,
-     23,  24,  25,  255, 255, 255, 255, 255, 255, 26,  27,  28,  29,  30,  31,  32,  33,  34,  35,  36,  37,  38,
-     39,  40,  41,  42,  43,  44,  45,  46,  47,  48,  49,  50,  51,  255, 255, 255, 255, 255}};
-
-struct _triple_byte
-{
-    unsigned char _1_1 : 2;
-    unsigned char _0 : 6;
-    unsigned char _2_1 : 4;
-    unsigned char _1_2 : 4;
-    unsigned char _3 : 6;
-    unsigned char _2_2 : 2;
-};
-
-struct _double_byte
-{
-    unsigned char _1_1 : 2;
-    unsigned char _0 : 6;
-    unsigned char _2_1 : 4;
-    unsigned char _1_2 : 4;
-};
-
-struct _single_byte
-{
-    unsigned char _1_1 : 2;
-    unsigned char _0 : 6;
-};
-
-//
-// A note on the implementation of BASE64 encoding and decoding:
-//
-// This is a fairly basic and naive implementation; there is probably a lot of room for
-// performance improvement, as well as for adding options such as support for URI-safe base64,
-// ignoring CRLF, relaxed validation rules, etc. The decoder is currently pretty strict.
-//
-
-#ifdef __GNUC__
-// gcc is concerned about the bitfield uses in the code, something we simply need to ignore.
-#pragma GCC diagnostic ignored "-Wconversion"
-#endif
-std::vector<unsigned char> _from_base64(const utility::string_t& input)
-{
-    std::vector<unsigned char> result;
-
-    if (input.empty()) return result;
-
-    size_t padding = 0;
-
-    // Validation
-    {
-        auto size = input.size();
-
-        if ((size % 4) != 0)
-        {
-            throw std::runtime_error("length of base64 string is not an even multiple of 4");
-        }
-
-        for (auto iter = input.begin(); iter != input.end(); ++iter, --size)
-        {
-            const size_t ch_sz = static_cast<size_t>(*iter);
-            if (ch_sz >= _base64_dectbl.size() || _base64_dectbl[ch_sz] == 255)
-            {
-                throw std::runtime_error("invalid character found in base64 string");
-            }
-            if (_base64_dectbl[ch_sz] == 254)
-            {
-                padding++;
-                // padding only at the end
-                if (size > 2)
-                {
-                    throw std::runtime_error("invalid padding character found in base64 string");
-                }
-                if (size == 2)
-                {
-                    const size_t ch2_sz = static_cast<size_t>(*(iter + 1));
-                    if (ch2_sz >= _base64_dectbl.size() || _base64_dectbl[ch2_sz] != 254)
-                    {
-                        throw std::runtime_error("invalid padding character found in base64 string");
-                    }
-                }
-            }
-        }
-    }
-
-    auto size = input.size();
-    const char_t* ptr = &input[0];
-
-    auto outsz = (size / 4) * 3;
-    outsz -= padding;
-
-    result.resize(outsz);
-
-    size_t idx = 0;
-    for (; size > 4; ++idx)
-    {
-        unsigned char target[3];
-        memset(target, 0, sizeof(target));
-        _triple_byte* record = reinterpret_cast<_triple_byte*>(target);
-
-        unsigned char val0 = _base64_dectbl[ptr[0]];
-        unsigned char val1 = _base64_dectbl[ptr[1]];
-        unsigned char val2 = _base64_dectbl[ptr[2]];
-        unsigned char val3 = _base64_dectbl[ptr[3]];
-
-        record->_0 = val0;
-        record->_1_1 = val1 >> 4;
-        result[idx] = target[0];
-
-        record->_1_2 = val1 & 0xF;
-        record->_2_1 = val2 >> 2;
-        result[++idx] = target[1];
-
-        record->_2_2 = val2 & 0x3;
-        record->_3 = val3 & 0x3F;
-        result[++idx] = target[2];
-
-        ptr += 4;
-        size -= 4;
-    }
-
-    // Handle the last four bytes separately, to avoid having the conditional statements
-    // in all the iterations (a performance issue).
-
-    {
-        unsigned char target[3];
-        memset(target, 0, sizeof(target));
-        _triple_byte* record = reinterpret_cast<_triple_byte*>(target);
-
-        unsigned char val0 = _base64_dectbl[ptr[0]];
-        unsigned char val1 = _base64_dectbl[ptr[1]];
-        unsigned char val2 = _base64_dectbl[ptr[2]];
-        unsigned char val3 = _base64_dectbl[ptr[3]];
-
-        record->_0 = val0;
-        record->_1_1 = val1 >> 4;
-        result[idx] = target[0];
-
-        record->_1_2 = val1 & 0xF;
-        if (val2 != 254)
-        {
-            record->_2_1 = val2 >> 2;
-            result[++idx] = target[1];
-        }
-        else
-        {
-            // There shouldn't be any information (ones) in the unused bits,
-            if (record->_1_2 != 0)
-            {
-                throw std::runtime_error("Invalid end of base64 string");
-            }
-            return result;
-        }
-
-        record->_2_2 = val2 & 0x3;
-        if (val3 != 254)
-        {
-            record->_3 = val3 & 0x3F;
-            result[++idx] = target[2];
-        }
-        else
-        {
-            // There shouldn't be any information (ones) in the unused bits.
-            if (record->_2_2 != 0)
-            {
-                throw std::runtime_error("Invalid end of base64 string");
-            }
-            return result;
-        }
-    }
-
-    return result;
-}
-
-utility::string_t _to_base64(const unsigned char* ptr, size_t size)
-{
-    utility::string_t result;
-
-    for (; size >= 3;)
-    {
-        const _triple_byte* record = reinterpret_cast<const _triple_byte*>(ptr);
-        unsigned char idx0 = record->_0;
-        unsigned char idx1 = (record->_1_1 << 4) | record->_1_2;
-        unsigned char idx2 = (record->_2_1 << 2) | record->_2_2;
-        unsigned char idx3 = record->_3;
-        result.push_back(char_t(_base64_enctbl[idx0]));
-        result.push_back(char_t(_base64_enctbl[idx1]));
-        result.push_back(char_t(_base64_enctbl[idx2]));
-        result.push_back(char_t(_base64_enctbl[idx3]));
-        size -= 3;
-        ptr += 3;
-    }
-    switch (size)
-    {
-        case 1:
-        {
-            const _single_byte* record = reinterpret_cast<const _single_byte*>(ptr);
-            unsigned char idx0 = record->_0;
-            unsigned char idx1 = (record->_1_1 << 4);
-            result.push_back(char_t(_base64_enctbl[idx0]));
-            result.push_back(char_t(_base64_enctbl[idx1]));
-            result.push_back('=');
-            result.push_back('=');
-            break;
-        }
-        case 2:
-        {
-            const _double_byte* record = reinterpret_cast<const _double_byte*>(ptr);
-            unsigned char idx0 = record->_0;
-            unsigned char idx1 = (record->_1_1 << 4) | record->_1_2;
-            unsigned char idx2 = (record->_2_1 << 2);
-            result.push_back(char_t(_base64_enctbl[idx0]));
-            result.push_back(char_t(_base64_enctbl[idx1]));
-            result.push_back(char_t(_base64_enctbl[idx2]));
-            result.push_back('=');
-            break;
-        }
-    }
-    return result;
-}

deps/cpprestsdk/src/utilities/web_utilities.cpp

@@ -1,157 +0,0 @@
-/***
- * Copyright (C) Microsoft. All rights reserved.
- * Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
- *
- * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
- *
- * Credential and proxy utilities.
- *
- * For the latest on this and related APIs, please see: https://github.com/Microsoft/cpprestsdk
- *
- * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- ****/
-
-#include "pch.h"
-
-#include <assert.h>
-
-#if defined(_WIN32) && !defined(__cplusplus_winrt)
-#include <Wincrypt.h>
-#endif
-
-#if defined(__cplusplus_winrt)
-#include <robuffer.h>
-#endif
-
-namespace web
-{
-namespace details
-{
-#if defined(_WIN32) && !defined(CPPREST_TARGET_XP)
-#if defined(__cplusplus_winrt)
-
-// Helper function to zero out memory of an IBuffer.
-void winrt_secure_zero_buffer(Windows::Storage::Streams::IBuffer ^ buffer)
-{
-    Microsoft::WRL::ComPtr<IInspectable> bufferInspectable(reinterpret_cast<IInspectable*>(buffer));
-    Microsoft::WRL::ComPtr<Windows::Storage::Streams::IBufferByteAccess> bufferByteAccess;
-    bufferInspectable.As(&bufferByteAccess);
-
-    // This shouldn't happen but if can't get access to the raw bytes for some reason
-    // then we can't zero out.
-    byte* rawBytes;
-    if (bufferByteAccess->Buffer(&rawBytes) == S_OK)
-    {
-        SecureZeroMemory(rawBytes, buffer->Length);
-    }
-}
-
-winrt_encryption::winrt_encryption(const std::wstring& data)
-{
-    auto provider = ref new Windows::Security::Cryptography::DataProtection::DataProtectionProvider(
-        ref new Platform::String(L"Local=user"));
-
-    // Create buffer containing plain text password.
-    Platform::ArrayReference<unsigned char> arrayref(
-        reinterpret_cast<unsigned char*>(const_cast<std::wstring::value_type*>(data.c_str())),
-        static_cast<unsigned int>(data.size()) * sizeof(std::wstring::value_type));
-    Windows::Storage::Streams::IBuffer ^ plaintext =
-        Windows::Security::Cryptography::CryptographicBuffer::CreateFromByteArray(arrayref);
-    m_buffer = pplx::create_task(provider->ProtectAsync(plaintext));
-    m_buffer.then(
-        [plaintext](pplx::task<Windows::Storage::Streams::IBuffer ^>) { winrt_secure_zero_buffer(plaintext); });
-}
-
-plaintext_string winrt_encryption::decrypt() const
-{
-    // To fully guarantee asynchrony would require significant impact on existing code. This code path
-    // is never run on a user's thread and is only done once when setting up a connection.
-    auto encrypted = m_buffer.get();
-    auto provider = ref new Windows::Security::Cryptography::DataProtection::DataProtectionProvider();
-    auto plaintext = pplx::create_task(provider->UnprotectAsync(encrypted)).get();
-
-    // Get access to raw bytes in plain text buffer.
-    Microsoft::WRL::ComPtr<IInspectable> bufferInspectable(reinterpret_cast<IInspectable*>(plaintext));
-    Microsoft::WRL::ComPtr<Windows::Storage::Streams::IBufferByteAccess> bufferByteAccess;
-    bufferInspectable.As(&bufferByteAccess);
-    byte* rawPlaintext;
-    const auto& result = bufferByteAccess->Buffer(&rawPlaintext);
-    if (result != S_OK)
-    {
-        throw ::utility::details::create_system_error(result);
-    }
-
-    // Construct string and zero out memory from plain text buffer.
-    auto data = plaintext_string(
-        new std::wstring(reinterpret_cast<const std::wstring::value_type*>(rawPlaintext), plaintext->Length / 2));
-    SecureZeroMemory(rawPlaintext, plaintext->Length);
-    return std::move(data);
-}
-
-#else
-
-win32_encryption::win32_encryption(const std::wstring& data) : m_numCharacters(data.size())
-{
-    // Early return because CryptProtectMemory crashes with empty string
-    if (m_numCharacters == 0)
-    {
-        return;
-    }
-
-    if (data.size() > (std::numeric_limits<DWORD>::max)() / sizeof(wchar_t))
-    {
-        throw std::length_error("Encryption string too long");
-    }
-
-    const auto dataSizeDword = static_cast<DWORD>(data.size() * sizeof(wchar_t));
-
-    // Round up dataSizeDword to be a multiple of CRYPTPROTECTMEMORY_BLOCK_SIZE
-    static_assert(CRYPTPROTECTMEMORY_BLOCK_SIZE == 16, "Power of 2 assumptions in this bit masking violated");
-    const auto mask = static_cast<DWORD>(CRYPTPROTECTMEMORY_BLOCK_SIZE - 1u);
-    const auto dataNumBytes = (dataSizeDword & ~mask) + ((dataSizeDword & mask) != 0) * CRYPTPROTECTMEMORY_BLOCK_SIZE;
-    assert((dataNumBytes % CRYPTPROTECTMEMORY_BLOCK_SIZE) == 0);
-    assert(dataNumBytes >= dataSizeDword);
-    m_buffer.resize(dataNumBytes);
-    memcpy_s(m_buffer.data(), m_buffer.size(), data.c_str(), dataNumBytes);
-    if (!CryptProtectMemory(m_buffer.data(), dataNumBytes, CRYPTPROTECTMEMORY_SAME_PROCESS))
-    {
-        throw ::utility::details::create_system_error(GetLastError());
-    }
-}
-
-win32_encryption::~win32_encryption() { SecureZeroMemory(m_buffer.data(), m_buffer.size()); }
-
-plaintext_string win32_encryption::decrypt() const
-{
-    // Copy the buffer and decrypt to avoid having to re-encrypt.
-    auto result = plaintext_string(new std::wstring(reinterpret_cast<const std::wstring::value_type*>(m_buffer.data()),
-                                                    m_buffer.size() / sizeof(wchar_t)));
-    auto& data = *result;
-    if (!m_buffer.empty())
-    {
-        if (!CryptUnprotectMemory(&data[0], static_cast<DWORD>(m_buffer.size()), CRYPTPROTECTMEMORY_SAME_PROCESS))
-        {
-            throw ::utility::details::create_system_error(GetLastError());
-        }
-
-        assert(m_numCharacters <= m_buffer.size());
-        SecureZeroMemory(&data[m_numCharacters], data.size() - m_numCharacters);
-        data.erase(m_numCharacters);
-    }
-
-    return result;
-}
-#endif
-#endif
-
-void zero_memory_deleter::operator()(::utility::string_t* data) const
-{
-    CASABLANCA_UNREFERENCED_PARAMETER(data);
-#if defined(_WIN32)
-    SecureZeroMemory(&(*data)[0], data->size() * sizeof(::utility::string_t::value_type));
-    delete data;
-#endif
-}
-} // namespace details
-
-} // namespace web

deps/cxxopts.props

@@ -0,0 +1,7 @@
+<Project>
+	<ItemDefinitionGroup>
+		<ClCompile>
+			<AdditionalIncludeDirectories>$(MSBuildThisFileDirectory)cxxopts\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+		</ClCompile>
+	</ItemDefinitionGroup>
+</Project>

deps/expected.props

@@ -0,0 +1,7 @@
+<Project>
+	<ItemDefinitionGroup>
+		<ClCompile>
+			<AdditionalIncludeDirectories>$(MSBuildThisFileDirectory)expected-lite\include\nonstd\;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+		</ClCompile>
+	</ItemDefinitionGroup>
+</Project>

deps/spdlog.props

@@ -0,0 +1,8 @@
+<Project>
+	<ItemDefinitionGroup>
+		<ClCompile>
+			<AdditionalIncludeDirectories>$(MSBuildThisFileDirectory)spdlog\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+			<PreprocessorDefinitions>SPDLOG_WCHAR_TO_UTF8_SUPPORT;SPDLOG_COMPILED_LIB;SPDLOG_WCHAR_FILENAMES;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+		</ClCompile>
+	</ItemDefinitionGroup>
+</Project>

doc/coding/organization.md

@@ -1,26 +0,0 @@
-# Code Organization
-
-## Rules
-
-- **Follow the pattern of what you already see in the code**
-- Try to package new ideas/components into libraries that have nicely defined interfaces
-- Package new ideas into classes or refactor existing ideas into a class as you extend
-
-## Code Overview
-
-General project organization:
-
-#### The [`deps`](/deps) folder
-Contains other projects that PowerToys uses as dependencies.
-
-#### The [`doc`](/doc) folder
-Documentation for the project, including a [coding guide](/doc/coding) and [design docs](/doc/specs).
-
-#### The [`installer`](/installer) folder
-Contains the source code of the PowerToys installer.
-
-#### The [`src`](/src) folder
-Contains the source code of the PowerToys runner and of all of the PowerToys modules. **This is where the most of the magic happens.**
-
-#### The [`tools`](/tools) folder
-Various tools used by PowerToys. Includes the Visual Studio 2019 project template for new PowerToys.

doc/coding/style.md

@@ -1,5 +0,0 @@
-# Coding Style
-
-## Philosophy
-1. If it's inserting something into the existing classes/functions, try to follow the existing style as closely as possible.
-1. If it's brand new code or refactoring a complete class or area of the code, please follow as Modern C++ of a style as you can and reference the [C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines) as much as you possibly can.

doc/devdocs/akaLinks.md

@@ -0,0 +1,47 @@
+# Full list of aka links
+
+| ShortUrl | TargetUrl |
+|----------|----------|
+| getpowertoys | ms-windows-store://pdp/?productid=XP89DCGQ3K6VLD |
+| installpowertoys | https://github.com/microsoft/PowerToys/releases/latest |
+| powertoys-license | https://github.com/microsoft/PowerToys/blob/main/LICENSE |
+| powertoys | https://github.com/microsoft/PowerToys |
+| PowerToysAppCompat | https://github.com/microsoft/PowerToys/wiki/Application-Compatibility |
+| powerToysCannotRemapKeys | https://docs.microsoft.com/windows/powertoys/keyboard-manager#keys-that-cannot-be-remapped |
+| powerToysColorPickerImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/ColorPicker_small.png |
+| powerToysColorPickerSettingImage | https://raw.githubusercontent.com/microsoft/PowerToys/main/doc/images/overview/ColorPicker_large.png |
+| powertoysDetectedElevatedHelp | https://docs.microsoft.com/windows/powertoys/administrator |
+| powertoys-docs | https://docs.microsoft.com/windows/powertoys/?WT.mc_id=twitter-0000-docsmsft |
+| powerToysFancyZoneImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/FancyZones_small.png |
+| powerToysFancyZoneSettingImage | https://raw.githubusercontent.com/microsoft/PowerToys/main/doc/images/overview/FancyZones_large.png |
+| powerToysGiveFeedback | https://github.com/microsoft/PowerToys/issues |
+| powerToysImageResizerImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/ImageResizer_small.png |
+| powerToysImageResizerSettingImage | https://raw.githubusercontent.com/microsoft/PowerToys/main/doc/images/overview/ImageResizer_large.png |
+| powerToysKBMImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/KBM_small.png |
+| powerToysKBMSettingImage | https://raw.githubusercontent.com/microsoft/PowerToys/main/doc/images/overview/KBM_large.png |
+| PowerToysOverview | https://docs.microsoft.com/windows/powertoys/ |
+| PowerToysOverview_ColorPicker | https://docs.microsoft.com/windows/powertoys/color-picker |
+| PowerToysOverview_FancyZones | https://docs.microsoft.com/windows/powertoys/fancyzones |
+| PowerToysOverview_FileExplorerAddOns | https://docs.microsoft.com/windows/powertoys/file-explorer |
+| PowerToysOverview_ImageResizer | https://docs.microsoft.com/windows/powertoys/image-resizer |
+| PowerToysOverview_KeyboardManager | https://docs.microsoft.com/windows/powertoys/keyboard-manager |
+| PowerToysOverview_MouseUtilities | https://docs.microsoft.com/windows/powertoys/mouse-utilities |
+| PowerToysOverview_PowerRename | https://docs.microsoft.com/windows/powertoys/powerrename |
+| PowerToysOverview_PowerToysRun | https://docs.microsoft.com/windows/powertoys/run |
+| PowerToysOverview_ShortcutGuide | https://docs.microsoft.com/windows/powertoys/shortcut-guide |
+| PowerToysOverview_VideoConference | https://docs.microsoft.com/windows/powertoys/video-conference-mute |
+| powerToysPowerLauncherImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/PowerLauncher_small.png |
+| powerToysPowerLauncherSettingImage | https://raw.githubusercontent.com/microsoft/PowerToys/main/doc/images/overview/PowerLauncher_large.png |
+| powerToysPowerPreviewImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/PowerPreview_small.png |
+| powerToysPowerPreviewSettingImage | https://raw.githubusercontent.com/microsoft/PowerToys/main/doc/images/overview/PowerPreview_large.png |
+| powerToysPowerRenameImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/PowerRename_small.png |
+| powerToysPowerRenameSettingImage | https://raw.githubusercontent.com/microsoft/PowerToys/main/doc/images/overview/PowerRename_large.png |
+| powerToysPTImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/PT_small.png |
+| powerToysPTSettingImage | https://raw.githubusercontent.com/microsoft/PowerToys/main/doc/images/overview/PT_large.png |
+| powerToysReportBug | https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=Issue-Bug%2CTriage-Needed&template=bug_report.yml&title= |
+| powerToysRequestFeature | https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=&template=feature_request.md&title= |
+| powerToysShortcutGuideImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/ShortcutGuide_small.png |
+| powerToysShortcutGuideSettingImage | https://raw.githubusercontent.com/microsoft/PowerToys/main/doc/images/overview/ShortcutGuide_large.png |
+| powerToysVideoConferenceImageSmall | https://github.com/microsoft/PowerToys/wiki/images/overview/VideoConference_small.png |
+| powerToysVideoConferenceSettingImage | https://github.com/microsoft/PowerToys/wiki/images/overview/VideoConference_large.png |
+| powertoyswiki | https://github.com/microsoft/PowerToys/wiki |

doc/devdocs/common.md

@@ -0,0 +1,100 @@
+# Classes and structures
+
+#### class Animation: [header](/src/common/animation.h) [source](/src/common/animation.cpp)
+Animation helper class with two easing-in animations: linear and exponential.
+
+#### class AsyncMessageQueue: [header](/src/common/async_message_queue.h)
+Header-only asynchronous message queue. Used by `TwoWayPipeMessageIPC`.
+
+#### class TwoWayPipeMessageIPC: [header](/src/common/two_way_pipe_message_ipc.h)
+Header-only asynchronous IPC messaging class. Used by the runner to communicate with the settings window.
+
+#### class DPIAware: [header](/src/common/dpi_aware.h) [source](/src/common/dpi_aware.cpp)
+Helper class for creating DPI-aware applications.
+
+#### struct MonitorInfo: [header](/src/common/monitors.h) [source](/src/common/monitors.cpp)
+Class for obtaining information about physical displays connected to the machine.
+
+#### class Settings, class PowerToyValues, class CustomActionObject: [header](/src/common/settings_objects.h) [source](/src/common/settings_objects.cpp)
+Classes used to define settings screens for the PowerToys modules.
+
+#### class Tasklist: [header](/src/common/tasklist_positions.h) [source](/src/common/tasklist_positions.cpp)
+Class that can detect the position of the windows buttons on the taskbar. It also detects which window will react to pressing `WinKey + number`.
+
+#### struct WindowsColors: [header](/src/common/windows_colors.h) [source](/src/common/windows_colors.cpp)
+Class for detecting the current Windows color scheme.
+
+# Helpers
+
+#### Common helpers: [header](/src/common/common.h) [source](/src/common/common.cpp)
+Various helper functions.
+
+#### Settings helpers: [header](/src/common/settings_helpers.h)
+Helper methods for the settings.
+
+#### Start visible helper: [header](/src/common/start_visible.h) [source](/src/common/start_visible.cpp)
+Contains function to test if the Start menu is visible.
+
+# Toast Notifications
+
+#### Notifications API [header](/src/common/notifications.h) [source](/src/common/notifications.cpp)
+To use UWP-style toast notifications, simply include the header and call one of these functions:
+
+```cpp
+    void show_toast(std::wstring_view message);       // #1
+    
+    void show_toast_background_activated(             // #2
+      std::wstring_view message,
+      std::wstring_view background_handler_id,
+      std::vector<std::wstring_view> button_labels);
+```
+We might add more functions in the future if the need arises, e.g. `show_toast_xml` which will accept raw XML for rich customization.
+
+Description:
+- `#1` is for sending simple notifications without any callbacks or buttons
+- `#2` is capable of showing a toast with multiple buttons and background activation
+- `message` is a plain-text argument
+
+Implement a toast activation handler/callback as a function in [handler_functions.cpp](/src/common/notifications_winrt/handler_functions.cpp) and register its `background_handler_id` via `handlers_map`, e.g.:
+
+```cpp
+// Your .cpp where you'd like to show a toast
+
+#include <common/notifications.h>
+
+void some_func() {
+// ...
+  notifications::show_toast_background_activated(
+    L"Toast message!",                                                  // text displayed in a toast
+    L"awesome_toast",                                                   // activation handler id
+    {L"Press me!", L"Also could press me!", L"I'm here to be pressed!"} // buttons in a toast
+  );
+```
+
+```cpp
+// handler_functions.cpp
+void awesome_toast_handler(IBackgroundTaskInstance, const size_t button_id)
+{
+  switch(button_id)
+  {
+    case 0:
+      // handle "Press me!" button click
+    case 1:
+      // handle "Also could press me!" button click
+    case 2:
+      // handle "I'm here to be pressed!" button click
+  }
+}
+
+namespace
+{
+  const std::unordered_map<std::wstring_view, handler_function_t> handlers_map = {
+    // ...other handlers...
+    {L"awesome_toast", awesome_toast_handler}
+  };}
+
+```
+
+Note: since _background activation_ implies that your toast handler will be invoked in a separate process, you can't share data directly from within a handler and your PT process. Also, since PT is currently a Desktop Bridge app, _foreground activation_ is [handled the same as background](https://docs.microsoft.com/en-US/windows/uwp/design/shell/tiles-and-notifications/send-local-toast-desktop-cpp-wrl#foreground-vs-background-activation), therefore we don't make a dedicated API for it. You can read more on the rationale of the current design [here](https://github.com/microsoft/PowerToys/pull/1178#issue-368768337).
+
+

doc/devdocs/embedded-msix.md

@@ -0,0 +1,30 @@
+# How to integrate new MSIX module with PowerToys Settings and WiX installer
+[`issue_11705_with_example` branch](https://github.com/microsoft/PowerToys/tree/issue_11705_with_example) contains HelloWorld UWP C# MSIX application which reads its module settings and is installed along PowerToys.
+
+## Steps
+- uncomment everything near "TODO: Use to activate embedded MSIX" comments
+- build PowerToys solution
+- deploy HelloModule module and sign it with a self-signed certificate (don't forget to put it into a trusted store)
+- build PowerToysSetup solution and install it
+
+Type HelloModule into start search and observe that it was installed:
+
+<img src="../images/msix/hello-module-start.png">
+
+Open PowerToys settings and change the stub setting to something:
+
+<img src="../images/msix/hello-module-settings-page.png">
+
+Open HelloModule:
+
+<img src="../images/msix/hello-module-screen.png">
+
+First time you press "Load Settings", it'll detect that it doesn't have permissions to access local file system and open its system settings window, toggle it there:
+
+<img src="../images/msix/hello-module-app-permissions.png">
+
+(it's a known uwp limitation, see https://stackoverflow.com/a/53533414/657390)
+
+HelloModule will close then, restart it, press "Load Settings" and you should see that the application was able to load the setting string which was set by the settings app:
+
+<img src="../images/msix/hello-module-loaded-settings.png">

doc/devdocs/guidance.md

@@ -0,0 +1,69 @@
+# Coding Guidance
+
+## Working With Strings
+
+In order to support localization **YOU SHOULD NOT** have hardcoded UI display strings in your code. Instead, use resource files to consume strings. 
+
+### For CPP
+Use [`StringTable` resource][String Table] to store the strings and resource header file(`resource.h`) to store Id's linked to the UI display string. Add the strings with Id's referenced from the header file to the resource-definition script file. You can use [Visual Studio Resource Editor][VS Resource Editor] to create and manage resource files.
+
+- `resource.h`:
+
+XXX must be a unique int in the list (mostly the int ID of the last string id plus one):
+
+```cpp
+#define IDS_MODULE_DISPLAYNAME                    XXX
+```
+
+- `StringTable` in resource-definition script file `validmodulename.rc`:
+
+```
+STRINGTABLE
+BEGIN
+    IDS_MODULE_DISPLAYNAME               L"Module Name"
+END
+```
+
+- Use the `GET_RESOURCE_STRING(UINT resource_id)` method to consume strings in your code.
+```cpp
+#include <common.h>
+
+std::wstring GET_RESOURCE_STRING(IDS_MODULE_DISPLAYNAME)
+```
+
+### For C#
+Use [XML resource file(.resx)][Resx Files] to store the UI display strings and [`Resource Manager`][Resource Manager] to consume those strings in the code. You can use [Visual Studio][Resx Files VS] to create and manage XML resources files.
+
+- `Resources.resx`
+
+```xml
+  <data name="ValidUIDisplayString" xml:space="preserve">
+    <value>Description to be displayed on UI.</value>
+    <comment>This text is displayed when XYZ button clicked.</comment>
+  </data>
+```
+
+- Use [`Resource Manager`][Resource Manager] to consume strings in code.
+```csharp
+System.Resources.ResourceManager manager = new System.Resources.ResourceManager(baseName, assembly);
+string validUIDisplayString = manager.GetString("ValidUIDisplayString", resourceCulture);
+```
+
+In case of Visual Studio is used to create the resource file. Simply use the `Resources` class in auto-generated `Resources.Designer.cs` file to access the strings which encapsulate the [`Resource Manager`][Resource Manager] logic.
+
+```csharp
+string validUIDisplayString = Resources.ValidUIDisplayString;
+```
+
+## More On Coding Guidance
+Please review these brief docs below relating to our coding standards etc.
+
+* [Coding Style](./style.md)
+* [Code Organization](./readme.md)
+
+
+[VS Resource Editor]: https://docs.microsoft.com/en-us/cpp/windows/resource-editors?view=vs-2019
+[String Table]: https://docs.microsoft.com/en-us/windows/win32/menurc/stringtable-resource
+[Resx Files VS]: https://docs.microsoft.com/en-us/dotnet/framework/resources/creating-resource-files-for-desktop-apps#resource-files-in-visual-studio
+[Resx Files]: https://docs.microsoft.com/en-us/dotnet/framework/resources/creating-resource-files-for-desktop-apps#resources-in-resx-files
+[Resource Manager]: https://docs.microsoft.com/en-us/dotnet/api/system.resources.resourcemanager?view=netframework-4.8

doc/devdocs/localization.md

@@ -0,0 +1,176 @@
+# Localization
+
+> **NOTE**: THIS DOCUMENT IS OUTDATED.
+> Follow [issue 15243](https://github.com/microsoft/PowerToys/issues/15243) for updates.
+
+## Table of Contents
+1. [Localization on the pipeline (CDPX)](#localization-on-the-pipeline-cdpx)
+    1. [UWP Special case](#uwp-special-case)
+2. [Enabling localization on a new project](#enabling-localization-on-a-new-project)
+    1. [C++](#c)
+    2. [C#](#c-1)
+    3. [UWP](#uwp)
+3. [Lcl Files](#lcl-files)
+4. [Possible Issues in localization PRs (LEGO)](#possible-issues-in-localization-prs-lego)
+5. [Enabling localized MSI for a new project](#enabling-localized-msi-for-a-new-project)
+
+## Localization on the pipeline (CDPX)
+[The localization step](https://github.com/microsoft/PowerToys/blob/86d77103e9c69686c297490acb04775d43ef8b76/.pipelines/pipeline.user.windows.yml#L45-L52) is run on the pipeline before the solution is built. This step runs the [build-localization](https://github.com/microsoft/PowerToys/blob/main/.pipelines/build-localization.cmd) script, which generates resx files for all the projects with localization enabled using the `Localization.XLoc` package.
+
+The [`Localization.XLoc`](https://github.com/microsoft/PowerToys/blob/86d77103e9c69686c297490acb04775d43ef8b76/.pipelines/build-localization.cmd#L24-L25) tool is run on the repo root, and it checks for all occurrences of `LocProject.json`. Each localized project has a `LocProject.json` file in the project root, which contains the location of the English resx file, list of languages for localization, and the output path where the localized resx files are to be copied to. In addition to this, some other parameters can be set, such as whether the language ID should be added as a folder in the file path or in the file name. When the CDPX pipeline is run, the localization team is notified of changes in the English resx files. For each project with localization enabled, a `loc` folder (see [this](https://github.com/microsoft/PowerToys/tree/main/src/modules/launcher/Microsoft.Launcher/loc) for example) is created in the same directory as the `LocProject.json` file. The folder contains language specific folders which in turn have a nested folder path equivalent to `OutputPath` in the `LocProject.json`. Each of these folders contain one `lcl` file. The `lcl` files contain the English resources along with their translation for that language. These are described in more detail [here](#lcl-files). Once the `.resx` files are generated, they will be used during the `Build PowerToys` step for localized versions of the modules.
+
+Since the localization script requires certain nuget packages, the [`restore-localization`](https://github.com/microsoft/PowerToys/blob/main/.pipelines/restore-localization.cmd) script is run before running `build-localization` to install all the required packages. This script must [run in the `restore` step](https://github.com/microsoft/PowerToys/blob/86d77103e9c69686c297490acb04775d43ef8b76/.pipelines/pipeline.user.windows.yml#L37-L39) of pipeline because [the host is network isolated](https://onebranch.visualstudio.com/Pipeline/_wiki/wikis/Pipeline.wiki/2066/Consuming-Packages-in-a-CDPx-Pipelinhttps://onebranch.visualstudio.com/Pipeline/_wiki/wikis/Pipeline.wiki/2066/Consuming-Packages-in-a-CDPx-Pipeline?anchor=overview) at the `build` step. The [Toolset package source](https://github.com/microsoft/PowerToys/blob/86d77103e9c69686c297490acb04775d43ef8b76/.pipelines/pipeline.user.windows.yml#L23) is used for this.
+
+The process and variables that can be tweaked on the pipeline are described in more detail [here](https://onebranch.visualstudio.com/Pipeline/_wiki/wikis/Pipeline.wiki/290/Localization).
+
+The localized resource dlls for C# projects are added to the MSI only for build on the pipeline. This is done by checking if the [`IsPipeline` variable is defined](https://github.com/microsoft/PowerToys/blob/f92bd6ffd38014c228544bb8d68d0937ce4c2b6d/installer/PowerToysSetup/Product.wxs#L804-L805), which gets defined before building the installer on the pipeline [here](https://github.com/microsoft/PowerToys/blob/f92bd6ffd38014c228544bb8d68d0937ce4c2b6d/.pipelines/build-installer.cmd#L4). This is done because the localized resx files are only present on the pipeline, and not having this check would result in the installer project failing to build locally.
+
+### UWP Special case
+C# projects normally expect localized resource files with the language id in the file name as Resources.`langId`.resx, where `langId` is generally a two character code except for language with specific variants (like zh-Hans or pt-BR):
+
+For example, `path\Resources.resx` for English and `path\Resources.fr.resx` for French.
+
+UWP differs from this as it expects the resources to have the same Resources.resw file name, but they should be present in language specific folders, with the full language ID (such as fr-fr, zh-hans, pt-br, etc.)
+
+For example, `path\en-us\Resources.resw` for English and `path\fr-fr\Resources.resw` for French.
+
+Since the pipeline generates it in this format, [a script is run](https://github.com/microsoft/PowerToys/blob/86d77103e9c69686c297490acb04775d43ef8b76/.pipelines/build-localization.cmd#L29-L31) to move these resw files to the correct format expected by all UWP projects. Currently the only UWP project is [Settings.UI](https://github.com/microsoft/PowerToys/tree/main/src/core/Settings.UI). The script used for moving the resources can be [found here](https://github.com/microsoft/PowerToys/blob/main/tools/localization/move_uwp_resources.ps1). The equivalent full language IDs for each shortened language ID obtained from the pipeline has been hardcoded in the script.
+
+## Enabling localization on a new project
+To enable localization on a new project, the first step is to create a file `LocProject.json` in the project root.
+
+For example, for a project in the folder `src\path` where the resx file is present in `resources\Resources.resx`, the LocProject.json file will contain the following:
+```
+{
+    "Projects": [
+        {
+            "LanguageSet": "Azure_Languages",
+            "LocItems": [
+                {
+                    "SourceFile": "src\\path\\resources\\Resources.resx",
+                    "CopyOption": "LangIDOnName",
+                    "OutputPath": "src\\path\\resources"
+                }
+            ]
+        }
+    ]
+}
+```
+The rest of the steps depend on the project type and are covered in the sections below. The steps to add the localized files to the MSI can be found [here](#Enabling-localized-MSI-for-a-new-project).
+
+### C++
+C++ projects do not support `resx` files, and instead use `rc` files along with `resource.h` files. The CDPX pipeline however doesn't support localizing `rc` files and the other alternative they support is directly translating the resources from the binary which makes it harder to maintain resources. To avoid this, a custom script has been added which expects a resx file and converts the entries to an rc file with a string table and adds resource declarations to a resource.h file so that the resources can be compiled with the C++ project.
+
+If you already have a .rc file, copy the string table to a separate txt file and run the [convert-stringtable-to-resx.ps1](https://github.com/microsoft/PowerToys/blob/main/tools/build/convert-stringtable-to-resx.ps1) script on it. This script is not very robust to input, and requires the data in a specific format, where `IDS_ResName L"ResourceValue"` and any number of spaces can be present in between. The script converts this file to the format expected by [`resgen`](https://docs.microsoft.com/en-us/dotnet/framework/tools/resgen-exe-resource-file-generator#Convert), which will convert it to resx. The resource names are changed from all uppercase to title case, and the `IDS_` prefix is removed. Escape characters might have to be manually replaced, for example .rc files would have escaped double quotes as `""`, so this should be replaced with just `"` before converting to the resx files.
+
+After generating the resx file, rename the existing rc and h files to ProjName.base.rc and resource.base.h. In the rc file remove the string table which is to be localized and in the .h file remove all `#define`s corresponding to localized resources. In the vcxproj of the C++ project, add the following build event:
+```
+<Target Name="GenerateResourceFiles" BeforeTargets="PrepareForBuild">
+    <Exec Command="powershell -NonInteractive -executionpolicy Unrestricted $(SolutionDir)tools\build\convert-resx-to-rc.ps1 $(MSBuildThisFileDirectory) resource.base.h resource.h ProjName.base.rc ProjName.rc" />
+</Target>
+```
+
+This event runs a script which generates a resource.h and ProjName.rc in the `Generated Files` folder using the strings in all the resx files along with the existing information in resource.base.h and ProjName.base.rc. The script can be found [here](https://github.com/microsoft/PowerToys/blob/main/tools/build/convert-resx-to-rc.ps1). The script uses [`resgen`](https://docs.microsoft.com/en-us/dotnet/framework/tools/resgen-exe-resource-file-generator#Convert) to convert the resx file to a string table expected in the .rc file format. When the resources are added to the rc file the `IDS_` prefix is added and resource names are in upper case (as it was originally). Any occurrences of `"` in the string resource is escaped as `""` to prevent build errors. The string tables are added to the rc file in the following format:
+```
+#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU)
+LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US
+
+STRINGTABLE
+BEGIN
+    strings
+END
+
+#endif
+```
+Since there is no API to identify the `AFX_TARG_*`, `LANG_*` or `SUBLANG_*` values from each langId from the pipeline, these are hardcoded in the script (for each language) as done [here](https://github.com/microsoft/PowerToys/blob/f92bd6ffd38014c228544bb8d68d0937ce4c2b6d/tools/build/convert-resx-to-rc.ps1#L50-L77). **If any other languages are added in the future, this script will have to be updated.** In order to determine what are the language codes, you can open the rc file in Resource View, right click the string table and press `Insert Copy` and choose the corresponding language. This autogenerates the required code and can be used to figure out the language codes. The files also add the resource declarations to a resource.h file, starting from 101 by default(this can be changed by an optional argument). Since the output files will be generated in `Generated Files`, any includes in these two files will require an additional `..\` and wherever resource.h is used, it will have to be included as `Generated Files\resource.h`. While adding `resource.base.h` and `ProjName.base.rc` to the vcxproj, these should be modified to not participate in the build to avoid build errors:
+```
+<None Include="Resources.resx" />
+```
+
+Some rc/resource.h files might be used in multiple projects (for example, KBM). To ensure the projects build for these cases, the build event can be added to the entire directory so that the rc files are generated before any project is built. See [Directory.Build.targets](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/Directory.Build.targets) for an example.
+
+Check [this PR](https://github.com/microsoft/PowerToys/pull/6104) for an example for making these changes for a C++ project.
+
+### C#
+Since C# projects natively support `resx` files, the only step required here is to include all the resx files in the build. For .NET Core projects this is done automatically and the .csproj does not need to be modified. For other projects, the following line needs to be added:
+```
+<EmbeddedResource Include="Properties\Resources.*.resx" />
+```
+
+**Note:** Building with localized resources may cause a build warning `Referenced assembly 'mscorlib.dll' targets a different processor` which is a VS bug. More details can be found [here](https://github.com/microsoft/PowerToys/issues/7269).
+
+**Note:** If a project needs to be migrated from XAML resources to resx, the easiest way to convert the resources would be to change to format to `=` separates resources by either manually (by Ctrl+H on a text editor), or by a script, and then running [`resgen`](https://docs.microsoft.com/en-us/dotnet/framework/tools/resgen-exe-resource-file-generator#Convert) on `Developer Command Prompt for VS` to convert it to resx format.
+```
+<system:String x:Key="wox_plugin_calculator_plugin_name">Calculator</system:String>
+<system:String x:Key="wox_plugin_calculator_plugin_description">Allows to do mathematical calculations.(Try 5*3-2 in Wox)</system:String>
+<system:String x:Key="wox_plugin_calculator_not_a_number">Not a number (NaN)</system:String>
+```
+to
+```
+wox_plugin_calculator_plugin_name=Calculator
+wox_plugin_calculator_plugin_description=Allows to do mathematical calculations.(Try 5*3-2 in Wox)
+wox_plugin_calculator_not_a_number=Not a number (NaN)
+```
+After adding the resx file to the project along with the resource generator, references to the strings will have to be replaced with `Properties.Resources.resName` rather than the custom APIs. Check [this PR](https://github.com/microsoft/PowerToys/pull/6165) for an example of the changes required.
+
+### UWP
+UWP projects expect `resw` files rather than `resx` (the format is almost the same). Unlike other C# projects, the files are expected in the format `fullLangId\Resources.resw`. To include these files in the build, replace the following line in the csproj:
+```
+<PRIResource Include="Strings\en-us\Resources.resw" />
+```
+to
+```
+<PRIResource Include="Strings\*\Resources.resw" />
+```
+
+## Lcl Files
+Lcl files contain all the resources that are present in the English resx file, along with a translation if it has been added.
+
+For example, an entry for a resource in the lcl file looks like this:
+```
+<Item ItemId=";EditKeyboard_WindowName" ItemType="0;.resx" PsrId="211" Leaf="true">
+    <Str Cat="Text">
+        <Val><![CDATA[Remap keys]]></Val>
+        <Tgt Cat="Text" Stat="Loc" Orig="New">
+            <Val><![CDATA[Remapper des touches]]></Val>
+        </Tgt>
+    </Str>
+    <Disp Icon="Str" />
+</Item>
+```
+The `<Tgt>` element would not be present in the initial commits of the lcl files, as only the English version of the string would be present.
+
+**Note:** The CDPX Localization system has a fail-safe check on the lcl files, where if the English string value which is present inside `<Val><![CDATA[*]]></Val>` does not match the value present in the English Resources.resx file then the translated value will not be copied to the localized resx file. This is present so that obsolete translations would not be loaded when the English resource has changed, and the English string will be used rather than the obsolete translation.
+
+## Possible Issues in localization PRs (LEGO)
+Since the LEGO PRs update some of the strings in LCL files at a time, there can be multiple PRs which modify the same files, leading to merge conflicts. In most cases this would show up on GitHub as a merge conflict, but sometimes a bad git merge may occur, and the file could end up with incorrect formatting, such as two `<Tgt>` elements for a single resource. These can be fixed by ensuring the elements follow the format described in [this section](#lcl-files). To catch such errors, the build farm should be run for every LEGO PR and if any error occurs in the localization step, we should check the corresponding resx/lcl files for conflicts.
+
+## Enabling localized MSI for a new project
+For C++ and UWP projects no additional files are generated with localization that need to be added to the MSI. For C++ projects all the resources are added to the dll/exe, while for UWP projects they are added to the `resources.pri` file (which is present even for an unlocalized project). To verify if the localized resources are added to the `resources.pri` file the following steps can be done:
+- Open `Developer Command Prompt for VS`
+- After navigating to the folder containing the pri file, run the following command:
+
+        makepri.exe dump /if .\resources.pri
+- Check the contents of the `resources.pri.xml` file that is generated from the command. The last section of the file will contain the resources with the strings in all the languages:
+```
+<NamedResource name="GeneralSettings_RunningAsAdminText" uri="ms-resource://f4f787a5-f0ae-47a9-be89-5408b1dd2b47/Resources/GeneralSettings_RunningAsAdminText">
+    <Candidate qualifiers="Language-FR" type="String">
+        <Value>Running as administrator</Value>
+    </Candidate>
+    <Candidate qualifiers="Language-EN-US" isDefault="true" type="String">
+        <Value>Running as administrator</Value>
+    </Candidate>
+</NamedResource>
+```
+
+For C# projects, satellite dlls are generated when the project is built. For a project named `ProjName`, files are created in the format `langId\ProjName.resources.dll` where `langId` is in the same format as the lcl files. The satellite dlls need to be included with the MSI, but they must be added only if the solution is built from the build farm, as the localized resx files will not be present on local machines (and that could cause local builds of the installer to fail).
+This can be done by adding the directory name of the project [here](https://github.com/microsoft/PowerToys/blob/f92bd6ffd38014c228544bb8d68d0937ce4c2b6d/installer/PowerToysSetup/Product.wxs#L806) and a resource component for the project can be created [here](https://github.com/microsoft/PowerToys/blob/f92bd6ffd38014c228544bb8d68d0937ce4c2b6d/installer/PowerToysSetup/Product.wxs#L845-L847) in this format:
+```
+<Component Id="ProjName_$(var.IdSafeLanguage)_Component" Directory="Resource$(var.IdSafeLanguage)ProjNameInstallFolder">
+    <File Id="ProjName_$(var.IdSafeLanguage)_File" Source="$(var.BinX64Dir)modules\ProjName\$(var.Language)\ProjName.resources.dll" />
+</Component>
+```
+
+We should also ensure the new dlls are signed by the pipeline. Currently all dlls of the form [`*.resources.dll` are signed](https://github.com/microsoft/PowerToys/blob/f92bd6ffd38014c228544bb8d68d0937ce4c2b6d/.pipelines/pipeline.user.windows.yml#L68).
+
+**Note:** The resource dlls should be added to the MSI project only after the initial commit with the lcl files has been done by the Localization team. Otherwise the pipeline will fail as there wouldn't be any resx files to generate the dlls.

doc/devdocs/logging.md

@@ -0,0 +1,9 @@
+# How to use
+
+We use the awesome [spdlog](https://github.com/gabime/spdlog) library for logging as a git submodule under the `deps` directory. To use it in your project, just include [spdlog.props](../../deps/spdlog.props) in a .vcxproj like this:
+
+```xml
+<Import Project="..\..\..\deps\spdlog.props" />
+```
+It'll add the required include dirs and link the library binary itself.
+

doc/devdocs/modules/fancyzones.md

@@ -0,0 +1,85 @@
+## FancyZones Lib
+
+#### [`FancyZones.cpp`](/src/modules/fancyzones/lib/FancyZones.cpp)
+TODO
+
+#### [`Settings.cpp`](/src/modules/fancyzones/lib/Settings.cpp)
+TODO
+
+#### [`trace.cpp`](/src/modules/fancyzones/lib/trace.cpp)
+TODO
+
+#### [`Zone.cpp`](/src/modules/fancyzones/lib/Zone.cpp)
+TODO
+
+#### [`ZoneSet.cpp`](/src/modules/fancyzones/lib/ZoneSet.cpp)
+TODO
+
+#### [`WorkArea.cpp`](/src/modules/fancyzones/lib/WorkArea.cpp)
+TODO
+
+## FancyZones Editor
+
+#### [`App.xaml.cs`](/src/modules/fancyzones/editor/App.xaml.cs)
+TODO
+
+#### [`Properties\AssemblyInfo.cs`](/src/modules/fancyzones/editor/Properties\AssemblyInfo.cs)
+TODO
+
+#### [`CanvasEditor.xaml.cs`](/src/modules/fancyzones/editor/CanvasEditor.xaml.cs)
+TODO
+
+#### [`CanvasEditorWindow.xaml.cs`](/src/modules/fancyzones/editor/CanvasEditorWindow.xaml.cs)
+TODO
+
+#### [`Models\CanvasLayoutModel.cs`](/src/modules/fancyzones/editor/Models\CanvasLayoutModel.cs)
+TODO
+
+#### [`CanvasZone.xaml.cs`](/src/modules/fancyzones/editor/CanvasZone.xaml.cs)
+TODO
+
+#### [`EditorOverlay.xaml.cs`](/src/modules/fancyzones/editor/EditorOverlay.xaml.cs)
+TODO
+
+#### [`EditorWindow.cs`](/src/modules/fancyzones/editor/EditorWindow.cs)
+TODO
+
+#### [`GridEditor.xaml.cs`](/src/modules/fancyzones/editor/GridEditor.xaml.cs)
+TODO
+
+#### [`GridEditorWindow.xaml.cs`](/src/modules/fancyzones/editor/GridEditorWindow.xaml.cs)
+TODO
+
+#### [`Models\GridLayoutModel.cs`](/src/modules/fancyzones/editor/Models\GridLayoutModel.cs)
+TODO
+
+#### [`GridResizer.xaml.cs`](/src/modules/fancyzones/editor/GridResizer.xaml.cs)
+TODO
+
+#### [`GridZone.xaml.cs`](/src/modules/fancyzones/editor/GridZone.xaml.cs)
+TODO
+
+#### [`Models\LayoutModel.cs`](/src/modules/fancyzones/editor/Models/LayoutModel.cs)
+TODO
+
+#### [`LayoutPreview.xaml.cs`](/src/modules/fancyzones/editor/LayoutPreview.xaml.cs)
+TODO
+
+#### [`MainWindow.xaml.cs`](/src/modules/fancyzones/editor/MainWindow.xaml.cs)
+TODO
+
+#### [`Properties\Resources.Designer.cs`](/src/modules/fancyzones/editor/Properties/Resources.Designer.cs)
+TODO
+
+#### [`RowColInfo.cs`](/src/modules/fancyzones/editor/RowColInfo.cs)
+TODO
+
+#### [`Models\Settings.cs`](/src/modules/fancyzones/editor/Models/Settings.cs)
+TODO
+
+#### [`Properties\Settings.Designer.cs`](/src/modules/fancyzones/editor/Properties/Settings.Designer.cs)
+TODO
+
+#### [`WindowLayout.xaml.cs`](/src/modules/fancyzones/editor/WindowLayout.xaml.cs)
+TODO
+

doc/devdocs/modules/interface.md

@@ -0,0 +1,134 @@
+# Interface definition
+
+```cpp
+class PowertoyModuleIface {
+public:
+  virtual const wchar_t* get_name() = 0;
+  virtual const wchar_t** get_events() = 0;
+  virtual bool get_config(wchar_t* buffer, int *buffer_size) = 0;
+  virtual void set_config(const wchar_t* config) = 0;
+  virtual void call_custom_action(const wchar_t* action) {};
+  virtual void enable() = 0;
+  virtual void disable() = 0;
+  virtual bool is_enabled() = 0;
+  virtual void destroy() = 0;
+};
+
+typedef PowertoyModuleIface* (__cdecl *powertoy_create_func)();
+```
+
+# Runtime logic
+
+The PowerToys runner will, for each PowerToy DLL:
+  - load the DLL,
+  - call [`powertoy_create()`](#powertoy_create_func) to create the PowerToy.
+
+On the received object, the runner will call:
+  - [`get_name()`](#get_name) to get the name of the PowerToy,
+  - [`enable()`](#enable) to initialize the PowerToy.
+
+While running, the runner might call the following methods between create_powertoy()
+and destroy():
+  - [`disable()`](#disable)/[`enable()`](#enable)/[`is_enabled()`](#is_enabled) to change or get the PowerToy's enabled state,
+  - [`get_config()`](#get_config) to get the available configuration settings,
+  - [`set_config()`](#set_config) to set settings after they have been edited in the Settings editor,
+  - [`call_custom_action()`](#call_custom_action) when the user selects a custom action in the Settings editor,
+
+When terminating, the runner will:
+  - call [`disable()`](#disable),
+  - call [`destroy()`](#destroy) which should free all the memory and delete the PowerToy object,
+  - unload the DLL.
+
+
+# Method definition
+
+This section contains a more detailed description of each of the interface methods.
+
+## powertoy_create_func
+
+```cpp
+typedef PowertoyModuleIface* (__cdecl *powertoy_create_func)()
+```
+
+Typedef of the factory function that creates the PowerToy object.
+Must be exported by the DLL as `powertoy_create()`.
+
+Called by the PowerToys runner to initialize each PowerToy.
+It will be called only once before a call to [`destroy()`](#destroy) is made.
+
+The returned PowerToy should be in the disabled state. The runner will call the [`enable()`](#enable) method to start the PowerToy.
+
+In case of errors returns `nullptr`.
+
+## get_name
+
+```cpp
+virtual const wchar_t* get_name()
+```
+
+Returns the name of the PowerToy, it will be cached by the runner.
+
+## get_config
+
+```
+virtual bool get_config(wchar_t* buffer, int *buffer_size)
+```
+
+Fills a buffer with the available configuration settings.
+
+If `buffer` is a null pointer or the buffer size is not large enough sets the required buffer size in 'buffer_size' and return false.
+
+Returns true if successful.
+
+## set_config
+
+```cpp
+virtual void set_config(const wchar_t* config)
+```
+
+After the user has changed the module settings in the Settings editor, the runner calls this method to pass to the module the updated values. It's a good place to save the settings as well.
+
+## call_custom_action
+
+```cpp
+  virtual void call_custom_action(const wchar_t* action)
+```
+
+Calls a custom action in response to the user pressing the custom action button in the Settings editor.
+This can be used to spawn custom editors defined by the PowerToy.
+
+## enable
+
+```cpp
+  virtual void enable()
+```
+
+Enables the PowerToy.
+
+## disable
+
+```cpp
+  virtual void disable()
+```
+
+Disables the PowerToy, should free as much memory as possible.
+
+## is_enabled
+
+```cpp
+  virtual bool is_enabled() = 0;
+```
+
+Returns the PowerToy state.
+
+## destroy
+
+```cpp
+  virtual void destroy()
+```
+Destroy the PowerToy and free all memory.
+
+# Code organization
+
+### [`powertoy_module_interface.h`](/src/modules/interface/powertoy_module_interface.h)
+Contains the PowerToys interface definition.

doc/devdocs/modules/keyboardmanager/README.md

@@ -0,0 +1,6 @@
+# Table of Contents
+The devdocs for Keyboard Manager have been divided into the following modules:
+1. [Keyboard Manager Module](keyboardmanager.md)
+2. [Keyboard Event Handlers](keyboardeventhandlers.md)
+3. [Keyboard Manager UI](keyboardmanagerui.md)
+4. [Keyboard Manager Common](keyboardmanagercommon.md)

doc/devdocs/modules/keyboardmanager/keyboardeventhandlers.md

@@ -0,0 +1,84 @@
+# Keyboard Event Handlers (Remapping Logic)
+This file contains documentation for all the methods involved in key/shortcut remapping.
+
+## Table of Contents:
+1. [HandleSingleKeyRemapEvent](#HandleSingleKeyRemapEvent)
+2. [HandleShortcutRemapEvent](#HandleShortcutRemapEvent)
+3. [HandleOSLevelShortcutRemapEvent](#HandleOSLevelShortcutRemapEvent)
+4. [HandleAppSpecificShortcutRemapEvent](#HandleAppSpecificShortcutRemapEvent)
+5. [HandleSingleKeyToggleToModEvent (Obsolete))](#HandleSingleKeyToggleToModEvent-(Obsolete---Code-from-PoC-which-is-commented-out))
+6. [Tests](#Tests)
+    1. [MockedInput](#MockedInput)
+    2. [Tests for single key remaps and shortcut remaps](#Tests-for-single-key-remaps-and-shortcut-remaps)
+
+## HandleSingleKeyRemapEvent
+[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L13-L124) is used for handling the key to key and key to shortcut remapping logic. The general logic is as follows:
+- Check if the `dwExtraInfo` field contains the `KEYBOARDMANAGER_INJECTED_FLAG` bit set. This bit is used to indicate that the key event was generated by KBM using `SendInput`. This ensures that we don't read events generated by the key or shortcut remap methods.
+- Check if the current key is present in the list of remaps. If it isn't, return 0 (i.e. do not suppress the event).
+- If it is remapped to Disable, suppress the event.
+- If it is remapped to a key, we send the key down/up message for the target key and suppress the current key event. We have a check for filtering artificial keys, such as `VK_WIN` (which is a keycode added by us), so that it is translated to `VK_LWIN` instead.
+- If it is remapped to a shortcut, for key down we set the target modifiers first, followed by the target action key, and for key up we release the action key first, followed by the modifiers.
+- All the remapped key events that we send above are sent with `KEYBOARDMANAGER_SINGLEKEY_FLAG` on the `dwExtraInfo` field.
+
+## HandleShortcutRemapEvent
+[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L178-L739) is used for handling the shortcut to shortcut and shortcut to key remapping logic. The general logic is as follows:
+- Check if any shortcut remap is currently invoked. This is required to ensure that two remaps don't occur simultaneously at a time, and we send key up events for the shortcuts only if they are actually invoked and not for artificial key up events. In addition to that, while a remap is in the middle of execution, the keyboard state will not match the physical keys, so we do not want a remap <kbd>Ctrl+A</kbd> to <kbd>Ctrl+V</kbd> to also trigger the remap from <kbd>Ctrl+V</kbd> to <kbd>Alt+V</kbd> on pressing <kbd>Ctrl+A</kbd> on the keyboard.
+- Get the remap table as per the the `activatedApp` argument (i.e. if it is empty, we get the global shortcut remap table and otherwise we get the corresponding app-specific shortcut remap table).
+- Iterate over the list of remaps in descending order of number of keys in the shortcut. This is required **for shortcut to key remaps** to ensure that if a user has both <kbd>Ctrl+A</kbd> and <kbd>Ctrl+Shift+A</kbd> remapped to some keys, and the user presses <kbd>Ctrl+Shift+A</kbd>, then we prefer the <kbd>Ctrl+Shift+A</kbd> remap. This logic would not be required if there were only shortcut to shortcut remaps, as they are invoked only on exact match.
+- If any shortcut was found to be invoked (from the first step), then we skip till we find the matching shortcut remap. If not we check if the modifiers of the original shortcut are pressed down. If they are, we check if the current key event is a key down event and it matches the action key of the original shortcut. For shortcut to shortcut and for disabling a shortcut [we have an additional step](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L208-L212) where we check if any other key is pressed apart from the original shortcut. This is required because for these two features we allow the remaps only if those exact keys are pressed. The method used for this is described in detail [here](keyboardmanagercommon.md#IsKeyboardStateClearExceptShortcut). If a win key was pressed, we store whether it was the left or the right one, in order to determine which key to set for remaps from/to the common Win key code which we added. This is so that pressing and releasing Left Win key results in that Win key getting modified and not the Right Win key.
+    - If the remap is to a key, we send a dummy key event followed by releasing the original shortcut's modifiers and setting the target key (or doing nothing if it is remapped to disable) and we suppress the event.
+    - If the remap is to a shortcut, if the modifiers in the original shortcut are present in the target, we only set the additional modifiers and the action key of the target. If it isn't, we send a dummy key event followed by releasing the modifiers which are not common, and setting the remaining ones in the target along with the action key.
+    - For both cases, we set the `isShortcutInvoked` flag to true, and set the `KeyboardManagerState.activatedApp` if it is an app-specific shortcut remap.
+- For the `isShortcutInvoked` is true scenario (i.e. the initial remap keydown section is done) there are several cases depending on the key pressed or released:
+    - [**Case 1:**](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L339-L430) If a modifier in the original shortcut is released, we need to reset back to the physical keys pressed.
+        - For remap to shortcut, we release the target action key if it is currently pressed, and depending on whether all the modifiers of the original shortcut are present in the target, we release the target modifiers that are not common, and set the remaining original shortcut modifiers except the one that was released. We do not need to send the original action key as that will get generate it's own key event if it is held down.
+        - For remap to key, we release the target key if it is pressed (and it is not remapped to Disable), and we set the original shortcut modifiers.
+        - For both the cases we send a dummy key event at the end, since we are setting modifiers without any other key after that, and we reset all the remap variables.
+    - [**Case 2:**](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L435-L461) If the original shortcut's action key is pressed again, we send the target shortcut's action key or the target key again (or for disable we just suppress the event).
+    - [**Case 3:**](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L463-L527) If the original shortcut's action key is released
+        - For remap to shortcut, we just release the target shortcut's action key
+        - For remap to disable, we suppress the event
+        - For remap to key, we check if any other keys are pressed apart from the target key. If not, we just release the target key. If there are, we reset back to the physical keys by releasing the target key and setting the original shortcut's modifiers along with a dummy key, and we reset all the remap variables. This behavior is different from remap to shortcut because if the action key is released while other keys are pressed the remap should be inactive, but such a state can't occur for shortcut to shortcut remaps since they happen only when the exact keys are pressed.
+    - [**Case 4:**](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L529-L551) If a modifier in the original shortcut is pressed, suppress the event
+    - [**Case 5:**](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L553-L732) If any other key is pressed
+        - For remap to shortcut, we need to reset back to physical keys as the shortcut remaps can't be pressed in combination with other keys. We release the target action key if it was pressed, and we release the modifier keys of the target shortcut that are not common and set the remaining ones in the original shortcut. We then send the original shortcut's action key if the target action key was found to be pressed, and we send the current key press at the end.
+        - For remap to key, if it is remapped to disable or if the target key is not found to be pressed, we reset to the physical keys, we set the original shortcut's modifiers and if is remap to Disable and the original shortcut's action key is physically pressed (this is checked by the `isOriginalActionKeyPressed` flag which we keep track of whenever the action key is pressed or released for remap to Disable), then we set the original shortcut's action key, followed by the current key press. If it is not remapped to disable and the target key is pressed, then we don't suppress the event as we allow shortcut to key remappings to be pressed along with other keys.
+        - For all the above cases, dummy key isn't required as we want the current key press to behave like a normal key.
+    - [**Case 6:**](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L733) If any other key is released, do not suppress the event as this event didn't appear with a corresponding key down event (such as an app sending a key up event) or we processed the key down and let it continue (for shortcut to key scenario).
+- All the remapped key events that we send above are sent with `KEYBOARDMANAGER_SHORTCUT_FLAG` on the `dwExtraInfo` field, except the usage of the current key press in Case 5, for which we don't send any extra info so that it is considered as a normal key event which may in turn invoke some other remap.
+
+**Note:** Shortcuts are considered valid if they have modifiers and an action key. The reason why we haven't supported key combinations of just modifiers (which is requested in this [issue](https://github.com/microsoft/PowerToys/issues/5670)) (like remapping <kbd>Ctrl+Alt</kbd>) is because this would require more cases and handling as these remappings have to take place only on press and release and if there is no key pressed in between similar to what Start Menu does. The remapping would have to be invoked only for this specific sequence <kbd>Ctrl</kbd> key down, <kbd>Alt</kbd> key down, <kbd>Alt</kbd> key up, <kbd>Ctrl</kbd> key up (ordering between Ctrl and Alt can be swapped). If any other key is pressed in between it shouldn't be invoked, and since this logic requires tracking exact states instead of using GetAsyncKeyStates, this could cause false positives if a user is not running as admin.
+
+## HandleOSLevelShortcutRemapEvent
+[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L741-L752) is used for handling global shortcut to shortcut and shortcut to key remaps. The general logic is as follows:
+- Check if the `dwExtraInfo` field is set to `KEYBOARDMANAGER_SHORTCUT_FLAG`. This indicates that the key event was generated by the KBM shortcut remap method using `SendInput`. This ensures that we don't read events generated by the shortcut remap method, but we still read events which are generated by the key remap method.
+- Call `HandleShortcutRemapEvent` without the `activatedApp` argument so that global shortcut remapping takes place if it applies for the current key event.
+
+## HandleAppSpecificShortcutRemapEvent
+[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L754-L809) is used for handling app-specific shortcut to shortcut and shortcut to key remaps. The general logic is as follows:
+- Check if the `dwExtraInfo` field is set to `KEYBOARDMANAGER_SHORTCUT_FLAG`. This indicates that the key event was generated by the KBM shortcut remap method using `SendInput`. This ensures that we don't read events generated by the shortcut remap method, but we still read events which are generated by the key remap method.
+- Get the name of the process in the foreground. This is done using `GetCurrentApplication` which uses `GetForegroundWindow` to get the window handle and `get_process_path` from the common lib. This approach can fail for UWP apps in full screen, so for that scenario we use the `GetGUIThreadInfo` approach to find the correct window handle, and hence the correct process name. This method is described in more detail [here](keyboardmanagercommon.md#Foreground-app-detection)
+- By checking `KeyboardManagerState.GetActivatedApp` we check if an app-specific shortcut is currently invoked. If so, we consider this application to be the activated app. This is required because some shortcut remaps could cause the current app to lose focus and hence until the shortcut is completely released we should allow that remap to continue, otherwise the user could end up in a state where some keys do not get released. For example: remap <kbd>Ctrl+A</kbd> to <kbd>Alt+Tab</kbd> for Edge, when a user presses <kbd>Ctrl+A</kbd> the window loses focus as <kbd>Alt+Tab</kbd> gets executed.
+- If there is no app-specific shortcut currently invoked, we check if the foreground process is present in the list of app-specific remaps, either with or without the file extension and case insensitive. If it is, this is considered to be the activated app.
+- Call `HandleShortcutRemapEvent` with the `activatedApp` argument so that app-specific shortcut remapping takes place if it applies for the current key event.
+
+## HandleSingleKeyToggleToModEvent (Obsolete - Code from PoC which is commented out)
+[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L126-L176) was added to support a feature for converting the behavior of a key from behaving like a toggle (like Caps Lock/Num Lock) to a modifier (like Ctrl), such that when you hold Caps Lock it would behave as if Caps Lock was active, and when it was not pressed Caps Lock would be off. For Caps Lock this would be similar to behaving like Shift, but for Num Lock there is no existing key which can substitute for this. This was added while testing out remapping for the KBM PoC, but wasn't added as a feature since it wasn't a priority.
+
+## Tests
+In order to test the remapping logic, a mocked keyboard input handler had to be created because otherwise the tests would process and send actual key events. For this the [`InputInterface`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/InputInterface.h) was made, and in production code the methods are implemented using [`SendInput`](https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-sendinput) and [`GetAsyncKeyState`](https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getasynckeystate). In addition to this, [`GetCurrentApplication`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L226-L268) had to be mocked so that app-specific remapping can be tested.
+
+### MockedInput
+The [`MockedInput`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/test/MockedInput.h) class uses a 256 size `bool` vector to store the key state for each key code. Identifying the foreground process is mocked by simply setting and getting a string value for the name of the current process.
+
+[To mock the `SendInput` method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/test/MockedInput.cpp#L10-L110), the steps for processing the input are as follows. This implementation is based on public documentation for SendInput and the behavior of key messages and keyboard hooks:
+- Iterate over all the inputs in the INPUT array argument
+- If the event is a key up event, then it is considered [`WM_SYSKEYUP`](https://docs.microsoft.com/en-us/windows/win32/inputdev/wm-syskeyup) if Alt is held down, otherwise it is `WM_KEYUP`.
+- If the event is a key down event, then it is considered [`WM_SYSKEYDOWN`](https://docs.microsoft.com/en-us/windows/win32/inputdev/wm-syskeydown) if either Alt is held down or if it is F10, otherwise it is `WM_KEYDOWN`.
+- An optional function which can be set on the `MockedInput` handler can be used to test for the number of times a key event is received by the system with a particular condition using [`sendVirtualInputCallCondition`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/test/MockedInput.cpp#L48-L52).
+- The hook logic for a low level hook which returns 0 or 1 can be set on the `MockedInput` handler such that it behaves like a low level hook would behave with actual keyboard input. If the method returns 1, then the keyboard state is not updated, and if it returns 0 the corresponding key event is used to update the key state. This works in the recursive way as well similar to low level hooks, as `SendVirtualInput` can be called from within the hook, thus simulating identical behavior to calling `SendInput` in a low level hook (as soon as SendInput is called, the low level hook is called for the new input event, and only after those are processed it returns back to the current event, check this [blog](https://devblogs.microsoft.com/oldnewthing/20140213-00/?p=1773) for more details).
+- For updating the keyboard state, KEYUP messages result in the state for that key code being set to false, and KEYDOWN result in the state for that key code being set to true.
+- For modifiers the behavior is slightly different as if the key state of the L/R version is modified, it should also modify the common version, and if a common version is released, it should release both the L and R versions.
+
+### Tests for single key remaps and shortcut remaps
+Using the MockedInput handler, all the expected (and known) key scenarios that can occur for while pressing a [remapped key](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/test/SingleKeyRemappingTests.cpp) or [remapped shortcut](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/test/OSLevelShortcutRemappingTests.cpp) are tested. The foreground app behavior which is specific to app-specific shortcuts is tested [here](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/test/AppSpecificShortcutRemappingTests.cpp).

doc/devdocs/modules/keyboardmanager/keyboardmanager.md

@@ -0,0 +1,199 @@
+# Keyboard Manager module
+This file contains the documentation for the KeyboardManager PowerToy module which is called by the runner.
+## Table of Contents:
+1. [Class members](#Class-members)
+2. [Enable/Disable](#Enable/disable)
+3. [Settings format](#Settings-format)
+4. [Loading settings](#Loading-settings)
+5. [Low level keyboard hook handler](#Low-level-keyboard-hook-handler)
+6. [Custom Action to launch KBM UI](#Custom-Action-to-launch-KBM-UI)
+7. [SendInput Special Scenarios](#SendInput-Special-Scenarios)
+    1. [Extended keys](#Extended-keys)
+    2. [Scan code](#Scan-code)
+8. [Special Scenarios](#Special-Scenarios)
+    1. [Dummy key events](#Dummy-key-events)
+    2. [Suppressing Num Lock in a keyboard hook](#Suppressing-Num-Lock-in-a-keyboard-hook)
+    3. [Modifier-Caps Lock interaction on Japanese IME keyboards](#Modifier-Caps-Lock-interaction-on-Japanese-IME-keyboards)
+    4. [UIPI Issues (not resolved)](#UIPI-Issues-(not-resolved))
+9. [Other remapping approaches](#Other-remapping-approaches)
+    1. [Registry approach](#Registry-approach)
+    2. [Driver approach](#Driver-approach)
+10. [Telemetry](#Telemetry)
+
+## Class members
+The `KeyboardManager` module has [3 main class members](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L54-L61):
+- A static pointer to the current object of `KeyboardManager`. This is required for using the `KeyboardManager` object in the low level keyboard hook handler as that method must be static. This is described in more detail in [this section](#Low-level-keyboard-hook-handler).
+- An object of type `Input`, which is used for all the operations that involving getting or setting keyboard states. This is wrapped in an object to allow testing the remapping methods.
+- An object of type `KeyboardManagerState`. This object contains all the data related to remappings and is also used in the sense of a View Model as it used to communicate common data that is shared between the KBM UI and the backend. This class is described in more detail [here](keyboardmanagercommon.md#keyboardmanagerstate).
+
+## Enable/Disable
+On enabling KBM, the low level keyboard hook is started, and it is unhooked on disable. This is done to allow users to manually restart KBM if some other application which registers a keyboard hook was launched after PowerToys, so that it can be brought back to the highest priority hook (as the last hook to be registered receives the input first as mentioned [here](https://docs.microsoft.com/en-us/windows/win32/winmsg/about-hooks#hook-procedures)).
+
+In addition to stopping the hook, any active KBM UI windows are also closed on disabling. This is done because the KBM UI uses the same keyboard hook for the Type button where you can type a key/shortcut, so if KBM is disabled the windows would not be completely functional.
+
+The enable/disable code can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L301-L322)
+
+## Settings format
+KBM uses two sets of settings files. 
+- The main `settings.json` is of the following format:
+
+        {
+            "properties":
+            {
+                "activeConfiguration":
+                {
+                    "value":"default"
+                },
+                "keyboardConfigurations":
+                {
+                    "value":["default"]
+                }
+            },
+            "name":"Keyboard Manager",
+            "version":"1"
+        }
+
+    - The `activeConfiguration` attribute stores the current remapping profile, while `keyboardConfigurations` stores all the profiles that the user has. This was added to avoid any future breaking changes for the [profiles feature](https://github.com/microsoft/PowerToys/issues/1881), which would allow users to switch between remappings
+- The profile format (`default.json`) is of the following format:
+
+        {
+            "remapKeys":
+            {
+                "inProcess":
+                [
+                    {
+                        "originalKeys":"91",
+                        "newRemapKeys":"162;70"
+                    },
+                    {
+                        "originalKeys":"92",
+                        "newRemapKeys":"162;70"
+                    }
+                ]
+            },
+            "remapShortcuts":
+            {
+                "global":
+                [
+                    {
+                        "originalKeys":"164;37",
+                        "newRemapKeys":"162;65"
+                    },
+                    {
+                        "originalKeys":"162;68",
+                        "newRemapKeys":"91"
+                    }
+                ],
+                "appSpecific":
+                [
+                    {
+                        "originalKeys":"91;162;65",
+                        "newRemapKeys":"162;86",
+                        "targetApp":"msedge"
+                    }
+                ]
+            }
+        }
+
+    - `originalKeys` stores the key/shortcut which is to be pressed for the remap, and `newKeys` stores the key/shortcut which is to be executed.
+    - Both contain semi-colon separated virtual key codes. For `remapKeys`, `originalKeys` must have only one key code, whereas for `remapShortcuts` it must have atleast two key codes.
+    - `inProcess` sub-key was added in `remapKeys` because there was a possibility of adding the registry based remapping approach (used by [SharpKeys](https://github.com/randyrants/sharpkeys)), so that would be under a separate sub-key while `inProcess` would be for keyboard hook based remaps. This was deprioritized as there weren't enough requests for it.
+    - `remapShortcuts` is split into `global` and `appSpecific`, where `global` remaps would apply to all applications, whereas `appSpecific` would apply on when the `targetApp` is in focus. `targetApp` must be the process name of the app (with or without it's extension), e.g. `msedge` or `msedge.exe` for Microsoft Edge.
+
+## Loading settings
+KBM settings are loaded only on the C++ side only at start up, in the [constructor](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L67-L68). The settings file may get modified from the KBM UI on applying new remappings, but the the file is not read again. The files are read from the PowerToys Settings process whenever a change is made to the file (using a FileWatcher) or whenever the KBM page is opened. The settings are updated only when the user presses the OK button from either of the Remap Keys or Remap Shortcuts windows. This is described in more detail [here](keyboardmanagerui.md#ok-and-cancel-button).
+
+## Low level keyboard hook handler
+Since the [`hook_proc`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L330-L349) cannot be a member function in the class, this is declared `static` and a `static pointer` to the `KeyboardManager` project is used ([`keyboardmanager_object_ptr`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L54-L55)).
+
+As seen in the code for `hook_proc`, similar to other keyboard hooks in PowerToys it consists of a main method `HandleKeyboardHookEvent` which computes whether the key needs to be suppressed and accordingly returns 1 or calls the `CallNextHook` method.
+
+`HandleKeyboardHookEvent` is covered in the [next section](#HandleKeyboardHookEvent). The `SetNumLockToPreviousState` code in the above snippet is required for a special scenario with keyboard input, which is covered in [this section](#Suppressing-Num-Lock-in-a-keyboard-hook).
+
+## HandleKeyboardHookEvent
+The [`HandleKeyboardHookEvent`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L384-L458) is the method which calls the corresponding remapping methods in the required order. The following checks are executed in order:
+- **`KeyboardManagerState.AreRemappingsEnabled`:** This returns false while the KBM remap tables are getting updated. If it is in this state, `HandleKeyboardHookEvent` returns `0`, i.e. the key event is not suppressed and is forwarded normally.
+- **Check for `KEYBOARDMANAGER_SUPPRESS_FLAG`:** If the key event has the suppress flag, the method returns 1 to suppress the key event.
+- **[`KeyboardManagerState.DetectSingleRemapKeyUIBackend`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L399-L408):** This method is used for handling hook operations for the single key Type UI in the Remap keys window. If the Remap keys window is open, then `HandleKeyboardHookEvent` returns `0` and the key event is forwarded normally. If the left column Type button is clicked on the Remap keys window and and the window is in focus, then the key event is suppressed and the UI is updated with the latest key from the recent key events. This method is described in more detail [here](keyboardmanagercommon.md#DetectSingleRemapKeyUIBackend-and-DetectShortcutUIBackend).
+- **[`KeyboardManagerState.DetectShortcutUIBackend(data, true)`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L410-L419):** This method is used for handling hook operations for the shortcut Type UI in the Remap keys window (when `isRemapKey` arg is `true`). If the Remap keys window is open, then `HandleKeyboardHookEvent` returns `0` and the key event is forwarded normally. If the right column Type button is clicked on the Remap keys window and and the window is in focus, then the key event is suppressed and the UI is updated with the shortcut from the recent key events. This method is described in more detail [here](keyboardmanagercommon.md#DetectSingleRemapKeyUIBackend-and-DetectShortcutUIBackend).
+- **`HandleSingleKeyRemapEvent`:** This method handles the single key remap logic. If a remapping takes place, the key event is suppressed. This method is described in more detail [here](keyboardeventhandlers.md#HandleSingleKeyRemapEvent).
+- **[`KeyboardManagerState.DetectShortcutUIBackend(data, false)`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L430-L439):** This method is used for handling hook operations for the shortcut Type UI in the Remap shortcuts window (when `isRemapKey` arg is `false`). If the Remap shortcuts window is open, then `HandleKeyboardHookEvent` returns `0` and the key event is forwarded normally. If the Type button is clicked on the Remap shortcuts window and and the window is in focus, then the key event is suppressed and the UI is updated with the shortcut from the recent key events. **Since this is executed after the single key remap method, all single key remappings are applied when the user is on the Remap shortcuts window.**
+- **`HandleAppSpecificShortcutRemapEvent`:** This method handles the app-specific shortcut remap logic. If a remapping takes place, the key event is suppressed. This method is described in more detail [here](keyboardeventhandlers.md#HandleAppSpecificShortcutRemapEvent). **Since this is executed after the single key remap method, single key remappings have precedence over shortcut remaps and are correspondingly reflected in shortcut remaps.**
+- **`HandleOSLevelShortcutRemapEvent`:** This method handles the global shortcut remap logic. If a remapping takes place, the key event is suppressed. This method is described in more detail [here](keyboardeventhandlers.md#HandleOSLevelShortcutRemapEvent). The app-specific remap method is executed before this because if a shortcut is remapped to different keys/shortcuts for a particular app and globally, the app-specific variant should be preferred if that app is in focus. **Since this is executed after the single key remap method, single key remappings have precedence over shortcut remaps and are correspondingly reflected in shortcut remaps.**
+
+**Note:** Single key remaps need to be executed before shortcut remaps, because otherwise there can be several logical issues. For example if a user has Ctrl remapped to X and Ctrl+A remapped to Y, we can't detect Ctrl+A because the moment Ctrl is pressed it would be remapped to X before the system ever sees Ctrl+A. This is why the design decision was made to separate Remap keys and Remap shortcuts, and all key remaps are reflected in the shortcut remaps.
+
+## Custom Action to launch KBM UI
+KBM uses the [`call_custom_action`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L249-L280) method from the `PowertoyModuleIface` in order to launch the KBM UI when the user clicks the Remap a key or Remap a shortcut button from the KBM settings page. On clicking the button, we check if there is already any active KBM UI window, and if there is it is brought to the foreground. If not, the corresponding KBM UI window is launched on a separate detached thread. The UI is described in more detail [here](keyboardmanagerui.md).
+
+## SendInput Special Scenarios
+
+### Extended keys
+Certain keys such as the arrow keys, <kbd>right Ctrl/Alt</kbd>, and <kbd>Del/Home/Ins</kbd>, etc need to be sent with the `KEYEVENTF_EXTENDEDKEY` flag because otherwise the NumPad versions get sent, which can cause weird behavior when NumLock is on. The code can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L190-L194) and the list of extended keys in code can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L73-L98). Docs about extended keys can be found [here](https://docs.microsoft.com/en-us/windows/win32/inputdev/about-keyboard-input#extended-key-flag). 
+
+The weird behavior that is caused by this can be found at these issues:
+- https://github.com/microsoft/PowerToys/issues/3478
+- https://github.com/microsoft/PowerToys/issues/3647
+- https://github.com/microsoft/PowerToys/issues/3981
+
+### Scan code
+Certain applications (such as Windows Terminal) may filter out key events which are set to scan code 0. Even though the `KEYEVENTF_SCANCODE` flag is not set, the `wScan` field is still sent, which defaults to 0. To avoid this issue we use the `MapVirtualKey` API to find the scan code from the virtual key code. Code can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L196-L198).
+
+## Special Scenarios
+Since we are using low level keyboard hooks and not actual OS level input handling certain scenarios with input require workarounds as do they not interact well with the OS input logic directly. These are covered in the sub-sections below.
+
+### Dummy key events
+To prevent the behavior that some modifiers have that occur when you press and release the modifier without pressing any key in between, we need to send a dummy key event in between the two states. Some examples of this behavior are Win key for Start Menu and Alt key to focus the menu bar. We need to send the dummy key events at any point where an unintentional modifier press/release sequence may occur. We use the undocumented `0xFF` virtual key code for this as we haven't found any side effects of using this key code yet. Initially we used only a key up message, but it has been tweaked now to send a key down followed by key up (code can be found (here)[https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L201-L208]), as without the key down there were [compatibility issues with some apps](https://github.com/microsoft/PowerToys/issues/7133) (like Slack).
+
+The dummy key event is currently used in the following places (the linked code snippets contains an example scenario of why it is required):
+- https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L251-L253
+- https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L289-L291
+- https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L382-L383
+- https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L409-L410
+- https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L509-L510
+
+### Suppressing Num Lock in a keyboard hook
+The <kbd>Num Lock</kbd> key state is updated by the OS before it is intercepted by low level hooks. This causes the issue that even if you suppress a <kbd>Num Lock</kbd> key event, <kbd>Num Lock</kbd> will still get toggled. In order to work around this, in the [`hook_proc`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L340-L344) whenever we suppress a <kbd>Num Lock</kbd> key down event, we send an additional <kbd>Num Lock</kbd> key up followed by key down so that the <kbd>Num Lock</kbd> state is reverted to it's previous value before the suppressed event. These are sent with a `KEYBOARDMANAGER_SUPPRESS_FLAG` in the `dwExtraInfo` field, so that we suppress them at the start of the hook (see code [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L811-L825)). Since these events will update the <kbd>Num Lock</kbd> state before the low level hooks, by suppressing them we ensure that these are not sent to any other hooks/applications and hence are only processed by the OS. 
+
+This assumes that KBM is the last hook to be registered (since another hook-based app like AutoHotkey could remap NumLock to some other key which could mess up this logic).
+
+### Modifier-Caps Lock interaction on Japanese IME keyboards
+While using Japanese IME on Windows, shortcuts like <kbd>Shift/Alt/Ctrl</kbd> + <kbd>Caps Lock</kbd> can be used to switch IME options.
+
+![japanese-ime](japanese-ime.png)
+
+These shortcuts are detected before low level hooks, and hence cause issues while remapping <kbd>Caps Lock</kbd> to <kbd>Shift/Alt/Ctrl</kbd> or vice-versa, as there could be an intermediate state where the system detects both the keys as being pressed. This results in a state where the modifier key does not get released since the OS suppresses the key up messages before they reach the low level hooks.
+
+In order to work around this when a key down for the modifier is being processed, we send a key up for the modifier key with the `KEYBOARDMANAGER_SUPPRESS_FLAG` in the `dwExtraInfo` field, so that we suppress them at the start of the hook, and this key event would only be processed by the OS, without getting forwarded to other hooks/apps. The approach is described in more detail at [this comment](https://github.com/microsoft/PowerToys/issues/3397#issuecomment-640136416), as discussed with the AutoHotkey team. The code for the workaround can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L827-L846). Tests for these scenarios have also been added at:
+- [Tests for workaround on single key remaps](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/test/SingleKeyRemappingTests.cpp#L110-L219)
+- [Tests for workaround on shortcut remaps](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/test/OSLevelShortcutRemappingTests.cpp#L1935-L2144)
+
+For example, while [remapping <kbd>Ctrl</kbd> to <kbd>Caps Lock</kbd>](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L59-L63), before sending the <kbd>Caps Lock</kbd> key down message and suppressing <kbd>Ctrl</kbd>, we send a suppressed <kbd>Ctrl</kbd> key up, so that the OS doesn't see <kbd>Ctrl</kbd> and <kbd>Caps Lock</kbd> pressed together at any point. For the [<kbd>Caps Lock</kbd> to <kbd>Ctrl</kbd> scenario](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L104-L116), we send a suppressed C<kbd>Ctrl</kbd>trl key up message after sending <kbd>Ctrl</kbd> key down before <kbd>Caps Lock</kbd> suppressed. Similar logic is added for such scenarios in shortcut remapping.
+
+While the above work around fixes most of the cases, there are still some scenarios where the modifier can get stuck, mentioned at this [comment](https://github.com/microsoft/PowerToys/issues/3397#issuecomment-663729278), which is why the issue is still open. This occurs if a modifier is pressed after the remap has been invoked before releasing the remapped key and it is a harder scenario to solve which requires refactoring the single key remap code.
+
+### UIPI Issues (not resolved)
+`SendInput` does not work directly with certain key codes such as Play/Pause Media, Calculator key, etc as it requires UAC privileges to be injected to the OS and accordingly play the active media app or launch the Calculator app. In order to resolve this the correct approach is that the executable which calls `SendInput` needs to have the [UIAccess flag](https://docs.microsoft.com/en-us/windows/win32/winauto/uiauto-securityoverview) set to true, which will also avoid the requirement of KBM having to run as administrator to intercept key events when an elevated window is in focus. The UIAccess flag has many constraints such as it must be a signed executable and must be located in a protected path like Program Files. Since KBM currently runs out of the runner process, it would make more sense to do this work after KBM is moved to a separate executable, and it could be enabled by a separate toggle in settings only if PowerToys is installed in Program Files. [This comment](https://github.com/microsoft/PowerToys/issues/3192#issuecomment-646323661) has more details on this approach and (this)[https://github.com/microsoft/PowerToys/issues/3255] is the tracking issue.
+
+## Other remapping approaches
+Other approaches for remapping which were deprioritized are:
+
+### Registry approach
+This method is used by [SharpKeys](https://github.com/randyrants/sharpkeys) and involves using the [Microsoft Keyboard Scancode mapper registry key](https://github.com/randyrants/sharpkeys) to remap keys based on their scan codes. This has the advantage of being applied in all scenarios and not facing any elevation or UAC issues, however the disadvantages are that for modifying the settings the process must run elevated (as it modifies HKLM registry) and it requires a reboot to get applied. Another issue which is an advantage/disadvantage for users is that the process does not need to be running, so the remaps are applied all the time, including at the password prompt on logging in to the user's Windows account, which could get a user stuck if they orphaned a key in their password. This registry doesn't have any support for remapping shortcuts either, so the hook approach was prioritized over this.
+
+### Driver approach
+Using a driver approach has the benefit of not depending on precedence orders as KBM could always run before low level hooks, and it also has the benefit of differentiating between different keyboards, allowing [multi keyboard-specific remaps](https://github.com/microsoft/PowerToys/issues/1460). The disadvantages are however that any bug or crash could have system level consequences. [Interception](https://github.com/oblitum/Interception) is an open source driver that could be used for implementing this. The approach was deprioritized due to the potential side effects.
+
+## Telemetry
+Keyboard Manager emits the following telemetry events (implemented in [trace.h](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/trace.h) and [trace.cpp](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/trace.cpp)):
+- **`KeyboardManager_EnableKeyboardManager`:** Logs a `boolean` value storing the KBM toggle state. It is logged whenever KBM is enabled or disabled (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L305-L316)).
+- **`KeyboardManager_KeyRemapCount`:** Logs the number of key to key and key to shortcut remaps (i.e. all the remaps on the Remap a key window). This gets logged on saving new settings in the Remap a key window (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L159-L163)).
+- **`KeyboardManager_OSLevelShortcutRemapCount`:** Logs the number of global shortcut to shortcut and shortcut to key remaps. This gets logged on saving new settings in the Remap a shortcut window (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L220)).
+- **`KeyboardManager_AppSpecificShortcutRemapCount`:** Logs the number of app-specific shortcut to shortcut and shortcut to key remaps. This gets logged on saving new settings in the Remap a shortcut window (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L221)).
+- **`KeyboardManager_KeyToKeyRemapInvoked`:** Logs an event when a key to key remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L101-L102)).
+- **`KeyboardManager_KeyToShortcutRemapInvoked`:** Logs an event when a key to shortcut remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L101-L102)).
+- **`KeyboardManager_OSLevelShortcutToShortcutRemapInvoked`:** Logs an event when a global shortcut to shortcut remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L320-L321)).
+- **`KeyboardManager_OSLevelShortcutToKeyRemapInvoked`:** Logs an event when a global shortcut to key remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L320-L321)).
+- **`KeyboardManager_AppSpecificShortcutToShortcutRemapInvoked`:** Logs an event when an app-specific shortcut to shortcut remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L320-L321)).
+- **`KeyboardManager_AppSpecificShortcutToKeyRemapInvoked`:** Logs an event when an app-specific shortcut to key remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L320-L321)).
+- **`KeyboardManager_Error`:** Logs the occurrence of an error in KBM with the name of the method, error code and the corresponding error message. This is currently used only for logging `SetWindowsHookEx` failures (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L364-L369)).

doc/devdocs/modules/keyboardmanager/keyboardmanagercommon.md

@@ -0,0 +1,63 @@
+# Keyboard Manager Common
+This project contains any code that is to be shared between the backend and UI projects. This file covers any functionality in this project which hasn't been covered along with the other modules.
+
+## Table of Contents
+1. [KeyboardManagerState](#KeyboardManagerState)
+    1. [UI States](#UI-States)
+    2. [DetectSingleRemapKeyUIBackend and DetectShortcutUIBackend](#DetectSingleRemapKeyUIBackend-and-DetectShortcutUIBackend)
+    3. [HandleKeyDelayEvent](#HandleKeyDelayEvent)
+    4. [Saving remappings to file](#Saving-remappings-to-file)
+    5. [Concurrent Access to remap tables](#Concurrent-Access-to-remap-tables)
+2. [KeyDelay](#KeyDelay)
+3. [Shortcut and RemapShortcut classes](#Shortcut-and-RemapShortcut-classes)
+    1. [IsKeyboardStateClearExceptShortcut](#IsKeyboardStateClearExceptShortcut)
+    2. [CheckModifiersKeyboardState](#CheckModifiersKeyboardState)
+    3. [Tests](#Tests)
+4. [Helpers](#Helpers)
+    1. [Foreground App Detection](#Foreground-App-Detection)
+
+## KeyboardManagerState
+[This class](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/KeyboardManagerState.cpp) stores all the data related to remappings and is also used in the sense of a View Model as it used to communicate common data that is shared between the KBM UI and the backend. They are accessed on the UI controls using static class members of `SingleKeyRemapControl` and `ShortcutControl`.
+
+### UI States
+[UI states](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.h#L27-L42) are used to keep track in which step of the UI flow is the user at, such as which Remap window they are on, or if they have one of the Type windows open. This is required because the hook needs to suppress input and update UI in some cases, and in some cases remappings have to be disabled altogether.
+
+### DetectSingleRemapKeyUIBackend and DetectShortcutUIBackend
+[These methods](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.cpp#L374-L446) are [called on the low level hook](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L399-L408) in the main keyboard event handler. When the user opens any UI window the UI states are updated and in this case some remappings have to be disabled. On the Remap keys window, all remappings are disabled, while on the Remap shortcuts window, shortcut remappings are disabled. 
+
+In addition to this, if the user has opened the Type window, and the window is in focus, [whenever a key event is received we have to update the set of selected keys in the TextBlock](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.cpp#L266-L329) in the ContentDialog. These methods also call the `KeyDelay` handlers to check if the input is Esc/Enter and accordingly handle the Accessibility events for the Type window. When the user clicks the Type button, [variables in the KeyboardManagerState store the corresponding TextBlocks](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/SingleKeyRemapControl.cpp#L375-L376) which appear in the ContentDialog, so that these UI controls can be updated from the hook on the dispatcher thread.
+
+### HandleKeyDelayEvent
+[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.cpp#L482-L498) checks if the UI is in the foreground, and if so runs the key delay handlers that have been registered.
+
+### Saving remappings to file
+The [`SaveConfigToFile`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.cpp#L500-L607) method is called on clicking the OK button on the EditKeyboardWindow or EditShortcutsWindow. Since PowerToys Settings also reads the config JSON file, [a named mutex is used](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.cpp#L582-L600) before accessing the file, with a 1 second timeout. If the mutex is obtained the settings are written to the default.json file.
+
+### Concurrent Access to remap tables
+To prevent the UI thread and low level hook thread from concurrently accessing the remap tables we use an [`atomic bool` variable](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.h#L91-L92), which is set to `true` while the tables are getting updated. When this is `true` the hook will skip all remappings. Use of mutexes in the hook were removed to prevent re-entrant mutex bugs.
+
+## KeyDelay
+[This class](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/KeyDelay.cpp) implements a queue based approach for processing key events and based on the time difference between key down and key up events [executes separate methods for `ShortPress`, `LongPress` or `LongPressReleased`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyDelay.h#L69-L72). The class is used for the hold Enter/Esc functionality required for making the Type window accessible and prevent keyboard traps (see [this](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/SingleKeyRemapControl.cpp#L273-L292) for an example of it's usage). The `KeyEvents` are added to the queue from the hook thread of KBM, and a separate [`DelayThread`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyDelay.cpp#L142-L166) is used to process the key events by checking the `time` member in the key event. The thresholds for short vs long press and hold wait timeouts are `static` constants, but if the module is extended for other purposes these could be made into arguments.
+
+**Note:** [Deletion of the `KeyDelay`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyDelay.cpp#L4-L12) object should never be called from the `DelayThread` i.e. from within one of the 3 handlers, as it can re-enter the mutex and would lead to a deadlock. This can be avoided by either deleting it on a separate thread or as done in the KBM UI, on the dispatcher thread. See [this PR](https://github.com/microsoft/PowerToys/pull/6959#issue-496583547) for more details on this issue.
+
+## Shortcut and RemapShortcut classes
+The [`Shortcut` class](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/Shortcut.h) is a data structure for storing key combinations which are valid shortcuts and it contains several methods which are used for shortcut specific operations. [`RemapShortcut`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/RemapShortcut.h) consists of a shortcut/key union (`std::variant`), along with other boolean flags which are required on the hook side for storing any relevant keyboard states mid-execution.
+
+### IsKeyboardStateClearExceptShortcut
+[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Shortcut.cpp#L665-L813) is used by the `HandleShortcutRemapEvent` to check if any other keys on the keyboard have been pressed apart from the keys in the shortcut. This is required because shortcut to shortcut remaps should not be applied if the shortcut is pressed with other keys. The method iterates over all the possible key codes, except any keys that are considered reserved, unassigned, OEM-specific or undefined, as well as mouse buttons (see list [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Shortcut.cpp#L628-L663)).
+
+### CheckModifiersKeyboardState
+[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Shortcut.cpp#L517-L614) uses `GetVirtualKeyState` (internally calls `GetAsyncKeyState` in production code), to check if all the modifiers of the current shortcut are being pressed. Since Win doesn't have a non-L/R key code we check this by checking both LWIN and RWIN.
+
+### Tests
+Tests for some methods in the `Shortcut` class can be found [here](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/test/ShortcutTests.cpp).
+
+## Helpers
+[This namespace](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/Helpers.cpp) has any methods which are used across either UI or the backend which aren't specific to either. Some of these methods have tests [here](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/test/SetKeyEventTests.cpp).
+
+### Foreground App Detection
+[`GetCurrentApplication`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L226-L268) is used for detecting the foreground process for App-specific shortcuts. The logic is very similar to that used for FZ's app exception feature, involving `GetForegroundWindow` and `get_process_path`. The one additional case which has been added is for full-screen UWP apps, where the above method fails and returns `ApplicationFrameHost.exe`. The [`GetFullscreenUWPWindowHandle`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L210-L224) uses `GetGUIThreadInfo` API to find the window linked to the GUI thread. This logic is based on [this stackoverflow answer](https://stackoverflow.com/questions/39702704/connecting-uwp-apps-hosted-by-applicationframehost-to-their-real-processes/55353165#55353165).
+
+**Note:** The [`GetForegroundProcess` method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/Input.cpp#L17-L21) performs string allocation in a weird way because of exceptions that were occurring while running tests as a result of memory being allocated or deallocated across dll boundaries. Here's the comment from the PR where this was added
+> To make app-specific logic test-able, a GetForegroundProcess was added to the input interface which internally calls GetCurrentApplication. This allows us to mock this method in the test project by just setting some process name as the foreground process for that function. When I set this to just return the string name, it would goes runtime errors on the test project in debug_heap with `__acrt_first_block == header`. Based on [this stackoverflow answer](https://stackoverflow.com/a/35311928), this would happen if allocation happens in one dll's code space and deallocation happens in another. One way to avoid this is to change both the projects to MD (multi threaded dll) instead of MT(multi threaded), however that results in many compile-time errors since all the PT projects are configured as MT. To solve this, the GetForegroundProcess was rewritten such that its argument is the output variable, and we allocate memory for that string within the AppSpecificHandler method rather than in that function.

doc/devdocs/modules/keyboardmanager/keyboardmanagerui.md

@@ -0,0 +1,122 @@
+# Keyboard Manager UI
+
+## Table of Contents:
+1. [C++ XAML Islands](#c---xaml-islands)
+    1. [Debugging exceptions in XAML Islands](#debugging-exceptions-in-xaml-islands)
+    2. [Build times](#build-times)
+    3. [Setting custom backgrounds for Xaml Controls using brushes](#setting-custom-backgrounds-for-xaml-controls-using-brushes)
+2. [UI Structure](#ui-structure)
+3. [EditKeyboardWindow/EditShortcutsWindow](#editkeyboardwindow-editshortcutswindow)
+    1. [OK and Cancel button](#ok-and-cancel-button)
+    2. [Delete button](#delete-button)
+    3. [Handling common modifiers in EditKeyboardWindow](#handling-common-modifiers-in-editkeyboardwindow)
+4. [SingleKeyRemapControl](#singlekeyremapcontrol)
+5. [ShortcutControl](#shortcutcontrol)
+6. [KeyDropDownControl](#keydropdowncontrol)
+    1. [Localized key names](#localized-key-names)
+    2. [Single Key ComboBox Selection Handler](#single-key-combobox-selection-handler)
+    3. [Shortcut ComboBox Selection Handler](#shortcut-combobox-selection-handler)
+
+## C++ XAML Islands
+The KBM UI is implemented as a C++ XAML Island, but all the controls are implemented in code behind rather than .xaml and .xaml.cs files. This was done as per a XAML Island Code sample and it didn't require a separate UWP project, which could be limited in terms of using hooks. There is a [tech debt item](https://github.com/microsoft/PowerToys/issues/2027) for moving this to XAML. The reason it wasn't implemented in the C# Settings was because it required communication with the low level hook thread, which could be too slow if IPC is used, since the UI needs to update on every key event.
+
+**Note:** For functions which take a XAML component as argument, pass it by value and not by reference. This is because `winrt` WinUI classes store their own internal references, so they are supposed to be passed by value (and internally ref counts are incremented). Passing by reference can lead to weird behavior where the object is `null`.
+
+The windows are [created as C++ windows](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L128-L140) and the window sizes are set to default by [scaling them as per DPI](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L120-L126) using the `DPIAware::Convert` API from common lib. Since the UI is launched on a new thread, the window may not be in the foreground, so [we call `SetForegroundWindow`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L146-L150).
+
+`DesktopWindowXamlSource` has to be declared and [it is initialized](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L159-L162) using the [`XamlBridge`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/ui/XamlBridge.cpp), and [a second window handle](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L161-L162) is generated for the internal Xaml Island window. Most of the code was based on the [Xaml Island Sample](https://github.com/microsoft/Xaml-Islands-Samples/blob/master/Samples/Win32/SampleCppApp/XamlBridge.cpp). The `XamlBridge` class contains code which handles initializing the Xaml Island containers as well as handling special messages like keyboard navigation, and focus between islands and between the C++ window and the island. It also has methods for clearing the xaml islands and closing the window.
+
+Once the UI controls are created, the parent container is set as the content for the `DesktopWindowXamlSource` and the `XamlBridge.MessageLoop` is executed. Messages are processed by the C++ window handler like [`EditKeyboardWindowProc`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L364-L404). The general structure we use for this is, for any `WM_PAINT` or `WM_SIZE` message we resize the Xaml Island window. For `WM_GETMINMAXINFO` we set minimum widths so that the window cannot be resized beyond a minimum height and width. This is done to prevent the WinUI elements from overlapping and getting cropped. If it is neither of these cases we send the message to the [`XamlBridge.MessageHandler`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/XamlBridge.cpp#L291-L301) which handles Destroy, Activation and Focus. If `WM_NCDESTROY` is received when the `XamlBridge` is `nullptr`, the window thread is terminated.
+
+**Note:** `ContentDialog` in Xaml Islands requires manually settings a `XamlRoot`. This can generally be done by passing the XamlRoot from a component in the main window, such as the button used to open the dialog ([`sender.as<Button>().XamlRoot()`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/ShortcutControl.cpp#L31-L32)). [These docs]((https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.contentdialog#contentdialog-in-appwindow-or-xaml-islands)) have more details about this.
+
+### Debugging exceptions in XAML Islands
+Sometimes if an exception occurs in XAML Islands, the stack trace may not always point to the correct code causing the exception and instead it will point to the Xaml Island message loop. In these cases the output window in VS will generally show the correct exception.
+
+### Build times
+C++ Xaml Islands generally take several minutes to build because the `pch` which contains the WinUI headers takes longer to build and compiles to a file of several GBs. To minimize the build times, multi-processor compilation within the projects have been enabled (files are distributed for compilation to the processors), and references to the Xaml headers have been removed from the .h headers files as much as possible. Since several classes of ours had class members with UI controls like `StackPanel` (which requires definitions of the classes in order to compile), we worked around this by declaring them as `IInspectable` (the equivalent of an object pointer in winrt), and initializing them to the actual control like `StackPanel` in the constructor and accessing all their member functions by inline typecasting (for `IInspectable x;` we do `x = StackPanel();` and `x.as<StackPanel>().MemberFunction()`). Check [this](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/ShortcutControl.cpp#L19-L25) for this type of usage in `ShortcutControl`.
+
+### Setting custom backgrounds for Xaml Controls using brushes
+To access the brushes available on C# Xaml, it has to be done with the `Resources.Lookup` syntax:
+`primaryButton.Background(Windows::UI::Xaml::Application::Current().Resources().Lookup(box_value(L"SystemControlBackgroundBaseMediumLowBrush")).as<Windows::UI::Xaml::Media::SolidColorBrush>());`
+
+## UI Structure
+The KBM UI consists of a [`Grid` with several columns](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L200-L218). Rows are added dynamically when [the add button is pressed](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L305-L309). [A vector of vector of unique pointers to `SingleKeyRemapControl`/`ShortcutControl`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L248-L249) is created so that references to the UI components and their data are not lost until the window is closed. [`SingleKeyRemapControl`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/ui/SingleKeyRemapControl.cpp) is the UI class for each row of the Remap keys table, and [`ShortcutControl`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/ui/ShortcutControl.cpp) is the UI class for each row of the Remap shortcuts table. [`KeyDropDownControl`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp) is used for handling the ComboBox operations. Each of these two classes [have vectors of unique pointers to the `KeyDropDownControl` objects](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/ShortcutControl.h#L44-L45) so that references to the objects are active until the control is deleted.
+
+When the UI windows are activated the `KeyboardManagerState` object [sets the `UIState` variable](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L251-L252) which is used for distinguishing if the UI is up from the keyboard hook thread. The [states are also updated](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/SingleKeyRemapControl.cpp#L53) on opening and closing the Type window.
+
+Clicking the Type Button [opens a content dialog](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/SingleKeyRemapControl.cpp#L206-L380) which registers key delays using the [`KeyDelay` class](keyboardmanagercommon.md#KeyDelay) for Enter and Esc keys and sets the UI states such that when a key event occurs the TextBlocks on the ContentDialog are updated accordingly. On accepting the dialog the selected keys are copied into the ComboBoxes from the TextBlocks, and on closing the window the key delays are unregistered and UI states are reset.
+
+Since ComboBoxes are added dynamically, handlers have been added which [update the accessible names for these controls](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L69-L74), which get executed whenever a drop down is added or removed.
+
+When the `EditKeyboardWindow`/`EditShortcutsWindow` is created, [we iterate through the remappings](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L254-L262) stored in `KeyboardManagerState` and add rows to the UI Grid. For both the windows we have `static` buffers [`singleKeyRemapBuffer`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/SingleKeyRemapControl.h#L39-L40) and [`shortcutRemapBuffer`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/ShortcutControl.h#L42-L43) which store the corresponding key/shortcuts as per the selections in the UI if they are valid with no warnings.
+
+## EditKeyboardWindow/EditShortcutsWindow 
+
+### OK and Cancel button
+[On pressing the OK button](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L66-L89) in `EditKeyboardWindow`, first the [`CheckIfRemappingsAreValid` method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L10-L44) is executed which performs basic validity checks on the current remappings in the remap buffer (`static SingleKeyRemapControl::singleKeyRemapBuffer`), such as if there are no NULL columns and none of the source keys are repeated. All other validity checks are assumed to happen while the user adds the remapping. If this is found to be invalid a ContentDialog is displayed which shows that some remappings are invalid and if the user proceeds only the valid ones will be applied. If it is valid [`GetOrphanedKeys`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L46-L75) is executed which checks if any keys are orphaned (i.e. the key has been remapped and no other key has been remapped to it, so there is no way to send that key code), and a dialog is shown for notifying the user with a list of orphaned keys. After this the settings are [applied by adding it to the `KeyboardManagerState.singleKeyReMap` member](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L102-L164) and they are saved to the JSON file. `EditShortcutsWindow` differs slightly from this, as there is no orphaned keys check, and [on pressing OK](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditShortcutsWindow.cpp#L32-L47) both the global and app-specific shortcuts are validated and [updated](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L166-L223).
+
+The code used for updating the remapping tables in `KeyboardManagerState` can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.cpp#L104-L183). For shortcut remaps, the `sortedKeys` vectors are updated and re-sorted whenever an element is added to them (like [this](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.cpp#L135-L136)).
+
+On pressing OK (after confirmation dialogs) or Cancel, the window is closed and UI states are reset.
+
+### Delete button
+Since there is no single method to delete the elements in a row for a Grid, [the logic](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/SingleKeyRemapControl.cpp#L143-L188) we use involves decrementing the rowIndex for all the UI controls that appearing after the row to be deleted, and removing each of the items of the row from the Grid, followed by deleting that row definition. We also update the accessible names for all the rows since the indexing has changed. After this the corresponding row in the remap buffer is also deleted, and `SingleKeyRemapControl`/`ShortcutControl` objects are deleted from the vector.
+
+### Handling common modifiers in EditKeyboardWindow
+In the SingleKeyRemap table for a remapping of the form Ctrl->X, where Ctrl is the common version and not L/R, we can't store it directly as Ctrl->X because when the hook receives the key event it only gets LCtrl or RCtrl specifically and not `VK_CONTROL`. To simplify the backend code, when [single key remappings are applied](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L116-L143), any remapping of the form Ctrl->X is split into Ctrl(L)->X and Ctrl(R)->X (i.e. both L and R versions are remapped to the same target), and when remappings are loaded in EditKeyboardWindow, we [pre-process the remap table](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L77-L100) such that if the L and R versions of a modifier are remapped to the same key/shortcut we combine them. This also results in the behavior where a user adds LCtrl->X and RCtrl->X and after closing and re-opening KBM UI it appears combined as Ctrl->X.
+
+## SingleKeyRemapControl
+The left drop down column uses a single ComboBox and the Type button is linked to `createDetectKeyWindow`, whereas the right column is linked to `createDetectShortcutWindow` as the column can accept a key or a shortcut (required to support key to key and key to shortcut). The `KeyDropDownControl` for the left column in the window uses a smaller key list, without `None`.
+
+## ShortcutControl
+Both the columns in are linked to `createDetectShortcutWindow`, however the drop down selection handlers differ in their logic as the left column only allows shortcuts, and the drop downs do not contain the `Disable` key, whereas the right column allows you to select both shortcuts and keys (to support shortcut to shortcut and shortcut to key), and it allows selection of `Disable`.
+
+For the app-specific shortcut target app text-box, we had to validate that the shortcut row is still valid when the target app is changed (for example, <kbd>Ctrl+A</kbd> is remapped for Chrome, and another remapping for <kbd>Ctrl+A</kbd> was remapped to Edge, but the target was changed to Chrome.). For this we didn't use the TextChanged handler as every time a letter is typed it would get executed. Instead we used the [`LostFocus` handler](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/ShortcutControl.cpp#L108-L167) which gets executed whenever you focus into the box (by clicking or tabbing) and then tabbing or clicking out. In the method we perform the same shortcut buffer validation used for selections in the drop down menus and update the buffers accordingly.
+
+## KeyDropDownControl
+Each ComboBox has a linked flyout, which is used to show warnings to the users whenever a user selects an invalid key from the drop down. When the warning is displayed the ComboBox is also reset to -1, i.e. no selection.
+
+For selection handlers on the ComboBoxes we couldn't use just the SelectionChanged handler directly as it gets executed even on searching for elements in the drop down. Instead we used DropDownClosed (when a user opens the drop down and searches and selects something) and SelectionChanged when the drop down is not open (for setting selections programmatically or selection made by searching with tab focus on the drop down without opening it). This was required because if we execute the selection handlers while users are searching, it could cause false positive flyout warnings if the search causes an invalid value to be selected, and flyouts cause the drop down to close leading to bad UI experience.
+
+### Localized key names
+For getting localized key names and symbols for each virtual key code, whenever the key lists are accessed, i.e. [whenever the drop down is opened](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L56-L60) or when `GetKeyName` is called in the Type window, the current `KeyboardLayout` is retrieved to ensure that the displayed key names are always updated. Since the `WM_INPUTLANGCHANGED` event was having some issues with XAML islands we weren't able to use this to update the keyboard layout. In addition to this we do not refresh the UI, so the key lists get updated only on opening/interacting with them.
+
+### Single Key ComboBox Selection Handler
+On making a selection in the drop down, [the selection handler](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L91-L130) validates the input with the buffer from the other column and other rows. Error messages are shown using flyouts if the selection is not considered valid and the drop down and buffer for that entry are reset to empty selection. The errors that can occur on the single key ComboBox are:
+- Remap to same key (A->A)
+- Same key previously remapped (A->B and A->C)
+- Conflicting modifier previously remapped (Ctrl->A and Ctrl(left)->B, since Ctrl also includes Ctrl(left))
+If the selection is found to be valid, the `singleKeyRemapBuffer` is updated accordingly.
+For handling `Shortcut` and key in the remap buffer for the right column, we use `std::variant`, which allows us to store either of the two types and check which one of them is present in the buffer by using the `index` method.
+[`ValidateAndUpdateKeyBufferElement`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/BufferValidationHelpers.cpp#L8-L66) does not reference any UI components and instead takes all the relevant data as arguments. This method [has tests](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/test/BufferValidationTests.cpp) which covers all the cases that could arise from making selections on the UI.
+
+### Shortcut ComboBox Selection Handler
+On making a selection in the drop down, [the selection handler](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L215-L295) validates the input with the buffer from the other column and other rows. Error messages are shown using flyouts if the selection is not considered valid and the drop down and buffer for that entry are reset to empty selection.
+This differs from the Single Key ComboBox handler in the sense that after validating the current selection we may perform [a set of actions](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L160-L204) such as:
+- Adding a drop down (if a modifier is selected)
+- Removing a drop down (if None is selected)
+- Clearing terminal empty drop downs (if an action key is selected in a non-last drop down and the remaining ones are empty)
+
+After performing the corresponding action, if any, we check if the drop down resulted in an error, in which case we do [a second level of validation](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L224-L229) on all the drop downs in that list of drop downs. This is done because there can be cases where an error in one drop down results us setting it to empty, and the remaining selection is also invalid. For example, you have Ctrl+A -> Ctrl+Shift+A, and you change Shift to Ctrl. This would show a warning for having two Ctrls in the shortcut being invalid, after which setting that to empty would result in Ctrl+A->Ctrl+Empty+A, which is a case of remapping a shortcut to itself.
+
+Once this second level of validation is done, we proceed with [updating the buffer](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L231-L251). Depending on the number of drop downs with valid values, this could be either a key or a shortcut (for the right columns). We also [set the buffer value for the target app](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L252-L267) while doing this.
+
+Unlike the Single Key handler, there is a different set of errors that can occur here which are related to making a selection that is considered as a valid shortcut. The `isHybridControl` argument is used to distinguish between the differing behaviors for the two types of columns (shortcut only or shortcut/key column). The errors that can occur for this handler are:
+- Shortcut must start with modifier (selecting A on the first drop for the left column is invalid)
+- Shortcut can't have a repeated modifier (Ctrl+Ctrl(left)+A is not a shortcut)
+- Shortcut can only have upto 2 modifiers (Ctrl+Shift+Alt is not supported as we have enforced a 3 key constraint (**not a backend limitation, there is [an issue](https://github.com/microsoft/PowerToys/issues/3936) requesting to remove this**))
+- Shortcut must contain an action key (Ctrl+A and change A to None, only for left column)
+- Shortcut must have at least two keys (Ctrl+A and change Ctrl to None, only for left column)
+- Disable can't be a modifier or action key (Ctrl+Disable is invalid)
+- Shortcut can't have more than one action key (Ctrl+Shift+A, change Shift to B)
+- Remap to same shortcut(Ctrl+A->Ctrl+A)
+- Same shortcut previously remapped for same target app (Ctrl+A->B and Ctrl+A->C)
+- Conflicting shortcut previously remapped for same target app (Ctrl+A->B and Ctrl(left)+A->C, since Ctrl also includes Ctrl(left))
+- Illegal shortcut remaps like Win+L or Ctrl+Alt+Del (since these cannot be remapped using LL hooks)
+
+[`ValidateShortcutBufferElement`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/BufferValidationHelpers.cpp#L68-L304) does not reference any UI components and instead takes all the relevant data as arguments. This method [has tests](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/test/BufferValidationTests.cpp) which covers all the cases that could arise from making selections on the UI.
+
+**Note:** After updating the buffer we have [code to handle a special case](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L269-L279), which was required to prevent scenarios where a drop down can get deleted but the corresponding `KeyDropDownControl` object isn't deleted. The code checks if the drop down is still linked to the parent and accordingly deletes the `KeyDropDownControl` object from the vector.
+
+**IgnoreKeyToShortcutWarning special case:** [An additional](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/KeyDropDownControl.cpp#L177-L181) check was added to ignore the Map to Same key error when an existing remapping is loaded. This was because a remapping like Ctrl->Ctrl+A has an intermediate step of Ctrl->Ctrl, which could lead to an error of invalid input, even though Ctrl+A is valid. The only way to actually add this is from the Type button or by adding them in a different order (like typing Shift+A and then changing Shift to Ctrl). Since the intermediate check could fail, this was causing the app to crash since the Xaml Island wouldn't be completely loaded at that point and the Flyout can't be displayed. [This](https://github.com/microsoft/PowerToys/issues/6695) is the linked issue which describes the repro scenario.

doc/devdocs/modules/launcher/architecture.md

@@ -0,0 +1,48 @@
+# Architecture 
+
+## Overview
+`PowerToys Run` is a plugin-based .net core desktop application. It is written in WPF using `Model-View-ViewModel (MVVM)` structural design pattern. This article provides an overview of `PowerToys Run` architecture and introduces major components in the data flow.
+
+Note : We refer to base application without plugins as `PowerLauncher`, which is same as the name of startup WPF project. 
+
+## UI
+PowerToys Run UI is written in the WPF framework. The UI code is present in the Powerlauncher project and is spanned across three high-level components: [`MainWindow.xaml`](/src/modules/launcher/PowerLauncher/MainWindow.xaml), [`LauncherControl.xaml`](/src/modules/launcher/PowerLauncher/LauncherControl.xaml) and [`ResultList.xaml`](/src/modules/launcher/PowerLauncher/LauncherControl.xaml). These components are discussed below. 
+
+![Image of PowerToys Run UI](/doc/images/launcher/pt_run_ui.png)
+**Fig 1: PowerToys Run UI architecture**
+
+1. **[`MainWindow.xaml`](/src/modules/launcher/PowerLauncher/MainWindow.xaml)**: This is the outermost-level UI control. It is composed of lower-level UI components such as [`LauncherControl.xaml`](/src/modules/launcher/PowerLauncher/LauncherControl.xaml) and [`ResultList.xaml`](/src/modules/launcher/PowerLauncher/LauncherControl.xaml). The corresponding code-behind file implements all the UI related functionalities such as autosuggest, key-bindings, toggling visibility of WPF window and animations.
+2. **[`LauncherControl.xaml`](/src/modules/launcher/PowerLauncher/LauncherControl.xaml)**: This control implements the UI component for editing query text.(marked in red in Fig 1) It consists of two overlapping WPF controls, `TextBox` and `TextBlock`. The outer `TextBox` is used for editing query whereas the inner `TextBlock` is used to display autosuggest text.
+3. **[`ResultList.xaml`](/src/modules/launcher/PowerLauncher/LauncherControl.xaml)**: This control implements the UI component for displaying results (marked in green in Fig 1). It consists of a `ListView` WPF control with a custom `ItemTemplate` to display application logo, name, tooltip text, and context menu.
+
+## Data flow
+The backend code is written using the `Model-View-ViewModel (MVVM)` structural design pattern. Plugins act as `Model` in this project. A detailed overview of the project's structure is given [here](/doc/devdocs/modules/launcher/project_structure.md).
+
+#### Flow of data between UI(view) and ViewModels
+Data flow between View and ViewModel follows typical `MVVM` scheme. Properties in viewModels are bound to WPF controls and when these properties are updated, `INotifyPropertyChanged` handler is invoked, which in turn updates UI. The diagram below provides a rough sketch of the components involved.
+![Flow of data between UI(view) and ViewModels](/doc/images/launcher/ui_vm_interaction.PNG)
+**Fig 2: Flow of data between UI and ViewModels.**
+
+#### Flow of data between ViewModels and Plugins(Model)
+`PowerLauncher` interact with plugins using [`IPlugin`](/src/modules/launcher/Wox.Plugin/IPlugin.cs) and `IDelayedExecutionPlugin` interface. [`IPlugin`](/src/modules/launcher/Wox.Plugin/IPlugin.cs) is used for initialization and making queries which are fast (typically return results in less than 100ms).[`IDelayedExecutionPlugin`](/src/modules/launcher/Wox.Plugin/IDelayedExecutionPlugin.cs) is used for long-running queries and is implemented only when required. For example, [`IDelayedExecutionPlugin`](/src/modules/launcher/Wox.Plugin/IDelayedExecutionPlugin.cs) is implemented by indexer plugin for searching files with names of form \*abc\*.
+```
+    public interface IPlugin
+    {
+        // Query plugin
+        List<Result> Query(Query query);
+
+        // Initialize plugin
+        void Init(PluginInitContext context);
+    }
+
+    public interface IDelayedExecutionPlugin : IFeatures
+    {
+        // Query plugin
+        List<Result> Query(Query query, bool delayedExecution);
+    }
+```
+![Flow of data between UI(view) and ViewModels](/doc/images/launcher/vm_plugin_interaction.PNG)
+**Fig 3: Flow of data between ViewModels and Plugins.**
+
+#### Requesting services from powerlauncher
+Plugins could use the [`IPublicAPI`](/src/modules/launcher/Wox.Plugin/IPublicAPI.cs) interface to request services such as getting the current theme (for deciding logo background), displaying messages to the user, and toggling the visibility of PowerLauncher.

doc/devdocs/modules/launcher/debugging.md

@@ -0,0 +1,20 @@
+# Debugging
+`PowerToys Run` is a single exe file associated with `launcher.exe` process and debugger should be attached to this process. There are two approaches to debug `PowerToys Run`. Both these approaches differ in the compile-time and the range of functionalities that could be debugged. These methods are discussed in detail in the following sections.
+
+
+## Debugging Prerequisite
+Setup development environment for PowerToys by following instruction [here.](https://github.com/microsoft/PowerToys/tree/main/doc/devdocs#prerequisites-for-compiling-powertoys)
+
+## Direct debugging
+This approach is used to test UI, plugins, and core `PowerToys Run` functionality. This **cannot** be used to test `PowerToys Run` settings. The approach is significantly faster compared to `Debugging with runner`, as it requires compiling projects relevant to `PowerToys Run`. Please follow the steps below for direct debugging.
+1. Right-click on `modules->launcher->PowerLauncher` and select `Set as startup Project`. 
+2. Press `F5` to start debugging.
+
+## Debugging with runner
+This approach can be used to test UI, plugins, core `PowerToys Run` functionality and `PowerToys Run` settings. This approach **cannot** be used to debug functions that execute on starting `launcher.exe` process. This requires building runner along with all the other modules on first compile, making it slower than `Direct debugging` approach. The subsequent compilations should be fast.
+1. Right-click on `runner` and select `Set as startup Project`. 
+2. Press `F5` to start debugging.
+3. Attach debugger to `launcher.exe` process. 
+    1. Go to `Debug->Attach to process..`
+    2. Filter and select `launcher.exe` process. 
+    3. Click on `Attach`.

doc/devdocs/modules/launcher/new-plugin-checklist.md

@@ -0,0 +1,36 @@
+# New plugin checklist
+- [ ] The plugin is a project under `modules\launcher\Plugins`
+- [ ] Microsoft plugin project name pattern: `Microsoft.PowerToys.Run.Plugin.{PluginName}`
+- [ ] Community plugin project name pattern: `Community.PowerToys.Run.Plugin.{PluginName}`
+- [ ] [`GlobalSuppressions.cs`](/src/codeAnalysis/GlobalSuppressions.cs) and [`StyleCop.json`](/src/codeAnalysis/StyleCop.json) have to be included in the plugin project so it follows PowerToys code guidelines
+- [ ] The project file should import `Version.props` and specify `<Version>$(Version).0</Version>`
+- [ ] Make sure `*.csproj` specify only x64 platform target
+- [ ] The plugin has to contain a `plugin.json` file of the following format in its root folder
+```
+{
+  "ID": string, // GUID string
+  "ActionKeyword": string, // Direct activation phrase
+  "IsGlobal": boolean,
+  "Name": string, // Has to be unique, same as 'PluginName' in the project name pattern  
+  "Author": string,
+  "Version": "1.0.0", // For future compatibility
+  "Language": "csharp", // So far we support only csharp 
+  "Website": "https://aka.ms/powertoys",
+  "ExecuteFileName": string, // Should be {Type}.PowerToys.Run.Plugin.{PluginName}.dll
+  "IcoPathDark": string, // Path to dark theme icon. The path is relative to the root plugin folder 
+  "IcoPathLight": string // Path to light theme icon. The path is relative to the root plugin folder 
+}
+```
+- [ ] Do not use plugin name or PowerToys as prefixes for entities inside of the plugin project
+- [ ] The plugin has to have Unit tests. Use MSTest framework
+- [ ] Plugin's output code and assets have to be included in the installer [`Product.wxs`](/installer/PowerToysSetup/Product.wxs)
+- [ ] Test the plugin with a local build. Build the installer, install, check that the plugin works as expected
+- [ ] All plugin's binaries have to be included in the signed build [`pipeline.user.windows.yml`](/.pipelines/pipeline.user.windows.yml)
+- [ ] The plugin target framework has to be .NET Core 3.1. All dependencies have to have .NET 5 version
+
+Some localization steps can only be done after the first pass by the localization team to provide the localized resources.
+In the PR that adds a new plugin, reference a new issue to track the work for fully enabling localization for the new plugin.
+
+ - [ ] Add the resource folder to https://github.com/microsoft/PowerToys/blob/21247c0bb09a1bee3d14d6efa53d0c247f7236af/installer/PowerToysSetup/Product.wxs#L825
+ - [ ] Add the resource files under the section https://github.com/microsoft/PowerToys/blob/21247c0bb09a1bee3d14d6efa53d0c247f7236af/installer/PowerToysSetup/Product.wxs#L882
+ 

doc/devdocs/modules/launcher/plugins/calculator.md

@@ -0,0 +1,23 @@
+# Calculator Plugin
+The Calculator plugin as the name suggests is used to perform calculations on the user entered query.
+
+![Image of Calculator plugin](/doc/images/launcher/plugins/calculator.png)
+
+### [`CalculateHelper`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator/CalculateHelper.cs)
+- The [`CalculateHelper.cs`](src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator/CalculateHelper.cs) class checks to see if the user entered query is a valid input to the calculator and only if the input is valid does it perform the operation.
+- It does so by matching the user query to a valid regex.
+
+### [`CalculateEngine`](src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator/CalculateEngine.cs)
+- The main computation is done in the [`CalculateEngine.cs`](src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator/CalculateEngine.cs) file using the `Mages` library.
+
+```csharp
+var result = CalculateEngine.Interpret(query.Search, CultureInfo.CurrentUICulture);
+```
+
+### [`CalculateResult`](src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator/CalculateResult.cs)
+- The class which encapsulates the result of the computation.
+- It comprises of the `Result` and `RoundedResult` properties.
+
+### Score
+The score of each result from the calculator plugin is `300`.
+