Merge branch 'subtree'
[fanfix.git] / src / jexer / teditor / Word.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.teditor;
30
31import jexer.bits.CellAttributes;
2d3f60d8 32import jexer.bits.StringUtils;
12b55d76
KL
33
34/**
35 * A Word represents text that was entered by the user. It can be either
36 * whitespace or non-whitespace.
e8a11f98
KL
37 *
38 * Very dumb highlighting is supported, it has no sense of parsing (not even
39 * comments). For now this only highlights some Java keywords and
40 * puctuation.
12b55d76
KL
41 */
42public class Word {
43
615a0d99
KL
44 // ------------------------------------------------------------------------
45 // Variables --------------------------------------------------------------
46 // ------------------------------------------------------------------------
47
12b55d76
KL
48 /**
49 * The color to render this word as on screen.
50 */
51 private CellAttributes color = new CellAttributes();
52
e8a11f98
KL
53 /**
54 * The default color for the TEditor class.
55 */
56 private CellAttributes defaultColor = null;
57
58 /**
59 * The text highlighter to use.
60 */
61 private Highlighter highlighter = null;
62
12b55d76
KL
63 /**
64 * The actual text of this word. Average word length is 6 characters,
65 * with a lot of shorter ones, so start with 3.
66 */
67 private StringBuilder text = new StringBuilder(3);
68
615a0d99
KL
69 // ------------------------------------------------------------------------
70 // Constructors -----------------------------------------------------------
71 // ------------------------------------------------------------------------
72
73 /**
74 * Construct a word with one character.
75 *
76 * @param ch the first character of the word
77 * @param defaultColor the color for unhighlighted text
78 * @param highlighter the highlighter to use
79 */
2d3f60d8 80 public Word(final int ch, final CellAttributes defaultColor,
615a0d99
KL
81 final Highlighter highlighter) {
82
83 this.defaultColor = defaultColor;
84 this.highlighter = highlighter;
2d3f60d8 85 text.append(Character.toChars(ch));
615a0d99
KL
86 }
87
88 /**
89 * Construct a word with an empty string.
90 *
91 * @param defaultColor the color for unhighlighted text
92 * @param highlighter the highlighter to use
93 */
94 public Word(final CellAttributes defaultColor,
95 final Highlighter highlighter) {
96
97 this.defaultColor = defaultColor;
98 this.highlighter = highlighter;
99 }
100
101 // ------------------------------------------------------------------------
102 // Word -------------------------------------------------------------------
103 // ------------------------------------------------------------------------
104
12b55d76
KL
105 /**
106 * Get the color used to display this word on screen.
107 *
108 * @return the color
109 */
110 public CellAttributes getColor() {
111 return new CellAttributes(color);
112 }
113
114 /**
115 * Set the color used to display this word on screen.
116 *
117 * @param color the color
118 */
119 public void setColor(final CellAttributes color) {
120 color.setTo(color);
121 }
122
123 /**
124 * Get the text to display.
125 *
126 * @return the text
127 */
128 public String getText() {
129 return text.toString();
130 }
131
132 /**
133 * Get the on-screen display length.
134 *
135 * @return the number of cells needed to display this word
136 */
137 public int getDisplayLength() {
2d3f60d8 138 return StringUtils.width(text.toString());
12b55d76
KL
139 }
140
141 /**
142 * See if this is a whitespace word. Note that empty string is
143 * considered whitespace.
144 *
145 * @return true if this word is whitespace
146 */
147 public boolean isWhitespace() {
148 if (text.length() == 0) {
149 return true;
150 }
151 if (Character.isWhitespace(text.charAt(0))) {
152 return true;
153 }
154 return false;
155 }
156
e8a11f98
KL
157 /**
158 * Perform highlighting.
12b55d76 159 */
e8a11f98
KL
160 public void applyHighlight() {
161 color.setTo(defaultColor);
162 if (highlighter == null) {
163 return;
164 }
165 String key = text.toString();
166 CellAttributes newColor = highlighter.getColor(key);
167 if (newColor != null) {
168 color.setTo(newColor);
169 }
170 }
12b55d76
KL
171
172 /**
173 * Add a character to this word. If this is a whitespace character
174 * adding to a non-whitespace word, create a new word and return that;
175 * similarly if this a non-whitespace character adding to a whitespace
71a389c9
KL
176 * word, create a new word and return that. Note package private access:
177 * this is only called by Line to figure out highlighting boundaries.
12b55d76
KL
178 *
179 * @param ch the new character to add
180 * @return either this word (if it was added), or a new word that
181 * contains ch
182 */
2d3f60d8 183 public Word addChar(final int ch) {
12b55d76 184 if (text.length() == 0) {
2d3f60d8 185 text.append(Character.toChars(ch));
12b55d76
KL
186 return this;
187 }
e8a11f98
KL
188
189 // Give the highlighter the option to split here.
190 if (highlighter != null) {
191 if (highlighter.shouldSplit(ch)
192 || highlighter.shouldSplit(text.charAt(0))
193 ) {
194 Word newWord = new Word(ch, defaultColor, highlighter);
195 return newWord;
196 }
197 }
198
199 // Highlighter didn't care, so split at whitespace.
12b55d76
KL
200 if (Character.isWhitespace(text.charAt(0))
201 && Character.isWhitespace(ch)
202 ) {
e8a11f98 203 // Adding to a whitespace word, keep at it.
2d3f60d8 204 text.append(Character.toChars(ch));
12b55d76
KL
205 return this;
206 }
207 if (!Character.isWhitespace(text.charAt(0))
208 && !Character.isWhitespace(ch)
209 ) {
e8a11f98 210 // Adding to a non-whitespace word, keep at it.
2d3f60d8 211 text.append(Character.toChars(ch));
12b55d76
KL
212 return this;
213 }
214
e8a11f98
KL
215 // Switching from whitespace to non-whitespace or vice versa, so
216 // split here.
217 Word newWord = new Word(ch, defaultColor, highlighter);
12b55d76
KL
218 return newWord;
219 }
220
221}