Commit 676eb2f

committed

Escape special characters in formatter configuration for Windows

The sketch code formatter configuration is passed to the ClangFormat tool as a string representing a JSON object via a command line argument. Previously, the contents of this string were not given any special treatment to ensure compatibility with the command interpreter used on Windows machines. That did not result in problems only because the configuration didn't contain problematic combinations of characters. This good fortune will not persist through updates to the configuration, so the command must be properly processed. The Windows command interpreter does not use the POSIX style backslash escaping. For this reason, escaped quotes in the argument are recognized as normal quotes, meaning that the string alternates between quoted and unquoted states at random. When a character with special significance to the Windows command interpreter happens to occur outside a quoted section, an error results. The solution is to use the Windows command interpreter's caret escaping on these characters. Since such an escaping system is not recognized by POSIX shells, this is only done when the application is running on a Windows machine. References: - https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/echo#remarks - https://en.wikipedia.org/wiki/Escape_character#Windows_Command_Prompt

1 parent ce273ad commit 676eb2fCopy full SHA for 676eb2f

File tree

1 file changed

+15

-1

lines changed

arduino-ide-extension/src/node
- clang-formatter.ts

1 file changed

+15

-1

lines changed

`‎arduino-ide-extension/src/node/clang-formatter.ts‎`

Lines changed: 15 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import * as os from 'os';`
`1`	`2`	`import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';`
`2`	`3`	`import { MaybePromise } from '@theia/core/lib/common/types';`
`3`	`4`	`import { FileUri } from '@theia/core/lib/node/file-uri';`
`@@ -123,10 +124,23 @@ function toClangOptions(`
`123`	`124`
`124`	`125`	`// See: https://releases.llvm.org/11.0.1/tools/clang/docs/ClangFormatStyleOptions.html`
`125`	`126`	`export function style({ TabWidth, UseTab }: ClangFormatOptions): string {`
`126`		`- return JSON.stringify(styleJson({ TabWidth, UseTab })).replace(`
	`127`	`+ letstyleArgument= JSON.stringify(styleJson({ TabWidth, UseTab })).replace(`
`127`	`128`	`/[\\"]/g,`
`128`	`129`	`'\\$&'`
`129`	`130`	`);`
	`131`	`+ if (os.platform() === 'win32') {`
	`132`	`+ // Windows command interpreter does not use backslash escapes. This causes the argument to have alternate quoted and`
	`133`	`+ // unquoted sections.`
	`134`	`+ // Special characters in the unquoted sections must be caret escaped.`
	`135`	`+ const styleArgumentSplit = styleArgument.split('"');`
	`136`	`+ for (let i = 1; i < styleArgumentSplit.length; i += 2) {`
	`137`	`+ styleArgumentSplit[i] = styleArgumentSplit[i].replace(/[<>^\|]/g, '^$&');`
	`138`	`+ }`
	`139`	`+`
	`140`	`+ styleArgument = styleArgumentSplit.join('"');`
	`141`	`+ }`
	`142`	`+`
	`143`	`+ return styleArgument;`
`130`	`144`	`}`
`131`	`145`
`132`	`146`	`function styleJson({`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 676eb2f

File tree

1 file changed

1 file changed

`‎arduino-ide-extension/src/node/clang-formatter.ts‎`

0 commit comments