Merge pull request #2627 from Microsoft/seanmcm/0_19_1_insiders_merge

Seanmcm/0 19 1 insiders merge

Author: sean-mcmanus

.github/ISSUE_TEMPLATE/language-service.md

@@ -4,10 +4,12 @@ about: 'Issues pertaining to IntelliSense, autocomplete, code editing, etc. '
 
 ---
 
-Type: LanguageService
-**----- Input information below -----**
+**Type: LanguageService**
+<!----- Input information below ----->
 
+<!--
 **Please review existing issues and our documentation at https://github.com/Microsoft/vscode-cpptools/tree/master/Documentation prior to filing an issue.**
+-->
 
 **Describe the bug**
 - OS and Version:
@@ -17,19 +19,21 @@ Type: LanguageService
 - A clear and concise description of what the bug is.
 
 **To Reproduce**
-Steps to reproduce the behavior:
-*Provide a code sample including configuration files such as c_cpp_properties.json*
+<!-- Steps to reproduce the behavior: -->
+<!-- *The most actionable issue reports include a code sample including configuration files such as c_cpp_properties.json* -->
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
 **Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- A clear and concise description of what you expected to happen. -->
 
 **Screenshots**
-If applicable, add screenshots to help explain your problem.
+<!-- If applicable, add screenshots to help explain your problem. -->
 
 **Additional context**
+<!--
 *Call Stacks: For bugs like crashes, deadlocks, infinite loops, etc. that we are not able to repro and for which the call stack may be useful, please attach a debugger and/or create a dmp and provide the call stacks. Starting with 0.17.3, Windows binaries have symbols available in VS Code by setting your "symbolSearchPath" to "http://msdl.microsoft.com/download/symbols".*
 Add any other context about the problem here including log messages in your Output window ("C_Cpp.loggingLevel": "Debug" in settings.json).
+-->

Documentation/FAQs.md

@@ -3,7 +3,8 @@
 ## Table of Contents
 * Setup: [Debugging Setup](#debugging-setup)
 * Debugger: [Why is debugging not working?](#why-is-debugging-not-working)
-* Build: [How to enable debug symbols?](#how-to-enable-debug-symbols)
+* Build: [How to enable debug symbols](#how-to-enable-debug-symbols)
+* Logging: [How to enable logging](#how-to-enable-logging)
 
 ## Debugging Setup
 The debugger needs to be configured to know which executable and debugger to use:
@@ -43,3 +44,39 @@ When in doubt, please check your compiler's documentation for the options necess
 
 * #### cl.exe
   Symbols are located in the `*.pdb` file.
+
+## How to enable logging
+
+Enabling logging will show communication information between VS Code and our extension and between our extension and the debugger.
+
+### Logging for `MI` debuggers
+
+The logging block with its defaults is as follows:
+
+```
+"logging": {
+    "trace": false,
+    "traceResponse": false,
+    "engineLogging": false
+}
+```
+
+#### VS Code and the CppTools extension
+
+The logging here is called `trace` logging and can be enabled by setting `trace` and `traceResponse` to `true` in the logging block inside `launch.json`. This will help diagnose issues related to VS Code's communication to our extension and our responses.
+
+#### CppTools extension and the debugger
+
+The logging between CppTools and the debugger is called `engineLogging`. When using an `MI` debugger such as `gdb` or `lldb`, this will show the request, response and events using the `mi` interpreter. This logging will help us determine whether the debugger is receiving the right commands and generating the correct responses.
+
+### Logging for `Visual C++` debugger
+
+The logging block with its defaults is as follows:
+
+```
+"logging": { 
+    "engineLogging": false
+}
+```
+
+The `Visual C++` debugger logging will show only the communication to and from VS Code as all communication to the debugger is done internally to the process and is not visible through logging.

Documentation/LanguageServer/Enabling logging.md

@@ -2,9 +2,9 @@
 
 If you are experiencing a problem that we are unable to diagnose based on information in your issue report, we might ask you to enable logging and send us your logs.
 
-As of version 0.14.0 of the extension, logging information is now delivered directly to the Output window in VSCode. To turn on full logging for an issue report, add `"C_Cpp.loggingLevel": "Information"` to your **settings.json**.
+As of version 0.14.0 of the extension, logging information is now delivered directly to the Output window in VSCode. To turn on full logging for an issue report, add `"C_Cpp.loggingLevel": "Information"` or `"C_Cpp.loggingLevel": "Debug"` to your **settings.json**.
 
-![image](https://user-images.githubusercontent.com/12818240/31898313-b32ff284-b7cd-11e7-97f5-89df93b5d9de.png)
+![image](https://user-images.githubusercontent.com/12818240/44601186-8a2af380-a790-11e8-9094-7064d1ba3cfb.png)
 
 VS Code organizes the logging from different extensions to improve readability so you must select the "C/C++" option in the log filter selector to see logging from the C/C++ extension:
 

Documentation/LanguageServer/MinGW.md

@@ -4,24 +4,17 @@ To use MinGW on Windows, we recommend you add the following configuration to you
 
 ## Extension version 0.17.0 and higher:
 
-When you set the `compilerPath` property and change `intelliSenseMode` to `clang-x64`, you no longer need to copy the system include path or defines to `includePath`, `browse.path`, or `defines` to enable IntelliSense to work properly. For example:
+When you set the `compilerPath` property and change `intelliSenseMode` to `clang-x64` (or `gcc-x64` in version 0.18.0 and higher), you no longer need to copy the system include path or defines to `includePath`, `browse.path`, or `defines` to enable IntelliSense to work properly. For example:
 
 ```json
 {
     "name": "MinGW",
-    "intelliSenseMode": "clang-x64",
+    "intelliSenseMode": "gcc-x64",
     "compilerPath": "C:/mingw64/bin/gcc.exe",
     "includePath": [
         "${workspaceFolder}"
     ],
     "defines": [],
-    "browse": {
-        "path": [
-            "${workspaceFolder}"
-        ],
-        "limitSymbolsToIncludedHeaders": true,
-        "databaseFilename": ""
-    },
     "cStandard": "c11",
     "cppStandard": "c++17"
 }

Documentation/LanguageServer/Windows Subsystem for Linux.md

@@ -1,6 +1,6 @@
 # Windows Subsystem for Linux
 
-> **Note:** If you are on **build 17110 of Windows or higher**, you must use version 0.17.0 or higher for IntelliSense to work. The Windows team turned on case-sensitive folders for the WSL environment and the C/C++ extension doesn't support case-sensitive folders until version 0.17.0.
+> **Note:** If you are on **build 17110 of Windows or higher**, you must use extension version 0.17.0 or higher for IntelliSense to work. The Windows team turned on case-sensitive folders for the WSL environment and the C/C++ extension doesn't support case-sensitive folders until version 0.17.0.
 
 To use the Windows Subsystem for Linux with this extension you need to add a configuration to your **c_cpp_properties.json** file which adds the necessary header paths from within the WSL filesystem to the `includePath`.
 
@@ -13,22 +13,12 @@ In **c_cpp_properties.json** you can directly address your WSL compiler and incl
 ```json
 {
     "name": "WSL",
-    "intelliSenseMode": "clang-x64",
+    "intelliSenseMode": "gcc-x64",
     "compilerPath": "/usr/bin/gcc",
     "includePath": [
-        "${workspaceFolder}",
-        "/mnt/c/libraries/lib1/include",
-        "C:/libraries/lib2/include"
+        "${workspaceFolder}/**"
     ],
     "defines": [],
-    "browse": {
-        "path": [
-            "${workspaceFolder}",
-            "/mnt/c/libraries"
-        ],
-        "limitSymbolsToIncludedHeaders": true,
-        "databaseFilename": ""
-    },
     "cStandard": "c11",
     "cppStandard": "c++17"
 }

Documentation/LanguageServer/c_cpp_properties.json.md

@@ -53,7 +53,7 @@
   A friendly name for the configuration. "Linux", "Mac", and "Win32" are special names that instruct the extension to load that configuration by default on the associated operating system unless additional configurations have been created. The status bar in VS Code will show you which configuration is active. You can also click on the label in the status bar to change the active configuration.
 
 * #### `intelliSenseMode`
-  If `"C_Cpp.intelliSenseEngine"` is set to "Default" in your settings file, this property determines which mode the IntelliSense engine will run in. `"msvc-x64"` maps to Visual Studio mode with 64-bit pointer sizes. `"clang-x64"` maps to GCC/CLang mode with 64-bit pointer sizes. Windows uses `"msvc-x64"` by default and Linux/Mac use `"clang-x64"` by default.
+  If `"C_Cpp.intelliSenseEngine"` is set to "Default" in your settings file, this property determines which mode the IntelliSense engine will run in. `"msvc-x64"` maps to Visual Studio mode with 64-bit pointer sizes. `"clang-x64"` maps to CLang mode with 64-bit pointer sizes. `"gcc-x64"` maps to GCC mode with 64-bit pointer sizes. Windows uses `"msvc-x64"` by default, macOS uses `"clang-x64"` by default, and Linux uses `"gcc-x64"` by default.
 
 * #### `includePath`
   If `"C_Cpp.intelliSenseEngine"` is set to "Default" in your settings file, this list of paths will be used by IntelliSense to search for headers included by your source files. This is basically the same as the list of paths you pass to your compiler with the `-I` switch. If a path ends with `/**` the IntelliSense engine will do a recursive search for includes starting from that directory. If on Windows with Visual Studio installed, or if a compiler is specified in the `compilerPath` setting, it is not necessary to list the system include paths in this list.
@@ -68,7 +68,11 @@
   A list of files that should be included before any other characters in the source file are processed. Files are included in the order listed.
 
 * #### `compilerPath` (optional)
-  The absolute path to the compiler you use to build your project. The extension will query the compiler to determine the system include paths and default defines to use for IntelliSense. Args can be added to modify the includes/defines used, e.g. `-nostdinc++`, `-m32`, etc., but paths with spaces must be surrounded by double quotes (`"`) if args are used.
+  The absolute path to the compiler you use to build your project. The extension will query the compiler to determine the system include paths and default defines to use for IntelliSense.
+  
+  Args can be added to modify the includes/defines used, e.g. `-nostdinc++`, `-m32`, `-fno-ms-extensions`, etc., but paths with spaces must be surrounded by double quotes (`"`) if args are used.
+  
+  If you want to disable automatic querying of system include paths and defines, set this value to the emptry string `""`. This is generally not recommended, but there are some cases where automatic querying of system includes and defines is undesirable.
 
 * #### `cStandard`
   The C standard revision to use for IntelliSense in your project.
@@ -87,7 +91,7 @@
 ### Browse properties
 
 * #### `path`
-  This list of paths will be used by the Tag Parser to search for headers included by your source files. The Tag Parser will automatically search all subfolders in these paths unless the path ends with a `/*` or `\*`. For example, `/usr/include` directs the Tag Parser to search the `include` folder and its subfolders for headers while `/usr/include/*` directs the Tag Parser not to look in any subfolders of `/usr/include`.
+  This list of paths will be used by the Tag Parser to search for headers included by your source files. If omitted, `includePath` will be used as the `path`. The Tag Parser will automatically search all subfolders in these paths unless the path ends with a `/*` or `\*`. For example, `/usr/include` directs the Tag Parser to search the `include` folder and its subfolders for headers while `/usr/include/*` directs the Tag Parser not to look in any subfolders of `/usr/include`.
 
 * #### `limitSymbolsToIncludedHeaders`
   When true, the Tag Parser will only parse code files that have been directly or indirectly included by a source file in `${workspaceFolder}`. When false, the Tag Parser will parse all code files found in the paths specified in the **path** list.

Extension/.gitignore

@@ -17,4 +17,5 @@ install.lock
 *.vsix
 
 # ignore vscode test
-.vscode-test/
+.vscode-test/
+browse*db*