aboutsummaryrefslogtreecommitdiff
path: root/include/ricochet/tui/view.hh
blob: cc1d0fd00455db994e1223b7532a998020c18392 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*
 * Ricochet - A minimalist CLI web browser for fast, distraction-free navigation.
 * Copyright (C) 2026  Richard Qin
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#pragma once

#include "ricochet/tui/position.hh"

#include <cstddef>
#include <cstdint>
#include <optional>
#include <string>
#include <vector>

namespace ricochet::tui {

enum class SelectionDirection : std::uint8_t
{
  Forward,
  Backward
};

struct SelectionSnapshot
{
  // The normalized half-open range also covers any controls between its endpoints.
  DocumentRange range {};
  SelectionDirection direction { SelectionDirection::Forward };
  // Inclusive endpoint units retain the anchor through reversal and history restore.
  DocumentRange anchor {};
  DocumentRange active {};
};

struct HorizontalScroll
{
  BlockId block {};
  std::size_t columns { 0 };
};

struct SearchSnapshot
{
  std::string query {};
  std::optional<DocumentRange> current_match {};
};

// All positions and ranges belong to scope and draft_revision.
// Editing sessions and control values (including passwords) are not exported here.
struct ViewSnapshot
{
  DocumentScope scope {};
  DraftRevision draft_revision {};
  DisplayPosition cursor {};
  DisplayPosition viewport_anchor {};
  // Relative visual row for blank table space with no text at the exact top.
  std::int64_t viewport_row_offset { 0 };
  std::optional<SelectionSnapshot> selection {};
  std::vector<HorizontalScroll> horizontal_scroll {};
  SearchSnapshot search {};
};

} // namespace ricochet::tui