Merge branch 'master' of https://github.com/owent-contrib/vscode-clang-format-provider

Author: owent

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Xaver Hellauer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -2,6 +2,12 @@
 
 ## Release history
 
+### v 0.9.0
+* add protobuf support (work with https://marketplace.visualstudio.com/items?itemName=peterj.proto)
+* add javascript/typescript support
+* allow different style & fallback style option for different languages
+* format on save is available now (just like https://github.com/Microsoft/vscode-go/blob/master/src/goMain.ts)
+
 ### v 0.6.1
 * clean up dependencies #9
 
@@ -28,5 +34,4 @@
 If clang-format is installed and in PATH, C/C++ etc source files can be formatted with Visual Studio Code's built-in formatter (Usually: Ctrl+Shift+F).
 
 ## Source code
-
 Available on github: https://github.com/xaverh/vscode-clang-format-provider

package.json

@@ -2,13 +2,13 @@
     "name": "clang-format",
     "displayName": "Clang-Format",
     "description": "Use Clang-Format in Visual Studio Code",
-    "version": "0.6.1",
+    "version": "0.9.0",
     "publisher": "xaver",
     "engines": {
         "vscode": "^1.0.0"
     },
     "dependencies": {
-        "sax" : "^1.1.5"
+        "sax": "^1.1.5"
     },
     "categories": [
         "Other"
@@ -20,7 +20,8 @@
         "onLanguage:objective-c",
         "onLanguage:java",
         "onLanguage:javascript",
-        "onLanguage:typescript"
+        "onLanguage:typescript",
+        "onLanguage:proto"
     ],
     "contributes": {
         "configuration": {
@@ -33,20 +34,90 @@
                     "description": "Run 'clang-format' on save."
                 },
                 "clang-format.executable": {
-					"type": "string",
-					"default": "clang-format",
-					"description": "clang-format executable path"
-				},
+                    "type": "string",
+                    "default": "clang-format",
+                    "description": "clang-format executable path"
+                },
                 "clang-format.style": {
-					"type": "string",
-					"default": "file",
-					"description": "clang-format style.(-style=value, value can be file, LLVM, Google, Chromium, Mozilla, WebKit or json configure)"
-				},
+                    "type": "string",
+                    "default": "file",
+                    "description": "clang-format style.(-style=value, value can be file, LLVM, Google, Chromium, Mozilla, WebKit or json configure)"
+                },
                 "clang-format.fallbackStyle": {
-					"type": "string",
-					"default": "LLVM",
-					"description": "clang-format fallback style.(-fallback-style=value, value can be none, LLVM, Google, Chromium, Mozilla, WebKit)"
-				}
+                    "type": "string",
+                    "default": "LLVM",
+                    "description": "clang-format fallback style.(-fallback-style=value, value can be none, LLVM, Google, Chromium, Mozilla, WebKit)"
+                },
+                "clang-format.language.cpp.style": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for c++, left empty to use clang-format.style"
+                },
+                "clang-format.language.cpp.fallbackStyle": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for c++, left empty to use clang-format.fallbackStyle"
+                },
+                "clang-format.language.c.style": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for c, left empty to use clang-format.style"
+                },
+                "clang-format.language.c.fallbackStyle": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for c, left empty to use clang-format.fallbackStyle"
+                },
+                "clang-format.language.objective-c.style": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for objective-c, left empty to use clang-format.style"
+                },
+                "clang-format.language.objective-c.fallbackStyle": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for objective-c, left empty to use clang-format.fallbackStyle"
+                },
+                "clang-format.language.java.style": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for java, left empty to use clang-format.style"
+                },
+                "clang-format.language.java.fallbackStyle": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for java, left empty to use clang-format.fallbackStyle"
+                },
+                "clang-format.language.javascript.style": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for javascript, left empty to use clang-format.style"
+                },
+                "clang-format.language.javascript.fallbackStyle": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for javascript, left empty to use clang-format.fallbackStyle"
+                },
+                "clang-format.language.typescript.style": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for typescript, left empty to use clang-format.style"
+                },
+                "clang-format.language.typescript.fallbackStyle": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for typescript, left empty to use clang-format.fallbackStyle"
+                },
+                "clang-format.language.proto.style": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for proto, left empty to use clang-format.style"
+                },
+                "clang-format.language.proto.fallbackStyle": {
+                    "type": "string",
+                    "default": "",
+                    "description": "clang-format fallback style for proto, left empty to use clang-format.fallbackStyle"
+                }
             }
         }
     },

src/clangMode.ts

@@ -2,5 +2,5 @@
 
 import vscode = require('vscode');
 
-const LANGUAGES: string[] = ['cpp', 'c', 'objective-c', 'java', 'javascript', 'typescript'];
+const LANGUAGES: string[] = ['cpp', 'c', 'objective-c', 'java', 'javascript', 'typescript', 'proto'];
 export const MODES: vscode.DocumentFilter[] = LANGUAGES.map(language => ({ language, scheme: 'file' }));

src/extension.ts

@@ -59,7 +59,9 @@ export class ClangDocumentFormattingEditProvider implements vscode.DocumentForma
 
 
             parser.onopentag = (tag) => {
-                if (currentEdit) { reject("Malformed output"); }
+                if (currentEdit) { 
+                    reject("Malformed output"); 
+                }
 
                 switch (tag.name) {
                     case "replacements":
@@ -120,24 +122,27 @@ export class ClangDocumentFormattingEditProvider implements vscode.DocumentForma
         return this.defaultConfigure.executable;
     }
 
-    private getStyle() {
-        let ret = vscode.workspace.getConfiguration('clang-format').get<string>('style');
+    private getStyle(document: vscode.TextDocument) {
+        let ret = vscode.workspace.getConfiguration('clang-format').get<string>(`language.${document.languageId}.style`);
         if (ret.trim()) {
-            ret = ret.trim();
+            return ret.trim();
+        }
+
+        ret = vscode.workspace.getConfiguration('clang-format').get<string>('style');
+        if (ret && ret.trim()) {
+            return ret.trim();
         } else {
-            ret = this.defaultConfigure.style;
+            return this.defaultConfigure.style;
         }
-        
-        // Custom style
-        // if (ret.match(/[\\\{\" ]/)) {
-        //     return `"${ret.replace(/([\\\"])/g, "\\$1")}"`
-        // }
-        
-        return ret;
     }  
 
-    private getFallbackStyle() {
-        let strConf = vscode.workspace.getConfiguration('clang-format').get<string>('fallbackStyle');
+    private getFallbackStyle(document: vscode.TextDocument) {
+        let strConf = vscode.workspace.getConfiguration('clang-format').get<string>(`language.${document.languageId}.fallbackStyle`);
+        if (strConf.trim()) {
+            return strConf;
+        }
+
+        strConf = vscode.workspace.getConfiguration('clang-format').get<string>('fallbackStyle');
         if (strConf.trim()) {
             return strConf;
         }
@@ -158,7 +163,9 @@ export class ClangDocumentFormattingEditProvider implements vscode.DocumentForma
                         vscode.window.showInformationMessage("The '" + formatCommandBinPath + "' command is not available.  Please check your clang.formatTool user setting and ensure it is installed.");
                         return resolve(null);
                     }
-                    if (err) return reject("Cannot format due to syntax errors.");
+                    if (err) {
+                        return reject("Cannot format due to syntax errors.");
+                    }
 
                     var dummyProcessor = (value: string) => {
                         debugger;
@@ -173,8 +180,8 @@ export class ClangDocumentFormattingEditProvider implements vscode.DocumentForma
 
             var formatArgs = [
                 '-output-replacements-xml',
-                `-style=${this.getStyle()}`,
-                `-fallback-style=${this.getFallbackStyle()}`,
+                `-style=${this.getStyle(document)}`,
+                `-fallback-style=${this.getFallbackStyle(document)}`,
                 `-assume-filename=${document.fileName}`,
             ];
 
@@ -198,23 +205,69 @@ export class ClangDocumentFormattingEditProvider implements vscode.DocumentForma
             var child = cp.execFile(formatCommandBinPath, formatArgs, { cwd: workingPath }, childCompleted);
             child.stdin.end(codeContent);
 
-            token.onCancellationRequested(() => {
-                child.kill();
-                reject("Cancelation requested");
-            });
+            if(token) {
+                token.onCancellationRequested(() => {
+                    child.kill();
+                    reject("Cancelation requested");
+                });
+            }
         });
     }
 
+    public formatDocument(document: vscode.TextDocument): Thenable<vscode.TextEdit[]>{
+        return this.doFormatDocument(document, null, null, null);
+    }
+
 }
 
 let diagnosticCollection: vscode.DiagnosticCollection;
 
 export function activate(ctx: vscode.ExtensionContext): void {
 
     var formatter = new ClangDocumentFormattingEditProvider();
+    var availableLanguages = {};
 
     MODES.forEach(mode => {
         ctx.subscriptions.push(vscode.languages.registerDocumentRangeFormattingEditProvider(mode, formatter));
         ctx.subscriptions.push(vscode.languages.registerDocumentFormattingEditProvider(mode, formatter));
-    })
+        availableLanguages[mode.language] = true;
+    });
+
+    // TODO: This is really ugly.  I'm not sure we can do better until
+    // Code supports a pre-save event where we can do the formatting before
+    // the file is written to disk.	
+    // @see https://github.com/Microsoft/vscode-go/blob/master/src/goMain.ts
+    let ignoreNextSave = new WeakSet<vscode.TextDocument>();
+
+    vscode.workspace.onDidSaveTextDocument(document => {
+        try {
+            let formatOnSave = vscode.workspace.getConfiguration('clang-format').get<boolean>('formatOnSave');
+            if (!formatOnSave) {
+                return;
+            }
+
+            if (!availableLanguages[document.languageId] || ignoreNextSave.has(document)) {
+                return;
+            }
+
+            let textEditor = vscode.window.activeTextEditor;
+            formatter.formatDocument(document).then(edits => {
+                return textEditor.edit(editBuilder => {
+                    edits.forEach(edit => editBuilder.replace(edit.range, edit.newText))
+                });
+            }).then(applied => {
+                ignoreNextSave.add(document);
+                return document.save();
+            }).then(
+                () => {
+                    ignoreNextSave.delete(document);
+                }, () => {
+                    // Catch any errors and ignore so that we still trigger 
+                    // the file save.
+                }
+            );
+        } catch(e) {
+            console.error('formate when save file failed.' + e.toString());
+        }
+    });
 }