KTextEditor

katetextlayout.cpp
1/*
2 SPDX-FileCopyrightText: 2002-2005 Hamish Rodda <rodda@kde.org>
3 SPDX-FileCopyrightText: 2003 Anakim Border <aborder@sources.sourceforge.net>
4
5 SPDX-License-Identifier: LGPL-2.0-or-later
6*/
7
8#include "katetextlayout.h"
9
10#include "katepartdebug.h"
11
12KateTextLayout::KateTextLayout(KateLineLayout *line, int viewLine)
13 : m_lineLayout(line)
14 , m_viewLine(viewLine)
15 , m_startX(m_viewLine ? -1 : 0)
16{
17 if (isValid()) {
18 m_textLayout = m_lineLayout->layout().lineAt(m_viewLine);
19 }
20}
21
22bool KateTextLayout::isDirty() const
23{
24 if (!isValid()) {
25 return m_invalidDirty;
26 }
27
28 return m_lineLayout->isDirty(viewLine());
29}
30
31bool KateTextLayout::setDirty(bool dirty)
32{
33 if (!isValid()) {
34 return (m_invalidDirty = dirty);
35 }
36
37 return m_lineLayout->setDirty(viewLine(), dirty);
38}
39
40bool KateTextLayout::includesCursor(const KTextEditor::Cursor realCursor) const
41{
42 return realCursor.line() == line() && realCursor.column() >= startCol() && (!wrap() || realCursor.column() < endCol());
43}
44
45int KateTextLayout::xOffset() const
46{
47 if (!isValid()) {
48 return 0;
49 }
50
51 return startX() ? m_lineLayout->shiftX : 0;
52}
53
54void KateTextLayout::debugOutput() const
55{
56 qCDebug(LOG_KTE) << "KateTextLayout: " << m_lineLayout << " valid " << isValid() << " line " << m_lineLayout->line() << " (" << line() << ") cols ["
57 << startCol() << " -> " << endCol() << "] x [" << startX() << " -> " << endX() << " off " << m_lineLayout->shiftX << "] wrap " << wrap();
58}
59
60bool operator>(const KateTextLayout &r, const KTextEditor::Cursor c)
61{
62 return r.line() > c.line() || r.endCol() > c.column();
63}
64
65bool operator>=(const KateTextLayout &r, const KTextEditor::Cursor c)
66{
67 return r.line() > c.line() || r.endCol() >= c.column();
68}
69
70bool operator<(const KateTextLayout &r, const KTextEditor::Cursor c)
71{
72 return r.line() < c.line() || r.startCol() < c.column();
73}
74
75bool operator<=(const KateTextLayout &r, const KTextEditor::Cursor c)
76{
77 return r.line() < c.line() || r.startCol() <= c.column();
78}
79
80bool KateTextLayout::isValid() const
81{
82 return m_lineLayout && m_lineLayout->isValid() && m_viewLine >= 0 && m_viewLine < m_lineLayout->viewLineCount();
83}
84
85int KateTextLayout::line() const
86{
87 if (!isValid()) {
88 return -1;
89 }
90
91 return m_lineLayout->line();
92}
93
94int KateTextLayout::virtualLine() const
95{
96 if (!isValid()) {
97 return -1;
98 }
99
100 return m_lineLayout->virtualLine();
101}
102
104{
105 if (!isValid()) {
106 return 0;
107 }
108
109 return m_viewLine;
110}
111
112const QTextLine &KateTextLayout::lineLayout() const
113{
114 return m_textLayout;
115}
116
117KateLineLayout *KateTextLayout::kateLineLayout() const
118{
119 return m_lineLayout;
120}
121
122int KateTextLayout::startCol() const
123{
124 if (!isValid()) {
125 return 0;
126 }
127
128 return lineLayout().textStart();
129}
130
131KTextEditor::Cursor KateTextLayout::start() const
132{
133 return KTextEditor::Cursor(line(), startCol());
134}
135
136int KateTextLayout::endCol(bool indicateEOL) const
137{
138 if (!isValid()) {
139 return 0;
140 }
141
142 if (indicateEOL) {
143 if (viewLine() == kateLineLayout()->viewLineCount() - 1) {
144 return -1;
145 }
146 }
147
148 return startCol() + m_textLayout.textLength();
149}
150
152{
153 return KTextEditor::Cursor(line(), endCol(indicateEOL));
154}
155
156int KateTextLayout::length() const
157{
158 if (!isValid()) {
159 return 0;
160 }
161
162 return m_textLayout.textLength();
163}
164
165bool KateTextLayout::isEmpty() const
166{
167 if (!isValid()) {
168 return true;
169 }
170
171 return startCol() == 0 && endCol() == 0;
172}
173
174bool KateTextLayout::wrap() const
175{
176 if (!isValid()) {
177 return false;
178 }
179
180 return viewLine() < m_lineLayout->viewLineCount() - 1;
181}
182
183int KateTextLayout::startX() const
184{
185 if (!isValid()) {
186 return 0;
187 }
188
189 if (m_startX == -1) {
190 // viewLine is already > 0, from the constructor
191 for (int i = 0; i < viewLine(); ++i) {
192 m_startX += (int)m_lineLayout->layout().lineAt(i).naturalTextWidth();
193 }
194 }
195
196 return m_startX;
197}
198
199int KateTextLayout::endX() const
200{
201 if (!isValid()) {
202 return 0;
203 }
204
205 return startX() + (int)m_textLayout.naturalTextWidth();
206}
207
208int KateTextLayout::width() const
209{
210 if (!isValid()) {
211 return 0;
212 }
213
214 return (int)m_textLayout.naturalTextWidth();
215}
216
217KateTextLayout KateTextLayout::invalid()
218{
219 return KateTextLayout();
220}
221
222bool KateTextLayout::isRightToLeft() const
223{
224 if (m_lineLayout) {
225 return m_lineLayout->isRightToLeft();
226 }
227
228 return false;
229}
The Cursor represents a position in a Document.
Definition cursor.h:75
constexpr int column() const noexcept
Retrieve the column on which this cursor is situated.
Definition cursor.h:192
constexpr int line() const noexcept
Retrieve the line on which this cursor is situated.
Definition cursor.h:174
This class represents one visible line of text; with dynamic wrapping, many KateTextLayouts can be ne...
KTextEditor::Cursor end(bool indicateEOL=false) const
Return the end position of this text line.
int endCol(bool indicateEOL=false) const
Return the end column of this text line.
int viewLine() const
Return the index of this visual line inside the document line (KateLineLayout).
bool isValid(QStringView ifopt)
bool operator<(const PosRange< Trait > &l, const PosRange< Trait > &r)
QTextLine lineAt(int i) const const
qreal naturalTextWidth() const const
int textLength() const const
int textStart() const const
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 20 2024 11:56:00 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.