* Added a global configuration switch which allows the IntelliSense auto-configuration to be turned off

* Prepared the compiler parser code to be injected into "upload" and "upload using programmer" without overhead
* Updated intellisense.ts to use only "let" instead of "var" which is much safer
* Updated branch documentation

Author: elektronikworkshop

BRANCHNOTES.md

@@ -40,15 +40,17 @@ src/arduino/arduino.ts
 |                                       | :heavy_check_mark: Basic file output |
 |                                       | :white_check_mark: Merging of parsing result and existing file content |
 |                                       | :white_check_mark: Handling inexistent files and folders |
-| **Configuration flags**               | :white_check_mark: |
+| **Configuration flags**               | :heavy_check_mark: Disable flag for IntelliSense auto-config |
+|                                       | :white_check_mark: Perhaps a general IntelliSense flag `{off/manual, auto, oldstyle}` whereas the old can be removed at some point |
+|                                       | :white_check_mark: Fine grained IntelliSense control: Global en-/disable and project override. This is probably more useful since the most boards will hopefully work and for the very special cases the user can disable the feature for this single project but still can enjoy it within his regular projects. |
 | **Unit tests**                        | :white_check_mark: Basic parser (known boards, match/no match)|
 |                                       | :white_check_mark: Querying of compiler built-in includes |
 |                                       | :white_check_mark: Throwing arbitrary data at parser engines |
 |                                       | :white_check_mark: JSON input |
 |                                       | :white_check_mark: JSON output |
 |                                       | :white_check_mark: Configuration merging |
 | **General**                           | :white_check_mark: Review and remove previous attempts messing with `c_cpp_properties.json` |
-|                                       | :white_check_mark: Auto-run verify after setting a board to generate a valid `c_cpp_properties.json`, identify other occasions where this applies |
+|                                       | :white_check_mark: Auto-run verify after setting a board to generate a valid `c_cpp_properties.json`, identify other occasions where this applies (usually when adding new libraries), hint the user to run *verify*? |
 
 `*` not committed to branch yet
 
@@ -139,30 +141,31 @@ As one can see with the ESP32-gcc not all include directories are named `include
 
 
 ### Settings
-Global user settings, on linux under `~/.config/Code/User/settings.json`, for instance:
+#### Global Settings
+Under linux at `~/.config/Code/User/settings.json`, for instance:
 ```json
 {
     "arduino.additionalUrls": "",
     "arduino.logLevel": "verbose",
-    "C_Cpp.default.cppStandard": "c++11",
-    "C_Cpp.default.cStandard": "c11",
     "arduino.disableTestingOpen": true,
     "workbench.editor.enablePreview": false
 }
 ```
-Project settings in `.vscode/arduino.json`
+Code: [src/arduino/arduinoSettings.ts](src/arduino/arduinoSettings.ts)
+Code: [src/arduino/vscodeSettings.ts](src/arduino/vscodeSettings.ts)
+Validator: [package.json](package.json)
+
+#### Project Settings
+Path in project `.vscode/arduino.json`
 ```json
 {
-    "board": "arduino:avr:nano",
-    "configuration": "cpu=atmega328old",
-    "sketch": "examples/lcdpong-butenc/lcdpong-butenc.ino",
-    "port": "/dev/ttyUSB0"
-}
-```
-The global settings are [here](src/arduino/vscodeSettings.ts)
-```ts
-if (VscodeSettings.getInstance().logLevel === "verbose") {
-    args.push("--verbose");
+  "board": "arduino:avr:nano",
+  "configuration": "cpu=atmega328old",
+  "sketch": "examples/lcdpong-butenc/lcdpong-butenc.ino",
+  "port": "/dev/ttyUSB0"
 }
 ```
+Code: [src/deviceContext.ts](src/deviceContext.ts)
+Validator: [misc/arduinoValidator.json](misc/arduinoValidator.json)
+
 ### Global Tasks in vscode-arduino

package.json

@@ -491,6 +491,11 @@
         "arduino.defaultBaudRate": {
           "type": "number",
           "default": 115200
+        },
+        "arduino.disableIntelliSenseAutoGen": {
+          "type": "boolean",
+          "default": false,
+          "description": "When disabled vscode-arduino will not auto-generate an IntelliSense configuration (i.e. c_cpp_properties.json) by analyzing the compiler output."
         }
       }
     },

src/arduino/arduino.ts

@@ -313,28 +313,17 @@ export class ArduinoApp {
         }
 
         arduinoChannel.show();
-        // we need to return the result of verify
+
         try {
-            var gccParserEngine = new CompilerCmdParserEngineGcc(dc.sketch);
-            let compilerParser = new CompilerCmdParser([gccParserEngine]);
+            let compilerParserContext = this.makeCompilerParserContext(dc);
 
             await util.spawn(this._settings.commandPath,
                              arduinoChannel.channel,
                              args,
                              {},
-                             compilerParser.callback);
-
-            // Write compiler command parser result to IntelliSense
-            // configuration file in case parsing was successful.
-            if (compilerParser.result) {
-                var cppPropsPath = path.join(ArduinoWorkspace.rootPath, constants.CPP_CONFIG_FILE);
-                var cppProps = new CCppProperties(cppPropsPath);
-                cppProps.merge(compilerParser.result);
-                cppProps.write();
-                arduinoChannel.info("IntelliSense configuration generated successfully.");
-            } else {
-                arduinoChannel.warning("Failed to generate IntelliSense configuration.");
-            }
+                             compilerParserContext.callback);
+
+            compilerParserContext.conclude();
 
             arduinoChannel.end(`Finished verify sketch - ${dc.sketch}${os.EOL}`);
             return true;
@@ -349,6 +338,44 @@ export class ArduinoApp {
         }
     }
 
+    /** Creates a context which is used for compiler command parsing
+     * during building (verify, upload, ...).
+     * 
+     * This context makes sure that it can be used in those sections
+     * without having to check whether this feature is en- or disabled
+     * and keeps the calling context more readable.
+     * 
+     * @param dc The device context of the caller.
+     */
+    private makeCompilerParserContext(dc: DeviceContext)
+        : { callback: (s:string)=>void; conclude: ()=>void; }
+    {
+        if (!VscodeSettings.getInstance().disableIntelliSenseAutoGen) {
+
+            // setup the parser with its engines
+            let gccParserEngine = new CompilerCmdParserEngineGcc(dc.sketch);
+            let compilerParser = new CompilerCmdParser([gccParserEngine]);
+            
+            // set up the function to be called after parsing
+            let _conclude = () => {
+                let cppPropsPath = path.join(ArduinoWorkspace.rootPath, constants.CPP_CONFIG_FILE);
+                if (compilerParser.processResult(cppPropsPath)) {
+                    arduinoChannel.info("IntelliSense configuration generated successfully.");
+                } else {
+                    arduinoChannel.warning("Failed to generate IntelliSense configuration.");
+                }
+            };
+            return {
+                callback: compilerParser.callback,
+                conclude: _conclude,
+            };
+        }
+        return {
+            callback: undefined,
+            conclude: ()=>void{},
+        };
+    };
+
     public tryToUpdateIncludePaths() {
         const configFilePath = path.join(ArduinoWorkspace.rootPath, constants.CPP_CONFIG_FILE);
         if (!fs.existsSync(configFilePath)) {

src/arduino/intellisense.ts

@@ -24,7 +24,7 @@ export class CompilerCmdParserResult {
     defines: Array<string> = [];
     options: Array<string> = [];
     compiler: string = "";
-    /** Dropped arguments like -c -Ox */
+    /** Dropped arguments like -c -Ox -o, the input and output file. */
     trash: Array<string> = [];
 };
 
@@ -71,13 +71,13 @@ export abstract class CompilerCmdParserEngine
     public match(line: string): CompilerCmdParserResult
     {
         // check for regexes that must match
-        for (var re of this._match) {
+        for (let re of this._match) {
             if (line.search(re) == -1) {
                 return undefined;
             }
         }
         // check for regexes that mustn't match
-        for (var re of this._nomatch) {
+        for (let re of this._nomatch) {
             if (line.search(re) != -1) {
                 return undefined;
             }
@@ -116,10 +116,10 @@ export class CompilerCmdParserEngineGcc
     }
     protected parse(line: string): CompilerCmdParserResult
     {
-        var result = new CompilerCmdParserResult();
-        var args = line.split(/\s+/);
+        let result = new CompilerCmdParserResult();
+        let args = line.split(/\s+/);
 
-        for (var arg of args) {
+        for (let arg of args) {
 
             // drop empty arguments
             if (!arg.length) {
@@ -131,41 +131,41 @@ export class CompilerCmdParserEngineGcc
             //   "-DMBEDTLS_CONFIG_FILE=\"mbedtls/esp_config.h\""
             //   "-DARDUINO_BOARD=\"ESP32_DEV\""
             //   "-DARDUINO_VARIANT=\"doitESP32devkitV1\""
-            var packed = arg.match(/^"(.+)"$/);
+            let packed = arg.match(/^"(.+)"$/);
             if (packed) {
                 arg = packed[1];
             }
 
             // extract defines
-            var define = arg.match(/^-D(.+)/);
+            let define = arg.match(/^-D(.+)/);
             if (define) {
                 result.defines.push(define[1]);
                 continue;
             }
 
             // extract includes
-            var include = arg.match(/^-I(.+)/);
+            let include = arg.match(/^-I(.+)/);
             if (include) {
                 result.includes.push(include[1]);
                 continue;
             }
 
             // extract the compiler executable
-            var c = arg.match(/g\+\+$/);
+            let c = arg.match(/g\+\+$/);
             if (c) {
                 result.compiler = arg;
                 continue;
             }
 
             // filter out option trash
-            var t = arg.match(/^-o|^-O|^-g|^-c|cpp(?:\.o){0,1}$/);
+            let t = arg.match(/^-o|^-O|^-g|^-c|cpp(?:\.o){0,1}$/);
             if (t) {
                 result.trash.push(arg);
                 continue;
             }
 
             // collect options
-            var o = arg.match(/^-/);
+            let o = arg.match(/^-/);
             if (o) {
                 result.options.push(arg);
                 continue;
@@ -182,8 +182,8 @@ export class CompilerCmdParserEngineGcc
 
             // Spawn synchronous child process and run bash command
             // Source: https://stackoverflow.com/a/6666338
-            var compilerinfocmd = `${result.compiler} -xc++ -E -v - < /dev/null 2>&1`;
-            var child = spawnSync("bash", ["-c", compilerinfocmd], { encoding : 'utf8' });
+            let compilerinfocmd = `${result.compiler} -xc++ -E -v - < /dev/null 2>&1`;
+            let child = spawnSync("bash", ["-c", compilerinfocmd], { encoding : 'utf8' });
 
             if (child.error || child.status != 0) {
                 // TODO: report the execution failure
@@ -201,11 +201,11 @@ export class CompilerCmdParserEngineGcc
                 //   #include "..." search starts here:
                 //
                 // but I havn't seen it so far.
-                var includeregex = /^#include\s+<\.\.\.>\ssearch\sstarts\shere\:$(.+)^End\sof\ssearch\slist\.$/ms;
-                var match = child.stdout.match(includeregex);
+                let includeregex = /^#include\s+<\.\.\.>\ssearch\sstarts\shere\:$(.+)^End\sof\ssearch\slist\.$/ms;
+                let match = child.stdout.match(includeregex);
                 if (match) {
                     // Split list by newlines. Should be platform independent
-                    var lines = match[1].split(/\s*(?:\r|\r\n|\n)\s*/);
+                    let lines = match[1].split(/\s*(?:\r|\r\n|\n)\s*/);
                     // Filter out empty elements (in most cases only the last element)
                     lines = lines.filter(function (val:string){return val != ""});
                     // Add built-in includes to command line includes
@@ -256,7 +256,7 @@ export class CompilerCmdParser
      */
     public parse(line: string): boolean
     {
-        for (var engine of this._engines) {
+        for (let engine of this._engines) {
             this._result = engine.match(line);
             if (this._result) {
                 return true;
@@ -275,6 +275,16 @@ export class CompilerCmdParser
             }
         }    
     }
+    public processResult(configPath: string): boolean
+    {
+        if (this._result) {
+            let cppProps = new CCppProperties(configPath);
+            cppProps.merge(this._result);
+            cppProps.write();
+            return true;
+        }
+        return false;
+    }
 }
 
 /** Class representing the contents of the IntelliSense
@@ -335,7 +345,7 @@ export class CCppProperties
     }
     public merge(result: CompilerCmdParserResult)
     {
-        var pc = new CCppPropertiesContent(result);
+        let pc = new CCppPropertiesContent(result);
 
         // TODO:
         //  * merge with existing configuration if desired
@@ -353,7 +363,7 @@ export class CCppProperties
         //  * write file only if modified
 
         if (this.propFileContent) {
-            var content = JSON.stringify(this.propFileContent, null, 4);
+            let content = JSON.stringify(this.propFileContent, null, 4);
             fs.writeFileSync(this.proppath, content);
         }
     }

src/arduino/vscodeSettings.ts

@@ -15,6 +15,7 @@ const configKeys = {
     IGNORE_BOARDS: "arduino.ignoreBoards",
     SKIP_HEADER_PROVIDER: "arduino.skipHeaderProvider",
     DEFAULT_BAUD_RATE: "arduino.defaultBaudRate",
+    DISABLE_INTELLISENSE_AUTO_GEN: "arduino.disableIntelliSenseAutoGen",
 };
 
 export interface IVscodeSettings {
@@ -28,6 +29,7 @@ export interface IVscodeSettings {
     ignoreBoards: string[];
     skipHeaderProvider: boolean;
     defaultBaudRate: number;
+    disableIntelliSenseAutoGen: boolean;
     updateAdditionalUrls(urls: string | string[]): void;
 }
 
@@ -87,6 +89,10 @@ export class VscodeSettings implements IVscodeSettings {
         return this.getConfigValue<boolean>(configKeys.SKIP_HEADER_PROVIDER);
     }
 
+    public get disableIntelliSenseAutoGen(): boolean {
+        return this.getConfigValue<boolean>(configKeys.DISABLE_INTELLISENSE_AUTO_GEN);
+    }
+
     public async updateAdditionalUrls(value) {
         await this.setConfigValue(configKeys.ADDITIONAL_URLS, value, true);
     }