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.preference.PreferenceManager;
 36import android.text.Editable;
 37import android.text.ParcelableSpan;
 38import android.text.Spannable;
 39import android.text.SpannableString;
 40import android.text.Spanned;
 41import android.text.TextWatcher;
 42import android.text.style.BackgroundColorSpan;
 43import android.text.style.ForegroundColorSpan;
 44import android.text.style.RelativeSizeSpan;
 45import android.text.style.StrikethroughSpan;
 46import android.text.style.StyleSpan;
 47import android.text.style.TypefaceSpan;
 48import android.widget.EditText;
 49import android.widget.TextView;
 50
 51import androidx.annotation.ColorInt;
 52import androidx.core.content.ContextCompat;
 53
 54import com.google.android.material.color.MaterialColors;
 55
 56import java.util.ArrayList;
 57import java.util.Arrays;
 58import java.util.List;
 59
 60import eu.siacs.conversations.R;
 61import eu.siacs.conversations.entities.Message;
 62import eu.siacs.conversations.ui.adapter.MessageAdapter;
 63import eu.siacs.conversations.ui.text.QuoteSpan;
 64
 65public class StylingHelper {
 66
 67	public static final int XHTML_IGNORE = 1;
 68	public static final int XHTML_REMOVE = 2;
 69	public static final int XHTML_EMPHASIS = 3;
 70
 71	private static final List<? extends Class<? extends ParcelableSpan>> SPAN_CLASSES = Arrays.asList(
 72			StyleSpan.class,
 73			StrikethroughSpan.class,
 74			TypefaceSpan.class,
 75			ForegroundColorSpan.class
 76	);
 77
 78	public static void clear(final Editable editable) {
 79		final int end = editable.length() - 1;
 80		for (Class<? extends ParcelableSpan> clazz : SPAN_CLASSES) {
 81			for (ParcelableSpan span : editable.getSpans(0, end, clazz)) {
 82				editable.removeSpan(span);
 83			}
 84		}
 85	}
 86
 87	public static void format(final Editable editable, int start, int end, @ColorInt int textColor, final boolean composing) {
 88		for (ImStyleParser.Style style : ImStyleParser.parse(editable, start, end)) {
 89			final int keywordLength = style.getKeyword().length();
 90			editable.setSpan(createSpanForStyle(style), style.getStart() + keywordLength, style.getEnd() - keywordLength + 1, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE | ("*".equals(style.getKeyword()) || "_".equals(style.getKeyword()) ? XHTML_EMPHASIS << Spanned.SPAN_USER_SHIFT : 0));
 91			makeKeywordOpaque(editable, style.getStart(), style.getStart() + keywordLength + ("```".equals(style.getKeyword()) ? 1 : 0), textColor, composing);
 92			makeKeywordOpaque(editable, style.getEnd() - keywordLength + 1, style.getEnd() + 1, textColor, composing);
 93		}
 94	}
 95
 96	public static void format(final Editable editable, @ColorInt int textColor) {
 97		format(editable, textColor, false);
 98	}
 99
100	public static void format(final Editable editable, @ColorInt int textColor, final boolean composing) {
101		int end = 0;
102		Message.MergeSeparator[] spans = editable.getSpans(0, editable.length() - 1, Message.MergeSeparator.class);
103		for (Message.MergeSeparator span : spans) {
104			format(editable, end, editable.getSpanStart(span), textColor, composing);
105			end = editable.getSpanEnd(span);
106		}
107		format(editable, end, editable.length() - 1, textColor, composing);
108	}
109
110	public static void highlight(final TextView view, final Editable editable, final List<String> needles) {
111		for (final String needle : needles) {
112			if (!FtsUtils.isKeyword(needle)) {
113				highlight(view, editable, needle);
114			}
115		}
116	}
117
118	public static List<String> filterHighlightedWords(List<String> terms) {
119		List<String> words = new ArrayList<>();
120		for (String term : terms) {
121			if (!FtsUtils.isKeyword(term)) {
122				StringBuilder builder = new StringBuilder();
123				for (int codepoint, i = 0; i < term.length(); i += Character.charCount(codepoint)) {
124					codepoint = term.codePointAt(i);
125					if (Character.isLetterOrDigit(codepoint)) {
126						builder.append(Character.toChars(codepoint));
127					} else if (builder.length() > 0) {
128						words.add(builder.toString());
129						builder.delete(0, builder.length());
130					}
131				}
132				if (builder.length() > 0) {
133					words.add(builder.toString());
134				}
135			}
136		}
137		return words;
138	}
139
140	private static void highlight(final TextView view, final Editable editable, final String needle) {
141		final int length = needle.length();
142		String string = editable.toString();
143		int start = indexOfIgnoreCase(string, needle, 0);
144		while (start != -1) {
145			int end = start + length;
146			editable.setSpan(new BackgroundColorSpan(MaterialColors.getColor(view, com.google.android.material.R.attr.colorPrimaryFixedDim)), start, end, SpannableString.SPAN_EXCLUSIVE_EXCLUSIVE);
147			editable.setSpan(new ForegroundColorSpan(MaterialColors.getColor(view, com.google.android.material.R.attr.colorOnPrimaryFixed)), start, end, SpannableString.SPAN_EXCLUSIVE_EXCLUSIVE);
148			start = indexOfIgnoreCase(string, needle, start + length);
149		}
150
151	}
152
153	static CharSequence subSequence(CharSequence charSequence, int start, int end) {
154		if (start == 0 && charSequence.length() + 1 == end) {
155			return charSequence;
156		}
157		if (charSequence instanceof Spannable spannable) {
158			Spannable sub = (Spannable) spannable.subSequence(start, end);
159			for (Class<? extends ParcelableSpan> clazz : SPAN_CLASSES) {
160				ParcelableSpan[] spannables = spannable.getSpans(start, end, clazz);
161				for (ParcelableSpan parcelableSpan : spannables) {
162					int beginSpan = spannable.getSpanStart(parcelableSpan);
163					int endSpan = spannable.getSpanEnd(parcelableSpan);
164					if (beginSpan >= start && endSpan <= end) {
165						continue;
166					}
167					sub.setSpan(clone(parcelableSpan), Math.max(beginSpan - start, 0), Math.min(Math.max(sub.length() - 1, 0), endSpan), Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
168				}
169			}
170			return sub;
171		} else {
172			return charSequence.subSequence(start, end);
173		}
174	}
175
176	private static ParcelableSpan clone(ParcelableSpan span) {
177		if (span instanceof ForegroundColorSpan) {
178			return new ForegroundColorSpan(((ForegroundColorSpan) span).getForegroundColor());
179		} else if (span instanceof TypefaceSpan) {
180			return new TypefaceSpan(((TypefaceSpan) span).getFamily());
181		} else if (span instanceof StyleSpan) {
182			return new StyleSpan(((StyleSpan) span).getStyle());
183		} else if (span instanceof StrikethroughSpan) {
184			return new StrikethroughSpan();
185		} else {
186			throw new AssertionError("Unknown Span");
187		}
188	}
189
190	private static ParcelableSpan createSpanForStyle(final ImStyleParser.Style style) {
191        return switch (style.getKeyword()) {
192            case "*" -> new StyleSpan(Typeface.BOLD);
193            case "_" -> new StyleSpan(Typeface.ITALIC);
194            case "~" -> new StrikethroughSpan();
195            case "`", "```" -> new TypefaceSpan("monospace");
196            default -> throw new AssertionError("Unknown Style");
197        };
198	}
199
200	private static void makeKeywordOpaque(final Editable editable, int start, int end, @ColorInt int fallbackTextColor, final boolean composing) {
201		QuoteSpan[] quoteSpans = editable.getSpans(start, end, QuoteSpan.class);
202		@ColorInt int textColor = quoteSpans.length > 0 ? quoteSpans[0].getColor() : fallbackTextColor;
203		@ColorInt int keywordColor = transformColor(textColor);
204		editable.setSpan(new ForegroundColorSpan(keywordColor), start, end, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE | (composing ? XHTML_REMOVE << Spanned.SPAN_USER_SHIFT : 0));
205	}
206
207	private static
208	@ColorInt
209	int transformColor(@ColorInt int c) {
210		return Color.argb(Math.round(Color.alpha(c) * 0.45f), Color.red(c), Color.green(c), Color.blue(c));
211	}
212
213	private static int indexOfIgnoreCase(final String haystack, final String needle, final int start) {
214		if (haystack == null || needle == null) {
215			return -1;
216		}
217		final int endLimit = haystack.length() - needle.length() + 1;
218		if (start > endLimit) {
219			return -1;
220		}
221		if (needle.length() == 0) {
222			return start;
223		}
224		for (int i = start; i < endLimit; i++) {
225			if (haystack.regionMatches(true, i, needle, 0, needle.length())) {
226				return i;
227			}
228		}
229		return -1;
230	}
231
232	public static class MessageEditorStyler implements TextWatcher {
233
234		private final EditText mEditText;
235		private final MessageAdapter mAdapter;
236
237		public MessageEditorStyler(EditText editText, MessageAdapter adapter) {
238			this.mEditText = editText;
239			this.mAdapter = adapter;
240		}
241
242		@Override
243		public void beforeTextChanged(CharSequence charSequence, int i, int i1, int i2) {
244
245		}
246
247		@Override
248		public void onTextChanged(CharSequence charSequence, int i, int i1, int i2) {
249
250		}
251
252		@Override
253		public void afterTextChanged(Editable editable) {
254			clear(editable);
255			final var p = PreferenceManager.getDefaultSharedPreferences(mEditText.getContext());
256			if (!p.getBoolean("compose_rich_text", mEditText.getContext().getResources().getBoolean(R.bool.compose_rich_text))) return;
257			for (final var span : editable.getSpans(0, editable.length() - 1, QuoteSpan.class)) {
258				editable.removeSpan(span);
259			}
260			for (final var span : editable.getSpans(0, editable.length() - 1, RelativeSizeSpan.class)) {
261				editable.removeSpan(span);
262			}
263			format(editable, mEditText.getCurrentTextColor(), true);
264			mAdapter.handleTextQuotes(mEditText, editable, false);
265		}
266	}
267}