IEP-1334: EIM Integration

.github/workflows/ci.yml

@@ -10,39 +10,34 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  build_linux:
 
-    runs-on:
-      - self-hosted
-      - eclipse
-      - BrnoUBU0004
+    runs-on: [self-hosted, eclipse, BrnoUBU0004]
 
     steps:
-    - uses: actions/checkout@v2
-
-    - name: Clone IDF Release From Github
-      uses: actions/checkout@v2
-      with:
-        repository: espressif/esp-idf
-        path: dependencies/idf-tools
-        submodules: 'true'
-        ref: release/v5.1
+    - uses: actions/checkout@v4
 
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-          python-version: '3.10'
+        python-version: '3.10'
+
+    - name: Install ESP-IDF via eim		
+      uses: espressif/install-esp-idf-action@v1
+      with:
+        version: 'v5.3'
 
     - name: Set up Maven
       uses: stCarolas/setup-maven@v5
       with:
         maven-version: 3.9.6
 
     - name: Set up JDK 17
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v4
       with:
         java-version: '17'
         distribution: 'temurin'
+        cache: 'maven'
 
     - name: Build with Maven
       run: export NO_AT_BRIDGE=1 && mvn clean verify -Djarsigner.skip=true spotbugs:spotbugs -DskipTests=false -DtestWorkspace=/opt/actions-runner/_work/workspace

bundles/com.espressif.idf.core/src/com/espressif/idf/core/IDFEnvironmentVariables.java

@@ -52,6 +52,8 @@ public class IDFEnvironmentVariables
 
 	public static final String IDF_CCACHE_ENABLE = "IDF_CCACHE_ENABLE"; //$NON-NLS-1$
 
+	public static final String ESP_IDF_EIM_ID = "ESP_IDF_EIM_ID"; //$NON-NLS-1$
+
 	/**
 	 * @param variableName Environment variable Name
 	 * @return IEnvironmentVariable

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/Messages.java

@@ -33,8 +33,23 @@ public class Messages extends NLS
 	public static String ToolsInitializationDifferentPathMessageBoxOptionYes;
 	public static String ToolsInitializationDifferentPathMessageBoxOptionNo;
 	public static String IDFToolChainsMissingErrorMsg;
+
+	public static String ToolsInitializationEimMissingMsgBoxTitle;
+	public static String ToolsInitializationEimMissingMsgBoxMessage;
 
 	public static String RefreshingProjects_JobName;
+
+	public static String NoActiveEspIdfInWorkspaceMsgTitle;
+	public static String NoActiveEspIdfInWorkspaceMsg;
+
+	public static String OldConfigFoundMsgBoxTitle;
+	public static String OldConfigFoundMsgBoxMsg;
+	public static String OldConfigExportDirectorSelectionDialogTitle;
+	public static String OldConfigExportDirectorSelectionDialogInfo;
+	public static String OldConfigExportCompleteSuccessMsgTitle;
+	public static String OldConfigExportCompleteSuccessMsg;
+	public static String OldConfigExportCompleteFailMsgTitle;
+	public static String OldConfigExportCompleteFailMsg;
 
 	static
 	{

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/messages.properties

@@ -19,9 +19,23 @@ IDFBuildConfiguration_ParseCommand=Parse Compile Commands File
 IncreasePartitionSizeTitle=Low Application Partition Size
 IncreasePartitionSizeMessage=Less than 30% of application partition size is free({0} of {1} bytes), would you like to increase it? Please click <a href={2}>here</a> to check more details.
 ToolsInitializationDifferentPathMessageBoxTitle=Different IDF path found in the config file
+ToolsInitializationEimMissingMsgBoxTitle=ESP-IDF Missing
+ToolsInitializationEimMissingMsgBoxMessage=ESP-IDF is not found on your system. Please use EIM to install the ESP-IDF on your system to use the IDE. Click Yes to go to the download page and install EIM.
 ToolsInitializationDifferentPathMessageBoxMessage=A different ESP-IDF path was found in the esp_idf.json.json configuration file. Do you want to install the tools in the new path or the old path? Please click on the appropriate button.\nNew Path: {0}\nOld Path: {1}
 ToolsInitializationDifferentPathMessageBoxOptionYes=Use New Path
 ToolsInitializationDifferentPathMessageBoxOptionNo=Use Old Path
 RefreshingProjects_JobName=Refreshing Projects...
 IDFBuildConfiguration_PreCheck_DifferentIdfPath=The project was built using the ESP-IDF located at the {0} path.\nThe currently active ESP-IDF path in the IDE is {1}.\nPlease clean the project using "ESP-IDF:Project Full Clean" menu option to use the active ESP-IDF configuration. 
-IDFToolChainsMissingErrorMsg=Toolchains are missing. Please use ESP-IDF Manager for configuring
+IDFToolChainsMissingErrorMsg=Toolchains are missing. Please use ESP-IDF Manager for configuring
+
+NoActiveEspIdfInWorkspaceMsgTitle=ESP-IDF Setup
+NoActiveEspIdfInWorkspaceMsg=ESP-IDF is required to use Espressif IDE. Would you like to configure it now?
+
+OldConfigFoundMsgBoxTitle=Old Configuration Found
+OldConfigFoundMsgBoxMsg=An old ESP-IDF configuration has been detected.\nIf you want to use these you need to export these configuration and pass them on to EIM for updated configurations.\nWould you like to export these settings?\n\nPress 'Yes' to choose a location to save.
+OldConfigExportDirectorSelectionDialogTitle=Select Destination
+OldConfigExportDirectorSelectionDialogInfo=Choose a directory to save the exported settings.
+OldConfigExportCompleteSuccessMsgTitle=Export Successful
+OldConfigExportCompleteSuccessMsg=The configuration has been successfully copied to:\n{0}
+OldConfigExportCompleteFailMsgTitle=Export Failed
+OldConfigExportCompleteFailMsg=An error occurred while copying the configuration.\n{0}

bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/EimConstants.java

@@ -0,0 +1,16 @@
+package com.espressif.idf.core.tools;
+
+public interface EimConstants
+{
+	String EIM_WIN_PATH = "C:\\Espressif\\tools\\eim_idf.json"; //$NON-NLS-1$
+
+	String EIM_URL = "https://dl.espressif.com/dl/eim/"; //$NON-NLS-1$
+
+	String EIM_POSIX_PATH = System.getProperty("user.home").concat("/.espressif/tools/eim_idf.json"); //$NON-NLS-1$ //$NON-NLS-2$
+
+	String INSTALL_TOOLS_FLAG = "INSTALL_TOOLS_FLAG"; //$NON-NLS-1$
+
+	String TOOL_SET_CONFIG_LEGACY_CONFIG_FILE = "tool_set_config.json"; //$NON-NLS-1$
+
+	String OLD_CONFIG_EXPORTED_FLAG = "OLD_CONFIG_EXPORTED_FLAG"; //$NON-NLS-1$
+}

bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/EimIdfConfiguratinParser.java

@@ -0,0 +1,47 @@
+package com.espressif.idf.core.tools;
+
+import java.io.FileReader;
+import java.io.IOException;
+
+import org.eclipse.core.runtime.Platform;
+
+import com.espressif.idf.core.tools.vo.EimJson;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+
+public class EimIdfConfiguratinParser
+{
+	private EimJson eimJson;
+	private Gson gson;
+
+	public EimIdfConfiguratinParser()
+	{
+		gson = new GsonBuilder().setPrettyPrinting().enableComplexMapKeySerialization()
+				.excludeFieldsWithoutExposeAnnotation().create();
+	}
+
+	private void load() throws IOException
+	{
+		try (FileReader fileReader = new FileReader(
+				Platform.getOS().equals(Platform.OS_WIN32) ? EimConstants.EIM_WIN_PATH : EimConstants.EIM_POSIX_PATH))
+		{
+			eimJson = gson.fromJson(fileReader, EimJson.class);
+		}
+	}
+
+
+	public EimJson getEimJson(boolean reload) throws IOException
+	{
+		if (reload)
+		{
+			load();
+		}
+
+		if (eimJson == null)
+		{
+			load();
+		}
+
+		return eimJson;
+	}
+}

bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/Messages.java

@@ -0,0 +1,27 @@
+package com.espressif.idf.core.tools;
+
+import org.eclipse.osgi.util.NLS;
+
+
+public class Messages extends NLS
+{
+	private static final String BUNDLE_NAME = "com.espressif.idf.core.tools.messages"; //$NON-NLS-1$
+
+	public static String InstallToolsHandler_CopyingOpenOCDRules;
+	public static String InstallToolsHandler_OpenOCDRulesCopyWarning;
+	public static String InstallToolsHandler_OpenOCDRulesCopyWarningMessage;
+	public static String InstallToolsHandler_OpenOCDRulesNotCopied;
+	public static String InstallToolsHandler_OpenOCDRulesCopyPaths;
+	public static String InstallToolsHandler_OpenOCDRulesCopyError;
+	public static String InstallToolsHandler_OpenOCDRulesCopied;
+
+	static
+	{
+		// initialize resource bundle
+		NLS.initializeMessages(BUNDLE_NAME, Messages.class);
+	}
+
+	private Messages()
+	{
+	}
+}