settings.hpp

/*++
Copyright (c) Microsoft Corporation
Licensed under the MIT license.

Module Name:
- settings.hpp

Abstract:
- This module is used for all configurable settings in the console

Author(s):
- Michael Niksa (MiNiksa) 23-Jul-2014
- Paul Campbell (PaulCam) 23-Jul-2014

Revision History:
- From components of consrv.h
- This is a reduced/de-duplicated version of settings that were stored in the registry, link files, and in the console information state.
--*/
#pragma once

// To prevent invisible windows, set a lower threshold on window alpha channel.
constexprunsignedshort MIN_WINDOW_OPACITY = 0x4D; // 0x4D is approximately 30% visible/opaque (70% transparent). Valid range is 0x00-0xff.

#include"ConsoleArguments.hpp"
#include"../renderer/inc/RenderSettings.hpp"

enumclassSettingsTextMeasurementMode : DWORD
{
 Graphemes,
 Wcswidth,
 Console,
};

classSettings
{
using RenderSettings = Microsoft::Console::Render::RenderSettings;

public:
Settings();

voidApplyDesktopSpecificDefaults();

voidApplyStartupInfo(const Settings* const pStartupSettings);
voidApplyCommandlineArguments(const ConsoleArguments& consoleArgs);
voidInitFromStateInfo(_In_ PCONSOLE_STATE_INFO pStateInfo);
voidValidate();

 CONSOLE_STATE_INFO CreateConsoleStateInfo() const;

 RenderSettings& GetRenderSettings() noexcept { return _renderSettings; };
const RenderSettings& GetRenderSettings() constnoexcept { return _renderSettings; };

 DWORD GetDefaultVirtTermLevel() const;
voidSetDefaultVirtTermLevel(const DWORD dwVirtTermLevel);

boolIsAltF4CloseAllowed() const;
voidSetAltF4CloseAllowed(constboolfAllowAltF4Close);

boolGetFilterOnPaste() const;
voidSetFilterOnPaste(constboolfFilterOnPaste);

const std::wstring_view GetLaunchFaceName() const;
voidSetLaunchFaceName(const std::wstring_view launchFaceName);

 UINT GetCodePage() const;
voidSetCodePage(const UINT uCodePage);

 UINT GetScrollScale() const;
voidSetScrollScale(const UINT uScrollScale);

boolGetTrimLeadingZeros() const;
voidSetTrimLeadingZeros(constboolfTrimLeadingZeros);

boolGetEnableColorSelection() const;
voidSetEnableColorSelection(constboolfEnableColorSelection);

boolGetLineSelection() const;
voidSetLineSelection(constbool bLineSelection);

boolGetWrapText() const;
voidSetWrapText(constbool bWrapText);

boolGetCtrlKeyShortcutsDisabled() const;
voidSetCtrlKeyShortcutsDisabled(constboolfCtrlKeyShortcutsDisabled);

 BYTE GetWindowAlpha() const;
voidSetWindowAlpha(const BYTE bWindowAlpha);

 DWORD GetHotKey() const;
voidSetHotKey(const DWORD dwHotKey);

boolIsStartupTitleIsLinkNameSet() const;

 DWORD GetStartupFlags() const;
voidSetStartupFlags(const DWORD dwStartupFlags);
voidUnsetStartupFlag(const DWORD dwFlagToUnset);

 WORD GetFillAttribute() const;
voidSetFillAttribute(const WORD wFillAttribute);

 WORD GetPopupFillAttribute() const;
voidSetPopupFillAttribute(const WORD wPopupFillAttribute);

 WORD GetShowWindow() const;
voidSetShowWindow(const WORD wShowWindow);

 WORD GetReserved() const;
voidSetReserved(const WORD wReserved);

 til::size GetScreenBufferSize() const;
voidSetScreenBufferSize(const til::size dwScreenBufferSize);

 til::size GetWindowSize() const;
voidSetWindowSize(const til::size dwWindowSize);

boolIsWindowSizePixelsValid() const;
 til::size GetWindowSizePixels() const;
voidSetWindowSizePixels(const til::size dwWindowSizePixels);

 til::size GetWindowOrigin() const;
voidSetWindowOrigin(const til::size dwWindowOrigin);

 DWORD GetFont() const;
voidSetFont(const DWORD dwFont);

 til::size GetFontSize() const;
voidSetFontSize(const til::size dwFontSize);

 UINT GetFontFamily() const;
voidSetFontFamily(const UINT uFontFamily);

 UINT GetFontWeight() const;
voidSetFontWeight(const UINT uFontWeight);

const WCHAR* constGetFaceName() const;
boolIsFaceNameSet() const;
voidSetFaceName(const std::wstring_view faceName);

 UINT GetCursorSize() const;
voidSetCursorSize(const UINT uCursorSize);

boolGetFullScreen() const;
voidSetFullScreen(constboolfFullScreen);

boolGetQuickEdit() const;
voidSetQuickEdit(constboolfQuickEdit);

boolGetInsertMode() const;
voidSetInsertMode(constboolfInsertMode);

boolGetAutoPosition() const;
voidSetAutoPosition(constboolfAutoPosition);

 UINT GetHistoryBufferSize() const;
voidSetHistoryBufferSize(const UINT uHistoryBufferSize);

 UINT GetNumberOfHistoryBuffers() const;
voidSetNumberOfHistoryBuffers(const UINT uNumberOfHistoryBuffers);

boolGetHistoryNoDup() const;
voidSetHistoryNoDup(constboolfHistoryNoDup);

voidSetColorTableEntry(constsize_t index, const COLORREF color);
 COLORREF GetColorTableEntry(constsize_t index) const;
voidSetLegacyColorTableEntry(constsize_t index, const COLORREF color);
 COLORREF GetLegacyColorTableEntry(constsize_t index) const;

 CursorType GetCursorType() constnoexcept;
voidSetCursorType(const CursorType cursorType) noexcept;

boolGetInterceptCopyPaste() constnoexcept;
voidSetInterceptCopyPaste(constbool interceptCopyPaste) noexcept;

voidCalculateDefaultColorIndices() noexcept;
voidSaveDefaultRenderSettings() noexcept;

boolIsTerminalScrolling() constnoexcept;
voidSetTerminalScrolling(constbool terminalScrollingEnabled) noexcept;

 std::wstring_view GetAnswerbackMessage() constnoexcept;

boolGetUseDx() constnoexcept;
boolGetCopyColor() constnoexcept;
 SettingsTextMeasurementMode GetTextMeasurementMode() constnoexcept;
voidSetTextMeasurementMode(SettingsTextMeasurementMode mode) noexcept;
boolGetEnableBuiltinGlyphs() constnoexcept;

private:
 RenderSettings _renderSettings;

 DWORD _dwHotKey;
 DWORD _dwStartupFlags;
 WORD _wFillAttribute;
 WORD _wPopupFillAttribute;
 WORD _wShowWindow; // used when window is created
 WORD _wReserved;
// START - This section filled via memcpy from shortcut properties. Do not rearrange/change.
 COORD _dwScreenBufferSize;
 COORD _dwWindowSize; // this is in characters.
 COORD _dwWindowOrigin; // used when window is created
 DWORD _nFont;
 COORD _dwFontSize;
 UINT _uFontFamily;
 UINT _uFontWeight;
 WCHAR _FaceName[LF_FACESIZE];
 UINT _uCursorSize;
 BOOL _bFullScreen; // deprecated
 BOOL _bQuickEdit;
 BOOL _bInsertMode; // used by command line editing
 BOOL _bAutoPosition;
 UINT _uHistoryBufferSize;
 UINT _uNumberOfHistoryBuffers;
 BOOL _bHistoryNoDup;
// END - memcpy
 UINT _uCodePage;
 UINT _uScrollScale;
bool _fTrimLeadingZeros;
bool _fEnableColorSelection;
bool _bLineSelection;
bool _bWrapText; // whether to use text wrapping when resizing the window
bool _fCtrlKeyShortcutsDisabled; // disables Ctrl+<something> key intercepts
 BYTE _bWindowAlpha; // describes the opacity of the window

bool _fFilterOnPaste; // should we filter text when the user pastes? (e.g. remove <tab>)
 std::wstring _LaunchFaceName;
bool _fAllowAltF4Close;
 DWORD _dwVirtTermLevel;
 SettingsTextMeasurementMode _textMeasurement = SettingsTextMeasurementMode::Graphemes;
bool _fUseDx;
bool _fCopyColor;
bool _fEnableBuiltinGlyphs = true;

// this is used for the special STARTF_USESIZE mode.
bool _fUseWindowSizePixels;
 COORD _dwWindowSizePixels;

 CursorType _CursorType;

bool _fInterceptCopyPaste;

bool _TerminalScrolling;
 WCHAR _answerbackMessage[32] = {};
friendclassRegistrySerialization;
};