Merge pull request arduino#8038 from cmaglie/pluggable-discovery

Pluggable discovery: search in platform.txt (WIP)

Author: facchinm

app/src/processing/app/Base.java

@@ -267,6 +267,8 @@ public Base(String[] args) throws Exception {
     splash.splashText(tr("Initializing packages..."));
     BaseNoGui.initPackages();
 
+    parser.getUploadPort().ifPresent(BaseNoGui::selectSerialPort);
+
     splash.splashText(tr("Preparing boards..."));
 
     if (!isCommandLine()) {

app/src/processing/app/Editor.java

@@ -52,7 +52,6 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
-import java.util.Comparator;
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.LinkedList;
@@ -96,6 +95,7 @@
 import cc.arduino.view.findreplace.FindReplace;
 import jssc.SerialPortException;
 import processing.app.debug.RunnerException;
+import processing.app.debug.TargetBoard;
 import processing.app.forms.PasswordAuthorizationDialog;
 import processing.app.helpers.DocumentTextChangeListener;
 import processing.app.helpers.Keys;
@@ -149,9 +149,6 @@ public boolean test(SketchController controller) {
     }
   }
 
-  private final static List<String> BOARD_PROTOCOLS_ORDER = Arrays.asList("serial", "network");
-  private final static List<String> BOARD_PROTOCOLS_ORDER_TRANSLATIONS = Arrays.asList(tr("Serial ports"), tr("Network ports"));
-
   final Base base;
 
   // otherwise, if the window is resized with the message label
@@ -1043,22 +1040,30 @@ class BoardPortJCheckBoxMenuItem extends JCheckBoxMenuItem {
     private BoardPort port;
 
     public BoardPortJCheckBoxMenuItem(BoardPort port) {
-      super(port.getLabel());
+      super();
+      this.port = port;
+      setText(toString());
       addActionListener(e -> {
         selectSerialPort(port.getAddress());
         base.onBoardOrPortChange();
       });
-      this.port = port;
     }
 
     @Override
     public String toString() {
       // This is required for serialPrompt()
-      return port.getLabel();
+      String label = port.getLabel();
+      if (port.getBoardName() != null && !port.getBoardName().isEmpty()) {
+        label += " (" + port.getBoardName() + ")";
+      }
+      return label;
     }
   }
 
   private void populatePortMenu() {
+    final List<String> PROTOCOLS_ORDER = Arrays.asList("serial", "network");
+    final List<String> PROTOCOLS_LABELS = Arrays.asList(tr("Serial ports"), tr("Network ports"));
+
     portMenu.removeAll();
 
     String selectedPort = PreferencesData.get("serial.port");
@@ -1067,31 +1072,43 @@ private void populatePortMenu() {
 
     ports = platform.filterPorts(ports, PreferencesData.getBoolean("serial.ports.showall"));
 
-    Collections.sort(ports, new Comparator<BoardPort>() {
-      @Override
-      public int compare(BoardPort o1, BoardPort o2) {
-        return (BOARD_PROTOCOLS_ORDER.indexOf(o1.getProtocol()) - BOARD_PROTOCOLS_ORDER.indexOf(o2.getProtocol())) * 10 +
-               o1.getAddress().compareTo(o2.getAddress());
-      }
+    ports.stream() //
+        .filter(port -> port.getProtocolLabel() == null || port.getProtocolLabel().isEmpty())
+        .forEach(port -> {
+          int labelIdx = PROTOCOLS_ORDER.indexOf(port.getProtocol());
+          if (labelIdx != -1) {
+            port.setProtocolLabel(PROTOCOLS_LABELS.get(labelIdx));
+          } else {
+            port.setProtocolLabel(port.getProtocol());
+          }
+        });
+
+    Collections.sort(ports, (port1, port2) -> {
+      String pr1 = port1.getProtocol();
+      String pr2 = port2.getProtocol();
+      int prIdx1 = PROTOCOLS_ORDER.contains(pr1) ? PROTOCOLS_ORDER.indexOf(pr1) : 999;
+      int prIdx2 = PROTOCOLS_ORDER.contains(pr2) ? PROTOCOLS_ORDER.indexOf(pr2) : 999;
+      int r = prIdx1 - prIdx2;
+      if (r != 0)
+        return r;
+      r = port1.getProtocolLabel().compareTo(port2.getProtocolLabel());
+      if (r != 0)
+        return r;
+      return port1.getAddress().compareTo(port2.getAddress());
     });
 
-    String lastProtocol = null;
-    String lastProtocolTranslated;
+    String lastProtocol = "";
+    String lastProtocolLabel = "";
     for (BoardPort port : ports) {
-      if (lastProtocol == null || !port.getProtocol().equals(lastProtocol)) {
-        if (lastProtocol != null) {
+      if (!port.getProtocol().equals(lastProtocol) || !port.getProtocolLabel().equals(lastProtocolLabel)) {
+        if (!lastProtocol.isEmpty()) {
           portMenu.addSeparator();
         }
         lastProtocol = port.getProtocol();
-
-        if (BOARD_PROTOCOLS_ORDER.indexOf(port.getProtocol()) != -1) {
-          lastProtocolTranslated = BOARD_PROTOCOLS_ORDER_TRANSLATIONS.get(BOARD_PROTOCOLS_ORDER.indexOf(port.getProtocol()));
-        } else {
-          lastProtocolTranslated = port.getProtocol();
-        }
-        JMenuItem lastProtocolMenuItem = new JMenuItem(tr(lastProtocolTranslated));
-        lastProtocolMenuItem.setEnabled(false);
-        portMenu.add(lastProtocolMenuItem);
+        lastProtocolLabel = port.getProtocolLabel();
+        JMenuItem item = new JMenuItem(tr(lastProtocolLabel));
+        item.setEnabled(false);
+        portMenu.add(item);
       }
       String address = port.getAddress();
 
@@ -2403,9 +2420,9 @@ private void handleBoardInfo() {
     for (BoardPort port : ports) {
       if (port.getAddress().equals(selectedPort)) {
         label = port.getBoardName();
-        vid = port.getVID();
-        pid = port.getPID();
-        iserial = port.getISerial();
+        vid = port.getPrefs().get("vid");
+        pid = port.getPrefs().get("pid");
+        iserial = port.getPrefs().get("iserial");
         protocol = port.getProtocol();
         found = true;
         break;
@@ -2575,12 +2592,12 @@ private void statusEmpty() {
   // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
 
   protected void onBoardOrPortChange() {
-    Map<String, String> boardPreferences = BaseNoGui.getBoardPreferences();
-    if (boardPreferences != null)
-      lineStatus.setBoardName(boardPreferences.get("name"));
+    TargetBoard board = BaseNoGui.getTargetBoard();
+    if (board != null)
+      lineStatus.setBoardName(board.getName());
     else
       lineStatus.setBoardName("-");
-    lineStatus.setSerialPort(PreferencesData.get("serial.port"));
+    lineStatus.setPort(PreferencesData.get("serial.port"));
     lineStatus.repaint();
   }
 

app/src/processing/app/EditorLineStatus.java

@@ -51,8 +51,7 @@ public class EditorLineStatus extends JComponent {
 
   String text = "";
   String name = "";
-  String serialport = "";
-  String serialnumber = "";
+  String port = "";
 
   public EditorLineStatus() {
     background = Theme.getColor("linestatus.bgcolor");
@@ -92,13 +91,13 @@ public void set(int newStart, int newStop) {
 
   public void paintComponent(Graphics graphics) {
     Graphics2D g = Theme.setupGraphics2D(graphics);
-    if (name.isEmpty() && serialport.isEmpty()) {
+    if (name.isEmpty() && port.isEmpty()) {
       PreferencesMap boardPreferences = BaseNoGui.getBoardPreferences();
       if (boardPreferences != null)
         setBoardName(boardPreferences.get("name"));
       else
         setBoardName("-");
-      setSerialPort(PreferencesData.get("serial.port"));
+      setPort(PreferencesData.get("serial.port"));
     }
     g.setColor(background);
     Dimension size = getSize();
@@ -112,8 +111,8 @@ public void paintComponent(Graphics graphics) {
     g.setColor(messageForeground);
 
     String statusText;
-    if (serialport != null && !serialport.isEmpty()) {
-      statusText = I18n.format(tr("{0} on {1}"), name, serialport);
+    if (port != null && !port.isEmpty()) {
+      statusText = I18n.format(tr("{0} on {1}"), name, port);
     } else {
       statusText = name;
     }
@@ -132,12 +131,8 @@ public void setBoardName(String name) {
     this.name = name;
   }
 
-  public void setSerialPort(String serialport) {
-    this.serialport = serialport;
-  }
-
-  public void setSerialNumber(String serialnumber) {
-    this.serialnumber = serialnumber;
+  public void setPort(String port) {
+    this.port = port;
   }
 
   public Dimension getPreferredSize() {

arduino-core/src/cc/arduino/packages/BoardPort.java

@@ -29,22 +29,36 @@
 
 package cc.arduino.packages;
 
+import processing.app.BaseNoGui;
+import processing.app.debug.TargetBoard;
+import processing.app.debug.TargetPackage;
+import processing.app.debug.TargetPlatform;
 import processing.app.helpers.PreferencesMap;
 
 public class BoardPort {
 
-  private String address;
-  private String protocol;
+  private String address;   // unique name for this port, used by Preferences
+  private String protocol;  // how to communicate, used for Ports menu sections
+  private String protocolLabel; // protocol extended name to display on GUI
   private String boardName;
-  private String vid;
-  private String pid;
-  private String iserial;
-  private String label;
-  private final PreferencesMap prefs;
-  private boolean online;
+  private String label;     // friendly name shown in Ports menu
+  private final PreferencesMap identificationPrefs; // data to match with boards.txt
+  private final PreferencesMap prefs; // "vendorId", "productId", "serialNumber"
+  private boolean online;   // used by SerialBoardsLister (during upload??)
 
   public BoardPort() {
     this.prefs = new PreferencesMap();
+    this.identificationPrefs = new PreferencesMap();
+  }
+
+  public BoardPort(BoardPort bp) {
+    prefs = new PreferencesMap(bp.prefs);
+    identificationPrefs = new PreferencesMap(bp.identificationPrefs);
+    address = bp.address;
+    protocol = bp.protocol;
+    boardName = bp.boardName;
+    label = bp.label;
+    online = bp.online;
   }
 
   public String getAddress() {
@@ -63,6 +77,14 @@ public void setProtocol(String protocol) {
     this.protocol = protocol;
   }
 
+  public String getProtocolLabel() {
+    return protocolLabel;
+  }
+
+  public void setProtocolLabel(String protocolLabel) {
+    this.protocolLabel = protocolLabel;
+  }
+
   public String getBoardName() {
     return boardName;
   }
@@ -75,6 +97,10 @@ public PreferencesMap getPrefs() {
     return prefs;
   }
 
+  public PreferencesMap getIdentificationPrefs() {
+    return identificationPrefs;
+  }
+
   public void setLabel(String label) {
     this.label = label;
   }
@@ -91,28 +117,76 @@ public boolean isOnline() {
     return online;
   }
 
-  public void setVIDPID(String vid, String pid) {
-    this.vid = vid;
-    this.pid = pid;
-  }
-
-  public String getVID() {
-    return vid;
-  }
-
-  public String getPID() {
-    return pid;
-  }
-
-  public void setISerial(String iserial) {
-    this.iserial = iserial;
-  }
-  public String getISerial() {
-    return iserial;
-  }
-
   @Override
   public String toString() {
-    return this.address+"_"+this.vid+"_"+this.pid;
+    return this.address;
+  }
+
+  // Search for the board which matches identificationPrefs.
+  // If found, boardName is set to the name from boards.txt
+  // and the board is returned.  If not found, null is returned.
+  public TargetBoard searchMatchingBoard() {
+    if (identificationPrefs == null || identificationPrefs.isEmpty()) return null;
+    for (TargetPackage targetPackage : BaseNoGui.packages.values()) {
+      for (TargetPlatform targetPlatform : targetPackage.getPlatforms().values()) {
+        for (TargetBoard board : targetPlatform.getBoards().values()) {
+          if (matchesBoard(board)) {
+            setBoardName(board.getName());
+            return board;
+          }
+        }
+      }
+    }
+    return null;
+  }
+
+  public boolean matchesBoard(TargetBoard board) {
+    PreferencesMap identificationProps = getIdentificationPrefs();
+    PreferencesMap boardProps = board.getPreferences();
+
+    String wildMatcher = identificationProps.get(".");
+    if (wildMatcher != null) {
+      if (wildMatcher.equals(board.getId())) {
+        return true;
+      }
+      if (wildMatcher.equals(board.getFQBN())) {
+        return true;
+      }
+    }
+
+    // Identification properties are defined in boards.txt with a ".N" suffix
+    // for example:
+    //
+    // uno.name=Arduino/Genuino Uno
+    // uno.vid.0=0x2341
+    // uno.pid.0=0x0043
+    // uno.vid.1=0x2341
+    // uno.pid.1=0x0001
+    // uno.vid.2=0x2A03
+    // uno.pid.2=0x0043
+    // uno.vid.3=0x2341
+    // uno.pid.3=0x0243
+    //
+    // so we must search starting from suffix ".0" and increasing until we
+    // found a match or the board has no more identification properties defined
+
+    for (int suffix = 0;; suffix++) {
+      boolean found = true;
+      for (String prop : identificationProps.keySet()) {
+        String value = identificationProps.get(prop);
+        prop += "." + suffix;
+        if (!boardProps.containsKey(prop)) {
+          return false;
+        }
+        if (!value.equalsIgnoreCase(boardProps.get(prop))) {
+          found = false;
+          break;
+        }
+      }
+      if (found) {
+        return true;
+      }
+    }
   }
+
 }