terminal/src/buffer/out/AttrRow.hpp

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

Module Name:
- AttrRow.hpp

Abstract:
- contains data structure for the attributes of one row of screen buffer

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)
--*/

#pragma once

#include "til/rle.h"
#include "TextAttribute.hpp"

class ATTR_ROW final
{
    using rle_vector = til::small_rle<TextAttribute, uint16_t, 1>;

public:
    using const_iterator = rle_vector::const_iterator;

    ATTR_ROW(uint16_t width, TextAttribute attr);

    ~ATTR_ROW() = default;

    ATTR_ROW(const ATTR_ROW&) = default;
    ATTR_ROW& operator=(const ATTR_ROW&) = default;
    ATTR_ROW(ATTR_ROW&&)
    noexcept = default;
    ATTR_ROW& operator=(ATTR_ROW&&) noexcept = default;

    TextAttribute GetAttrByColumn(uint16_t column) const;
    std::vector<uint16_t> GetHyperlinks() const;

    bool SetAttrToEnd(uint16_t beginIndex, TextAttribute attr);
    void ReplaceAttrs(const TextAttribute& toBeReplacedAttr, const TextAttribute& replaceWith);
    void Resize(uint16_t newWidth);
    void Replace(uint16_t beginIndex, uint16_t endIndex, const TextAttribute& newAttr);

    const_iterator begin() const noexcept;
    const_iterator end() const noexcept;

    const_iterator cbegin() const noexcept;
    const_iterator cend() const noexcept;

    friend bool operator==(const ATTR_ROW& a, const ATTR_ROW& b) noexcept;
    friend class ROW;

private:
    void Reset(const TextAttribute attr);

    rle_vector _data;

#ifdef UNIT_TESTING
    friend class CommonState;
#endif
};