extern/Unexpected-Keyboard
1
0
Fork 1
mirror of https://github.com/Julow/Unexpected-Keyboard.git synced 2025-06-26 04:32:25 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Refactor: Make KeyValue payload Comparable

Browse Source 
and use 'toString()' instead of 'getSymbol()'.

This removes unecessary casts when computing symbols and comparing key
values. This will make adding other kind of keys easier.
This commit is contained in:
Jules Aguillon 2025-01-11 15:47:32 +01:00
parent c4e2b446e5
commit 4f8b5fa6ce
1 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
srcs/juloo.keyboard2/KeyValue.java
View File

@ -132,12 +132,10 @@ public final class KeyValue implements Comparable<KeyValue>
} }
/** /**
* The symbol that is rendered on the keyboard as a [String]. * [_payload.toString()] is the symbol that is rendered on the keyboard.
* Except for keys of kind: * For keys of kind [String], this is also the string to output.
* - [String], this is also the string to output.
* - [Complex], this is an instance of [KeyValue.Complex].
*/ */
private final Object _payload; private final Comparable _payload;
/** This field encodes three things: Kind, flags and value. */ /** This field encodes three things: Kind, flags and value. */
private final int _code; private final int _code;
@ -161,9 +159,7 @@ public final class KeyValue implements Comparable<KeyValue>
When [getKind() == Kind.String], also the string to send. */ When [getKind() == Kind.String], also the string to send. */
public String getString() public String getString()
{ {
if (getKind() == Kind.Complex) return _payload.toString();
return ((Complex)_payload).getSymbol();
return (String)_payload;
} }
/** Defined only when [getKind() == Kind.Char]. */ /** Defined only when [getKind() == Kind.Char]. */
@ -255,6 +251,7 @@ public final class KeyValue implements Comparable<KeyValue>
return sameKey((KeyValue)obj); return sameKey((KeyValue)obj);
} }
@Override
public int compareTo(KeyValue snd) public int compareTo(KeyValue snd)
{ {
// Compare the kind and value first, then the flags. // Compare the kind and value first, then the flags.
@ -264,9 +261,7 @@ public final class KeyValue implements Comparable<KeyValue>
d = _code - snd._code; d = _code - snd._code;
if (d != 0) if (d != 0)
return d; return d;
if (getKind() == Kind.Complex) return _payload.compareTo(snd._payload);
return ((Complex)_payload).compareTo((Complex)snd._payload);
return ((String)_payload).compareTo((String)snd._payload);
} }
/** Type-safe alternative to [equals]. */ /** Type-safe alternative to [equals]. */
@ -289,7 +284,7 @@ public final class KeyValue implements Comparable<KeyValue>
return "[KeyValue " + getKind().toString() + "+" + getFlags() + "+" + value + " \"" + getString() + "\"]"; return "[KeyValue " + getKind().toString() + "+" + getFlags() + "+" + value + " \"" + getString() + "\"]";
} }
private KeyValue(Object p, int kind, int value, int flags) private KeyValue(Comparable p, int kind, int value, int flags)
{ {
if (p == null) if (p == null)
throw new NullPointerException("KeyValue payload cannot be null"); throw new NullPointerException("KeyValue payload cannot be null");
@ -297,13 +292,12 @@ public final class KeyValue implements Comparable<KeyValue>
_code = (kind & KIND_BITS) | (flags & FLAGS_BITS) | (value & VALUE_BITS); _code = (kind & KIND_BITS) | (flags & FLAGS_BITS) | (value & VALUE_BITS);
} }
public KeyValue(Complex p, Complex.Kind value, int flags) private KeyValue(Complex p, Complex.Kind value, int flags)
{ {
this((Object)p, (Kind.Complex.ordinal() << KIND_OFFSET), value.ordinal(), this(p, Kind.Complex, value.ordinal(), flags);
flags);
} }
public KeyValue(String p, Kind k, int v, int f) public KeyValue(Comparable p, Kind k, int v, int f)
{ {
this(p, (k.ordinal() << KIND_OFFSET), v, f); this(p, (k.ordinal() << KIND_OFFSET), v, f);
} }
@ -747,13 +741,15 @@ public final class KeyValue implements Comparable<KeyValue>
throw new RuntimeException("Assertion failure"); throw new RuntimeException("Assertion failure");
} }
public static abstract class Complex public static abstract class Complex implements Comparable<Complex>
{ {
public abstract String getSymbol(); public abstract String getSymbol();
/** [compareTo] can assume that [snd] is an instance of the same class. */ /** [compareTo] can assume that [snd] is an instance of the same class. */
@Override
public abstract int compareTo(Complex snd); public abstract int compareTo(Complex snd);
@Override
public boolean equals(Object snd) public boolean equals(Object snd)
{ {
if (snd instanceof Complex) if (snd instanceof Complex)
@ -761,6 +757,12 @@ public final class KeyValue implements Comparable<KeyValue>
return false; return false;
} }
@Override
public String toString()
{
return getSymbol();
}
/** [hashCode] will be called on this class. */ /** [hashCode] will be called on this class. */
/** The kind is stored in the [value] field of the key. */ /** The kind is stored in the [value] field of the key. */
@ -780,8 +782,10 @@ public final class KeyValue implements Comparable<KeyValue>
_symbol = _sym; _symbol = _sym;
} }
@Override
public String getSymbol() { return _symbol; } public String getSymbol() { return _symbol; }
@Override
public int compareTo(Complex _snd) public int compareTo(Complex _snd)
{ {
StringWithSymbol snd = (StringWithSymbol)_snd; StringWithSymbol snd = (StringWithSymbol)_snd;