Michael Jolley 6acb793184
Some checks failed
Spell checking / Check Spelling (push) Has been cancelled
Spell checking / Report (Push) (push) Has been cancelled
Spell checking / Report (PR) (push) Has been cancelled
Spell checking / Update PR (push) Has been cancelled
CmdPal: Null pattern matching based on is expression rather than overridable operators (#40972)
What the title says. 😄 

Rather than relying on the potentially overloaded `!=` or `==` operators
when checking for null, now we'll use the `is` expression (possibly
combined with the `not` operator) to ensure correct checking. Probably
overkill for many of these classes, but decided to err on the side of
consistency. Would matter more on classes that may be inherited or
extended.

Using `is` and `is not` will provide us a guarantee that no
user-overloaded equality operators (`==`/`!=`) is invoked when a
`expression is null` is evaluated.

In code form, changed all instances of:

```c#
something != null

something == null
```

to:

```c#
something is not null

something is null
```

The one exception was checking null on a `KeyChord`. `KeyChord` is a
struct which is never null so VS will raise an error when trying this
versus just providing a warning when using `keyChord != null`. In
reality, we shouldn't do this check because it can't ever be null. In
the case of a `KeyChord` it **would** be a `KeyChord` equivalent to:

```c#
KeyChord keyChord = new ()
{
    Modifiers = 0,
    Vkey = 0,
    ScanCode = 0
};
```
2025-08-18 06:07:28 -05:00

94 lines
3.1 KiB
C#

// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using Microsoft.Win32;
namespace Microsoft.CmdPal.UI.Helpers;
internal enum GpoRuleConfiguredValue
{
WrongValue = -3,
Unavailable = -2,
NotConfigured = -1,
Disabled = 0,
Enabled = 1,
}
/*
* Contains methods extracted from PowerToys gpo.h
* The idea is to keep CmdPal codebase take as little dependences on the PowerToys codebase as possible.
* Having this class to check GPO being contained in CmdPal means we don't need to depend on GPOWrapper.
*/
internal static class GpoValueChecker
{
private const string PoliciesPath = @"SOFTWARE\Policies\PowerToys";
private static readonly RegistryKey PoliciesScopeMachine = Registry.LocalMachine;
private static readonly RegistryKey PoliciesScopeUser = Registry.CurrentUser;
private const string PolicyConfigureEnabledCmdPal = @"ConfigureEnabledUtilityCmdPal";
private const string PolicyConfigureEnabledGlobalAllUtilities = @"ConfigureGlobalUtilityEnabledState";
private static GpoRuleConfiguredValue GetConfiguredValue(string registryValueName)
{
// For GPO policies, machine scope should take precedence over user scope
var value = ReadRegistryValue(PoliciesScopeMachine, PoliciesPath, registryValueName);
if (!value.HasValue)
{
// If not found in machine scope, check user scope
value = ReadRegistryValue(PoliciesScopeUser, PoliciesPath, registryValueName);
if (!value.HasValue)
{
return GpoRuleConfiguredValue.NotConfigured;
}
}
return value switch
{
0 => GpoRuleConfiguredValue.Disabled,
1 => GpoRuleConfiguredValue.Enabled,
_ => GpoRuleConfiguredValue.WrongValue,
};
}
// Reads an integer registry value if it exists.
private static int? ReadRegistryValue(RegistryKey rootKey, string subKeyPath, string valueName)
{
using (RegistryKey? key = rootKey.OpenSubKey(subKeyPath, false))
{
if (key is null)
{
return null;
}
var value = key.GetValue(valueName);
if (value is int intValue)
{
return intValue;
}
return null;
}
}
private static GpoRuleConfiguredValue GetUtilityEnabledValue(string utilityName)
{
var individualValue = GetConfiguredValue(utilityName);
if (individualValue == GpoRuleConfiguredValue.Disabled || individualValue == GpoRuleConfiguredValue.Enabled)
{
return individualValue;
}
else
{
// If the individual utility value is not set, check the global all utilities policy value.
return GetConfiguredValue(PolicyConfigureEnabledGlobalAllUtilities);
}
}
internal static GpoRuleConfiguredValue GetConfiguredCmdPalEnabledValue()
{
return GetUtilityEnabledValue(PolicyConfigureEnabledCmdPal);
}
}