001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.tools;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.awt.event.KeyEvent;
007import java.util.ArrayList;
008import java.util.Arrays;
009import java.util.Comparator;
010import java.util.HashMap;
011import java.util.List;
012import java.util.Map;
013import java.util.Optional;
014import java.util.concurrent.CopyOnWriteArrayList;
015import java.util.function.Predicate;
016import java.util.stream.Collectors;
017
018import javax.swing.AbstractAction;
019import javax.swing.AbstractButton;
020import javax.swing.JMenu;
021import javax.swing.KeyStroke;
022import javax.swing.text.JTextComponent;
023
024import org.openstreetmap.josm.Main;
025import org.openstreetmap.josm.gui.util.GuiHelper;
026
027/**
028 * Global shortcut class.
029 *
030 * Note: This class represents a single shortcut, contains the factory to obtain
031 *       shortcut objects from, manages shortcuts and shortcut collisions, and
032 *       finally manages loading and saving shortcuts to/from the preferences.
033 *
034 * Action authors: You only need the {@link #registerShortcut} factory. Ignore everything else.
035 *
036 * All: Use only public methods that are also marked to be used. The others are
037 *      public so the shortcut preferences can use them.
038 * @since 1084
039 */
040public final class Shortcut {
041    /** the unique ID of the shortcut */
042    private final String shortText;
043    /** a human readable description that will be shown in the preferences */
044    private String longText;
045    /** the key, the caller requested */
046    private final int requestedKey;
047    /** the group, the caller requested */
048    private final int requestedGroup;
049    /** the key that actually is used */
050    private int assignedKey;
051    /** the modifiers that are used */
052    private int assignedModifier;
053    /** true if it got assigned what was requested.
054     * (Note: modifiers will be ignored in favour of group when loading it from the preferences then.) */
055    private boolean assignedDefault;
056    /** true if the user changed this shortcut */
057    private boolean assignedUser;
058    /** true if the user cannot change this shortcut (Note: it also will not be saved into the preferences) */
059    private boolean automatic;
060    /** true if the user requested this shortcut to be set to its default value
061     * (will happen on next restart, as this shortcut will not be saved to the preferences) */
062    private boolean reset;
063
064    // simple constructor
065    private Shortcut(String shortText, String longText, int requestedKey, int requestedGroup, int assignedKey, int assignedModifier,
066            boolean assignedDefault, boolean assignedUser) {
067        this.shortText = shortText;
068        this.longText = longText;
069        this.requestedKey = requestedKey;
070        this.requestedGroup = requestedGroup;
071        this.assignedKey = assignedKey;
072        this.assignedModifier = assignedModifier;
073        this.assignedDefault = assignedDefault;
074        this.assignedUser = assignedUser;
075        this.automatic = false;
076        this.reset = false;
077    }
078
079    public String getShortText() {
080        return shortText;
081    }
082
083    public String getLongText() {
084        return longText;
085    }
086
087    // a shortcut will be renamed when it is handed out again, because the original name may be a dummy
088    private void setLongText(String longText) {
089        this.longText = longText;
090    }
091
092    public int getAssignedKey() {
093        return assignedKey;
094    }
095
096    public int getAssignedModifier() {
097        return assignedModifier;
098    }
099
100    public boolean isAssignedDefault() {
101        return assignedDefault;
102    }
103
104    public boolean isAssignedUser() {
105        return assignedUser;
106    }
107
108    public boolean isAutomatic() {
109        return automatic;
110    }
111
112    public boolean isChangeable() {
113        return !automatic && !"core:none".equals(shortText);
114    }
115
116    private boolean isReset() {
117        return reset;
118    }
119
120    /**
121     * FOR PREF PANE ONLY
122     */
123    public void setAutomatic() {
124        automatic = true;
125    }
126
127    /**
128     * FOR PREF PANE ONLY.<p>
129     * Sets the modifiers that are used.
130     * @param assignedModifier assigned modifier
131     */
132    public void setAssignedModifier(int assignedModifier) {
133        this.assignedModifier = assignedModifier;
134    }
135
136    /**
137     * FOR PREF PANE ONLY.<p>
138     * Sets the key that actually is used.
139     * @param assignedKey assigned key
140     */
141    public void setAssignedKey(int assignedKey) {
142        this.assignedKey = assignedKey;
143    }
144
145    /**
146     * FOR PREF PANE ONLY.<p>
147     * Sets whether the user has changed this shortcut.
148     * @param assignedUser {@code true} if the user has changed this shortcut
149     */
150    public void setAssignedUser(boolean assignedUser) {
151        this.reset = (this.assignedUser || reset) && !assignedUser;
152        if (assignedUser) {
153            assignedDefault = false;
154        } else if (reset) {
155            assignedKey = requestedKey;
156            assignedModifier = findModifier(requestedGroup, null);
157        }
158        this.assignedUser = assignedUser;
159    }
160
161    /**
162     * Use this to register the shortcut with Swing
163     * @return the key stroke
164     */
165    public KeyStroke getKeyStroke() {
166        if (assignedModifier != -1)
167            return KeyStroke.getKeyStroke(assignedKey, assignedModifier);
168        return null;
169    }
170
171    // create a shortcut object from an string as saved in the preferences
172    private Shortcut(String prefString) {
173        List<String> s = new ArrayList<>(Main.pref.getCollection(prefString));
174        this.shortText = prefString.substring(15);
175        this.longText = s.get(0);
176        this.requestedKey = Integer.parseInt(s.get(1));
177        this.requestedGroup = Integer.parseInt(s.get(2));
178        this.assignedKey = Integer.parseInt(s.get(3));
179        this.assignedModifier = Integer.parseInt(s.get(4));
180        this.assignedDefault = Boolean.parseBoolean(s.get(5));
181        this.assignedUser = Boolean.parseBoolean(s.get(6));
182    }
183
184    private void saveDefault() {
185        Main.pref.getCollection("shortcut.entry."+shortText, Arrays.asList(new String[]{longText,
186        String.valueOf(requestedKey), String.valueOf(requestedGroup), String.valueOf(requestedKey),
187        String.valueOf(getGroupModifier(requestedGroup)), String.valueOf(true), String.valueOf(false)}));
188    }
189
190    // get a string that can be put into the preferences
191    private boolean save() {
192        if (isAutomatic() || isReset() || !isAssignedUser()) {
193            return Main.pref.putCollection("shortcut.entry."+shortText, null);
194        } else {
195            return Main.pref.putCollection("shortcut.entry."+shortText, Arrays.asList(new String[]{longText,
196            String.valueOf(requestedKey), String.valueOf(requestedGroup), String.valueOf(assignedKey),
197            String.valueOf(assignedModifier), String.valueOf(assignedDefault), String.valueOf(assignedUser)}));
198        }
199    }
200
201    private boolean isSame(int isKey, int isModifier) {
202        // an unassigned shortcut is different from any other shortcut
203        return isKey == assignedKey && isModifier == assignedModifier && assignedModifier != getGroupModifier(NONE);
204    }
205
206    public boolean isEvent(KeyEvent e) {
207        return getKeyStroke() != null && getKeyStroke().equals(
208        KeyStroke.getKeyStroke(e.getKeyCode(), e.getModifiers()));
209    }
210
211    /**
212     * use this to set a menu's mnemonic
213     * @param menu menu
214     */
215    public void setMnemonic(JMenu menu) {
216        if (assignedModifier == getGroupModifier(MNEMONIC) && getKeyStroke() != null && KeyEvent.getKeyText(assignedKey).length() == 1) {
217            menu.setMnemonic(KeyEvent.getKeyText(assignedKey).charAt(0)); //getKeyStroke().getKeyChar() seems not to work here
218        }
219    }
220
221    /**
222     * use this to set a buttons's mnemonic
223     * @param button button
224     */
225    public void setMnemonic(AbstractButton button) {
226        if (assignedModifier == getGroupModifier(MNEMONIC) && getKeyStroke() != null && KeyEvent.getKeyText(assignedKey).length() == 1) {
227            button.setMnemonic(KeyEvent.getKeyText(assignedKey).charAt(0)); //getKeyStroke().getKeyChar() seems not to work here
228        }
229    }
230
231    /**
232     * Sets the mnemonic key on a text component.
233     * @param component component
234     */
235    public void setFocusAccelerator(JTextComponent component) {
236        if (assignedModifier == getGroupModifier(MNEMONIC) && getKeyStroke() != null && KeyEvent.getKeyText(assignedKey).length() == 1) {
237            component.setFocusAccelerator(KeyEvent.getKeyText(assignedKey).charAt(0));
238        }
239    }
240
241    /**
242     * use this to set a actions's accelerator
243     * @param action action
244     */
245    public void setAccelerator(AbstractAction action) {
246        if (getKeyStroke() != null) {
247            action.putValue(AbstractAction.ACCELERATOR_KEY, getKeyStroke());
248        }
249    }
250
251    /**
252     * Returns a human readable text for the shortcut.
253     * @return a human readable text for the shortcut
254     */
255    public String getKeyText() {
256        KeyStroke keyStroke = getKeyStroke();
257        if (keyStroke == null) return "";
258        String modifText = KeyEvent.getKeyModifiersText(keyStroke.getModifiers());
259        if ("".equals(modifText)) return KeyEvent.getKeyText(keyStroke.getKeyCode());
260        return modifText + '+' + KeyEvent.getKeyText(keyStroke.getKeyCode());
261    }
262
263    @Override
264    public String toString() {
265        return getKeyText();
266    }
267
268    ///////////////////////////////
269    // everything's static below //
270    ///////////////////////////////
271
272    // here we store our shortcuts
273    private static ShortcutCollection shortcuts = new ShortcutCollection();
274
275    private static class ShortcutCollection extends CopyOnWriteArrayList<Shortcut> {
276        @Override
277        public boolean add(Shortcut shortcut) {
278            // expensive consistency check only in debug mode
279            if (Main.isDebugEnabled()
280                    && stream().map(Shortcut::getShortText).anyMatch(shortcut.getShortText()::equals)) {
281                Main.warn(new AssertionError(shortcut.getShortText() + " already added"));
282            }
283            return super.add(shortcut);
284        }
285
286        public void replace(Shortcut newShortcut) {
287            final Optional<Shortcut> existing = findShortcutByKeyOrShortText(-1, NONE, newShortcut.shortText);
288            if (existing.isPresent()) {
289                replaceAll(sc -> existing.get() == sc ? newShortcut : sc);
290            } else {
291                add(newShortcut);
292            }
293        }
294    }
295
296    // and here our modifier groups
297    private static Map<Integer, Integer> groups = new HashMap<>();
298
299    // check if something collides with an existing shortcut
300
301    /**
302     * Returns the registered shortcut fot the key and modifier
303     * @param requestedKey the requested key
304     * @param modifier the modifier
305     * @return an {@link Optional} registered shortcut, never {@code null}
306     */
307    public static Optional<Shortcut> findShortcut(int requestedKey, int modifier) {
308        return findShortcutByKeyOrShortText(requestedKey, modifier, null);
309    }
310
311    private static Optional<Shortcut> findShortcutByKeyOrShortText(int requestedKey, int modifier, String shortText) {
312        final Predicate<Shortcut> sameKey = sc -> modifier != getGroupModifier(NONE) && sc.isSame(requestedKey, modifier);
313        final Predicate<Shortcut> sameShortText = sc -> sc.getShortText().equals(shortText);
314        return shortcuts.stream()
315                .filter(sameKey.or(sameShortText))
316                .findAny();
317    }
318
319    /**
320     * Returns a list of all shortcuts.
321     * @return a list of all shortcuts
322     */
323    public static List<Shortcut> listAll() {
324        return shortcuts.stream()
325                .filter(c -> !"core:none".equals(c.shortText))
326                .collect(Collectors.toList());
327    }
328
329    /** None group: used with KeyEvent.CHAR_UNDEFINED if no shortcut is defined */
330    public static final int NONE = 5000;
331    public static final int MNEMONIC = 5001;
332    /** Reserved group: for system shortcuts only */
333    public static final int RESERVED = 5002;
334    /** Direct group: no modifier */
335    public static final int DIRECT = 5003;
336    /** Alt group */
337    public static final int ALT = 5004;
338    /** Shift group */
339    public static final int SHIFT = 5005;
340    /** Command group. Matches CTRL modifier on Windows/Linux but META modifier on OS X */
341    public static final int CTRL = 5006;
342    /** Alt-Shift group */
343    public static final int ALT_SHIFT = 5007;
344    /** Alt-Command group. Matches ALT-CTRL modifier on Windows/Linux but ALT-META modifier on OS X */
345    public static final int ALT_CTRL = 5008;
346    /** Command-Shift group. Matches CTRL-SHIFT modifier on Windows/Linux but META-SHIFT modifier on OS X */
347    public static final int CTRL_SHIFT = 5009;
348    /** Alt-Command-Shift group. Matches ALT-CTRL-SHIFT modifier on Windows/Linux but ALT-META-SHIFT modifier on OS X */
349    public static final int ALT_CTRL_SHIFT = 5010;
350
351    /* for reassignment */
352    private static int[] mods = {ALT_CTRL, ALT_SHIFT, CTRL_SHIFT, ALT_CTRL_SHIFT};
353    private static int[] keys = {KeyEvent.VK_F1, KeyEvent.VK_F2, KeyEvent.VK_F3, KeyEvent.VK_F4,
354                                 KeyEvent.VK_F5, KeyEvent.VK_F6, KeyEvent.VK_F7, KeyEvent.VK_F8,
355                                 KeyEvent.VK_F9, KeyEvent.VK_F10, KeyEvent.VK_F11, KeyEvent.VK_F12};
356
357    // bootstrap
358    private static boolean initdone;
359    private static void doInit() {
360        if (initdone) return;
361        initdone = true;
362        int commandDownMask = GuiHelper.getMenuShortcutKeyMaskEx();
363        groups.put(NONE, -1);
364        groups.put(MNEMONIC, KeyEvent.ALT_DOWN_MASK);
365        groups.put(DIRECT, 0);
366        groups.put(ALT, KeyEvent.ALT_DOWN_MASK);
367        groups.put(SHIFT, KeyEvent.SHIFT_DOWN_MASK);
368        groups.put(CTRL, commandDownMask);
369        groups.put(ALT_SHIFT, KeyEvent.ALT_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK);
370        groups.put(ALT_CTRL, KeyEvent.ALT_DOWN_MASK | commandDownMask);
371        groups.put(CTRL_SHIFT, commandDownMask | KeyEvent.SHIFT_DOWN_MASK);
372        groups.put(ALT_CTRL_SHIFT, KeyEvent.ALT_DOWN_MASK | commandDownMask | KeyEvent.SHIFT_DOWN_MASK);
373
374        // (1) System reserved shortcuts
375        Main.platform.initSystemShortcuts();
376        // (2) User defined shortcuts
377        Main.pref.getAllPrefixCollectionKeys("shortcut.entry.").stream()
378                .map(Shortcut::new)
379                .filter(sc -> !findShortcut(sc.getAssignedKey(), sc.getAssignedModifier()).isPresent())
380                .sorted(Comparator.comparing(sc -> sc.isAssignedUser() ? 1 : sc.isAssignedDefault() ? 2 : 3))
381                .forEachOrdered(shortcuts::replace);
382    }
383
384    private static int getGroupModifier(int group) {
385        Integer m = groups.get(group);
386        if (m == null)
387            m = -1;
388        return m;
389    }
390
391    private static int findModifier(int group, Integer modifier) {
392        if (modifier == null) {
393            modifier = getGroupModifier(group);
394            if (modifier == null) { // garbage in, no shortcut out
395                modifier = getGroupModifier(NONE);
396            }
397        }
398        return modifier;
399    }
400
401    // shutdown handling
402    public static boolean savePrefs() {
403        return shortcuts.stream()
404                .map(Shortcut::save)
405                .reduce(false, Boolean::logicalOr); // has changed
406    }
407
408    /**
409     * FOR PLATFORMHOOK USE ONLY.
410     * <p>
411     * This registers a system shortcut. See PlatformHook for details.
412     * @param shortText an ID. re-use a {@code "system:*"} ID if possible, else use something unique.
413     * @param longText this will be displayed in the shortcut preferences dialog. Better
414     * use something the user will recognize...
415     * @param key the key. Use a {@link KeyEvent KeyEvent.VK_*} constant here.
416     * @param modifier the modifier. Use a {@link KeyEvent KeyEvent.*_MASK} constant here.
417     * @return the system shortcut
418     */
419    public static Shortcut registerSystemShortcut(String shortText, String longText, int key, int modifier) {
420        final Optional<Shortcut> existing = findShortcutByKeyOrShortText(key, modifier, shortText);
421        if (existing.isPresent() && shortText.equals(existing.get().getShortText())) {
422            return existing.get();
423        } else if (existing.isPresent()) {
424            // this always is a logic error in the hook
425            Main.error("CONFLICT WITH SYSTEM KEY " + shortText + ": " + existing.get());
426            return null;
427        }
428        final Shortcut shortcut = new Shortcut(shortText, longText, key, RESERVED, key, modifier, true, false);
429        shortcuts.add(shortcut);
430        return shortcut;
431    }
432
433    /**
434     * Register a shortcut.
435     *
436     * Here you get your shortcuts from. The parameters are:
437     *
438     * @param shortText an ID. re-use a {@code "system:*"} ID if possible, else use something unique.
439     * {@code "menu:*"} is reserved for menu mnemonics, {@code "core:*"} is reserved for
440     * actions that are part of JOSM's core. Use something like
441     * {@code <pluginname>+":"+<actionname>}.
442     * @param longText this will be displayed in the shortcut preferences dialog. Better
443     * use something the user will recognize...
444     * @param requestedKey the key you'd prefer. Use a {@link KeyEvent KeyEvent.VK_*} constant here.
445     * @param requestedGroup the group this shortcut fits best. This will determine the
446     * modifiers your shortcut will get assigned. Use the constants defined above.
447     * @return the shortcut
448     */
449    public static Shortcut registerShortcut(String shortText, String longText, int requestedKey, int requestedGroup) {
450        return registerShortcut(shortText, longText, requestedKey, requestedGroup, null);
451    }
452
453    // and now the workhorse. same parameters as above, just one more
454    private static Shortcut registerShortcut(String shortText, String longText, int requestedKey, int requestedGroup, Integer modifier) {
455        doInit();
456        Integer defaultModifier = findModifier(requestedGroup, modifier);
457        final Optional<Shortcut> existing = findShortcutByKeyOrShortText(requestedKey, defaultModifier, shortText);
458        if (existing.isPresent() && shortText.equals(existing.get().getShortText())) {
459            // a re-register? maybe a sc already read from the preferences?
460            final Shortcut sc = existing.get();
461            sc.setLongText(longText); // or set by the platformHook, in this case the original longText doesn't match the real action
462            sc.saveDefault();
463            return sc;
464        } else if (existing.isPresent()) {
465            final Shortcut conflict = existing.get();
466            if (Main.isPlatformOsx()) {
467                // Try to reassign Meta to Ctrl
468                int newmodifier = findNewOsxModifier(requestedGroup);
469                if (!findShortcut(requestedKey, newmodifier).isPresent()) {
470                    Main.info("Reassigning OSX shortcut '" + shortText + "' from Meta to Ctrl because of conflict with " + conflict);
471                    return reassignShortcut(shortText, longText, requestedKey, conflict, requestedGroup, requestedKey, newmodifier);
472                }
473            }
474            for (int m : mods) {
475                for (int k : keys) {
476                    int newmodifier = getGroupModifier(m);
477                    if (!findShortcut(k, newmodifier).isPresent()) {
478                        Main.info("Reassigning shortcut '" + shortText + "' from " + modifier + " to " + newmodifier +
479                                " because of conflict with " + conflict);
480                        return reassignShortcut(shortText, longText, requestedKey, conflict, m, k, newmodifier);
481                    }
482                }
483            }
484        } else {
485            Shortcut newsc = new Shortcut(shortText, longText, requestedKey, requestedGroup, requestedKey, defaultModifier, true, false);
486            newsc.saveDefault();
487            shortcuts.add(newsc);
488            return newsc;
489        }
490
491        return null;
492    }
493
494    private static int findNewOsxModifier(int requestedGroup) {
495        switch (requestedGroup) {
496            case CTRL: return KeyEvent.CTRL_DOWN_MASK;
497            case ALT_CTRL: return KeyEvent.ALT_DOWN_MASK | KeyEvent.CTRL_DOWN_MASK;
498            case CTRL_SHIFT: return KeyEvent.CTRL_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK;
499            case ALT_CTRL_SHIFT: return KeyEvent.ALT_DOWN_MASK | KeyEvent.CTRL_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK;
500            default: return 0;
501        }
502    }
503
504    private static Shortcut reassignShortcut(String shortText, String longText, int requestedKey, Shortcut conflict,
505            int m, int k, int newmodifier) {
506        Shortcut newsc = new Shortcut(shortText, longText, requestedKey, m, k, newmodifier, false, false);
507        Main.info(tr("Silent shortcut conflict: ''{0}'' moved by ''{1}'' to ''{2}''.",
508            shortText, conflict.getShortText(), newsc.getKeyText()));
509        newsc.saveDefault();
510        shortcuts.add(newsc);
511        return newsc;
512    }
513
514    /**
515     * Replies the platform specific key stroke for the 'Copy' command, i.e.
516     * 'Ctrl-C' on windows or 'Meta-C' on a Mac. null, if the platform specific
517     * copy command isn't known.
518     *
519     * @return the platform specific key stroke for the  'Copy' command
520     */
521    public static KeyStroke getCopyKeyStroke() {
522        return getKeyStrokeForShortKey("system:copy");
523    }
524
525    /**
526     * Replies the platform specific key stroke for the 'Paste' command, i.e.
527     * 'Ctrl-V' on windows or 'Meta-V' on a Mac. null, if the platform specific
528     * paste command isn't known.
529     *
530     * @return the platform specific key stroke for the 'Paste' command
531     */
532    public static KeyStroke getPasteKeyStroke() {
533        return getKeyStrokeForShortKey("system:paste");
534    }
535
536    /**
537     * Replies the platform specific key stroke for the 'Cut' command, i.e.
538     * 'Ctrl-X' on windows or 'Meta-X' on a Mac. null, if the platform specific
539     * 'Cut' command isn't known.
540     *
541     * @return the platform specific key stroke for the 'Cut' command
542     */
543    public static KeyStroke getCutKeyStroke() {
544        return getKeyStrokeForShortKey("system:cut");
545    }
546
547    private static KeyStroke getKeyStrokeForShortKey(String shortKey) {
548        return shortcuts.stream()
549                .filter(sc -> shortKey.equals(sc.getShortText()))
550                .findAny()
551                .map(Shortcut::getKeyStroke)
552                .orElse(null);
553    }
554}