/* Copyright (C) 2018-2024 Andreas Shimokawa, Carsten Pfeiffer, Roi Greenberg
This file is part of Gadgetbridge.
Gadgetbridge is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Gadgetbridge is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see . */
package nodomain.freeyourgadget.gadgetbridge.util;
import android.text.TextUtils;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import nodomain.freeyourgadget.gadgetbridge.GBApplication;
public class RtlUtils {
/**
* Checks the status of right-to-left option
* @return true if right-to-left option is On, and false, if Off or not exist
*/
public static boolean rtlSupport()
{
return GBApplication.getPrefs().getBoolean(GBPrefs.RTL_SUPPORT, false);
}
public enum characterType{
ltr,
rtl,
rtl_arabic,
punctuation,
lineEnd,
space,
}
public static characterType getCharacterType(Character c){
characterType type;
switch (Character.getDirectionality(c)) {
case Character.DIRECTIONALITY_RIGHT_TO_LEFT:
type = characterType.rtl;
break;
case Character.DIRECTIONALITY_RIGHT_TO_LEFT_ARABIC:
type = characterType.rtl_arabic;
break;
case Character.DIRECTIONALITY_EUROPEAN_NUMBER_SEPARATOR:
case Character.DIRECTIONALITY_EUROPEAN_NUMBER_TERMINATOR:
case Character.DIRECTIONALITY_COMMON_NUMBER_SEPARATOR:
case Character.DIRECTIONALITY_OTHER_NEUTRALS:
type = characterType.punctuation;
break;
case Character.DIRECTIONALITY_BOUNDARY_NEUTRAL:
case Character.DIRECTIONALITY_PARAGRAPH_SEPARATOR:
type = characterType.lineEnd;
break;
case Character.DIRECTIONALITY_WHITESPACE:
type = characterType.space;
break;
default:
type = characterType.ltr;
}
return type;
}
/**
* Checks the status of right-to-left option
* @return true if right-to-left option is On, and false, if Off or not exist
*/
public static boolean contextualSupport()
{
return GBApplication.getPrefs().getBoolean(GBPrefs.RTL_CONTEXTUAL_ARABIC, false);
}
//map with brackets chars to change there direction
private static Map directionSignsMap = new HashMap(){
{
put('(', ')'); put(')', '('); put('[', ']'); put(']', '['); put('{','}'); put('}','{');
}
};
/**
* @return true if the char is in the rtl range, otherwise false
*/
public static boolean isHebrew(Character c){
return getCharacterType(c) == characterType.rtl;
}
/**
* @return true if the char is in the rtl range, otherwise false
*/
public static boolean isArabic(Character c){
return getCharacterType(c) == characterType.rtl_arabic;
}
/**
* @return true if the char is in the rtl range, otherwise false
*/
public static boolean isLtr(Character c){
return getCharacterType(c) == characterType.ltr;
}
/**
* @return true if the char is in the rtl range, otherwise false
*/
public static boolean isRtl(Character c){
return (getCharacterType(c) == characterType.rtl) || (getCharacterType(c) == characterType.rtl_arabic);
}
/**
* @return true if the char is in the punctuations range, otherwise false
*/
public static boolean isPunctuations(Character c){
return getCharacterType(c) == characterType.punctuation;
}
/**
* @return true if the char is in the end of word list, otherwise false
*/
public static boolean isSpaceSign(Character c){
return getCharacterType(c) == characterType.space;
}
/**
* @return true if the char is in the end of word list, otherwise false
*/
public static boolean isEndLineSign(Character c){
return getCharacterType(c) == characterType.lineEnd;
}
//map from Arabian characters to their contextual form in the beginning of the word
private static Map contextualArabicIsolated = new HashMap(){
{
put('ا', '\uFE8D');
put('ب', '\uFE8F');
put('ت', '\uFE95');
put('ث', '\uFE99');
put('ج', '\uFE9D');
put('ح', '\uFEA1');
put('خ', '\uFEA5');
put('د', '\uFEA9');
put('ذ', '\uFEAB');
put('ر', '\uFEAD');
put('ز', '\uFEAF');
put('س', '\uFEB1');
put('ش', '\uFEB5');
put('ص', '\uFEB9');
put('ض', '\uFEBD');
put('ط', '\uFEC1');
put('ظ', '\uFEC5');
put('ع', '\uFEC9');
put('غ', '\uFECD');
put('ف', '\uFED1');
put('ق', '\uFED5');
put('ك', '\uFED9');
put('ل', '\uFEDD');
put('م', '\uFEE1');
put('ن', '\uFEE5');
put('ه', '\uFEE9');
put('و', '\uFEED');
put('ي', '\uFEF1');
put('آ', '\uFE81');
put('ة', '\uFE93');
put('ى', '\uFEEF');
put('ئ', '\uFE89');
put('إ', '\uFE87');
put('أ', '\uFE83');
put('ء', '\uFE80');
put('ؤ', '\uFE85');
put((char)('ل' + 'آ'), '\uFEF5');
put((char)('ل' + 'أ'), '\uFEF7');
put((char)('ل' + 'إ'), '\uFEF9');
put((char)('ل' + 'ا'), '\uFEFB');
//Farsi
put('گ', '\uFB92');
put('ک', '\uFB8E');
put('چ', '\uFB7A');
put('پ', '\uFB56');
put('ژ', '\uFB8A');
put('ی', '\uFBFC');
}
};
//map from Arabian characters to their contextual form in the beginning of the word
private static Map contextualArabicBeginning = new HashMap(){
{
put('ب', '\uFE91');
put('ت', '\uFE97');
put('ث', '\uFE9B');
put('ج', '\uFE9F');
put('ح', '\uFEA3');
put('خ', '\uFEA7');
put('س', '\uFEB3');
put('ش', '\uFEB7');
put('ص', '\uFEBB');
put('ض', '\uFEBF');
put('ط', '\uFEC3');
put('ظ', '\uFEC7');
put('ع', '\uFECB');
put('غ', '\uFECF');
put('ف', '\uFED3');
put('ق', '\uFED7');
put('ك', '\uFEDB');
put('ل', '\uFEDF');
put('م', '\uFEE3');
put('ن', '\uFEE7');
put('ه', '\uFEEB');
put('ي', '\uFEF3');
put('ئ', '\uFE8B');
//Farsi
put('گ', '\uFB94');
put('ک', '\uFB90');
put('چ', '\uFB7C');
put('پ', '\uFB58');
put('ی', '\uFBFE');
}
};
//map from Arabian characters to their contextual form in the middle of the word
private static Map contextualArabicMiddle = new HashMap(){
{
put('ب', '\uFE92');
put('ت', '\uFE98');
put('ث', '\uFE9C');
put('ج', '\uFEA0');
put('ح', '\uFEA4');
put('خ', '\uFEA8');
put('س', '\uFEB4');
put('ش', '\uFEB8');
put('ص', '\uFEBC');
put('ض', '\uFEC0');
put('ط', '\uFEC4');
put('ظ', '\uFEC8');
put('ع', '\uFECC');
put('غ', '\uFED0');
put('ف', '\uFED4');
put('ق', '\uFED8');
put('ك', '\uFEDC');
put('ل', '\uFEE0');
put('م', '\uFEE4');
put('ن', '\uFEE8');
put('ه', '\uFEEC');
put('ي', '\uFEF4');
put('ئ', '\uFE8C');
//Farsi
put('گ', '\uFB95');
put('ک', '\uFB91');
put('چ', '\uFB7D');
put('پ', '\uFB59');
put('ی', '\uFBFF');
}
};
//map from Arabian characters to their contextual form in the end of the word
private static Map contextualArabicEnd = new HashMap(){
{
put('ا', '\uFE8E');
put('ب', '\uFE90');
put('ت', '\uFE96');
put('ث', '\uFE9A');
put('ج', '\uFE9E');
put('ح', '\uFEA2');
put('خ', '\uFEA6');
put('د', '\uFEAA');
put('ذ', '\uFEAC');
put('ر', '\uFEAE');
put('ز', '\uFEB0');
put('س', '\uFEB2');
put('ش', '\uFEB6');
put('ص', '\uFEBA');
put('ض', '\uFEBE');
put('ط', '\uFEC2');
put('ظ', '\uFEC6');
put('ع', '\uFECA');
put('غ', '\uFECE');
put('ف', '\uFED2');
put('ق', '\uFED6');
put('ك', '\uFEDA');
put('ل', '\uFEDE');
put('م', '\uFEE2');
put('ن', '\uFEE6');
put('ه', '\uFEEA');
put('و', '\uFEEE');
put('ي', '\uFEF2');
put('آ', '\uFE82');
put('ة', '\uFE94');
put('ى', '\uFEF0');
put('ئ', '\uFE8A');
put('إ', '\uFE88');
put('أ', '\uFE84');
put('ؤ', '\uFE86');
put((char)('ل' + 'آ'), '\uFEF6');
put((char)('ل' + 'أ'), '\uFEF8');
put((char)('ل' + 'إ'), '\uFEFA');
put((char)('ل' + 'ا'), '\uFEFC');
//Farsi
put('گ', '\uFB93');
put('ک', '\uFB8F');
put('چ', '\uFB7B');
put('پ', '\uFB57');
put('ژ', '\uFB8B');
put('ی', '\uFBFD');
}
};
public enum contextualState{
isolate,
begin,
middle,
end
}
public static boolean exceptionAfterLam(Character c){
switch (c){
case '\u0622':
case '\u0623':
case '\u0625':
case '\u0627':
return true;
default:
return false;
}
}
/**
* This function return the contextual form of Arabic characters in a given state
* @param c - the character to convert
* @param state - the character state: beginning, middle, end or isolated
* @return the contextual character
*/
public static Character getContextualSymbol(Character c, contextualState state) {
Character newChar;
switch (state){
case begin:
newChar = contextualArabicBeginning.get(c);
break;
case middle:
newChar = contextualArabicMiddle.get(c);
break;
case end:
newChar = contextualArabicEnd.get(c);
break;
case isolate:
default:
newChar = contextualArabicIsolated.get(c);;
}
if (newChar != null){
return newChar;
} else{
return c;
}
}
/**
* This function return the contextual state of a given character, depend of the previous
* character state and the next charachter.
* @param prevState - previous character state or isolated if none
* @param curChar - the current character
* @param nextChar - the next character or null if none
* @return the current character contextual state
*/
public static contextualState getCharContextualState(contextualState prevState, Character curChar, Character nextChar) {
contextualState curState;
if ((prevState == contextualState.isolate || prevState == contextualState.end) &&
contextualArabicBeginning.containsKey(curChar) &&
contextualArabicEnd.containsKey(nextChar)){
curState = contextualState.begin;
} else if ((prevState == contextualState.begin || prevState == contextualState.middle) &&
contextualArabicEnd.containsKey(curChar)){
if (contextualArabicMiddle.containsKey(curChar) && contextualArabicEnd.containsKey(nextChar)){
curState = contextualState.middle;
}else{
curState = contextualState.end;
}
}else{
curState = contextualState.isolate;
}
return curState;
}
/**
* this function convert given string to it's contextual form
* @param s - the given string
* @return the contextual form of the string
*/
public static String convertToContextual(String s){
if (s == null || s.isEmpty() || s.length() == 1){
return s;
}
int length = s.length();
StringBuilder newWord = new StringBuilder(length);
Character curChar, nextChar = s.charAt(0);
contextualState prevState = contextualState.isolate;
contextualState curState = contextualState.isolate;
for (int i = 0; i < length - 1; i++){
curChar = nextChar;
nextChar = s.charAt(i + 1);
if (curChar == 'ل' && exceptionAfterLam(nextChar)){
i++;
curChar = (char)(nextChar + curChar);
if (i < length - 1) {
nextChar = s.charAt(i + 1);
}else{
nextChar = curChar;
prevState = curState;
break;
}
}
curState = getCharContextualState(prevState, curChar, nextChar);
newWord.append(getContextualSymbol(curChar, curState));
prevState = curState;
}
curState = getCharContextualState(prevState, nextChar, null);
newWord.append(getContextualSymbol(nextChar, curState));
return newWord.toString();
}
/**
* The function get a string and reverse it.
* in case of end-of-word sign, it will leave it at the end.
* in case of sign with direction like brackets, it will change the direction.
* @param s - the string to reverse
* @return reversed string
*/
public static String reverse(String s) {
int j = s.length();
int isEndLine = 0;
char[] newWord = new char[j];
if (j == 0) {
return s;
}
for (int i = 0; i < s.length() - isEndLine; i++) {
if (directionSignsMap.containsKey(s.charAt(i))) {
newWord[--j] = directionSignsMap.get(s.charAt(i));
} else {
newWord[--j] = s.charAt(i);
}
}
return new String(newWord);
}
public static String fixWhitespace(String s){
int length = s.length();
if (length > 0 && isSpaceSign(s.charAt(length - 1))){
return s.charAt(length - 1) + s.substring(0, length - 1);
} else {
return s;
}
}
/**
* The function get a string and fix the rtl words.
* since simple reverse puts the beginning of the text at the end, the text should have been from bottom to top.
* To avoid that, we save the text in lines (line max size can be change in the settings)
* @param oldString - the string to fix.
* @return a fix string.
*/
public static String fixRtl(String oldString) {
if (oldString == null || oldString.isEmpty()){
return oldString;
}
debug("before: |" + org.apache.commons.lang3.StringEscapeUtils.escapeJava(oldString) + "|");
int length = oldString.length();
String newString = "";
List lines = new ArrayList<>();
char[] newWord = new char[length];
int line_max_size = GBApplication.getPrefs().getInt("rtl_max_line_length", 18);
int startPos = 0;
int endPos = 0;
characterType CurRtlType = isRtl(oldString.charAt(0))? characterType.rtl : characterType.ltr;
characterType PhraseRtlType = CurRtlType;
Character c;
// String word = "", phrase = "", line = "";
StringBuilder word = new StringBuilder();
StringBuilder phrase = new StringBuilder();
StringBuilder line = new StringBuilder();
String phraseString = "";
boolean addCharToWord = false;
for (int i = 0; i < length; i++) {
c = oldString.charAt(i);
addCharToWord = false;
debug("char: " + c + " :" + Character.getDirectionality(c));
// debug( "hex : " + (int)c);
if (isLtr(c)){
CurRtlType = characterType.ltr;
} else if (isRtl(c)) {
CurRtlType = characterType.rtl;
}
if ((CurRtlType == PhraseRtlType) && !(isSpaceSign(c) || isEndLineSign(c))){
debug("add: " + c + " to: " + word);
word.append(c);
addCharToWord = true;
if (i < length - 1) {
continue;
}
}
do {
if ((line.length() + phrase.length() + word.length() < line_max_size) ||
(line.length() == 0 && word.length() >= line_max_size)) {
if (isSpaceSign(c)) {
word.append(c);
addCharToWord = true;
}
phrase.append(word);
word.setLength(0);
if (isSpaceSign(c)) {
break;
}
}
phraseString = phrase.toString();
debug("phrase: |" + phraseString + "|");
if (PhraseRtlType == characterType.rtl) {
if (contextualSupport()) {
phraseString = convertToContextual(phraseString);
}
phraseString = reverse(phraseString);
}
line.insert(0, fixWhitespace(phraseString));
debug("line now: |" + line + "|");
phrase.setLength(0);
if (word.length() > 0){
line.append('\n');
} else if (isEndLineSign(c)) {
line.append(c);
} else if (!addCharToWord) {
word.append(c);
if (i == length - 1){
addCharToWord = true;
continue;
}
PhraseRtlType = PhraseRtlType == characterType.rtl ? characterType.ltr : characterType.rtl;
break;
}
lines.add(line.toString());
debug("line: |" + line + "|");
line.setLength(0);
if (word.length() == 0){
break;
}
} while (true);
}
lines.add(line.toString());
newString = TextUtils.join("", lines);
debug("after : |" + org.apache.commons.lang3.StringEscapeUtils.escapeJava(newString) + "|");
return newString;
}
private static void debug(String s) {
// Log.d("ROIGR", s);
}
}