/src/serenity/Userland/Libraries/LibLine/SuggestionDisplay.h
Line | Count | Source |
1 | | /* |
2 | | * Copyright (c) 2020-2022, the SerenityOS developers. |
3 | | * |
4 | | * SPDX-License-Identifier: BSD-2-Clause |
5 | | */ |
6 | | |
7 | | #pragma once |
8 | | |
9 | | #include <AK/Forward.h> |
10 | | #include <LibLine/StringMetrics.h> |
11 | | #include <LibLine/SuggestionManager.h> |
12 | | |
13 | | namespace Line { |
14 | | |
15 | | class Editor; |
16 | | |
17 | | class SuggestionDisplay { |
18 | | public: |
19 | 0 | virtual ~SuggestionDisplay() = default; |
20 | | virtual ErrorOr<void> display(SuggestionManager const&) = 0; |
21 | | virtual ErrorOr<bool> cleanup() = 0; |
22 | | virtual void finish() = 0; |
23 | | virtual void set_initial_prompt_lines(size_t) = 0; |
24 | | |
25 | | ErrorOr<void> redisplay(SuggestionManager const& manager, size_t lines, size_t columns) |
26 | 0 | { |
27 | 0 | if (m_is_showing_suggestions) { |
28 | 0 | TRY(cleanup()); |
29 | 0 | set_vt_size(lines, columns); |
30 | 0 | TRY(display(manager)); |
31 | 0 | } else { |
32 | 0 | set_vt_size(lines, columns); |
33 | 0 | } |
34 | |
|
35 | 0 | return {}; |
36 | 0 | } |
37 | | |
38 | | virtual void set_vt_size(size_t lines, size_t columns) = 0; |
39 | | |
40 | 0 | size_t origin_row() const { return m_origin_row; } |
41 | 0 | size_t origin_col() const { return m_origin_column; } |
42 | | |
43 | | void set_origin(int row, int col, Badge<Editor>) |
44 | 0 | { |
45 | 0 | m_origin_row = row; |
46 | 0 | m_origin_column = col; |
47 | 0 | } |
48 | | |
49 | | protected: |
50 | 0 | void did_display() { m_is_showing_suggestions = true; } |
51 | 0 | void did_cleanup() { m_is_showing_suggestions = false; } |
52 | | |
53 | | int m_origin_row { 0 }; |
54 | | int m_origin_column { 0 }; |
55 | | bool m_is_showing_suggestions { false }; |
56 | | }; |
57 | | |
58 | | class XtermSuggestionDisplay : public SuggestionDisplay { |
59 | | public: |
60 | | XtermSuggestionDisplay(size_t lines, size_t columns) |
61 | 0 | : m_num_lines(lines) |
62 | 0 | , m_num_columns(columns) |
63 | 0 | { |
64 | 0 | } |
65 | 0 | virtual ~XtermSuggestionDisplay() override = default; |
66 | | virtual ErrorOr<void> display(SuggestionManager const&) override; |
67 | | virtual ErrorOr<bool> cleanup() override; |
68 | | virtual void finish() override |
69 | 0 | { |
70 | 0 | m_pages.clear(); |
71 | 0 | } |
72 | | |
73 | | virtual void set_initial_prompt_lines(size_t lines) override |
74 | 0 | { |
75 | 0 | m_prompt_lines_at_suggestion_initiation = lines; |
76 | 0 | } |
77 | | |
78 | | virtual void set_vt_size(size_t lines, size_t columns) override |
79 | 0 | { |
80 | 0 | m_num_lines = lines; |
81 | 0 | m_num_columns = columns; |
82 | 0 | m_pages.clear(); |
83 | 0 | } |
84 | | |
85 | | private: |
86 | | size_t fit_to_page_boundary(size_t selection_index); |
87 | | size_t m_lines_used_for_last_suggestions { 0 }; |
88 | | size_t m_num_lines { 0 }; |
89 | | size_t m_num_columns { 0 }; |
90 | | size_t m_prompt_lines_at_suggestion_initiation { 0 }; |
91 | | |
92 | | struct PageRange { |
93 | | size_t start; |
94 | | size_t end; |
95 | | }; |
96 | | Vector<PageRange> m_pages; |
97 | | }; |
98 | | |
99 | | } |