Use clang-format for auto-format (replaces libastyle) #11543
+404
−276
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| /* | ||
| * This file is part of Arduino. | ||
| * | ||
| * Arduino is free software; you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation; either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program; if not, write to the Free Software | ||
| * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | ||
| * | ||
| * As a special exception, you may use this file as part of a free software | ||
| * library without restriction. Specifically, if other files instantiate | ||
| * templates or use macros or inline functions from this file, or you compile | ||
| * this file and link it with other files to produce an executable, this | ||
| * file does not by itself cause the resulting executable to be covered by | ||
| * the GNU General Public License. This exception does not however | ||
| * invalidate any other reasons why the executable file might be covered by | ||
| * the GNU General Public License. | ||
| * | ||
| * Copyright 2021 Arduino LLC (http://www.arduino.cc/) | ||
| */ | ||
|
|
||
| package cc.arduino.packages.formatter.clangformat; | ||
|
|
||
| import static processing.app.I18n.tr; | ||
|
|
||
| import java.io.ByteArrayInputStream; | ||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.OutputStream; | ||
|
|
||
| import org.apache.commons.compress.utils.IOUtils; | ||
|
|
||
| import com.fasterxml.jackson.databind.DeserializationFeature; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
|
|
||
| import processing.app.Base; | ||
| import processing.app.BaseNoGui; | ||
| import processing.app.Editor; | ||
| import processing.app.syntax.SketchTextArea; | ||
|
|
||
| public class ClangFormat implements Runnable { | ||
|
|
||
| private final String clangExecutable = Base.getContentFile("clang-format") | ||
| .getAbsolutePath(); | ||
| private Editor editor; | ||
|
|
||
| public ClangFormat(Editor editor) { | ||
| this.editor = editor; | ||
| } | ||
|
|
||
| @Override | ||
| public void run() { | ||
| SketchTextArea tab = editor.getCurrentTab().getTextArea(); | ||
| String originalText = tab.getText(); | ||
| int cursorOffset = tab.getCaretPosition(); | ||
| try { | ||
| FormatResult result = runClangFormatOn(originalText, cursorOffset); | ||
| if (result.FormattedText.equals(originalText)) { | ||
| editor.statusNotice(tr("No changes necessary for Auto Format.")); | ||
| return; | ||
| } | ||
|
|
||
| // To keep cursor position after UNDO we produce a bogus edit (insertion | ||
| // and removal of a " " at cursor position) and we compound this change | ||
| // with the full auto-format update. | ||
| tab.beginAtomicEdit(); | ||
| tab.insert(" ", cursorOffset); | ||
| tab.replaceRange("", cursorOffset, cursorOffset + 1); | ||
| tab.setText(result.FormattedText); | ||
| tab.endAtomicEdit(); | ||
|
|
||
| tab.setCaretPosition(result.Cursor); | ||
|
|
||
| editor.statusNotice(tr("Auto Format finished.")); | ||
| } catch (IOException | InterruptedException e) { | ||
| editor.statusError("Auto format error: " + e.getMessage()); | ||
| e.printStackTrace(); | ||
| } catch (ClangException e) { | ||
| editor.statusError("Auto format error: " + e.getMessage()); | ||
| } | ||
| } | ||
|
|
||
| private Thread copyAndClose(InputStream input, OutputStream output) { | ||
| Thread t = new Thread(() -> { | ||
| try { | ||
| IOUtils.copy(input, output); | ||
| } catch (IOException e) { | ||
| e.printStackTrace(); | ||
| } | ||
| try { | ||
| input.close(); | ||
| } catch (IOException e) { | ||
| e.printStackTrace(); | ||
| } | ||
| try { | ||
| output.close(); | ||
| } catch (IOException e) { | ||
| e.printStackTrace(); | ||
| } | ||
| }); | ||
| t.start(); | ||
| return t; | ||
| } | ||
|
|
||
| private File findConfigFile() { | ||
| // check if sketch has a config file | ||
| File sketchDir = editor.getSketch().getFolder(); | ||
| if (new File(sketchDir, ".clang-format").isFile()) { | ||
| return sketchDir; | ||
| } | ||
|
|
||
| // check if a global config file exists | ||
| if (BaseNoGui.getSettingsFile(".clang-format").isFile()) { | ||
| return BaseNoGui.getSettingsFolder(); | ||
| } | ||
|
|
||
| // otherwise: no custom configs, return Arduino IDE app dir. | ||
| return new File(clangExecutable).getParentFile(); | ||
| } | ||
|
|
||
| FormatResult runClangFormatOn(String source, int cursorOffset) | ||
| throws IOException, InterruptedException, ClangException { | ||
| String cmd[] = new String[] { clangExecutable, "--cursor=" + cursorOffset }; | ||
|
|
||
| Process process = Runtime.getRuntime().exec(cmd, null, findConfigFile()); | ||
| ByteArrayOutputStream clangOutput = new ByteArrayOutputStream(); | ||
| ByteArrayOutputStream clangError = new ByteArrayOutputStream(); | ||
| ByteArrayInputStream dataOut = new ByteArrayInputStream(source.getBytes()); | ||
|
|
||
| Thread in = copyAndClose(dataOut, process.getOutputStream()); | ||
| Thread err = copyAndClose(process.getErrorStream(), clangError); | ||
| Thread out = copyAndClose(process.getInputStream(), clangOutput); | ||
|
|
||
| int r = process.waitFor(); | ||
| in.join(); | ||
| out.join(); | ||
| err.join(); | ||
|
|
||
| if (r != 0) { | ||
| throw new ClangException(clangError.toString()); | ||
| } | ||
|
|
||
| // clang-format will output first a JSON object with: | ||
| // - the resulting cursor position and | ||
| // - a flag teling if the conversion was successful | ||
| // for example: | ||
| // | ||
| // { "Cursor": 34, "IncompleteFormat": false } | ||
| ObjectMapper mapper = new ObjectMapper(); | ||
| mapper.configure(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY, true); | ||
| mapper.configure(DeserializationFeature.EAGER_DESERIALIZER_FETCH, true); | ||
| mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); | ||
| FormatResult res = mapper.readValue(clangOutput.toByteArray(), | ||
| FormatResult.class); | ||
|
|
||
| // After the JSON object above clang-format will output the formatted source | ||
| // code in plain text | ||
| String formattedText = clangOutput.toString(); | ||
| formattedText = formattedText.substring(formattedText.indexOf('}') + 1); | ||
| // handle different line endings | ||
| res.FormattedText = formattedText.replaceFirst("\\R", ""); | ||
| return res; | ||
| } | ||
| } | ||
|
|
||
| class ClangException extends Exception { | ||
| public ClangException(String string) { | ||
| super(string); | ||
| } | ||
| } | ||
|
|
||
| class FormatResult { | ||
| public String FormattedText; | ||
| public int Cursor; | ||
| public boolean IncompleteFormat; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| b10e77fb79a41880766439dc65cd8aaa328af5bc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| e3fe347cdb2e4b7b1c92b8e21b4aae49eeaaad55 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| a81b7e8c6c5922fbcd423228f13a1148a91a3932 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| d10ae0b04eadf9fd0fa52d16549a2c6bec482738 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 154b62e3062b5040594155702c7c7508d18c6b3a |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| # See: https://releases.llvm.org/11.0.1/tools/clang/docs/ClangFormatStyleOptions.html | ||
| --- | ||
| Language: Cpp | ||
| # LLVM is the default style setting, used when a configuration option is not set here | ||
| BasedOnStyle: LLVM | ||
| AccessModifierOffset: -2 | ||
| AlignAfterOpenBracket: Align | ||
| AlignConsecutiveAssignments: false | ||
| AlignConsecutiveBitFields: false | ||
| AlignConsecutiveDeclarations: false | ||
| AlignConsecutiveMacros: false | ||
| AlignEscapedNewlines: DontAlign | ||
| AlignOperands: Align | ||
| AlignTrailingComments: true | ||
| AllowAllArgumentsOnNextLine: true | ||
| AllowAllConstructorInitializersOnNextLine: true | ||
| AllowAllParametersOfDeclarationOnNextLine: true | ||
| AllowShortBlocksOnASingleLine: Always | ||
| AllowShortCaseLabelsOnASingleLine: true | ||
| AllowShortEnumsOnASingleLine: true | ||
| AllowShortFunctionsOnASingleLine: Empty | ||
| AllowShortIfStatementsOnASingleLine: Always | ||
| AllowShortLambdasOnASingleLine: Empty | ||
| AllowShortLoopsOnASingleLine: true | ||
| AlwaysBreakAfterDefinitionReturnType: None | ||
| AlwaysBreakAfterReturnType: None | ||
| AlwaysBreakBeforeMultilineStrings: false | ||
| AlwaysBreakTemplateDeclarations: No | ||
| BinPackArguments: true | ||
| BinPackParameters: true | ||
| # Only used when "BreakBeforeBraces" set to "Custom" | ||
| BraceWrapping: | ||
| AfterCaseLabel: false | ||
| AfterClass: false | ||
| AfterControlStatement: Never | ||
| AfterEnum: false | ||
| AfterFunction: false | ||
| AfterNamespace: false | ||
| #AfterObjCDeclaration: | ||
| AfterStruct: false | ||
| AfterUnion: false | ||
| AfterExternBlock: false | ||
| BeforeCatch: false | ||
| BeforeElse: false | ||
| BeforeLambdaBody: false | ||
| BeforeWhile: false | ||
| IndentBraces: false | ||
| SplitEmptyFunction: false | ||
| SplitEmptyRecord: false | ||
| SplitEmptyNamespace: false | ||
| # Java-specific | ||
| #BreakAfterJavaFieldAnnotations: | ||
| BreakBeforeBinaryOperators: NonAssignment | ||
| BreakBeforeBraces: Attach | ||
| BreakBeforeTernaryOperators: true | ||
| BreakConstructorInitializers: BeforeColon | ||
| BreakInheritanceList: BeforeColon | ||
| BreakStringLiterals: false | ||
| ColumnLimit: 0 | ||
| # "" matches none | ||
| CommentPragmas: "" | ||
| CompactNamespaces: false | ||
| ConstructorInitializerAllOnOneLineOrOnePerLine: true | ||
| ConstructorInitializerIndentWidth: 2 | ||
| ContinuationIndentWidth: 2 | ||
| Cpp11BracedListStyle: false | ||
| DeriveLineEnding: true | ||
| DerivePointerAlignment: true | ||
| DisableFormat: false | ||
| # Docs say "Do not use this in config files". The default (LLVM 11.0.1) is "false". | ||
| #ExperimentalAutoDetectBinPacking: | ||
| FixNamespaceComments: false | ||
| ForEachMacros: [] | ||
| IncludeBlocks: Preserve | ||
| IncludeCategories: [] | ||
| # "" matches none | ||
| IncludeIsMainRegex: "" | ||
| IncludeIsMainSourceRegex: "" | ||
| IndentCaseBlocks: true | ||
| IndentCaseLabels: true | ||
| IndentExternBlock: Indent | ||
| IndentGotoLabels: false | ||
| IndentPPDirectives: None | ||
| IndentWidth: 2 | ||
| IndentWrappedFunctionNames: false | ||
| InsertTrailingCommas: None | ||
| # Java-specific | ||
| #JavaImportGroups: | ||
| # JavaScript-specific | ||
| #JavaScriptQuotes: | ||
| #JavaScriptWrapImports | ||
| KeepEmptyLinesAtTheStartOfBlocks: true | ||
| MacroBlockBegin: "" | ||
| MacroBlockEnd: "" | ||
| # Set to a large number to effectively disable | ||
| MaxEmptyLinesToKeep: 100000 | ||
| NamespaceIndentation: None | ||
| NamespaceMacros: [] | ||
| # Objective C-specific | ||
| #ObjCBinPackProtocolList: | ||
| #ObjCBlockIndentWidth: | ||
| #ObjCBreakBeforeNestedBlockParam: | ||
| #ObjCSpaceAfterProperty: | ||
| #ObjCSpaceBeforeProtocolList | ||
| PenaltyBreakAssignment: 1 | ||
| PenaltyBreakBeforeFirstCallParameter: 1 | ||
| PenaltyBreakComment: 1 | ||
| PenaltyBreakFirstLessLess: 1 | ||
| PenaltyBreakString: 1 | ||
| PenaltyBreakTemplateDeclaration: 1 | ||
| PenaltyExcessCharacter: 1 | ||
| PenaltyReturnTypeOnItsOwnLine: 1 | ||
| # Used as a fallback if alignment style can't be detected from code (DerivePointerAlignment: true) | ||
| PointerAlignment: Right | ||
| RawStringFormats: [] | ||
| ReflowComments: false | ||
| SortIncludes: false | ||
| SortUsingDeclarations: false | ||
| SpaceAfterCStyleCast: false | ||
| SpaceAfterLogicalNot: false | ||
| SpaceAfterTemplateKeyword: false | ||
| SpaceBeforeAssignmentOperators: true | ||
| SpaceBeforeCpp11BracedList: false | ||
| SpaceBeforeCtorInitializerColon: true | ||
| SpaceBeforeInheritanceColon: true | ||
| SpaceBeforeParens: ControlStatements | ||
| SpaceBeforeRangeBasedForLoopColon: true | ||
| SpaceBeforeSquareBrackets: false | ||
| SpaceInEmptyBlock: false | ||
| SpaceInEmptyParentheses: false | ||
| SpacesBeforeTrailingComments: 2 | ||
| SpacesInAngles: false | ||
| SpacesInCStyleCastParentheses: false | ||
| SpacesInConditionalStatement: false | ||
| SpacesInContainerLiterals: false | ||
| SpacesInParentheses: false | ||
| SpacesInSquareBrackets: false | ||
| Standard: Auto | ||
| StatementMacros: [] | ||
| TabWidth: 2 | ||
| TypenameMacros: [] | ||
| # Default to LF if line endings can't be detected from the content (DeriveLineEnding). | ||
| UseCRLF: false | ||
| UseTab: Never | ||
| WhitespaceSensitiveMacros: [] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| d2a5246fed18b61d96de49887e16520be5dad944 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Care to removee
e.printStackTrace();?