retrofit from gjexer
[nikiroo-utils.git] / src / jexer / TEditorWidget.java
CommitLineData
12b55d76
KL
1/*
2 * Jexer - Java Text User Interface
3 *
4 * The MIT License (MIT)
5 *
a69ed767 6 * Copyright (C) 2019 Kevin Lamonte
12b55d76
KL
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
28 */
29package jexer;
30
71a389c9
KL
31import java.io.IOException;
32
12b55d76
KL
33import jexer.bits.CellAttributes;
34import jexer.event.TKeypressEvent;
35import jexer.event.TMouseEvent;
e8a11f98 36import jexer.event.TResizeEvent;
12b55d76
KL
37import jexer.teditor.Document;
38import jexer.teditor.Line;
39import jexer.teditor.Word;
40import static jexer.TKeypress.*;
41
42/**
43 * TEditorWidget displays an editable text document. It is unaware of
44 * scrolling behavior, but can respond to mouse and keyboard events.
45 */
051e2913 46public class TEditorWidget extends TWidget {
12b55d76 47
615a0d99
KL
48 // ------------------------------------------------------------------------
49 // Constants --------------------------------------------------------------
50 // ------------------------------------------------------------------------
51
b1a8acec
KL
52 /**
53 * The number of lines to scroll on mouse wheel up/down.
54 */
55 private static final int wheelScrollSize = 3;
56
615a0d99
KL
57 // ------------------------------------------------------------------------
58 // Variables --------------------------------------------------------------
59 // ------------------------------------------------------------------------
60
12b55d76
KL
61 /**
62 * The document being edited.
63 */
64 private Document document;
65
e8a11f98
KL
66 /**
67 * The default color for the TEditor class.
68 */
69 private CellAttributes defaultColor = null;
70
71 /**
72 * The topmost line number in the visible area. 0-based.
73 */
74 private int topLine = 0;
75
76 /**
77 * The leftmost column number in the visible area. 0-based.
78 */
79 private int leftColumn = 0;
80
615a0d99
KL
81 // ------------------------------------------------------------------------
82 // Constructors -----------------------------------------------------------
83 // ------------------------------------------------------------------------
84
12b55d76
KL
85 /**
86 * Public constructor.
87 *
88 * @param parent parent widget
89 * @param text text on the screen
90 * @param x column relative to parent
91 * @param y row relative to parent
92 * @param width width of text area
93 * @param height height of text area
94 */
95 public TEditorWidget(final TWidget parent, final String text, final int x,
96 final int y, final int width, final int height) {
97
98 // Set parent and window
99 super(parent, x, y, width, height);
100
101 setCursorVisible(true);
e8a11f98
KL
102
103 defaultColor = getTheme().getColor("teditor");
104 document = new Document(text, defaultColor);
12b55d76
KL
105 }
106
615a0d99
KL
107 // ------------------------------------------------------------------------
108 // TWidget ----------------------------------------------------------------
109 // ------------------------------------------------------------------------
110
12b55d76
KL
111 /**
112 * Draw the text box.
113 */
114 @Override
115 public void draw() {
12b55d76
KL
116 for (int i = 0; i < getHeight(); i++) {
117 // Background line
e8a11f98 118 getScreen().hLineXY(0, i, getWidth(), ' ', defaultColor);
12b55d76
KL
119
120 // Now draw document's line
e8a11f98
KL
121 if (topLine + i < document.getLineCount()) {
122 Line line = document.getLine(topLine + i);
12b55d76
KL
123 int x = 0;
124 for (Word word: line.getWords()) {
e8a11f98
KL
125 // For now, we are cheating: draw outside the left region
126 // if needed and let screen do the clipping.
127 getScreen().putStringXY(x - leftColumn, i, word.getText(),
12b55d76
KL
128 word.getColor());
129 x += word.getDisplayLength();
e8a11f98 130 if (x - leftColumn > getWidth()) {
12b55d76
KL
131 break;
132 }
133 }
134 }
135 }
12b55d76
KL
136 }
137
138 /**
139 * Handle mouse press events.
140 *
141 * @param mouse mouse button press event
142 */
143 @Override
144 public void onMouseDown(final TMouseEvent mouse) {
145 if (mouse.isMouseWheelUp()) {
b1a8acec
KL
146 for (int i = 0; i < wheelScrollSize; i++) {
147 if (topLine > 0) {
148 topLine--;
149 alignDocument(false);
150 }
e8a11f98 151 }
12b55d76
KL
152 return;
153 }
154 if (mouse.isMouseWheelDown()) {
b1a8acec
KL
155 for (int i = 0; i < wheelScrollSize; i++) {
156 if (topLine < document.getLineCount() - 1) {
157 topLine++;
158 alignDocument(true);
159 }
e8a11f98 160 }
12b55d76
KL
161 return;
162 }
163
e8a11f98
KL
164 if (mouse.isMouse1()) {
165 // Set the row and column
166 int newLine = topLine + mouse.getY();
167 int newX = leftColumn + mouse.getX();
df602ccf 168 if (newLine > document.getLineCount() - 1) {
e8a11f98
KL
169 // Go to the end
170 document.setLineNumber(document.getLineCount() - 1);
171 document.end();
df602ccf
KL
172 if (newLine > document.getLineCount() - 1) {
173 setCursorY(document.getLineCount() - 1 - topLine);
e8a11f98 174 } else {
df602ccf 175 setCursorY(mouse.getY());
e8a11f98
KL
176 }
177 alignCursor();
178 return;
179 }
180
181 document.setLineNumber(newLine);
182 setCursorY(mouse.getY());
4297b49b 183 if (newX >= document.getCurrentLine().getDisplayLength()) {
e8a11f98
KL
184 document.end();
185 alignCursor();
186 } else {
df602ccf 187 document.setCursor(newX);
e8a11f98
KL
188 setCursorX(mouse.getX());
189 }
190 return;
191 }
12b55d76
KL
192
193 // Pass to children
194 super.onMouseDown(mouse);
195 }
196
197 /**
198 * Handle keystrokes.
199 *
200 * @param keypress keystroke event
201 */
202 @Override
203 public void onKeypress(final TKeypressEvent keypress) {
204 if (keypress.equals(kbLeft)) {
df602ccf
KL
205 document.left();
206 alignTopLine(false);
12b55d76 207 } else if (keypress.equals(kbRight)) {
df602ccf
KL
208 document.right();
209 alignTopLine(true);
12b55d76 210 } else if (keypress.equals(kbUp)) {
71a389c9
KL
211 document.up();
212 alignTopLine(false);
12b55d76 213 } else if (keypress.equals(kbDown)) {
71a389c9
KL
214 document.down();
215 alignTopLine(true);
12b55d76 216 } else if (keypress.equals(kbPgUp)) {
71a389c9
KL
217 document.up(getHeight() - 1);
218 alignTopLine(false);
12b55d76 219 } else if (keypress.equals(kbPgDn)) {
71a389c9
KL
220 document.down(getHeight() - 1);
221 alignTopLine(true);
12b55d76 222 } else if (keypress.equals(kbHome)) {
e8a11f98
KL
223 if (document.home()) {
224 leftColumn = 0;
225 if (leftColumn < 0) {
226 leftColumn = 0;
227 }
228 setCursorX(0);
229 }
12b55d76 230 } else if (keypress.equals(kbEnd)) {
e8a11f98
KL
231 if (document.end()) {
232 alignCursor();
233 }
12b55d76
KL
234 } else if (keypress.equals(kbCtrlHome)) {
235 document.setLineNumber(0);
236 document.home();
e8a11f98
KL
237 topLine = 0;
238 leftColumn = 0;
239 setCursorX(0);
240 setCursorY(0);
12b55d76
KL
241 } else if (keypress.equals(kbCtrlEnd)) {
242 document.setLineNumber(document.getLineCount() - 1);
243 document.end();
71a389c9 244 alignTopLine(false);
12b55d76
KL
245 } else if (keypress.equals(kbIns)) {
246 document.setOverwrite(!document.getOverwrite());
247 } else if (keypress.equals(kbDel)) {
248 document.del();
71a389c9 249 alignCursor();
12b55d76
KL
250 } else if (keypress.equals(kbBackspace)) {
251 document.backspace();
df602ccf
KL
252 alignTopLine(false);
253 } else if (keypress.equals(kbTab)) {
254 // TODO: tab character. For now just add spaces until we hit
255 // modulo 8.
256 for (int i = document.getCursor(); (i + 1) % 8 != 0; i++) {
257 document.addChar(' ');
258 }
e8a11f98 259 alignCursor();
71a389c9 260 } else if (keypress.equals(kbEnter)) {
df602ccf
KL
261 document.enter();
262 alignTopLine(true);
12b55d76
KL
263 } else if (!keypress.getKey().isFnKey()
264 && !keypress.getKey().isAlt()
265 && !keypress.getKey().isCtrl()
266 ) {
267 // Plain old keystroke, process it
268 document.addChar(keypress.getKey().getChar());
71a389c9 269 alignCursor();
12b55d76
KL
270 } else {
271 // Pass other keys (tab etc.) on to TWidget
272 super.onKeypress(keypress);
273 }
274 }
275
e8a11f98
KL
276 /**
277 * Method that subclasses can override to handle window/screen resize
278 * events.
279 *
280 * @param resize resize event
281 */
282 @Override
283 public void onResize(final TResizeEvent resize) {
284 // Change my width/height, and pull the cursor in as needed.
285 if (resize.getType() == TResizeEvent.Type.WIDGET) {
286 setWidth(resize.getWidth());
287 setHeight(resize.getHeight());
288 // See if the cursor is now outside the window, and if so move
289 // things.
290 if (getCursorX() >= getWidth()) {
291 leftColumn += getCursorX() - (getWidth() - 1);
292 setCursorX(getWidth() - 1);
293 }
294 if (getCursorY() >= getHeight()) {
295 topLine += getCursorY() - (getHeight() - 1);
296 setCursorY(getHeight() - 1);
297 }
298 } else {
299 // Let superclass handle it
300 super.onResize(resize);
301 }
302 }
303
615a0d99
KL
304 // ------------------------------------------------------------------------
305 // TEditorWidget ----------------------------------------------------------
306 // ------------------------------------------------------------------------
307
308 /**
309 * Align visible area with document current line.
310 *
311 * @param topLineIsTop if true, make the top visible line the document
312 * current line if it was off-screen. If false, make the bottom visible
313 * line the document current line.
314 */
315 private void alignTopLine(final boolean topLineIsTop) {
316 int line = document.getLineNumber();
317
318 if ((line < topLine) || (line > topLine + getHeight() - 1)) {
319 // Need to move topLine to bring document back into view.
320 if (topLineIsTop) {
321 topLine = line - (getHeight() - 1);
322 if (topLine < 0) {
323 topLine = 0;
324 }
325 assert (topLine >= 0);
326 } else {
327 topLine = line;
328 assert (topLine >= 0);
329 }
330 }
331
332 /*
333 System.err.println("line " + line + " topLine " + topLine);
334 */
335
336 // Document is in view, let's set cursorY
337 assert (line >= topLine);
338 setCursorY(line - topLine);
339 alignCursor();
340 }
341
342 /**
343 * Align document current line with visible area.
344 *
345 * @param topLineIsTop if true, make the top visible line the document
346 * current line if it was off-screen. If false, make the bottom visible
347 * line the document current line.
348 */
349 private void alignDocument(final boolean topLineIsTop) {
350 int line = document.getLineNumber();
351 int cursor = document.getCursor();
352
353 if ((line < topLine) || (line > topLine + getHeight() - 1)) {
354 // Need to move document to ensure it fits view.
355 if (topLineIsTop) {
356 document.setLineNumber(topLine);
357 } else {
358 document.setLineNumber(topLine + (getHeight() - 1));
359 }
360 if (cursor < document.getCurrentLine().getDisplayLength()) {
361 document.setCursor(cursor);
362 }
363 }
364
365 /*
366 System.err.println("getLineNumber() " + document.getLineNumber() +
367 " topLine " + topLine);
368 */
369
370 // Document is in view, let's set cursorY
371 setCursorY(document.getLineNumber() - topLine);
372 alignCursor();
373 }
374
375 /**
376 * Align visible cursor with document cursor.
377 */
378 private void alignCursor() {
379 int width = getWidth();
380
381 int desiredX = document.getCursor() - leftColumn;
382 if (desiredX < 0) {
383 // We need to push the screen to the left.
384 leftColumn = document.getCursor();
385 } else if (desiredX > width - 1) {
386 // We need to push the screen to the right.
387 leftColumn = document.getCursor() - (width - 1);
388 }
389
390 /*
391 System.err.println("document cursor " + document.getCursor() +
392 " leftColumn " + leftColumn);
393 */
394
395
396 setCursorX(document.getCursor() - leftColumn);
397 }
398
71a389c9
KL
399 /**
400 * Get the number of lines in the underlying Document.
401 *
402 * @return the number of lines
403 */
404 public int getLineCount() {
405 return document.getLineCount();
406 }
407
b6faeac0
KL
408 /**
409 * Get the current visible top row number. 1-based.
410 *
411 * @return the visible top row number. Row 1 is the first row.
412 */
413 public int getVisibleRowNumber() {
414 return topLine + 1;
415 }
416
417 /**
418 * Set the current visible row number. 1-based.
419 *
420 * @param row the new visible row number. Row 1 is the first row.
421 */
422 public void setVisibleRowNumber(final int row) {
423 assert (row > 0);
424 if ((row > 0) && (row < document.getLineCount())) {
425 topLine = row - 1;
426 alignDocument(true);
427 }
428 }
429
71a389c9
KL
430 /**
431 * Get the current editing row number. 1-based.
432 *
433 * @return the editing row number. Row 1 is the first row.
434 */
435 public int getEditingRowNumber() {
436 return document.getLineNumber() + 1;
437 }
438
439 /**
440 * Set the current editing row number. 1-based.
441 *
442 * @param row the new editing row number. Row 1 is the first row.
443 */
444 public void setEditingRowNumber(final int row) {
fe0770f9
KL
445 assert (row > 0);
446 if ((row > 0) && (row < document.getLineCount())) {
447 document.setLineNumber(row - 1);
448 alignTopLine(true);
449 }
71a389c9
KL
450 }
451
452 /**
453 * Get the current editing column number. 1-based.
454 *
455 * @return the editing column number. Column 1 is the first column.
456 */
457 public int getEditingColumnNumber() {
458 return document.getCursor() + 1;
459 }
460
461 /**
462 * Set the current editing column number. 1-based.
463 *
464 * @param column the new editing column number. Column 1 is the first
465 * column.
466 */
467 public void setEditingColumnNumber(final int column) {
fe0770f9
KL
468 if ((column > 0) && (column < document.getLineLength())) {
469 document.setCursor(column - 1);
470 alignCursor();
471 }
71a389c9
KL
472 }
473
474 /**
475 * Get the maximum possible row number. 1-based.
476 *
477 * @return the maximum row number. Row 1 is the first row.
478 */
479 public int getMaximumRowNumber() {
480 return document.getLineCount() + 1;
481 }
482
483 /**
484 * Get the maximum possible column number. 1-based.
485 *
486 * @return the maximum column number. Column 1 is the first column.
487 */
488 public int getMaximumColumnNumber() {
489 return document.getLineLengthMax() + 1;
490 }
491
492 /**
493 * Get the dirty value.
494 *
495 * @return true if the buffer is dirty
496 */
497 public boolean isDirty() {
498 return document.isDirty();
499 }
500
501 /**
502 * Save contents to file.
503 *
504 * @param filename file to save to
505 * @throws IOException if a java.io operation throws
506 */
507 public void saveToFilename(final String filename) throws IOException {
508 document.saveToFilename(filename);
509 }
510
12b55d76 511}