feat: refactoring and creating clang-format after build

espressif · Jul 19, 2024 · 8df0e5a · 8df0e5a
1 parent b5eae99
commit 8df0e5a
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 57 deletions.
diff --git a/bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/IDFBuildConfiguration.java b/bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/IDFBuildConfiguration.java
@@ -85,6 +85,7 @@
 import com.espressif.idf.core.internal.CMakeConsoleWrapper;
 import com.espressif.idf.core.internal.CMakeErrorParser;
 import com.espressif.idf.core.logging.Logger;
+import com.espressif.idf.core.util.ClangFormatFileHandler;
 import com.espressif.idf.core.util.ClangdConfigFileHandler;
 import com.espressif.idf.core.util.DfuCommandsUtil;
 import com.espressif.idf.core.util.HintsUtil;
@@ -339,6 +340,7 @@ public IProject[] build(int kind, Map<String, String> args, IConsole console, IP
 			}
 			runCmakeBuildCommand(console, monitor, project, start, generator, infoStream, buildDir);
 			new ClangdConfigFileHandler().update(project);
+			new ClangFormatFileHandler(project).update();
 			return new IProject[] { project };
 		}
 		catch (Exception e)

diff --git a/bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/ClangFormatFileHandler.java b/bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/ClangFormatFileHandler.java
@@ -1,7 +1,9 @@
+/*******************************************************************************
+ * Copyright 2024 Espressif Systems (Shanghai) PTE LTD. All rights reserved.
+ * Use is subject to license terms.
+ *******************************************************************************/
 package com.espressif.idf.core.util;
 
-import java.io.File;
-import java.io.FileInputStream;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.io.Writer;
@@ -19,63 +21,67 @@
 
 import com.espressif.idf.core.ILSPConstants;
 
-public class ClangFormatFileHandler
-{
+public class ClangFormatFileHandler {
 
-	public void update(IProject project) throws CoreException, IOException
-	{
-		File file = getClangFormatFile(project);
+    private final IProject project;
+    private final Path clangFormatPath;
 
-		// Load existing .clang-format file
-		FileInputStream inputStream = new FileInputStream(file);
-		final DumperOptions options = new DumperOptions();
-		options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
-		options.setPrettyFlow(true);
-		Yaml yaml = new Yaml(options);
-		Map<String, Object> obj = yaml.load(inputStream);
+    public ClangFormatFileHandler(IProject project) throws CoreException {
+        this.project = project;
+        this.clangFormatPath = project.getLocation().toPath().resolve(ILSPConstants.CLANG_FORMAT_FILE);
+    }
 
-		// Create new YAML structure if file is empty
-		Map<String, Object> data = createOrGetExistingYamlStructure(obj);
-		data.put("BasedOnStyle", data.getOrDefault("BasedOnStyle", "LLVM")); //$NON-NLS-1$
-		data.put("IndentWidth", data.getOrDefault("IndentWidth", 4));
-		// Write updated clang-format back to file
-		try (Writer writer = new FileWriter(file))
-		{
-			yaml.dump(data, writer);
-		}
-		catch (IOException e)
-		{
-			throw new IOException("Error writing .clang-format file: " + e.getMessage(), e); //$NON-NLS-1$
-		}
-	}
+	/**
+	 * Updates the .clang-format file. If the file does not exist, it is created and initialized with default settings.
+	 *
+	 * @throws IOException   if an I/O error occurs during file creation or writing
+	 * @throws CoreException if an error occurs while refreshing the project
+	 */
+    public void update() throws IOException, CoreException {
+		boolean isNewFile = createNewClangFormatFile();
 
-	@SuppressWarnings("unchecked")
-	private Map<String, Object> createOrGetExistingYamlStructure(Object obj)
-	{
-		if (obj instanceof Map)
-		{
-			return (Map<String, Object>) obj;
-		}
-		return new LinkedHashMap<>();
-	}
+        if (isNewFile) {
+			Map<String, Object> data = new LinkedHashMap<>();
+			data.put("BasedOnStyle", "LLVM"); //$NON-NLS-1$ //$NON-NLS-2$
+			data.put("IndentWidth", 4); //$NON-NLS-1$
+
+            writeYamlFile(data);
+        }
+    }
+
+    private DumperOptions createYamlOptions() {
+        DumperOptions options = new DumperOptions();
+        options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
+        options.setPrettyFlow(true);
+        return options;
+    }
+
+    private void writeYamlFile(Map<String, Object> data) throws IOException {
+        try (Writer writer = new FileWriter(clangFormatPath.toFile())) {
+            new Yaml(createYamlOptions()).dump(data, writer);
+        }
+    }
 
-	private File getClangFormatFile(IProject project) throws IOException, CoreException
+	/**
+	 * Ensures that the .clang-format file exists. If the file does not exist, it is created and the project is
+	 * refreshed.
+	 *
+	 * @return true if the file was created, false if it already existed
+	 * @throws IOException   if an I/O error occurs during file creation
+	 * @throws CoreException if an error occurs while refreshing the project
+	 */
+	private boolean createNewClangFormatFile() throws IOException, CoreException
 	{
-		// Resolve the path of the clang-format config file within the project directory
-		Path clangFormatPath = project.getLocation().toPath().resolve(ILSPConstants.CLANG_FORMAT_FILE);
-		if (!Files.exists(clangFormatPath))
-		{
-			try
-			{
-				Files.createFile(clangFormatPath);
-			}
-			catch (IOException e)
-			{
-				throw new IOException("Failed to create .clang_format file: " + e.getMessage(), e); //$NON-NLS-1$
-			}
-			project.refreshLocal(IResource.DEPTH_INFINITE, new NullProgressMonitor());
-		}
-		return clangFormatPath.toFile();
-	}
+        if (Files.exists(clangFormatPath)) {
+            return false;
+        }
 
+        try {
+            Files.createFile(clangFormatPath);
+            project.refreshLocal(IResource.DEPTH_INFINITE, new NullProgressMonitor());
+            return true;
+        } catch (IOException e) {
+            throw new IOException("Failed to create .clang_format file: " + e.getMessage(), e); //$NON-NLS-1$
+        }
+    }
 }
diff --git a/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/NewIDFProjectWizard.java b/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/NewIDFProjectWizard.java
@@ -111,7 +111,7 @@ public boolean performFinish()
 				String projectName = projectCreationWizardPage.getProjectName();
 				IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(projectName);
 				selProvider.setSelection(new StructuredSelection(project));
-				updateClangdFile(project);
+				updateClangFiles(project);
 			}
 		}
 
@@ -142,12 +142,12 @@ public boolean performFinish()
 		return performFinish;
 	}
 
-	private void updateClangdFile(IProject project)
+	private void updateClangFiles(IProject project)
 	{
 		try
 		{
-			new ClangFormatFileHandler().update(project);
 			new ClangdConfigFileHandler().update(project);
+			new ClangFormatFileHandler(project).update();
 		}
 		catch (Exception e)
 		{