luckyimnotanigger/HeliBoard
1
0
Fork 0
mirror of https://github.com/Helium314/HeliBoard.git synced 2025-04-23 07:39:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

remove icon name "undefined" and use null instead

Browse source
This commit is contained in:
Helium314 2024-06-08 11:47:42 +02:00
parent a297b6037c
commit 743874f74c
6 changed files with 33 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
app/src/main/java/helium314/keyboard/keyboard/Key.java
View file

@ -78,7 +78,7 @@ public class Key implements Comparable<Key> {
public static final int LABEL_FLAGS_DISABLE_ADDITIONAL_POPUP_KEYS = 0x80000000; public static final int LABEL_FLAGS_DISABLE_ADDITIONAL_POPUP_KEYS = 0x80000000;
/** Icon to display instead of a label. Icon takes precedence over a label */ /** Icon to display instead of a label. Icon takes precedence over a label */
@NonNull private final String mIconName; @Nullable private final String mIconName;
/** Width of the key, excluding the gap */ /** Width of the key, excluding the gap */
private final int mWidth; private final int mWidth;
@ -154,13 +154,13 @@ public class Key implements Comparable<Key> {
public final String mOutputText; public final String mOutputText;
public final int mAltCode; public final int mAltCode;
/** Icon for disabled state */ /** Icon for disabled state */
public final String mDisabledIconName; @Nullable public final String mDisabledIconName;
/** The visual insets */ /** The visual insets */
public final int mVisualInsetsLeft; public final int mVisualInsetsLeft;
public final int mVisualInsetsRight; public final int mVisualInsetsRight;
private OptionalAttributes(final String outputText, final int altCode, private OptionalAttributes(final String outputText, final int altCode, @Nullable final String disabledIconName,
final String disabledIconName, final int visualInsetsLeft, final int visualInsetsRight) { final int visualInsetsLeft, final int visualInsetsRight) {
mOutputText = outputText; mOutputText = outputText;
mAltCode = altCode; mAltCode = altCode;
mDisabledIconName = disabledIconName; mDisabledIconName = disabledIconName;
@ -170,9 +170,9 @@ public class Key implements Comparable<Key> {
@Nullable @Nullable
public static OptionalAttributes newInstance(final String outputText, final int altCode, public static OptionalAttributes newInstance(final String outputText, final int altCode,
final String disabledIconName, final int visualInsetsLeft, final int visualInsetsRight) { @Nullable final String disabledIconName, final int visualInsetsLeft, final int visualInsetsRight) {
if (outputText == null && altCode == KeyCode.NOT_SPECIFIED if (outputText == null && altCode == KeyCode.NOT_SPECIFIED
&& disabledIconName.equals(KeyboardIconsSet.NAME_UNDEFINED) && visualInsetsLeft == 0 && disabledIconName == null && visualInsetsLeft == 0
&& visualInsetsRight == 0) { && visualInsetsRight == 0) {
return null; return null;
} }
@ -191,7 +191,7 @@ public class Key implements Comparable<Key> {
/** /**
* Constructor for a key on <code>PopupKeyKeyboard</code> and on <code>MoreSuggestions</code>. * Constructor for a key on <code>PopupKeyKeyboard</code> and on <code>MoreSuggestions</code>.
*/ */
public Key(@Nullable final String label, @NonNull final String iconName, final int code, public Key(@Nullable final String label, @Nullable final String iconName, final int code,
@Nullable final String outputText, @Nullable final String hintLabel, @Nullable final String outputText, @Nullable final String hintLabel,
final int labelFlags, final int backgroundType, final int x, final int y, final int labelFlags, final int backgroundType, final int x, final int y,
final int width, final int height, final int horizontalGap, final int verticalGap) { final int width, final int height, final int horizontalGap, final int verticalGap) {
@ -207,8 +207,7 @@ public class Key implements Comparable<Key> {
mPopupKeys = null; mPopupKeys = null;
mPopupKeysColumnAndFlags = 0; mPopupKeysColumnAndFlags = 0;
mLabel = label; mLabel = label;
mOptionalAttributes = OptionalAttributes.newInstance(outputText, KeyCode.NOT_SPECIFIED, mOptionalAttributes = OptionalAttributes.newInstance(outputText, KeyCode.NOT_SPECIFIED, null, 0, 0);
KeyboardIconsSet.NAME_UNDEFINED, 0, 0);
mCode = code; mCode = code;
mEnabled = (code != KeyCode.NOT_SPECIFIED); mEnabled = (code != KeyCode.NOT_SPECIFIED);
mIconName = iconName; mIconName = iconName;
@ -278,7 +277,7 @@ public class Key implements Comparable<Key> {
mActionFlags = key.mActionFlags; mActionFlags = key.mActionFlags;
mKeyVisualAttributes = key.mKeyVisualAttributes; mKeyVisualAttributes = key.mKeyVisualAttributes;
mOptionalAttributes = outputText == null ? null mOptionalAttributes = outputText == null ? null
: Key.OptionalAttributes.newInstance(outputText, KeyCode.NOT_SPECIFIED, KeyboardIconsSet.NAME_UNDEFINED, 0, 0); : Key.OptionalAttributes.newInstance(outputText, KeyCode.NOT_SPECIFIED, null, 0, 0);
mHashCode = key.mHashCode; mHashCode = key.mHashCode;
// Key state. // Key state.
mPressed = key.mPressed; mPressed = key.mPressed;
@ -404,7 +403,7 @@ public class Key implements Comparable<Key> {
&& o.mCode == mCode && o.mCode == mCode
&& TextUtils.equals(o.mLabel, mLabel) && TextUtils.equals(o.mLabel, mLabel)
&& TextUtils.equals(o.mHintLabel, mHintLabel) && TextUtils.equals(o.mHintLabel, mHintLabel)
&& o.mIconName.equals(mIconName) && TextUtils.equals(o.mIconName, mIconName)
&& o.mBackgroundType == mBackgroundType && o.mBackgroundType == mBackgroundType
&& Arrays.equals(o.mPopupKeys, mPopupKeys) && Arrays.equals(o.mPopupKeys, mPopupKeys)
&& TextUtils.equals(o.getOutputText(), getOutputText()) && TextUtils.equals(o.getOutputText(), getOutputText())
@ -445,7 +444,7 @@ public class Key implements Comparable<Key> {
public String toLongString() { public String toLongString() {
final String iconName = getIconName(); final String iconName = getIconName();
final String topVisual = (iconName.equals(KeyboardIconsSet.NAME_UNDEFINED)) final String topVisual = (iconName != null)
? KeyboardIconsSet.PREFIX_ICON + iconName : getLabel(); ? KeyboardIconsSet.PREFIX_ICON + iconName : getLabel();
final String hintLabel = getHintLabel(); final String hintLabel = getHintLabel();
final String visual = (hintLabel == null) ? topVisual : topVisual + "^" + hintLabel; final String visual = (hintLabel == null) ? topVisual : topVisual + "^" + hintLabel;
@ -703,6 +702,7 @@ public class Key implements Comparable<Key> {
return (attrs != null) ? attrs.mAltCode : KeyCode.NOT_SPECIFIED; return (attrs != null) ? attrs.mAltCode : KeyCode.NOT_SPECIFIED;
} }
@Nullable
public String getIconName() { public String getIconName() {
return mIconName; return mIconName;
} }
@ -710,7 +710,7 @@ public class Key implements Comparable<Key> {
@Nullable @Nullable
public Drawable getIcon(final KeyboardIconsSet iconSet, final int alpha) { public Drawable getIcon(final KeyboardIconsSet iconSet, final int alpha) {
final OptionalAttributes attrs = mOptionalAttributes; final OptionalAttributes attrs = mOptionalAttributes;
final String iconName = mEnabled ? getIconName() : ((attrs != null) ? attrs.mDisabledIconName : KeyboardIconsSet.NAME_UNDEFINED); final String iconName = mEnabled ? getIconName() : ((attrs != null) ? attrs.mDisabledIconName : null);
final Drawable icon = iconSet.getIconDrawable(iconName); final Drawable icon = iconSet.getIconDrawable(iconName);
if (icon != null) { if (icon != null) {
icon.setAlpha(alpha); icon.setAlpha(alpha);
@ -921,6 +921,7 @@ public class Key implements Comparable<Key> {
public final boolean isAccentColored() { public final boolean isAccentColored() {
if (hasActionKeyBackground()) return true; if (hasActionKeyBackground()) return true;
final String iconName = getIconName(); final String iconName = getIconName();
if (iconName == null) return false;
// todo: other way of identifying the color? // todo: other way of identifying the color?
// if yes, NAME_CLIPBOARD_ACTION_KEY and NAME_CLIPBOARD_NORMAL_KEY could be merged // if yes, NAME_CLIPBOARD_ACTION_KEY and NAME_CLIPBOARD_NORMAL_KEY could be merged
return iconName.equals(KeyboardIconsSet.NAME_NEXT_KEY) return iconName.equals(KeyboardIconsSet.NAME_NEXT_KEY)
@ -945,7 +946,7 @@ public class Key implements Comparable<Key> {
*/ */
protected Spacer(final KeyboardParams params, final int x, final int y, final int width, protected Spacer(final KeyboardParams params, final int x, final int y, final int width,
final int height) { final int height) {
super(null, KeyboardIconsSet.NAME_UNDEFINED, KeyCode.NOT_SPECIFIED, null, super(null, null, KeyCode.NOT_SPECIFIED, null,
null, 0, BACKGROUND_TYPE_EMPTY, x, y, width, null, 0, BACKGROUND_TYPE_EMPTY, x, y, width,
height, params.mHorizontalGap, params.mVerticalGap); height, params.mHorizontalGap, params.mVerticalGap);
} }
@ -970,7 +971,7 @@ public class Key implements Comparable<Key> {
@Nullable public String mLabel; @Nullable public String mLabel;
@Nullable public final String mHintLabel; @Nullable public final String mHintLabel;
public final int mLabelFlags; public final int mLabelFlags;
@NonNull public final String mIconName; @Nullable public final String mIconName;
@Nullable public PopupKeySpec[] mPopupKeys; @Nullable public PopupKeySpec[] mPopupKeys;
public final int mPopupKeysColumnAndFlags; public final int mPopupKeysColumnAndFlags;
public int mBackgroundType; public int mBackgroundType;
@ -1151,10 +1152,10 @@ public class Key implements Comparable<Key> {
|| (mCode == KeyCode.SYMBOL_ALPHA && !params.mId.isAlphabetKeyboard()) || (mCode == KeyCode.SYMBOL_ALPHA && !params.mId.isAlphabetKeyboard())
) )
actionFlags |= ACTION_FLAGS_ENABLE_LONG_PRESS; actionFlags |= ACTION_FLAGS_ENABLE_LONG_PRESS;
if (mCode <= Constants.CODE_SPACE && mCode != KeyCode.MULTIPLE_CODE_POINTS && mIconName.equals(KeyboardIconsSet.NAME_UNDEFINED)) if (mCode <= Constants.CODE_SPACE && mCode != KeyCode.MULTIPLE_CODE_POINTS && mIconName == null)
actionFlags |= ACTION_FLAGS_NO_KEY_PREVIEW; actionFlags |= ACTION_FLAGS_NO_KEY_PREVIEW;
switch (mCode) { switch (mCode) {
case KeyCode.DELETE, KeyCode.SHIFT, Constants.CODE_ENTER, KeyCode.SHIFT_ENTER, KeyCode.ALPHA, Constants.CODE_SPACE, case KeyCode.DELETE, KeyCode.SHIFT, Constants.CODE_ENTER, KeyCode.SHIFT_ENTER, KeyCode.ALPHA, Constants.CODE_SPACE, KeyCode.NUMPAD,
KeyCode.SYMBOL, KeyCode.SYMBOL_ALPHA -> actionFlags |= ACTION_FLAGS_NO_KEY_PREVIEW; // no preview even if icon! KeyCode.SYMBOL, KeyCode.SYMBOL_ALPHA -> actionFlags |= ACTION_FLAGS_NO_KEY_PREVIEW; // no preview even if icon!
case KeyCode.SETTINGS, KeyCode.LANGUAGE_SWITCH -> actionFlags |= ACTION_FLAGS_ALT_CODE_WHILE_TYPING; case KeyCode.SETTINGS, KeyCode.LANGUAGE_SWITCH -> actionFlags |= ACTION_FLAGS_ALT_CODE_WHILE_TYPING;
} }
@ -1172,7 +1173,7 @@ public class Key implements Comparable<Key> {
: altCodeInAttr; : altCodeInAttr;
mOptionalAttributes = OptionalAttributes.newInstance(outputText, altCode, mOptionalAttributes = OptionalAttributes.newInstance(outputText, altCode,
// disabled icon only ever for old version of shortcut key, visual insets can be replaced with spacer // disabled icon only ever for old version of shortcut key, visual insets can be replaced with spacer
KeyboardIconsSet.NAME_UNDEFINED, 0, 0); null, 0, 0);
// KeyVisualAttributes for a key essentially are what the theme has, but on a per-key base // KeyVisualAttributes for a key essentially are what the theme has, but on a per-key base
// could be used e.g. for having a color gradient on key color // could be used e.g. for having a color gradient on key color
mKeyVisualAttributes = null; mKeyVisualAttributes = null;
@ -1212,11 +1213,11 @@ public class Key implements Comparable<Key> {
mLabel = label; mLabel = label;
mOptionalAttributes = code == KeyCode.MULTIPLE_CODE_POINTS mOptionalAttributes = code == KeyCode.MULTIPLE_CODE_POINTS
? OptionalAttributes.newInstance(label, KeyCode.NOT_SPECIFIED, KeyboardIconsSet.NAME_UNDEFINED, 0, 0) ? OptionalAttributes.newInstance(label, KeyCode.NOT_SPECIFIED, null, 0, 0)
: null; : null;
mCode = code; mCode = code;
mEnabled = (code != KeyCode.NOT_SPECIFIED); mEnabled = (code != KeyCode.NOT_SPECIFIED);
mIconName = KeyboardIconsSet.NAME_UNDEFINED; mIconName = null;
mKeyVisualAttributes = null; mKeyVisualAttributes = null;
} }
@ -1230,7 +1231,7 @@ public class Key implements Comparable<Key> {
mHintLabel = null; mHintLabel = null;
mKeyVisualAttributes = null; mKeyVisualAttributes = null;
mOptionalAttributes = null; mOptionalAttributes = null;
mIconName = KeyboardIconsSet.NAME_UNDEFINED; mIconName = null;
mBackgroundType = BACKGROUND_TYPE_NORMAL; mBackgroundType = BACKGROUND_TYPE_NORMAL;
mActionFlags = ACTION_FLAGS_NO_KEY_PREVIEW; mActionFlags = ACTION_FLAGS_NO_KEY_PREVIEW;
mPopupKeys = null; mPopupKeys = null;

2
app/src/main/java/helium314/keyboard/keyboard/internal/KeyPreviewView.java
View file

@ -45,7 +45,7 @@ public class KeyPreviewView extends AppCompatTextView {
public void setPreviewVisual(final Key key, final KeyboardIconsSet iconsSet, final KeyDrawParams drawParams) { public void setPreviewVisual(final Key key, final KeyboardIconsSet iconsSet, final KeyDrawParams drawParams) {
// What we show as preview should match what we show on a key top in onDraw(). // What we show as preview should match what we show on a key top in onDraw().
if (!key.getIconName().equals(KeyboardIconsSet.NAME_UNDEFINED)) { if (key.getIconName() != null) {
setCompoundDrawables(null, null, null, key.getPreviewIcon(iconsSet)); setCompoundDrawables(null, null, null, key.getPreviewIcon(iconsSet));
setText(null); setText(null);
return; return;

6
app/src/main/java/helium314/keyboard/keyboard/internal/KeySpecParser.java
View file

@ -221,14 +221,14 @@ public final class KeySpecParser {
return defaultCode; return defaultCode;
} }
@NonNull // todo: why not null instead of NAME_UNDEFINED? @Nullable
public static String getIconName(@Nullable final String keySpec) { public static String getIconName(@Nullable final String keySpec) {
if (keySpec == null) { if (keySpec == null) {
// TODO: Throw {@link KeySpecParserError} once Key.keyLabel attribute becomes mandatory. // TODO: Throw {@link KeySpecParserError} once Key.keyLabel attribute becomes mandatory.
return KeyboardIconsSet.NAME_UNDEFINED; return null;
} }
if (!hasIcon(keySpec)) { if (!hasIcon(keySpec)) {
return KeyboardIconsSet.NAME_UNDEFINED; return null;
} }
final int labelEnd = indexOfLabelEnd(keySpec); final int labelEnd = indexOfLabelEnd(keySpec);
return getBeforeLabelEnd(keySpec, labelEnd).substring(KeyboardIconsSet.PREFIX_ICON.length()).intern(); return getBeforeLabelEnd(keySpec, labelEnd).substring(KeyboardIconsSet.PREFIX_ICON.length()).intern();

3
app/src/main/java/helium314/keyboard/keyboard/internal/KeyboardIconsSet.kt
View file

@ -24,13 +24,12 @@ class KeyboardIconsSet {
} }
} }
fun getIconDrawable(name: String) = iconsByName[name] fun getIconDrawable(name: String?) = iconsByName[name]
companion object { companion object {
private val TAG = KeyboardIconsSet::class.simpleName private val TAG = KeyboardIconsSet::class.simpleName
const val PREFIX_ICON = "!icon/" const val PREFIX_ICON = "!icon/"
const val NAME_UNDEFINED = "undefined"
const val NAME_SHIFT_KEY = "shift_key" const val NAME_SHIFT_KEY = "shift_key"
const val NAME_SHIFT_KEY_SHIFTED = "shift_key_shifted" const val NAME_SHIFT_KEY_SHIFTED = "shift_key_shifted"
const val NAME_SHIFT_KEY_LOCKED = "shift_key_locked" const val NAME_SHIFT_KEY_LOCKED = "shift_key_locked"

9
app/src/main/java/helium314/keyboard/keyboard/internal/PopupKeySpec.java
View file

@ -40,7 +40,7 @@ public final class PopupKeySpec {
public final String mLabel; public final String mLabel;
@Nullable @Nullable
public final String mOutputText; public final String mOutputText;
@NonNull @Nullable
public final String mIconName; public final String mIconName;
public PopupKeySpec(@NonNull final String popupKeySpec, boolean needsToUpperCase, public PopupKeySpec(@NonNull final String popupKeySpec, boolean needsToUpperCase,
@ -78,7 +78,8 @@ public final class PopupKeySpec {
@Override @Override
public int hashCode() { public int hashCode() {
int hashCode = 31 + mCode; int hashCode = 31 + mCode;
hashCode = hashCode * 31 + mIconName.hashCode(); final String iconName = mIconName;
hashCode = hashCode * 31 + (iconName == null ? 0 : iconName.hashCode());
final String label = mLabel; final String label = mLabel;
hashCode = hashCode * 31 + (label == null ? 0 : label.hashCode()); hashCode = hashCode * 31 + (label == null ? 0 : label.hashCode());
final String outputText = mOutputText; final String outputText = mOutputText;
@ -94,7 +95,7 @@ public final class PopupKeySpec {
if (o instanceof PopupKeySpec) { if (o instanceof PopupKeySpec) {
final PopupKeySpec other = (PopupKeySpec)o; final PopupKeySpec other = (PopupKeySpec)o;
return mCode == other.mCode return mCode == other.mCode
&& mIconName.equals(other.mIconName) && TextUtils.equals(mIconName, other.mIconName)
&& TextUtils.equals(mLabel, other.mLabel) && TextUtils.equals(mLabel, other.mLabel)
&& TextUtils.equals(mOutputText, other.mOutputText); && TextUtils.equals(mOutputText, other.mOutputText);
} }
@ -103,7 +104,7 @@ public final class PopupKeySpec {
@Override @Override
public String toString() { public String toString() {
final String label = (mIconName.equals(KeyboardIconsSet.NAME_UNDEFINED) ? mLabel final String label = (mIconName == null ? mLabel
: KeyboardIconsSet.PREFIX_ICON + mIconName); : KeyboardIconsSet.PREFIX_ICON + mIconName);
final String output = (mCode == KeyCode.MULTIPLE_CODE_POINTS ? mOutputText final String output = (mCode == KeyCode.MULTIPLE_CODE_POINTS ? mOutputText
: Constants.printableCode(mCode)); : Constants.printableCode(mCode));

2
app/src/main/java/helium314/keyboard/latin/suggestions/MoreSuggestions.java
View file

@ -231,7 +231,7 @@ public final class MoreSuggestions extends Keyboard {
public MoreSuggestionKey(final String word, final String info, final int index, public MoreSuggestionKey(final String word, final String info, final int index,
final MoreSuggestionsParam params) { final MoreSuggestionsParam params) {
super(word, KeyboardIconsSet.NAME_UNDEFINED, KeyCode.MULTIPLE_CODE_POINTS, super(word, null, KeyCode.MULTIPLE_CODE_POINTS,
word, info, 0, Key.BACKGROUND_TYPE_NORMAL, word, info, 0, Key.BACKGROUND_TYPE_NORMAL,
params.getX(index), params.getY(index), params.getWidth(index), params.getX(index), params.getY(index), params.getWidth(index),
params.mDefaultAbsoluteRowHeight, params.mHorizontalGap, params.mVerticalGap); params.mDefaultAbsoluteRowHeight, params.mHorizontalGap, params.mVerticalGap);