mirror of
https://github.com/microsoft/terminal.git
synced 2025-12-19 18:11:39 -05:00
ed27737233
Previously this project used a great variety of types to present text buffer coordinates: `short`, `unsigned short`, `int`, `unsigned int`, `size_t`, `ptrdiff_t`, `COORD`/`SMALL_RECT` (aka `short`), and more. This massive commit migrates almost all use of those types over to the centralized types `til::point`/`size`/`rect`/`inclusive_rect` and their underlying type `til::CoordType` (aka `int32_t`). Due to the size of the changeset and statistics I expect it to contain bugs. The biggest risk I see is that some code potentially, maybe implicitly, expected arithmetic to be mod 2^16 and that this code now allows it to be mod 2^32. Any narrowing into `short` later on would then throw exceptions. ## PR Checklist * [x] Closes #4015 * [x] I work here * [x] Tests added/passed ## Validation Steps Performed Casual usage of OpenConsole and Windows Terminal. ✅
126 lines
4.4 KiB
C++
126 lines
4.4 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- OutputCellIterator.hpp
|
|
|
|
Abstract:
|
|
- Read-only view into an entire batch of data to be written into the output buffer.
|
|
- This is done for performance reasons (avoid heap allocs and copies).
|
|
|
|
Author:
|
|
- Michael Niksa (MiNiksa) 06-Oct-2018
|
|
|
|
Revision History:
|
|
- Based on work from OutputCell.hpp/cpp by Austin Diviness (AustDi)
|
|
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "TextAttribute.hpp"
|
|
|
|
#include "OutputCell.hpp"
|
|
#include "OutputCellView.hpp"
|
|
|
|
class OutputCellIterator final
|
|
{
|
|
public:
|
|
using iterator_category = std::input_iterator_tag;
|
|
using value_type = OutputCellView;
|
|
using difference_type = til::CoordType;
|
|
using pointer = OutputCellView*;
|
|
using reference = OutputCellView&;
|
|
|
|
OutputCellIterator(const wchar_t& wch, const size_t fillLimit = 0) noexcept;
|
|
OutputCellIterator(const TextAttribute& attr, const size_t fillLimit = 0) noexcept;
|
|
OutputCellIterator(const wchar_t& wch, const TextAttribute& attr, const size_t fillLimit = 0) noexcept;
|
|
OutputCellIterator(const CHAR_INFO& charInfo, const size_t fillLimit = 0) noexcept;
|
|
OutputCellIterator(const std::wstring_view utf16Text);
|
|
OutputCellIterator(const std::wstring_view utf16Text, const TextAttribute& attribute, const size_t fillLimit = 0);
|
|
OutputCellIterator(const gsl::span<const WORD> legacyAttributes) noexcept;
|
|
OutputCellIterator(const gsl::span<const CHAR_INFO> charInfos) noexcept;
|
|
OutputCellIterator(const gsl::span<const OutputCell> cells);
|
|
~OutputCellIterator() = default;
|
|
|
|
OutputCellIterator& operator=(const OutputCellIterator& it) = default;
|
|
|
|
operator bool() const noexcept;
|
|
|
|
til::CoordType GetCellDistance(OutputCellIterator other) const noexcept;
|
|
til::CoordType GetInputDistance(OutputCellIterator other) const noexcept;
|
|
friend til::CoordType operator-(OutputCellIterator one, OutputCellIterator two) = delete;
|
|
|
|
OutputCellIterator& operator++();
|
|
OutputCellIterator operator++(int);
|
|
|
|
const OutputCellView& operator*() const noexcept;
|
|
const OutputCellView* operator->() const noexcept;
|
|
|
|
private:
|
|
enum class Mode
|
|
{
|
|
// Loose mode is where we're given text and attributes in a raw sort of form
|
|
// like while data is being inserted from an API call.
|
|
Loose,
|
|
|
|
// Loose mode with only text is where we're given just text and we want
|
|
// to use the attribute already in the buffer when writing
|
|
LooseTextOnly,
|
|
|
|
// Fill mode is where we were given one thing and we just need to keep giving
|
|
// that back over and over for eternity.
|
|
Fill,
|
|
|
|
// Given a run of legacy attributes, convert each of them and insert only attribute data.
|
|
LegacyAttr,
|
|
|
|
// CharInfo mode is where we've been given a pair of text and attribute for each
|
|
// cell in the legacy format from an API call.
|
|
CharInfo,
|
|
|
|
// Cell mode is where we have an already fully structured cell data usually
|
|
// from accessing/copying data already put into the OutputBuffer.
|
|
Cell,
|
|
};
|
|
Mode _mode;
|
|
|
|
gsl::span<const WORD> _legacyAttrs;
|
|
|
|
std::variant<
|
|
std::wstring_view,
|
|
gsl::span<const WORD>,
|
|
gsl::span<const CHAR_INFO>,
|
|
gsl::span<const OutputCell>,
|
|
std::monostate>
|
|
_run;
|
|
|
|
TextAttribute _attr;
|
|
|
|
bool _TryMoveTrailing() noexcept;
|
|
|
|
static OutputCellView s_GenerateView(const std::wstring_view view);
|
|
|
|
static OutputCellView s_GenerateView(const std::wstring_view view,
|
|
const TextAttribute attr);
|
|
|
|
static OutputCellView s_GenerateView(const std::wstring_view view,
|
|
const TextAttribute attr,
|
|
const TextAttributeBehavior behavior);
|
|
|
|
static OutputCellView s_GenerateView(const wchar_t& wch) noexcept;
|
|
static OutputCellView s_GenerateViewLegacyAttr(const WORD& legacyAttr) noexcept;
|
|
static OutputCellView s_GenerateView(const TextAttribute& attr) noexcept;
|
|
static OutputCellView s_GenerateView(const wchar_t& wch, const TextAttribute& attr) noexcept;
|
|
static OutputCellView s_GenerateView(const CHAR_INFO& charInfo) noexcept;
|
|
|
|
static OutputCellView s_GenerateView(const OutputCell& cell);
|
|
|
|
OutputCellView _currentView;
|
|
|
|
size_t _pos;
|
|
size_t _distance;
|
|
size_t _fillLimit;
|
|
};
|