Added IntelliSense compiler parsing engine code

* Added IntelliSense compiler parsing engine code
* First injection of the compiler command parser and IntelliSense auto-configuration. Currently injected into "verify" only.
* Updated branch documentation to reflect the current state of this project

Author: elektronikworkshop

BRANCHNOTES.md

@@ -25,25 +25,31 @@ src/arduino/arduino.ts
 
 ### Status
 **2020-02-05** Currently I'm able to generate error free IntelliSense setups for AVR and ESP32 using the preliminary implementation. For ESP32 I just had to add the intrinsic compiler paths manually. A solution has to be found for these ... which there is, see [here](https://stackoverflow.com/a/6666338)
+**2020-02-06** Got it fully working (with built-in include directories) for AVR, ESP32, ESP8266. Rewrote the backend to facilitate writing of further parser engines in the future.
 
 |      | Tasks   |
 |-----:|:--------|
-| **Build output parser**               | :heavy_check_mark: Basic parser working* |
-|                                       | :white_check_mark: Support for different boards |
+| **Build output parser**               | :heavy_check_mark: Basic parser working |
+|                                       | :heavy_check_mark: Support for different boards (done for AVR, ESP32, ESP8266) -- The code has been designed such that it is easy to write/add new parser engines (for non gcc compilers for instance) |
+|                                       | :heavy_check_mark: Getting intrinsic gcc include paths |
+|                                       | :heavy_check_mark: Handling quoted arguments |
 |                                       | :white_check_mark: X-platform support |
-| **`c_cpp_properties.json` generator** | :heavy_check_mark: Basic objects* |
-|                                       | :heavy_check_mark: Basic setting of parsing result* |
-|                                       | :heavy_check_mark: Basic file input*  |
-|                                       | :heavy_check_mark: Basic file output* |
+| **`c_cpp_properties.json` generator** | :heavy_check_mark: Basic objects |
+|                                       | :heavy_check_mark: Basic setting of parsing result |
+|                                       | :heavy_check_mark: Basic file input  |
+|                                       | :heavy_check_mark: Basic file output |
 |                                       | :white_check_mark: Merging of parsing result and existing file content |
-|                                       | :white_check_mark: Getting intrinsic gcc include paths (partly done)|
+|                                       | :white_check_mark: Handling inexistent files and folders |
 | **Configuration flags**               | :white_check_mark: |
-| **Unit tests**                        | :white_check_mark: Basic parser |
+| **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` |
-* not committed to branch yet
+
+`*` not committed to branch yet
 
 ## Motivation
 I write a lot of code for Arduino, especially libraries. The Arduino IDE is not suited for more complex projects and I tried several alternatives. The old and dysfunctional Arduino CDT extension for eclipse somehow stalled (even if it was promising), Sloeber could be an option but the maintainer is disillusioned and the project is more or less dead. Platform IO IDE's license is very [restrictive](https://community.platformio.org/t/what-part-of-platformio-is-open-source-licenced/1447/2).
@@ -63,6 +69,7 @@ I will list every supporter here, thanks!
 1h coding -> 20$ -> 4 :beers:
 2020-02-04 Elektronik Workshop: 32 :beers: (8h coding)
 2020-02-05 Elektronik Workshop: 40 :beers: (10h coding)
+2020-02-06 Elektronik Workshop: 36 :beers: (9h coding)
 
 <!-- https://github.com/StylishThemes/GitHub-Dark/wiki/Emoji -->
 
@@ -83,7 +90,7 @@ I will list every supporter here, thanks!
 
 ## Implementation
 
-### `c_cpp_properties.json` Generator
+### Build Output Parser
 #### Intrinsic Include Paths
 Some include paths are built into gcc and don't have to be specified on the command line. This requires that we have to get them from the compiler.
 
@@ -96,9 +103,9 @@ won't do since not all include directories are named `include`. Fortunately gcc
 # generally for C++
 gcc -xc++ -E -v -
 # for esp32
-~/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/1.22.0-80-g6c4433a-5.2.0/bin/xtensa-esp32-elf-gcc -xc++ -E -v - < /dev/null 2>&1 | tee xtensa-esp32-elf-gcc_built_in_specs.txt
+~/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/1.22.0-80-g6c4433a-5.2.0/bin/xtensa-esp32-elf-gcc -xc++ -E -v - < /dev/null > xtensa-esp32-elf-gcc_built_in_specs.txt 2>&1
 # avr
-~/.arduino15/packages/arduino/tools/avr-gcc/7.3.0-atmel3.6.1-arduino5/bin/avr-gcc -xc++ -E -v - < /dev/null 2>&1 | tee avr-gcc_built_in_specs.txt
+~/.arduino15/packages/arduino/tools/avr-gcc/7.3.0-atmel3.6.1-arduino5/bin/avr-gcc -xc++ -E -v - < /dev/null > avr-gcc_built_in_specs.txt 2>&1
 ```
 The result can be inspected here:
 * [xtensa-esp32-elf-gcc_built_in_specs.txt](doc/intellisense/compilerinfo/xtensa-esp32-elf-gcc_built_in_specs.txt)
@@ -127,6 +134,9 @@ End of search list.
 ```
 As one can see with the ESP32-gcc not all include directories are named `include`. Parsing of this output is pretty trivial though.
 
+### `c_cpp_properties.json` Generator
+
+
 ### Settings
 Global user settings, on linux under `~/.config/Code/User/settings.json`, for instance:
 ```json
@@ -148,3 +158,5 @@ Project settings in `.vscode/arduino.json`
     "port": "/dev/ttyUSB0"
 }
 ```
+
+### Global Tasks in vscode-arduino

src/arduino/arduino.ts

@@ -22,6 +22,7 @@ import { arduinoChannel } from "../common/outputChannel";
 import { ArduinoWorkspace } from "../common/workspace";
 import { SerialMonitor } from "../serialmonitor/serialMonitor";
 import { UsbDetector } from "../serialmonitor/usbDetector";
+import { CCppProperties, CompilerCmdParser, CompilerCmdParserEngineGcc } from "./intellisense";
 import { ProgrammerManager } from "./programmerManager";
 
 /**
@@ -268,7 +269,27 @@ export class ArduinoApp {
         arduinoChannel.show();
         // we need to return the result of verify
         try {
-            await util.spawn(this._settings.commandPath, arduinoChannel.channel, args);
+            const gccParserEngine = new CompilerCmdParserEngineGcc(dc.sketch);
+            const compilerParser = new CompilerCmdParser([gccParserEngine]);
+
+            await util.spawn(this._settings.commandPath,
+                             arduinoChannel.channel,
+                             args,
+                             undefined,
+                             compilerParser.callback);
+
+            // Write compiler command parser result to IntelliSense
+            // configuration file in case parsing was successful.
+            if (compilerParser.result) {
+                const cppPropsPath = path.join(ArduinoWorkspace.rootPath, constants.CPP_CONFIG_FILE);
+                const cppProps = new CCppProperties(cppPropsPath);
+                cppProps.merge(compilerParser.result);
+                cppProps.write();
+                arduinoChannel.info("IntelliSense configuration generated successfully.");
+            } else {
+                arduinoChannel.warning("Failed to generate IntelliSense configuration.");
+            }
+
             arduinoChannel.end(`Finished verify sketch - ${dc.sketch}${os.EOL}`);
             return true;
         } catch (reason) {
@@ -280,7 +301,6 @@ export class ArduinoApp {
             arduinoChannel.error(msg);
             return false;
         }
-
     }
 
     public tryToUpdateIncludePaths() {