2d18874c8e
In Windows, we build with /Zc:wchar_t- (which makes wchar_t an unsigned short typedef.) This causes build breaks when we compare two wchar_t values (or a wchar_t and an enum class that's of type wchar_t) and the compiler decides that it might want to _promote them to TextAttribute_ before doing the comparison.
253 lines
10 KiB
C++
253 lines
10 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- TextAttribute.hpp
|
|
|
|
Abstract:
|
|
- contains data structure for run-length-encoding of text attribute data
|
|
|
|
Author(s):
|
|
- Michael Niksa (miniksa) 10-Apr-2014
|
|
- Paul Campbell (paulcam) 10-Apr-2014
|
|
|
|
Revision History:
|
|
- From components of output.h/.c
|
|
by Therese Stowell (ThereseS) 1990-1991
|
|
- Pulled into its own file from textBuffer.hpp/cpp (AustDi, 2017)
|
|
- Pulled each of the fg/bg colors into their own abstraction (migrie, Nov 2018)
|
|
--*/
|
|
|
|
#pragma once
|
|
#include "TextColor.h"
|
|
#include "../../inc/conattrs.hpp"
|
|
|
|
#ifdef UNIT_TESTING
|
|
#include "WexTestClass.h"
|
|
#endif
|
|
|
|
#pragma pack(push, 1)
|
|
|
|
class TextAttribute final
|
|
{
|
|
public:
|
|
constexpr TextAttribute() noexcept :
|
|
_wAttrLegacy{ 0 },
|
|
_foreground{},
|
|
_background{},
|
|
_extendedAttrs{ ExtendedAttributes::Normal }
|
|
{
|
|
}
|
|
|
|
explicit constexpr TextAttribute(const WORD wLegacyAttr) noexcept :
|
|
_wAttrLegacy{ gsl::narrow_cast<WORD>(wLegacyAttr & META_ATTRS) },
|
|
_foreground{ gsl::narrow_cast<BYTE>(wLegacyAttr & FG_ATTRS), true },
|
|
_background{ gsl::narrow_cast<BYTE>((wLegacyAttr & BG_ATTRS) >> 4), true },
|
|
_extendedAttrs{ ExtendedAttributes::Normal }
|
|
{
|
|
// If we're given lead/trailing byte information with the legacy color, strip it.
|
|
WI_ClearAllFlags(_wAttrLegacy, COMMON_LVB_SBCSDBCS);
|
|
}
|
|
|
|
constexpr TextAttribute(const COLORREF rgbForeground,
|
|
const COLORREF rgbBackground) noexcept :
|
|
_wAttrLegacy{ 0 },
|
|
_foreground{ rgbForeground },
|
|
_background{ rgbBackground },
|
|
_extendedAttrs{ ExtendedAttributes::Normal }
|
|
{
|
|
}
|
|
|
|
WORD GetLegacyAttributes() const noexcept
|
|
{
|
|
const BYTE fg = (_foreground.GetIndex() & FG_ATTRS);
|
|
const BYTE bg = (_background.GetIndex() << 4) & BG_ATTRS;
|
|
const WORD meta = (_wAttrLegacy & META_ATTRS);
|
|
const bool brighten = _foreground.IsIndex16() && IsBold();
|
|
return (fg | bg | meta) | (brighten ? FOREGROUND_INTENSITY : 0);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Returns a WORD with legacy-style attributes for this textattribute.
|
|
// If either the foreground or background of this textattribute is not
|
|
// a legacy attribute, then instead use the provided default index as
|
|
// the value for that component.
|
|
// Arguments:
|
|
// - defaultFgIndex: the BYTE to use as the index for the foreground, should
|
|
// the foreground not be a legacy style attribute.
|
|
// - defaultBgIndex: the BYTE to use as the index for the background, should
|
|
// the background not be a legacy style attribute.
|
|
// Return Value:
|
|
// - a WORD with legacy-style attributes for this textattribute.
|
|
WORD GetLegacyAttributes(const BYTE defaultFgIndex,
|
|
const BYTE defaultBgIndex) const noexcept
|
|
{
|
|
const BYTE fgIndex = _foreground.IsLegacy() ? _foreground.GetIndex() : defaultFgIndex;
|
|
const BYTE bgIndex = _background.IsLegacy() ? _background.GetIndex() : defaultBgIndex;
|
|
const BYTE fg = (fgIndex & FG_ATTRS);
|
|
const BYTE bg = (bgIndex << 4) & BG_ATTRS;
|
|
const WORD meta = (_wAttrLegacy & META_ATTRS);
|
|
const bool brighten = _foreground.IsIndex16() && IsBold();
|
|
return (fg | bg | meta) | (brighten ? FOREGROUND_INTENSITY : 0);
|
|
}
|
|
|
|
COLORREF CalculateRgbForeground(std::basic_string_view<COLORREF> colorTable,
|
|
COLORREF defaultFgColor,
|
|
COLORREF defaultBgColor) const noexcept;
|
|
COLORREF CalculateRgbBackground(std::basic_string_view<COLORREF> colorTable,
|
|
COLORREF defaultFgColor,
|
|
COLORREF defaultBgColor) const noexcept;
|
|
|
|
bool IsLeadingByte() const noexcept;
|
|
bool IsTrailingByte() const noexcept;
|
|
bool IsTopHorizontalDisplayed() const noexcept;
|
|
bool IsBottomHorizontalDisplayed() const noexcept;
|
|
bool IsLeftVerticalDisplayed() const noexcept;
|
|
bool IsRightVerticalDisplayed() const noexcept;
|
|
|
|
void SetLeftVerticalDisplayed(const bool isDisplayed) noexcept;
|
|
void SetRightVerticalDisplayed(const bool isDisplayed) noexcept;
|
|
|
|
void Invert() noexcept;
|
|
|
|
friend constexpr bool operator==(const TextAttribute& a, const TextAttribute& b) noexcept;
|
|
friend constexpr bool operator!=(const TextAttribute& a, const TextAttribute& b) noexcept;
|
|
friend constexpr bool operator==(const TextAttribute& attr, const WORD& legacyAttr) noexcept;
|
|
friend constexpr bool operator!=(const TextAttribute& attr, const WORD& legacyAttr) noexcept;
|
|
friend constexpr bool operator==(const WORD& legacyAttr, const TextAttribute& attr) noexcept;
|
|
friend constexpr bool operator!=(const WORD& legacyAttr, const TextAttribute& attr) noexcept;
|
|
|
|
bool IsLegacy() const noexcept;
|
|
bool IsHighColor() const noexcept;
|
|
bool IsBold() const noexcept;
|
|
bool IsItalic() const noexcept;
|
|
bool IsBlinking() const noexcept;
|
|
bool IsInvisible() const noexcept;
|
|
bool IsCrossedOut() const noexcept;
|
|
bool IsUnderlined() const noexcept;
|
|
bool IsReverseVideo() const noexcept;
|
|
|
|
void SetBold(bool isBold) noexcept;
|
|
void SetItalics(bool isItalic) noexcept;
|
|
void SetBlinking(bool isBlinking) noexcept;
|
|
void SetInvisible(bool isInvisible) noexcept;
|
|
void SetCrossedOut(bool isCrossedOut) noexcept;
|
|
void SetUnderline(bool isUnderlined) noexcept;
|
|
void SetReverseVideo(bool isReversed) noexcept;
|
|
|
|
ExtendedAttributes GetExtendedAttributes() const noexcept;
|
|
|
|
void SetForeground(const COLORREF rgbForeground) noexcept;
|
|
void SetBackground(const COLORREF rgbBackground) noexcept;
|
|
void SetIndexedForeground(const BYTE fgIndex) noexcept;
|
|
void SetIndexedBackground(const BYTE bgIndex) noexcept;
|
|
void SetIndexedForeground256(const BYTE fgIndex) noexcept;
|
|
void SetIndexedBackground256(const BYTE bgIndex) noexcept;
|
|
void SetColor(const COLORREF rgbColor, const bool fIsForeground) noexcept;
|
|
|
|
void SetDefaultForeground() noexcept;
|
|
void SetDefaultBackground() noexcept;
|
|
|
|
bool ForegroundIsDefault() const noexcept;
|
|
bool BackgroundIsDefault() const noexcept;
|
|
|
|
void SetStandardErase() noexcept;
|
|
|
|
// This returns whether this attribute, if printed directly next to another attribute, for the space
|
|
// character, would look identical to the other one.
|
|
bool HasIdenticalVisualRepresentationForBlankSpace(const TextAttribute& other, const bool inverted = false) const noexcept
|
|
{
|
|
// sneaky-sneaky: I'm using xor here
|
|
// inverted is whether there's a global invert; Reverse is a local one.
|
|
// global ^ local == true : the background attribute is actually the visible foreground, so we care about the foregrounds being identical
|
|
// global ^ local == false: the foreground attribute is the visible foreground, so we care about the backgrounds being identical
|
|
const auto checkForeground = (inverted != IsReverseVideo());
|
|
return !IsAnyGridLineEnabled() && // grid lines have a visual representation
|
|
// crossed out, doubly and singly underlined have a visual representation
|
|
WI_AreAllFlagsClear(_extendedAttrs, ExtendedAttributes::CrossedOut | ExtendedAttributes::DoublyUnderlined | ExtendedAttributes::Underlined) &&
|
|
// all other attributes do not have a visual representation
|
|
(_wAttrLegacy & META_ATTRS) == (other._wAttrLegacy & META_ATTRS) &&
|
|
((checkForeground && _foreground == other._foreground) ||
|
|
(!checkForeground && _background == other._background)) &&
|
|
_extendedAttrs == other._extendedAttrs;
|
|
}
|
|
|
|
constexpr bool IsAnyGridLineEnabled() const noexcept
|
|
{
|
|
return WI_IsAnyFlagSet(_wAttrLegacy, COMMON_LVB_GRID_HORIZONTAL | COMMON_LVB_GRID_LVERTICAL | COMMON_LVB_GRID_RVERTICAL | COMMON_LVB_UNDERSCORE);
|
|
}
|
|
|
|
private:
|
|
COLORREF _GetRgbForeground(std::basic_string_view<COLORREF> colorTable,
|
|
COLORREF defaultColor) const noexcept;
|
|
COLORREF _GetRgbBackground(std::basic_string_view<COLORREF> colorTable,
|
|
COLORREF defaultColor) const noexcept;
|
|
|
|
WORD _wAttrLegacy;
|
|
TextColor _foreground;
|
|
TextColor _background;
|
|
ExtendedAttributes _extendedAttrs;
|
|
|
|
#ifdef UNIT_TESTING
|
|
friend class TextBufferTests;
|
|
friend class TextAttributeTests;
|
|
template<typename TextAttribute>
|
|
friend class WEX::TestExecution::VerifyOutputTraits;
|
|
#endif
|
|
};
|
|
|
|
#pragma pack(pop)
|
|
// 2 for _wAttrLegacy
|
|
// 4 for _foreground
|
|
// 4 for _background
|
|
// 1 for _extendedAttrs
|
|
static_assert(sizeof(TextAttribute) <= 11 * sizeof(BYTE), "We should only need 11B for an entire TextColor. Any more than that is just waste");
|
|
|
|
enum class TextAttributeBehavior
|
|
{
|
|
Stored, // use contained text attribute
|
|
Current, // use text attribute of cell being written to
|
|
StoredOnly, // only use the contained text attribute and skip the insertion of anything else
|
|
};
|
|
|
|
constexpr bool operator==(const TextAttribute& a, const TextAttribute& b) noexcept
|
|
{
|
|
return a._wAttrLegacy == b._wAttrLegacy &&
|
|
a._foreground == b._foreground &&
|
|
a._background == b._background &&
|
|
a._extendedAttrs == b._extendedAttrs;
|
|
}
|
|
|
|
constexpr bool operator!=(const TextAttribute& a, const TextAttribute& b) noexcept
|
|
{
|
|
return !(a == b);
|
|
}
|
|
|
|
#ifdef UNIT_TESTING
|
|
|
|
#define LOG_ATTR(attr) (Log::Comment(NoThrowString().Format( \
|
|
L#attr L"=%s", VerifyOutputTraits<TextAttribute>::ToString(attr).GetBuffer())))
|
|
|
|
namespace WEX
|
|
{
|
|
namespace TestExecution
|
|
{
|
|
template<>
|
|
class VerifyOutputTraits<TextAttribute>
|
|
{
|
|
public:
|
|
static WEX::Common::NoThrowString ToString(const TextAttribute& attr)
|
|
{
|
|
return WEX::Common::NoThrowString().Format(
|
|
L"{FG:%s,BG:%s,bold:%d,wLegacy:(0x%04x)}",
|
|
VerifyOutputTraits<TextColor>::ToString(attr._foreground).GetBuffer(),
|
|
VerifyOutputTraits<TextColor>::ToString(attr._background).GetBuffer(),
|
|
attr.IsBold(),
|
|
attr._wAttrLegacy);
|
|
}
|
|
};
|
|
}
|
|
}
|
|
#endif
|