#682 triggering on workspace change eclipse runtinme change and os

change

Also: Use board descriptor for upload instead of com port

Author: jantje

io.sloeber.core/src/io/sloeber/core/InternalBoardDescriptor.java

@@ -40,7 +40,7 @@ public TxtFile getTxtFile() {
 
 	@Override
 	public void saveConfiguration() {
-		saveConfiguration(this.mConfdesc);
+		saveConfiguration(this.mConfdesc, null);
 	}
 
 }

io.sloeber.core/src/io/sloeber/core/api/BoardDescriptor.java

@@ -3,6 +3,7 @@
 import java.io.File;
 import java.net.URI;
 import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
@@ -34,44 +35,82 @@
 import org.eclipse.core.runtime.NullProgressMonitor;
 import org.eclipse.core.runtime.OperationCanceledException;
 import org.eclipse.core.runtime.Path;
+import org.eclipse.core.runtime.Platform;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.core.runtime.preferences.IEclipsePreferences;
 import org.eclipse.core.runtime.preferences.InstanceScope;
 
 import io.sloeber.core.Activator;
 import io.sloeber.core.InternalBoardDescriptor;
 import io.sloeber.core.common.Common;
+import io.sloeber.core.common.ConfigurationPreferences;
 import io.sloeber.core.common.Const;
 import io.sloeber.core.tools.Helpers;
 import io.sloeber.core.tools.Programmers;
 import io.sloeber.core.tools.ShouldHaveBeenInCDT;
 import io.sloeber.core.tools.TxtFile;
 
+@SuppressWarnings("nls")
 public class BoardDescriptor {
 
+	@Override
+	public String toString() {
+		return getBoardsFile() + " \"" + getBoardName() + "\" " + getUploadPort(); //$NON-NLS-2$
+	}
+
 	// preference nodes
 	public static final String NODE_ARDUINO = Activator.NODE_ARDUINO;
-	/**
-	 *
-	 */
 
+	/*
+	 * This is the basic info contained in the descriptor
+	 */
 	private String myUploadPort;
 	private String myUploadProtocol;
 	private String myBoardID;
-	private String myProjectName = new String();
 	private Map<String, String> myOptions;
+
+	/*
+	 * the following data is stored to detect changes that will make the equal
+	 * fail so os changes, workspace changes, eclipse install changes will force
+	 * a update on the stored data
+	 */
+	private String myProjectName = new String();
+	private String myOSName = Platform.getOS();
+	private String myWorkSpaceLocation = Common.getWorkspaceRoot().toString();
+	private String myWorkEclipseLocation = ConfigurationPreferences.getEclipseHome().toString();
+
+	/*
+	 * Stuff to make things work
+	 */
 	private File myBoardsFile;
 	protected TxtFile myTxtFile;
 	private ChangeListener myChangeListeners = null;
 	private static final IEclipsePreferences myStorageNode = InstanceScope.INSTANCE.getNode(NODE_ARDUINO);
 
-	private static final String KEY_LAST_USED_BOARD = "Last used Board"; //$NON-NLS-1$
-	private static final String KEY_LAST_USED_UPLOAD_PORT = "Last Used Upload port"; //$NON-NLS-1$
-	private static final String KEY_LAST_USED_UPLOAD_PROTOCOL = "last Used upload Protocol"; //$NON-NLS-1$
-	private static final String KEY_LAST_USED_BOARDS_FILE = "Last used Boards file"; //$NON-NLS-1$
-	private static final String KEY_LAST_USED_BOARD_MENU_OPTIONS = "last used Board custom option selections"; //$NON-NLS-1$
-	private static final String MENUSELECTION = Const.ENV_KEY_JANTJE_START + "MENU."; //$NON-NLS-1$
+	/*
+	 * Some constants
+	 */
+	private static final String KEY_LAST_USED_BOARD = "Last used Board";
+	private static final String KEY_LAST_USED_UPLOAD_PORT = "Last Used Upload port";
+	private static final String KEY_LAST_USED_UPLOAD_PROTOCOL = "last Used upload Protocol";
+	private static final String KEY_LAST_USED_BOARDS_FILE = "Last used Boards file";
+	private static final String KEY_LAST_USED_BOARD_MENU_OPTIONS = "last used Board custom option selections";
+	private static final String MENUSELECTION = Const.ENV_KEY_JANTJE_START + "MENU.";
+	private static final String ENV_KEY_JANTJE_UPLOAD_PORT = Const.ENV_KEY_JANTJE_START + "COM_PORT";
+	private static final String ENV_KEY_JANTJE_BOARD_NAME = Const.ENV_KEY_JANTJE_START + "BOARD_NAME";
+	private static final String ENV_KEY_JANTJE_PROJECT_NAME = Const.ENV_KEY_JANTJE_START + "PROJECT_NAME";
+	private static final String ENV_KEY_JANTJE_OS = Const.ENV_KEY_JANTJE_START + "OS_NAME";
+	private static final String ENV_KEY_JANTJE_WORKSPACE_LOCATION = Const.ENV_KEY_JANTJE_START + "WORKSPACE_LOCATION";
+	private static final String ENV_KEY_JANTJE_ECLIPSE_LOCATION = Const.ENV_KEY_JANTJE_START + "ECLIPSE_LOCATION";
 
+	/**
+	 * Compare 2 descriptors and return true is they are equal. This method
+	 * detects - OS changes - project name changes - moves of workspace -
+	 * changed runtine eclipse install
+	 *
+	 * @param obj
+	 * @return true if equal otherwise false
+	 */
 	public boolean equals(BoardDescriptor obj) {
 		if (!this.getUploadPort().equals(obj.getUploadPort())) {
 			return false;
@@ -91,13 +130,18 @@ public boolean equals(BoardDescriptor obj) {
 		if (!this.getProjectName().equals(obj.getProjectName())) {
 			return false;
 		}
+		if (!this.getMyOSName().equals(obj.getMyOSName())) {
+			return false;
+		}
+		if (!this.getMyWorkEclipseLocation().equals(obj.getMyWorkEclipseLocation())) {
+			return false;
+		}
+		if (!this.getMyWorkSpaceLocation().equals(obj.getMyWorkSpaceLocation())) {
+			return false;
+		}
 		return true;
 	}
 
-	public String getProjectName() {
-		return this.myProjectName;
-	}
-
 	/*
 	 * Create a sketchProject. This class does not really create a sketch
 	 * object. Nor does it look for existing (mapping) sketch projects This
@@ -115,7 +159,6 @@ protected BoardDescriptor() {
 
 	}
 
-	@SuppressWarnings("nls")
 	protected BoardDescriptor(ICConfigurationDescription confdesc) {
 		if (confdesc == null) {
 			this.myBoardsFile = new File(myStorageNode.get(KEY_LAST_USED_BOARDS_FILE, ""));
@@ -127,14 +170,19 @@ protected BoardDescriptor(ICConfigurationDescription confdesc) {
 			menuOptionsFromString(myStorageNode.get(KEY_LAST_USED_BOARD_MENU_OPTIONS, new String()));
 
 		} else {
-			this.myUploadPort = Common.getBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_UPLOAD_PORT, "");
+			this.myUploadPort = Common.getBuildEnvironmentVariable(confdesc, ENV_KEY_JANTJE_UPLOAD_PORT, "");
 			this.myUploadProtocol = Common.getBuildEnvironmentVariable(confdesc,
 					Common.get_Jantje_KEY_PROTOCOL(Const.ACTION_UPLOAD), "");
 			this.myBoardsFile = new File(
 					Common.getBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_BOARDS_FILE, ""));
 			this.myBoardID = Common.getBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_BOARD_ID, "");
-			this.myProjectName = Common.getBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_PROJECT_NAME, "");
+			this.myProjectName = Common.getBuildEnvironmentVariable(confdesc, ENV_KEY_JANTJE_PROJECT_NAME, "");
 			this.myTxtFile = new TxtFile(this.myBoardsFile);
+			this.myOSName = Common.getBuildEnvironmentVariable(confdesc, ENV_KEY_JANTJE_OS, "");
+			this.myWorkSpaceLocation = Common.getBuildEnvironmentVariable(confdesc, ENV_KEY_JANTJE_WORKSPACE_LOCATION,
+					"");
+			this.myWorkEclipseLocation = Common.getBuildEnvironmentVariable(confdesc, ENV_KEY_JANTJE_ECLIPSE_LOCATION,
+					"");
 
 			this.myOptions = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
 			IEnvironmentVariableManager envManager = CCorePlugin.getDefault().getBuildEnvironmentManager();
@@ -152,14 +200,53 @@ public static BoardDescriptor makeBoardDescriptor(File boardsFile, String boardI
 		return new InternalBoardDescriptor(boardsFile, boardID, options);
 	}
 
+	/**
+	 * make a board descriptor for each board in the board.txt file with the
+	 * default options
+	 *
+	 * @param boardFile
+	 * @return a list of board descriptors
+	 */
+	public static List<BoardDescriptor> makeBoardDescriptors(File boardFile) {
+		TxtFile txtFile = new TxtFile(boardFile);
+		List<BoardDescriptor> boards = new ArrayList<>();
+		for (String curboardName : txtFile.getAllNames()) {
+			Map<String, String> boardSection = txtFile.getSection(curboardName);
+			if (!"true".equalsIgnoreCase(boardSection.get("hide"))) {
+				boards.add(makeBoardDescriptor(boardFile, txtFile.getBoardIDFromBoardName(curboardName), null));
+			}
+		}
+		return boards;
+	}
+
+	/**
+	 * create a board descriptor
+	 *
+	 * @param boardsFile
+	 * @param boardID
+	 * @param options
+	 *            if null default options are taken
+	 */
 	protected BoardDescriptor(File boardsFile, String boardID, Map<String, String> options) {
-		this.myUploadPort = Const.EMPTY_STRING;
+		this.myUploadPort = new String();
 		this.myUploadProtocol = Defaults.getDefaultUploadProtocol();
 		this.myBoardID = boardID;
 		this.myOptions = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
-		this.myOptions.putAll(options);
 		this.myBoardsFile = boardsFile;
 		this.myTxtFile = new TxtFile(this.myBoardsFile);
+		if (options != null) {
+			this.myOptions.putAll(options);
+		} else {
+			TreeMap<String, String> allOptions = this.myTxtFile.getMenus();
+			for (Map.Entry<String, String> curoption : allOptions.entrySet()) {
+				if (!this.myOptions.containsKey(curoption.getKey())) {
+					String[] menuOptions = this.myTxtFile.getMenuItemIDsFromMenuID(curoption.getKey(), boardID);
+					if (menuOptions.length > 0) {
+						this.myOptions.put(curoption.getKey(), menuOptions[0]);
+					}
+				}
+			}
+		}
 	}
 
 	/**
@@ -177,9 +264,8 @@ public boolean configureProject(IProject project, IProgressMonitor monitor) {
 			// prjCDesc.setActiveConfiguration(configurationDescription);
 			CoreModel.getDefault().getProjectDescriptionManager().setProjectDescription(project, prjCDesc, true, null);
 		} catch (Exception e) {
-			// TODO Auto-generated catch block
 			e.printStackTrace();
-			Common.log(new Status(IStatus.ERROR, io.sloeber.core.Activator.getId(), "failed to save the board settings", //$NON-NLS-1$
+			Common.log(new Status(IStatus.ERROR, io.sloeber.core.Activator.getId(), "failed to save the board settings",
 					e));
 			return false;
 		}
@@ -235,19 +321,18 @@ public IProject createProject(String projectName, URI projectURI,
 		ICConfigurationDescription defaultConfigDescription = prjCDesc
 				.getConfigurationByName(cfgNamesAndTCIds.get(0).configName);
 
-		ICResourceDescription cfgd = defaultConfigDescription.getResourceDescription(new Path(Const.EMPTY_STRING),
-				true);
+		ICResourceDescription cfgd = defaultConfigDescription.getResourceDescription(new Path(new String()), true);
 		ICExclusionPatternPathEntry[] entries = cfgd.getConfiguration().getSourceEntries();
 		if (entries.length == 1) {
 			Path exclusionPath[] = new Path[8];
-			exclusionPath[0] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/**/?xamples/**"); //$NON-NLS-1$
-			exclusionPath[1] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/**/?xtras/**"); //$NON-NLS-1$
-			exclusionPath[2] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/**/test*/**"); //$NON-NLS-1$
-			exclusionPath[3] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/**/third-party/**"); //$NON-NLS-1$
-			exclusionPath[4] = new Path(Const.LIBRARY_PATH_SUFFIX + "**/._*"); //$NON-NLS-1$
-			exclusionPath[5] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/c*/?*"); //$NON-NLS-1$
-			exclusionPath[6] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/d*/?*"); //$NON-NLS-1$
-			exclusionPath[7] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/D*/?*"); //$NON-NLS-1$
+			exclusionPath[0] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/**/?xamples/**");
+			exclusionPath[1] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/**/?xtras/**");
+			exclusionPath[2] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/**/test*/**");
+			exclusionPath[3] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/**/third-party/**");
+			exclusionPath[4] = new Path(Const.LIBRARY_PATH_SUFFIX + "**/._*");
+			exclusionPath[5] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/c*/?*");
+			exclusionPath[6] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/d*/?*");
+			exclusionPath[7] = new Path(Const.LIBRARY_PATH_SUFFIX + "/?*/D*/?*");
 
 			ICExclusionPatternPathEntry newSourceEntry = new CSourceEntry(entries[0].getFullPath(), exclusionPath,
 					ICSettingEntry.VALUE_WORKSPACE_PATH);
@@ -275,7 +360,7 @@ public IProject createProject(String projectName, URI projectURI,
 	}
 
 	public void save(ICConfigurationDescription confdesc) throws Exception {
-		saveConfiguration(confdesc);
+		saveConfiguration(confdesc, null);
 		if (confdesc != null) {
 			IProject project = confdesc.getProjectDescription().getProject();
 
@@ -289,25 +374,38 @@ public void save(ICConfigurationDescription confdesc) throws Exception {
 	}
 
 	public void saveConfiguration() {
-		saveConfiguration(null);
+		saveConfiguration(null, null);
 	}
 
-	public void saveConfiguration(ICConfigurationDescription confdesc) {
-		if (confdesc != null) {
-
-			Common.setBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_PLATFORM_FILE, getPlatformFile());
-			Common.setBuildEnvironmentVariable(confdesc, "JANTJE.SELECTED.PLATFORM", getPlatformPath().toString()); //$NON-NLS-1$
-			Common.setBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_BOARD_NAME, getBoardName());
-			Common.setBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_BOARDS_FILE, getBoardsFile());
-			Common.setBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_BOARD_ID, this.myBoardID);
-			Common.setBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_ARCITECTURE_ID, getArchitecture());
-			Common.setBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_PACKAGE_ID, getPackage());
-			Common.setBuildEnvironmentVariable(confdesc, Const.ENV_KEY_JANTJE_UPLOAD_PORT, this.myUploadPort);
-			Common.setBuildEnvironmentVariable(confdesc, Common.get_Jantje_KEY_PROTOCOL(Const.ACTION_UPLOAD),
+	public void saveConfiguration(ICConfigurationDescription confDesc, IContributedEnvironment contribEnvIn) {
+		if (confDesc != null) {
+			IContributedEnvironment contribEnv = contribEnvIn;
+			if (contribEnv == null) {
+				IEnvironmentVariableManager envManager = CCorePlugin.getDefault().getBuildEnvironmentManager();
+				contribEnv = envManager.getContributedEnvironment();
+			}
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, Const.ENV_KEY_JANTJE_PLATFORM_FILE,
+					getPlatformFile());
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, "JANTJE.SELECTED.PLATFORM",
+					getPlatformPath().toString());
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, ENV_KEY_JANTJE_BOARD_NAME, getBoardName());
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, Const.ENV_KEY_JANTJE_BOARDS_FILE, getBoardsFile());
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, Const.ENV_KEY_JANTJE_BOARD_ID, this.myBoardID);
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, Const.ENV_KEY_JANTJE_ARCITECTURE_ID,
+					getArchitecture());
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, Const.ENV_KEY_JANTJE_PACKAGE_ID, getPackage());
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, ENV_KEY_JANTJE_UPLOAD_PORT, this.myUploadPort);
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, ENV_KEY_JANTJE_PROJECT_NAME, getProjectName());
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, ENV_KEY_JANTJE_OS, this.myOSName);
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, ENV_KEY_JANTJE_WORKSPACE_LOCATION,
+					this.myWorkSpaceLocation);
+			Common.setBuildEnvironmentVariable(contribEnv, confDesc, ENV_KEY_JANTJE_ECLIPSE_LOCATION,
+					this.myWorkEclipseLocation);
+			Common.setBuildEnvironmentVariable(confDesc, Common.get_Jantje_KEY_PROTOCOL(Const.ACTION_UPLOAD),
 					this.myUploadProtocol);
 			if (this.myOptions != null) {
 				for (Map.Entry<String, String> curoption : this.myOptions.entrySet()) {
-					Common.setBuildEnvironmentVariable(confdesc, MENUSELECTION + curoption.getKey(),
+					Common.setBuildEnvironmentVariable(contribEnv, confDesc, MENUSELECTION + curoption.getKey(),
 							curoption.getValue());
 				}
 			}
@@ -468,28 +566,43 @@ public String getMenuIdFromMenuName(String menuName) {
 		return this.myTxtFile.getMenuIDFromMenuName(menuName);
 	}
 
+	public String getMenuNameFromMenuID(String id) {
+		return this.myTxtFile.getMenuNameFromID(id);
+	}
+
 	public String getMenuItemNamedFromMenuItemID(String menuItemID, String menuID) {
 		return this.myTxtFile.getMenuItemNameFromMenuItemID(this.myBoardID, menuID, menuItemID);
 	}
 
+	/**
+	 * convert the options to a string so it can be stored
+	 *
+	 * @return a string representation of the options
+	 */
 	private String menuOptionsToString() {
 		String ret = new String();
 		String concat = new String();
 		if (this.myOptions != null) {
 			for (Entry<String, String> curOption : this.myOptions.entrySet()) {
 				ret += concat + curOption.getKey() + '=' + curOption.getValue();
-				concat = "\n"; //$NON-NLS-1$
+				concat = "\n";
 			}
 		}
 		return ret;
 	}
 
+	/**
+	 * convert a string to a options so it can be read from a string based
+	 * storage
+	 *
+	 * @param options
+	 */
 	private void menuOptionsFromString(String options) {
 		this.myOptions = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
 		if (options != null) {
-			String[] lines = options.split("\n"); //$NON-NLS-1$
+			String[] lines = options.split("\n");
 			for (String curLine : lines) {
-				String[] values = curLine.split("=", 2); //$NON-NLS-1$
+				String[] values = curLine.split("=", 2);
 				if (values.length == 2) {
 					this.myOptions.put(values[0], values[1]);
 				}
@@ -501,4 +614,28 @@ public String getMenuItemIDFromMenuItemName(String menuItemName, String menuID)
 		return this.myTxtFile.getMenuItemIDFromMenuItemName(this.myBoardID, menuID, menuItemName);
 	}
 
+	public static String getUploadPort(IProject project) {
+		return Common.getBuildEnvironmentVariable(project, ENV_KEY_JANTJE_UPLOAD_PORT, new String());
+	}
+
+	public static void storeUploadPort(IProject project, String uploadPort) {
+		Common.setBuildEnvironmentVariable(project, ENV_KEY_JANTJE_UPLOAD_PORT, uploadPort);
+	}
+
+	public String getMyOSName() {
+		return this.myOSName;
+	}
+
+	public String getMyWorkSpaceLocation() {
+		return this.myWorkSpaceLocation;
+	}
+
+	public String getMyWorkEclipseLocation() {
+		return this.myWorkEclipseLocation;
+	}
+
+	public String getProjectName() {
+		return this.myProjectName;
+	}
+
 }