Add per-session recently used boards list

facchinm · facchinm · commit cd41ab54b4a7 · 2020-04-08T14:35:12.000+02:00
The list appears at the top of Board submenu
Boards are also reachable via a CTRL+SHIFT+number (starting from 1)
diff --git a/app/src/processing/app/Base.java b/app/src/processing/app/Base.java
@@ -118,6 +118,11 @@ public class Base {
   Editor activeEditor;
 
   private static JMenu boardMenu;
+  private static ButtonGroup boardsButtonGroup;
+  private static ButtonGroup recentBoardsButtonGroup;
+  private static Map<String, ButtonGroup> buttonGroupsMap;
+  private static List<JMenuItem> menuItemsToClickAfterStartup;
+  private static MenuScroller boardMenuScroller;
 
   // these menus are shared so that the board and serial port selections
   // are the same for all windows (since the board and serial port that are
@@ -1335,6 +1340,41 @@ public void selectTargetBoard(TargetBoard targetBoard) {
     onBoardOrPortChange();
     rebuildImportMenu(Editor.importMenu);
     rebuildExamplesMenu(Editor.examplesMenu);
+    try {
+      rebuildRecentBoardsMenu();
+    } catch (Exception e) {
+      // fail silently
+    }
+  }
+
+  public void rebuildRecentBoardsMenu() throws Exception {
+
+    Enumeration<AbstractButton> btns = recentBoardsButtonGroup.getElements();
+    while (btns.hasMoreElements()) {
+      AbstractButton x = btns.nextElement();
+      if (x.isSelected()) {
+        return;
+      }
+    }
+    btns = recentBoardsButtonGroup.getElements();
+    while (btns.hasMoreElements()) {
+      AbstractButton x = btns.nextElement();
+      boardMenu.remove(x);
+    }
+    int index = 0;
+    for (TargetBoard board : BaseNoGui.getRecentlyUsedBoards()) {
+      JMenuItem item = createBoardMenusAndCustomMenus(boardsCustomMenus, menuItemsToClickAfterStartup,
+              buttonGroupsMap,
+              board, board.getContainerPlatform(), board.getContainerPlatform().getContainerPackage());
+      boardMenu.insert(item, 3);
+      item.setAccelerator(KeyStroke.getKeyStroke('1' + index,
+         Toolkit.getDefaultToolkit().getMenuShortcutKeyMask() |
+         ActionEvent.SHIFT_MASK));
+      recentBoardsButtonGroup.add(item);
+      boardsButtonGroup.add(item);
+      index ++;
+    }
+    boardMenuScroller.setTopFixedCount(3 + index);
   }
 
   public void onBoardOrPortChange() {
@@ -1432,7 +1472,8 @@ public void rebuildBoardsMenu() throws Exception {
     // The first custom menu is the "Board" selection submenu
     boardMenu = new JMenu(tr("Board"));
     boardMenu.putClientProperty("removeOnWindowDeactivation", true);
-    MenuScroller.setScrollerFor(boardMenu).setTopFixedCount(1);
+    boardMenuScroller = MenuScroller.setScrollerFor(boardMenu);
+    boardMenuScroller.setTopFixedCount(1);
 
     boardMenu.add(new JMenuItem(new AbstractAction(tr("Boards Manager...")) {
       public void actionPerformed(ActionEvent actionevent) {
@@ -1472,21 +1513,26 @@ public void actionPerformed(ActionEvent actionevent) {
       boardsCustomMenus.add(customMenu);
     }
 
-    List<JMenuItem> menuItemsToClickAfterStartup = new LinkedList<>();
+    List<JMenuItem> _menuItemsToClickAfterStartup = new LinkedList<>();
+    boardsButtonGroup = new ButtonGroup();
+    recentBoardsButtonGroup = new ButtonGroup();
+    buttonGroupsMap = new HashMap<>();
 
-    ButtonGroup boardsButtonGroup = new ButtonGroup();
-    Map<String, ButtonGroup> buttonGroupsMap = new HashMap<>();
+    boolean hasRecentBoardsMenu =  (PreferencesData.getInteger("editor.recent_boards.size", 4) != 0);
+
+    if (hasRecentBoardsMenu) {
+      JMenuItem recentLabel = new JMenuItem(tr("Recently used boards"));
+      recentLabel.setEnabled(false);
+      boardMenu.add(recentLabel);
+    }
 
     // Cycle through all packages
-    boolean first = true;
     for (TargetPackage targetPackage : BaseNoGui.packages.values()) {
       // For every package cycle through all platform
       for (TargetPlatform targetPlatform : targetPackage.platforms()) {
 
         // Add a separator from the previous platform
-        if (!first)
-          boardMenu.add(new JSeparator());
-        first = false;
+        boardMenu.add(new JSeparator());
 
         // Add a title for each platform
         String platformLabel = targetPlatform.getPreferences().get("name");
@@ -1500,7 +1546,7 @@ public void actionPerformed(ActionEvent actionevent) {
         for (TargetBoard board : targetPlatform.getBoards().values()) {
           if (board.getPreferences().get("hide") != null)
             continue;
-          JMenuItem item = createBoardMenusAndCustomMenus(boardsCustomMenus, menuItemsToClickAfterStartup,
+          JMenuItem item = createBoardMenusAndCustomMenus(boardsCustomMenus, _menuItemsToClickAfterStartup,
                   buttonGroupsMap,
                   board, targetPlatform, targetPackage);
           boardMenu.add(item);
@@ -1509,14 +1555,16 @@ public void actionPerformed(ActionEvent actionevent) {
       }
     }
 
-    if (menuItemsToClickAfterStartup.isEmpty()) {
-      menuItemsToClickAfterStartup.add(selectFirstEnabledMenuItem(boardMenu));
+    if (_menuItemsToClickAfterStartup.isEmpty()) {
+      _menuItemsToClickAfterStartup.add(selectFirstEnabledMenuItem(boardMenu));
     }
 
-    for (JMenuItem menuItemToClick : menuItemsToClickAfterStartup) {
+    for (JMenuItem menuItemToClick : _menuItemsToClickAfterStartup) {
       menuItemToClick.setSelected(true);
       menuItemToClick.getAction().actionPerformed(new ActionEvent(this, -1, ""));
     }
+
+    menuItemsToClickAfterStartup = _menuItemsToClickAfterStartup;
   }
 
   private JRadioButtonMenuItem createBoardMenusAndCustomMenus(
@@ -1552,6 +1600,9 @@ public void actionPerformed(ActionEvent actionevent) {
     for (final String menuId : customMenus.keySet()) {
       String title = customMenus.get(menuId);
       JMenu menu = getBoardCustomMenu(tr(title));
+      if (menu == null) {
+        continue;
+      }
 
       if (board.hasMenu(menuId)) {
         PreferencesMap boardCustomMenu = board.getMenuLabels(menuId);
@@ -1614,13 +1665,13 @@ private static boolean ifThereAreVisibleItemsOn(JMenu menu) {
     return false;
   }
 
-  private JMenu getBoardCustomMenu(String label) throws Exception {
+  private JMenu getBoardCustomMenu(String label) {
     for (JMenu menu : boardsCustomMenus) {
       if (label.equals(menu.getText())) {
         return menu;
       }
     }
-    throw new Exception("Custom menu not found!");
+    return null;
   }
 
   public List<JMenuItem> getProgrammerMenus() {
diff --git a/arduino-core/src/processing/app/BaseNoGui.java b/arduino-core/src/processing/app/BaseNoGui.java
@@ -915,6 +915,12 @@ static public void saveFile(String str, File file) throws IOException {
     }
   }
 
+  static private LinkedList<TargetBoard> recentlyUsedBoards = new LinkedList<TargetBoard>();
+
+  static public LinkedList<TargetBoard> getRecentlyUsedBoards() {
+	  return recentlyUsedBoards;
+  }
+
   static public void selectBoard(TargetBoard targetBoard) {
     TargetPlatform targetPlatform = targetBoard.getContainerPlatform();
     TargetPackage targetPackage = targetPlatform.getContainerPackage();
@@ -926,6 +932,13 @@ static public void selectBoard(TargetBoard targetBoard) {
     File platformFolder = targetPlatform.getFolder();
     PreferencesData.set("runtime.platform.path", platformFolder.getAbsolutePath());
     PreferencesData.set("runtime.hardware.path", platformFolder.getParentFile().getAbsolutePath());
+
+    if (!recentlyUsedBoards.contains(targetBoard)) {
+      recentlyUsedBoards.add(targetBoard);
+    }
+    if (recentlyUsedBoards.size() > PreferencesData.getInteger("editor.recent_boards.size", 4)) {
+      recentlyUsedBoards.remove();
+    }
   }
 
   public static void selectSerialPort(String port) {
