Framework to allow boards.txt and platform.txt files to be inside the plugin.

Author: jantje

it.baeyens.arduino.common/src/it/baeyens/arduino/common/ArduinoConst.java

@@ -154,5 +154,9 @@ public class ArduinoConst {
 
     public static final String ARDUINO_IDE_DUMP__FILE_NAME_TRAILER = "ArduinoIDE.tmp";
     public static final String ARDUINO_IDE_DUMP__FILE_NAME_PREFIX = "DUMP_";
+    public static final String PRE_PROCESSING_BOARDS_TXT = "pre_processing_boards.txt";
+    public static final String POST_PROCESSING_BOARDS_TXT = "post_processing_boards.txt";
+    public static final String PRE_PROCESSING_PLATFORM_TXT = "pre_processing_platform.txt";
+    public static final String POST_PROCESSING_PLATFORM_TXT = "post_processing_platform.txt";
 
 }

it.baeyens.arduino.core/config/arduino_eclipse_plugin.txt

@@ -0,0 +1 @@
+gemma.AA.post.processing.boards.6.1.5=true

it.baeyens.arduino.core/config/post_processing_boards_1.6.5.txt

@@ -0,0 +1 @@
+gemma.AA.post.processing.boards.default=true

it.baeyens.arduino.core/config/post_processing_boards_default.txt

@@ -0,0 +1 @@
+AA.post.processing.platform.default=true

it.baeyens.arduino.core/config/post_processing_platform_default.txt

@@ -0,0 +1 @@
+gemma.AA.pre.processing.boards.default=true

it.baeyens.arduino.core/config/pre_processing_boards_default.txt

@@ -0,0 +1 @@
+AA.pre.processing.platform.default=true

it.baeyens.arduino.core/config/pre_processing_platform_default.txt

@@ -54,33 +54,6 @@ public Map<String, String> getSection(String SectionKey) {
 	return mArduinoSupportedBoards.get(SectionKey);
     }
 
-    // /**
-    // * Generic method to read a value from the boards file
-    // *
-    // * @param boardName
-    // * @param Key
-    // * @return
-    // */
-    // private String getBoardSetting(String boardName, String Key, String
-    // defaultValue) {
-    // if (!mLastLoadedBoard.equals(boardName)) {
-    // mLastLoadedBoard = boardName;
-    // String mapName = getBoardIDFromName(boardName);
-    // settings = mArduinoSupportedBoards.get(mapName);
-    // }
-    //
-    // if (settings != null) {
-    // String TagContent = settings.get(Key);
-    // if (TagContent != null)
-    // return TagContent;
-    // } else {
-    // IStatus status = new Status(IStatus.ERROR, ArduinoConst.CORE_PLUGIN_ID,
-    // "Settings in ArduinoBoards is null. This should never happen.", null);
-    // Common.log(status);
-    // }
-    // return defaultValue;
-    // }
-
     /**
      * Get all the options in the boards.txt file
      * 
@@ -144,76 +117,6 @@ public String[] getMenuItemNames(String menuLabel, String boardName) {
 	return ret.toArray(new String[ret.size()]);
     }
 
-    //
-    // /**
-    // * getMCUName returns the mcu name for a given board. <br/>
-    // * This function assumes (and does not test so will fail) that the board
-    // file has been loaded
-    // *
-    // * @param boardName
-    // * the board name for which the mcu name will be returned
-    // * @return the MCU name
-    // * @author Jan Baeyens
-    // */
-    // public String getMCUName(String boardName) {
-    // return getBoardSetting(boardName, ArduinoConst.ProcessorTypeKeyTAG, "");
-    // }
-    //
-    // /**
-    // * getMCUFrequency returns the mcu frequency for a given board. <br/>
-    // * This function assumes (and does not test so will fail) that the board
-    // file has been loaded
-    // *
-    // * @param boardName
-    // * the board name for which the mcu frequency will be returned
-    // * @return the MCU frequency
-    // * @author Jan Baeyens
-    // */
-    // public String getMCUFrequency(String boardName) {
-    // return getBoardSetting(boardName, ArduinoConst.FrequencyKeyTAG,
-    // "").replaceFirst("L", " ").trim();
-    // }
-    //
-    // /**
-    // * returns the variant of the arduino board<br/>
-    // * This function assumes (and does not test so will fail) that the board
-    // file has been loaded
-    // *
-    // * @param boardName
-    // * the board name for which the board variant will be returned
-    // * @return the Arduino board variant
-    // * @author Jan Baeyens
-    // */
-    // public String getBoardVariant(String boardName) {
-    // return getBoardSetting(boardName, ArduinoConst.BoardVariantTAG, "");
-    // }
-    //
-    // /**
-    // * getDisableFlushing returns the disable flushing flag for a given board.
-    // <br/>
-    // * This function assumes (and does not test so will fail) that the board
-    // file has been loaded. This function is currently unused
-    // *
-    // * @param boardName
-    // * the board name for which the disable flushing flag will be returned
-    // * @return disable flushing flag
-    // * @author Jan Baeyens
-    // */
-    // public boolean getDisableFlushing(String boardName) {
-    // return getBoardSetting(boardName, ArduinoConst.disableFlushingKeyTAG,
-    // "").equalsIgnoreCase("TRUE");
-    // }
-    //
-    // public String getUploadTool(String boardName) {
-    // return getBoardSetting(boardName, ArduinoConst.UploadToolTAG,
-    // ArduinoConst.UploadToolDefault);
-    // }
-    //
-    // public String getBuildCoreFolder(String boardName) {
-    // return getBoardSetting(boardName, ArduinoConst.BoardBuildCoreFolder,
-    // ArduinoConst.BoardBuildCoreFolderdefault);
-    //
-    // }
     /**
      * GetArduinoBoards returns all the boards that are in the currently loaded board.txt file.
      * 
@@ -261,6 +164,10 @@ public boolean LoadBoardsFile(String boardsFile) {
 	return LoadBoardsFile();
     }
 
+    public boolean exists() {
+	return mLastLoadedBoardsFile.exists();
+    }
+
     /**
      * Load loads the board.txt file based on the arduino path.
      * 

it.baeyens.arduino.core/src/it/baeyens/arduino/tools/ArduinoBoards.java

@@ -621,7 +621,8 @@ private static void setTheEnvironmentVariablesAddAFile(IContributedEnvironment c
 			} else if (value.contains(BUILD_PATH_SYSCALLS_MTK)) {
 			    value = value.replace(BUILD_PATH_SYSCALLS_MTK, BUILD_PATH_ARDUINO_SYSCALLS_MTK);
 			}
-			IEnvironmentVariable envVar = new EnvironmentVariable(MakeKeyString(var[0]), MakeEnvironmentString(value));
+			IEnvironmentVariable envVar = new EnvironmentVariable(MakeKeyString(var[0]), MakeEnvironmentString(value,
+				ArduinoConst.ENV_KEY_ARDUINO_START));
 			contribEnv.addVariable(envVar, confDesc);
 		    }
 		}
@@ -660,7 +661,7 @@ private static void setTheEnvironmentVariablesAddtheBoardsTxt(IContributedEnviro
 	    // if it is not a menu item add it
 	    if (!currentPair.getKey().startsWith("menu.")) {
 		String keyString = MakeKeyString(currentPair.getKey());
-		String valueString = MakeEnvironmentString(currentPair.getValue());
+		String valueString = MakeEnvironmentString(currentPair.getValue(), ArduinoConst.ENV_KEY_ARDUINO_START);
 		contribEnv.addVariable(new EnvironmentVariable(keyString, valueString), confDesc);
 	    } else {
 
@@ -672,7 +673,7 @@ private static void setTheEnvironmentVariablesAddtheBoardsTxt(IContributedEnviro
 		    String StartValue = "menu." + menuID + "." + menuItemID + ".";
 		    if (currentPair.getKey().startsWith(StartValue)) {
 			String keyString = MakeKeyString(currentPair.getKey().substring(StartValue.length()));
-			String valueString = MakeEnvironmentString(currentPair.getValue());
+			String valueString = MakeEnvironmentString(currentPair.getValue(), ArduinoConst.ENV_KEY_ARDUINO_START);
 			contribEnv.addVariable(new EnvironmentVariable(keyString, valueString), confDesc);
 		    }
 		}
@@ -714,8 +715,9 @@ private static void setTheEnvironmentVariablesAddtheBoardsTxt(IContributedEnviro
 		    for (Entry<String, String> curOption : menuSectionMap.entrySet()) {
 			if (curOption.getKey().startsWith(keyStartsWithValue)) {
 			    String key = curOption.getKey().substring(keyStartsWithValue.length());
-			    contribEnv
-				    .addVariable(new EnvironmentVariable(MakeKeyString(key), MakeEnvironmentString(curOption.getValue())), confDesc);
+			    contribEnv.addVariable(
+				    new EnvironmentVariable(MakeKeyString(key), MakeEnvironmentString(curOption.getValue(),
+					    ArduinoConst.ENV_KEY_ARDUINO_START)), confDesc);
 			}
 		    }
 
@@ -760,83 +762,44 @@ private static boolean isThisMenuItemSelected(ArduinoBoards boardsFile, ICConfig
 
     public static void setTheEnvironmentVariables(IProject project, ICConfigurationDescription confDesc, boolean debugCompilerSettings) {
 
+	// first get all the data we need
 	IEnvironmentVariableManager envManager = CCorePlugin.getDefault().getBuildEnvironmentManager();
 	IContributedEnvironment contribEnv = envManager.getContributedEnvironment();
 
 	IPath boardFileName = new Path(Common.getBuildEnvironmentVariable(confDesc, ArduinoConst.ENV_KEY_JANTJE_BOARDS_FILE,
 		ArduinoInstancePreferences.getLastUsedBoardsFile()));
 	IPath localPlatformFilename = new Path(Common.getBuildEnvironmentVariable(confDesc, ArduinoConst.ENV_KEY_JANTJE_PLATFORM_FILE, ""));
 
-	/*
-	 * Trying to find the file in the plugin as described here :http://blog.vogella.com/2010/07/06/reading-resources-from-plugin/
-	 */
-	// Bundle bundle = Platform.getBundle(ArduinoConst.CORE_PLUGIN_ID);
-	// URL fileURL = bundle.getEntry("config/arduino_eclipse_plugin.txt");
-	// File file = null;
-	// try {
-	// file = new File(FileLocator.resolve(fileURL).toURI());
-	// } catch (URISyntaxException e1) {
-	// e1.printStackTrace();
-	// } catch (IOException e1) {
-	// e1.printStackTrace();
-	// }
-	// if (file == null) {
-	// Common.log(new Status(IStatus.ERROR, ArduinoConst.CORE_PLUGIN_ID,
-	// "Your setup has gotten corrupt. Missing config/arduino_eclipse_plugin.txt file."));
-	// return;
-	// }
-	// IPath arduinoEclipsePluginFile = new Path(file.getAbsolutePath());
-
-	/*
-	 * try the second method as the first method fails
-	 */
-	// URL url;
-	// try {
-	// url = new URL("platform:/plugin/it.baeyens.arduino.core/config/arduino_eclipse_plugin.txt");
-	// } catch (MalformedURLException e) {
-	// // TODO Auto-generated catch block
-	// e.printStackTrace();
-	// return;
-	// }
-	// File file = null;
-	// try {
-	// URL resolved_url = FileLocator.resolve(url);
-	// URI resolverdURI = resolved_url.toURI();
-	// file = new File(resolverdURI);
-	// } catch (URISyntaxException e1) {
-	// e1.printStackTrace();
-	// } catch (IOException e1) {
-	// e1.printStackTrace();
-	// } catch (Exception e1) {
-	// e1.printStackTrace();
-	// }
-	// if (file == null) {
-	// Common.log(new Status(IStatus.ERROR, ArduinoConst.CORE_PLUGIN_ID,
-	// "Your setup has gotten corrupt. Missing config/arduino_eclipse_plugin.txt file."));
-	// return;
-	// }
-	// IPath arduinoEclipsePluginFile = new Path(file.getAbsolutePath());
-
 	String boardID = Common.getBuildEnvironmentVariable(confDesc, ArduinoConst.ENV_KEY_JANTJE_BOARD_ID, "");
 	String architecture = Common.getBuildEnvironmentVariable(confDesc, ArduinoConst.ENV_KEY_JANTJE_ARCITECTURE_ID, "");
 	String packageName = Common.getBuildEnvironmentVariable(confDesc, ArduinoConst.ENV_KEY_JANTJE_PACKAGE_ID, "");
 	File anduinoIDEEnvNamesFile = Common.getArduinoIdeDumpName(packageName, architecture, boardID);
 	IPath anduinoIDEEnvNamesPath = new Path(anduinoIDEEnvNamesFile.toString());
 	architecture = architecture.toUpperCase();
+	IPath workspacePath = new Path(Common.getWorkspaceRoot().getAbsolutePath());
+	ArduinoBoards pluginPreProcessingBoardsTxt = new ArduinoBoards(workspacePath.append(ArduinoConst.PRE_PROCESSING_BOARDS_TXT).toString());
+	ArduinoBoards pluginPostProcessingBoardsTxt = new ArduinoBoards(workspacePath.append(ArduinoConst.POST_PROCESSING_BOARDS_TXT).toString());
+	IPath pluginPreProcessingPlatformTxt = new Path(workspacePath.append(ArduinoConst.PRE_PROCESSING_PLATFORM_TXT).toString());
+	IPath pluginPostProcessingPlatformTxt = new Path(workspacePath.append(ArduinoConst.POST_PROCESSING_PLATFORM_TXT).toString());
+	ArduinoBoards boardsFile = new ArduinoBoards(boardFileName.toOSString());
+	if (!(pluginPreProcessingBoardsTxt.exists() && pluginPostProcessingBoardsTxt.exists())) {
+	    Common.log(new Status(IStatus.ERROR, ArduinoConst.CORE_PLUGIN_ID, "Plugin is not properly configured. Please reconfigure plugin."));
+	    return;
+	}
+
+	// Now we have all info we can start processing
 
 	// first remove all Arduino Variables so there is no memory effect
 	RemoveAllArduinoEnvironmentVariables(contribEnv, confDesc);
 
-	// process the default env variables first. This way the platform.txt
-	// and boards.txt will
-	// overwrite the default settings
 	setTheEnvironmentVariablesSetTheDefaults(contribEnv, confDesc, localPlatformFilename);
 
+	setTheEnvironmentVariablesAddAFile(contribEnv, confDesc, pluginPreProcessingPlatformTxt);
+	setTheEnvironmentVariablesAddtheBoardsTxt(contribEnv, confDesc, pluginPreProcessingBoardsTxt, boardID, true);
+
 	// Do some magic for the arduino:arduino stuff
-	ArduinoBoards boardsFile = new ArduinoBoards(boardFileName.toOSString());
 	setTheEnvironmentVariablesRedirectToOtherVendors(contribEnv, confDesc, boardsFile, boardID, architecture.toLowerCase());// TOFIX again some
 																// dirty thing
-
 	// process the dump file from the arduino IDE
 	if (anduinoIDEEnvNamesFile.exists()) {
 	    setTheEnvironmentVariablesAddAFile(contribEnv, confDesc, anduinoIDEEnvNamesPath);
@@ -856,19 +819,15 @@ public static void setTheEnvironmentVariables(IProject project, ICConfigurationD
 	// now process the boards file
 	setTheEnvironmentVariablesAddtheBoardsTxt(contribEnv, confDesc, boardsFile, boardID, true);
 
-	// also process the file as part of the plugin
-	// if (arduinoEclipsePluginFile.toFile().exists()) {
-	// ArduinoBoards myBoardsFile = new ArduinoBoards(arduinoEclipsePluginFile.toOSString());
-	// setTheEnvironmentVariablesAddtheBoardsTxt(contribEnv, confDesc, myBoardsFile, boardID, false);
-	// }
+	setTheEnvironmentVariablesAddAFile(contribEnv, confDesc, pluginPostProcessingPlatformTxt);
+	setTheEnvironmentVariablesAddtheBoardsTxt(contribEnv, confDesc, pluginPostProcessingBoardsTxt, boardID, true);
 
-	// Do some post processing
+	// Do some coded post processing
 	setTheEnvironmentVariablesPostProcessing(contribEnv, confDesc);
 
 	// If this is a debug config we modify the environment variables for compilation
 	if (debugCompilerSettings) {
 	    setTheEnvironmentVariablesModifyDebugCompilerSettings(confDesc, envManager, contribEnv);
-
 	}
 
     }
@@ -1083,12 +1042,12 @@ private static void setTheEnvironmentVariablesModifyDebugCompilerSettings(ICConf
      *            the value string as read from the file
      * @return the string to be stored as value for the environment variable
      */
-    public static String MakeEnvironmentString(String inputString) {
+    public static String MakeEnvironmentString(String inputString, String keyPrefix) {
 	// String ret = inputString.replaceAll("-o \"\\{object_file}\"",
 	// "").replaceAll("\"\\{object_file}\"",
 	// "").replaceAll("\"\\{source_file}\"", "")
 	// .replaceAll("\\{", "\\${" + ArduinoConst.ENV_KEY_START);
-	String ret = inputString.replaceAll("\\{(?!\\{)", "\\${" + ArduinoConst.ENV_KEY_ARDUINO_START);
+	String ret = inputString.replaceAll("\\{(?!\\{)", "\\${" + keyPrefix);
 	StringBuilder sb = new StringBuilder(ret);
 	String regex = "\\{[^}]*\\}";
 	Pattern p = Pattern.compile(regex); // Create the pattern.