StylingHelper.java

  1/*
  2 * Copyright (c) 2017, Daniel Gultsch All rights reserved.
  3 *
  4 * Redistribution and use in source and binary forms, with or without modification,
  5 * are permitted provided that the following conditions are met:
  6 *
  7 * 1. Redistributions of source code must retain the above copyright notice, this
  8 * list of conditions and the following disclaimer.
  9 *
 10 * 2. Redistributions in binary form must reproduce the above copyright notice,
 11 * this list of conditions and the following disclaimer in the documentation and/or
 12 * other materials provided with the distribution.
 13 *
 14 * 3. Neither the name of the copyright holder nor the names of its contributors
 15 * may be used to endorse or promote products derived from this software without
 16 * specific prior written permission.
 17 *
 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 22 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 25 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 28 */
 29
 30package eu.siacs.conversations.utils;
 31
 32import android.content.Context;
 33import android.graphics.Color;
 34import android.graphics.Typeface;
 35import android.text.Editable;
 36import android.text.ParcelableSpan;
 37import android.text.Spannable;
 38import android.text.SpannableString;
 39import android.text.Spanned;
 40import android.text.TextWatcher;
 41import android.text.style.BackgroundColorSpan;
 42import android.text.style.ForegroundColorSpan;
 43import android.text.style.StrikethroughSpan;
 44import android.text.style.StyleSpan;
 45import android.text.style.TypefaceSpan;
 46import android.widget.EditText;
 47import android.widget.TextView;
 48
 49import androidx.annotation.ColorInt;
 50import androidx.core.content.ContextCompat;
 51
 52import com.google.android.material.color.MaterialColors;
 53
 54import java.util.ArrayList;
 55import java.util.Arrays;
 56import java.util.List;
 57
 58import eu.siacs.conversations.R;
 59import eu.siacs.conversations.entities.Message;
 60import eu.siacs.conversations.ui.text.QuoteSpan;
 61
 62public class StylingHelper {
 63
 64	private static final List<? extends Class<? extends ParcelableSpan>> SPAN_CLASSES = Arrays.asList(
 65			StyleSpan.class,
 66			StrikethroughSpan.class,
 67			TypefaceSpan.class,
 68			ForegroundColorSpan.class
 69	);
 70
 71	public static void clear(final Editable editable) {
 72		final int end = editable.length() - 1;
 73		for (Class<? extends ParcelableSpan> clazz : SPAN_CLASSES) {
 74			for (ParcelableSpan span : editable.getSpans(0, end, clazz)) {
 75				editable.removeSpan(span);
 76			}
 77		}
 78	}
 79
 80	public static void format(final Editable editable, int start, int end, @ColorInt int textColor) {
 81		for (ImStyleParser.Style style : ImStyleParser.parse(editable, start, end)) {
 82			final int keywordLength = style.getKeyword().length();
 83			editable.setSpan(createSpanForStyle(style), style.getStart() + keywordLength, style.getEnd() - keywordLength + 1, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
 84			makeKeywordOpaque(editable, style.getStart(), style.getStart() + keywordLength, textColor);
 85			makeKeywordOpaque(editable, style.getEnd() - keywordLength + 1, style.getEnd() + 1, textColor);
 86		}
 87	}
 88
 89	public static void format(final Editable editable, @ColorInt int textColor) {
 90		int end = 0;
 91		Message.MergeSeparator[] spans = editable.getSpans(0, editable.length() - 1, Message.MergeSeparator.class);
 92		for (Message.MergeSeparator span : spans) {
 93			format(editable, end, editable.getSpanStart(span), textColor);
 94			end = editable.getSpanEnd(span);
 95		}
 96		format(editable, end, editable.length() - 1, textColor);
 97	}
 98
 99	public static void highlight(final TextView view, final Editable editable, final List<String> needles) {
100		for (final String needle : needles) {
101			if (!FtsUtils.isKeyword(needle)) {
102				highlight(view, editable, needle);
103			}
104		}
105	}
106
107	public static List<String> filterHighlightedWords(List<String> terms) {
108		List<String> words = new ArrayList<>();
109		for (String term : terms) {
110			if (!FtsUtils.isKeyword(term)) {
111				StringBuilder builder = new StringBuilder();
112				for (int codepoint, i = 0; i < term.length(); i += Character.charCount(codepoint)) {
113					codepoint = term.codePointAt(i);
114					if (Character.isLetterOrDigit(codepoint)) {
115						builder.append(Character.toChars(codepoint));
116					} else if (builder.length() > 0) {
117						words.add(builder.toString());
118						builder.delete(0, builder.length());
119					}
120				}
121				if (builder.length() > 0) {
122					words.add(builder.toString());
123				}
124			}
125		}
126		return words;
127	}
128
129	private static void highlight(final TextView view, final Editable editable, final String needle) {
130		final int length = needle.length();
131		String string = editable.toString();
132		int start = indexOfIgnoreCase(string, needle, 0);
133		while (start != -1) {
134			int end = start + length;
135			editable.setSpan(new BackgroundColorSpan(MaterialColors.getColor(view, com.google.android.material.R.attr.colorPrimaryFixedDim)), start, end, SpannableString.SPAN_EXCLUSIVE_EXCLUSIVE);
136			editable.setSpan(new ForegroundColorSpan(MaterialColors.getColor(view, com.google.android.material.R.attr.colorOnPrimaryFixed)), start, end, SpannableString.SPAN_EXCLUSIVE_EXCLUSIVE);
137			start = indexOfIgnoreCase(string, needle, start + length);
138		}
139
140	}
141
142	static CharSequence subSequence(CharSequence charSequence, int start, int end) {
143		if (start == 0 && charSequence.length() + 1 == end) {
144			return charSequence;
145		}
146		if (charSequence instanceof Spannable spannable) {
147			Spannable sub = (Spannable) spannable.subSequence(start, end);
148			for (Class<? extends ParcelableSpan> clazz : SPAN_CLASSES) {
149				ParcelableSpan[] spannables = spannable.getSpans(start, end, clazz);
150				for (ParcelableSpan parcelableSpan : spannables) {
151					int beginSpan = spannable.getSpanStart(parcelableSpan);
152					int endSpan = spannable.getSpanEnd(parcelableSpan);
153					if (beginSpan >= start && endSpan <= end) {
154						continue;
155					}
156					sub.setSpan(clone(parcelableSpan), Math.max(beginSpan - start, 0), Math.min(Math.max(sub.length() - 1, 0), endSpan), Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
157				}
158			}
159			return sub;
160		} else {
161			return charSequence.subSequence(start, end);
162		}
163	}
164
165	private static ParcelableSpan clone(ParcelableSpan span) {
166		if (span instanceof ForegroundColorSpan) {
167			return new ForegroundColorSpan(((ForegroundColorSpan) span).getForegroundColor());
168		} else if (span instanceof TypefaceSpan) {
169			return new TypefaceSpan(((TypefaceSpan) span).getFamily());
170		} else if (span instanceof StyleSpan) {
171			return new StyleSpan(((StyleSpan) span).getStyle());
172		} else if (span instanceof StrikethroughSpan) {
173			return new StrikethroughSpan();
174		} else {
175			throw new AssertionError("Unknown Span");
176		}
177	}
178
179	private static ParcelableSpan createSpanForStyle(final ImStyleParser.Style style) {
180        return switch (style.getKeyword()) {
181            case "*" -> new StyleSpan(Typeface.BOLD);
182            case "_" -> new StyleSpan(Typeface.ITALIC);
183            case "~" -> new StrikethroughSpan();
184            case "`", "```" -> new TypefaceSpan("monospace");
185            default -> throw new AssertionError("Unknown Style");
186        };
187	}
188
189	private static void makeKeywordOpaque(final Editable editable, int start, int end, @ColorInt int fallbackTextColor) {
190		QuoteSpan[] quoteSpans = editable.getSpans(start, end, QuoteSpan.class);
191		@ColorInt int textColor = quoteSpans.length > 0 ? quoteSpans[0].getColor() : fallbackTextColor;
192		@ColorInt int keywordColor = transformColor(textColor);
193		editable.setSpan(new ForegroundColorSpan(keywordColor), start, end, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
194	}
195
196	private static
197	@ColorInt
198	int transformColor(@ColorInt int c) {
199		return Color.argb(Math.round(Color.alpha(c) * 0.45f), Color.red(c), Color.green(c), Color.blue(c));
200	}
201
202	private static int indexOfIgnoreCase(final String haystack, final String needle, final int start) {
203		if (haystack == null || needle == null) {
204			return -1;
205		}
206		final int endLimit = haystack.length() - needle.length() + 1;
207		if (start > endLimit) {
208			return -1;
209		}
210		if (needle.length() == 0) {
211			return start;
212		}
213		for (int i = start; i < endLimit; i++) {
214			if (haystack.regionMatches(true, i, needle, 0, needle.length())) {
215				return i;
216			}
217		}
218		return -1;
219	}
220
221	public static class MessageEditorStyler implements TextWatcher {
222
223		private final EditText mEditText;
224
225		public MessageEditorStyler(EditText editText) {
226			this.mEditText = editText;
227		}
228
229		@Override
230		public void beforeTextChanged(CharSequence charSequence, int i, int i1, int i2) {
231
232		}
233
234		@Override
235		public void onTextChanged(CharSequence charSequence, int i, int i1, int i2) {
236
237		}
238
239		@Override
240		public void afterTextChanged(Editable editable) {
241			clear(editable);
242			format(editable, mEditText.getCurrentTextColor());
243		}
244	}
245}