using System;

namespace AcDream.UI.Abstractions.Input;

/// <summary>
/// Bitmask of modifier keys held alongside a primary chord key. Bit values
/// are taken from the retail <c>acclient.keymap</c> "Metakeys" table:
/// <c>LSHIFT=1, LCTRL=2, LALT=4, LWIN=8</c>. Same numeric layout the
/// retail keymap text format writes — keeping it compatible lets us load
/// future user keymap exports byte-for-byte.
/// </summary>
[Flags]
public enum ModifierMask : uint
{
    /// <summary>No modifier held — bare key.</summary>
    None  = 0,
    /// <summary>Shift (left or right) — retail keymap bit 1.</summary>
    Shift = 0x01,
    /// <summary>Control (left or right) — retail keymap bit 2.</summary>
    Ctrl  = 0x02,
    /// <summary>Alt / Menu (left or right) — retail keymap bit 3.</summary>
    Alt   = 0x04,
    /// <summary>Windows / GUI key — retail keymap bit 4.</summary>
    Win   = 0x08,
}