abouttreesummaryrefslogcommitdiff
path: root/srcs/juloo.keyboard2/ExtraKeys.java
blob: aa2e38f6c394e20ab153152d3b3e96ce9f391ff9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
package juloo.keyboard2;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

class ExtraKeys
{
  public static final ExtraKeys EMPTY = new ExtraKeys(Collections.EMPTY_LIST);

  Collection<ExtraKey> _ks;

  public ExtraKeys(Collection<ExtraKey> ks)
  {
    _ks = ks;
  }

  /** Add the keys that should be added to the keyboard into [dst]. Keys
      already added to [dst] might have an impact, see [ExtraKey.compute].  */
  public void compute(Map<KeyValue, KeyboardData.PreferredPos> dst, Query q)
  {
    for (ExtraKey k : _ks)
      k.compute(dst, q);
  }

  public static ExtraKeys parse(String script, String str)
  {
    Collection<ExtraKey> dst = new ArrayList<ExtraKey>();
    String[] ks = str.split("\\|");
    for (int i = 0; i < ks.length; i++)
      dst.add(ExtraKey.parse(ks[i], script));
    return new ExtraKeys(dst);
  }

  /** Merge identical keys. This is required to decide whether to add
      alternatives. Script is generalized (set to null) on any conflict. */
  public static ExtraKeys merge(List<ExtraKeys> kss)
  {
    Map<KeyValue, ExtraKey> merged_keys = new HashMap<KeyValue, ExtraKey>();
    for (ExtraKeys ks : kss)
      for (ExtraKey k : ks._ks)
      {
        ExtraKey k2 = merged_keys.get(k.kv);
        if (k2 != null)
          k = k.merge_with(k2);
        merged_keys.put(k.kv, k);
      }
    return new ExtraKeys(merged_keys.values());
  }

  final static class ExtraKey
  {
    /** The key to add. */
    final KeyValue kv;
    /** The key will be added to layouts of the same script. If null, might be
        added to layouts of any script. */
    final String script;
    /** The key will not be added to layout that already contain all the
        alternatives. */
    final List<KeyValue> alternatives;

    ExtraKey(KeyValue kv_, String script_, List<KeyValue> alts_)
    {
      kv = kv_;
      script = script_;
      alternatives = alts_;
    }

    /** Whether the key should be added to the keyboard. */
    public void compute(Map<KeyValue, KeyboardData.PreferredPos> dst, Query q)
    {
      // Add the alternative if it's the only one. The list of alternatives is
      // enforced to be complete by the merging step. The same [kv] will not
      // appear again in the list of extra keys with a different list of
      // alternatives.
      // Selecting the dead key in the "Add key to the keyboard" option would
      // disable this behavior for a key.
      boolean use_alternative = (alternatives.size() == 1 && !dst.containsKey(kv));
      if
        ((q.script == null || script == null || q.script.equals(script))
        && (alternatives.size() == 0 || !q.present.containsAll(alternatives)))
      {
        KeyValue kv_ = use_alternative ? alternatives.get(0) : kv;
        dst.put(kv_, KeyboardData.PreferredPos.DEFAULT);
      }
    }

    /** Return a new key from two. [kv] are expected to be equal. [script] is
        generalized to [null] on any conflict. [alternatives] are concatenated.
        */
    public ExtraKey merge_with(ExtraKey k2)
    {
      String script_ =
        (script != null && k2.script != null && script.equals(k2.script))
        ? script : null;
      List<KeyValue> alts = new ArrayList<KeyValue>(alternatives);
      alts.addAll(k2.alternatives);
      return new ExtraKey(kv, script_, alts);
    }

    /** Extra keys are of the form "key name" or "key name:alt 1:alt 2". */
    public static ExtraKey parse(String str, String script)
    {
      String[] strs = str.split(":");
      KeyValue kv = KeyValue.getKeyByName(strs[0]);
      KeyValue[] alts = new KeyValue[strs.length-1];
      for (int i = 1; i < strs.length; i++)
        alts[i-1] = KeyValue.getKeyByName(strs[i]);
      return new ExtraKey(kv, script, Arrays.asList(alts));
    }
  }

  public final static class Query
  {
    /** Script of the current layout. Might be null. */
    final String script;
    /** Keys present on the layout. */
    final Set<KeyValue> present;

    public Query(String script_, Set<KeyValue> present_)
    {
      script = script_;
      present = present_;
    }
  }
}