Merge pull request #1458 from Microsoft/master

0.14.6 release

Author: sean-mcmanus

.travis.yml

@@ -0,0 +1,43 @@
+language: node_js
+
+node_js:
+- "8"
+
+before_install:
+  # Do not modify. Required for GUI based tests: See https://docs.travis-ci.com/user/gui-and-headless-browsers/#Using-xvfb-to-Run-Tests-That-Require-a-GUI
+  - if [ $TRAVIS_OS_NAME == "linux" ]; then
+      export CXX="g++-4.9" CC="gcc-4.9" DISPLAY=:99.0;
+      sh -e /etc/init.d/xvfb start;
+      sleep 3;
+    fi
+
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+      - sourceline: 'deb https://packages.microsoft.com/repos/microsoft-ubuntu-trusty-prod trusty main'
+        key_url: 'https://packages.microsoft.com/keys/microsoft.asc'
+    packages:
+      - gdb
+      - g++-4.9
+
+
+script:
+  # Download debugAdapters from an existing extension version. See TravisCI settings to set CPPTOOL_VERSION
+  - mkdir -p ~/.vscode/extensions/ms-vscode.cpptools-$CPPTOOL_VERSION
+  - wget https://github.com/Microsoft/vscode-cpptools/releases/download/$CPPTOOL_VERSION/cpptools.vsix -O ~/cpptools.vsix
+  - unzip ~/cpptools.vsix "extension/debugAdapters/*" -d ~/.
+  - mv ~/extension/debugAdapters ~/.vscode/extensions/ms-vscode.cpptools-$CPPTOOL_VERSION/debugAdapters
+  # Build and then run tests
+  - cd Extension
+  - npm install
+  - npm run tslint
+  - npm run compile
+  - npm run test
+
+after_failure:
+  - find ~ -name "integrationTests.log" -type f -exec cat {} \;
+
+after_success:
+  - find ~ -name "integrationTests.log" -type f -exec cat {} \;
+  

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# How to Contribute Changes
+
+## Contribution Steps:
+  * [Build and debug the extension](Documentation/Getting%20started.md#build-and-debug-the-cpptools-extension).
+  * File an [issue](https://github.com/Microsoft/vscode-cpptools/issues) and a [pull request](https://github.com/Microsoft/vscode-cpptools/pulls) with the change and we will review it.
+  * If the change affects functionality, add a line describing the change to [CHANGELOG.md](Extension/CHANGELOG.md).
+  * Try and add a test in [test/extension.test.ts](Extension/test/unitTests/extension.test.ts).
+  * Run tests via opening the [Extension](https://github.com/Microsoft/vscode-cpptools/tree/master/Extension) folder in Visual Studio Code, selecting the `Launch Tests` configuration in the Debug pane, and choosing `Start Debugging`.
+
+## About the Code
+  * Execution starts in the `activate` method in [main.ts](Extension/src/main.ts).
+    * `processRuntimeDependencies` handles the downloading and installation of the OS-dependent files. Downloading code exists in [packageManager.ts](Extension/src/packageManager.ts).
+    * `downloadCpptoolsJsonPkg` handles the `cpptools.json`, which can be used to enable changes to occur mid-update, such as turning the `intelliSenseEngine` to `"Default"` for a certain percentage of users.
+  * The debugger code is in the [Debugger](https://github.com/Microsoft/vscode-cpptools/tree/master/Extension/src/Debugger) folder.
+  * [LanguageServer/client.ts](Extension/src/LanguageServer/client.ts) handles various language server functionality.
+  * [LanguageServer/configurations.ts](Extension/src/LanguageServer/configurations.ts) handles functionality related to `c_cpp_properties.json`.
+  * [telemetry.ts](Extension/src/telemetry.ts): Telemetry data gets sent to either `logLanguageServerEvent` or `logDebuggerEvent`.
+  * The Tag Parser (symbol database) doesn't automatically expand macros, so the [cpp.hint](Extension/cpp.hint) file contains definitions of macros that should be expanded in order for symbols to be parsed correctly.

Code Samples/Fib/.vscode/launch.json

@@ -0,0 +1,40 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "(gdb) Launch",
+            "preLaunchTask": "build",
+            "type": "cppdbg",
+            "request": "launch",
+            "args": [],
+            "stopAtEntry": true,
+            "cwd": "${workspaceRoot}",
+            "environment": [],
+            "externalConsole": true,
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                }
+            ],
+            "logging": {
+                "engineLogging": false,
+                "trace": false
+            },
+            "windows": {
+                "program": "${workspaceRoot}/fib.exe",
+                "MIMode": "gdb",
+                "miDebuggerPath": "<Path/To/GDB>" // Path to gdb on windows
+            },
+            "linux": {
+                "program": "${workspaceRoot}/fib.out",
+                "MIMode": "gdb"
+            },
+            "osx": {
+                "program": "${workspaceRoot}/fib.out",
+                "MIMode": "lldb"
+            }
+        }
+    ]
+}

Code Samples/Fib/.vscode/tasks.json

@@ -0,0 +1,50 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "taskName": "build",
+            "type": "shell",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared"
+            },
+            "windows": {
+                "command": "${workspaceRoot}/build.cmd",
+                "args": [
+                    "<Path/To/MinGW/Cygwin/Bin/Folder>",    // Path to the bin folder containing g++ to compile
+                    "fib.exe"                               // Output executable name
+                ]
+            },
+            "linux": {
+                "command": "g++",
+                "args": [
+                    "-g",
+                    "*.cpp",
+                    "-lpthread",
+                    "--std=c++11",
+                    "-o",
+                    "fib.out"
+                ]
+            },
+            "osx": {
+                "command": "g++",
+                "args": [
+                    "-g",
+                    "*.cpp",
+                    "-lpthread",
+                    "--std=c++11",
+                    "-o",
+                    "fib.out"
+                ]
+            }
+        }
+    ]
+}

Code Samples/Fib/README.md

@@ -0,0 +1,3 @@
+# Fib
+
+This code sample is to show debugging. Update `launch.json` and `tasks.json` in the `.vscode` folder to use your setup to build and debug. 

Code Samples/Fib/build.cmd

@@ -0,0 +1,2 @@
+SET PATH=%PATH%;%1
+g++ -g *.cpp -lpthread --std=c++11 -O0 -o %2

Code Samples/Fib/main.cpp

@@ -0,0 +1,58 @@
+#include <iostream>
+#include <unistd.h>
+#include <sys/types.h>
+#include <pthread.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <time.h>
+#include <string.h>
+
+#include "thread.h"
+
+#define THREAD_COUNT 10
+
+static char block[] = "--block";
+int test = 0;
+
+int main(int argc, char **argv)
+{
+    srand(time(NULL));
+
+    static char pidText[] = "PID: ";
+    std::string helpText = "Attach a debugger and execute 'set foo=0' to continue";
+    char helloText[] = "Hello World!";
+
+    std::cout << helloText << std::endl;
+
+    pthread_t threads[THREAD_COUNT];
+
+    if (argc == 2 && !strcmp(block, argv[1]))
+    {
+        std::cout << helpText << std::endl;
+        volatile int foo = 1;
+        while (foo)
+            ;
+    }
+
+    if (argc == 2 && !strcmp("--crash", argv[1]))
+    {
+        int foo = 0;
+        int bar = 1 / foo;
+    }
+
+    for (int i = 0; i < THREAD_COUNT; i++)
+    {
+        std::cout << "Test " << i << std::endl;
+        pthread_create(&threads[i], NULL, &thread_proc, NULL);
+    }
+
+    for (int i = 0; i < THREAD_COUNT; i++)
+    {
+        pthread_join(threads[i], NULL);
+        test++;
+    }
+
+    std::cout << "All threads exited!" << std::endl;
+
+    return 1;
+}

Code Samples/Fib/thread.cpp

@@ -0,0 +1,48 @@
+#include <iostream>
+#include <unistd.h>
+#include <sys/types.h>
+#include <pthread.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <time.h>
+#include <string.h>
+
+#include "thread.h"
+
+static int g_tid = 0;
+
+static int fib(int n){
+    switch (n) {
+        case 0: return 1;
+        case 1: return 1;
+        default: return (fib(n-2) + fib(n-1)); 
+    }    
+}
+
+void * thread_proc(void* ctx)
+{
+    int tid = g_tid++;
+    
+    char thread_name[16];
+    sprintf(thread_name, "Thread %d", tid);
+#ifdef __APPLE__
+    pthread_setname_np(thread_name);
+#else
+    pthread_setname_np(pthread_self(), thread_name);
+#endif
+    
+    // Random delay, 0 - 0.5 sec
+    timespec ts;
+    ts.tv_sec = 0;
+    ts.tv_nsec = 500000000 + ((float)rand() / (float)RAND_MAX) * 500000000;
+    nanosleep(&ts, NULL);
+    
+    volatile int i = 0;
+    while (i <= 30) {
+        std::cout << "Thread " << tid << ": fib(" << i << ") = " << fib(i) << std::endl;
+        i++;
+        nanosleep(&ts, NULL);
+    }
+    
+    std::cout << thread_name << " exited!" << std::endl;
+}

Code Samples/Fib/thread.h

@@ -0,0 +1 @@
+void * thread_proc(void* ctx);

Documentation/Debugger/natvis/Natvis.md

@@ -0,0 +1,15 @@
+# Natvis - Custom views for native objects
+
+Natvis framework is a framework that allows developers to write custom schemas to help visualize native objects. 
+
+For gdb/lldb debugging (`"type": "cppdbg"`), a subset of the Natvis framework has been ported to the C/C++ extension and the code resides in the [MIEngine](https://github.com/Microsoft/MIEngine) shared component. If additional features that are not implemented are requested, please file an [issue](https://github.com/Microsoft/MIEngine/issues) on the MIEngine GitHub page with details of what is missing.
+
+For Visual C++ debugging (`"type": "cppvsdbg"`), the debugger contains the full implementation of the Natvis framework as Visual Studio. 
+
+## Documentation
+
+Official documentation can be found [here](https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects).
+
+## Schema
+
+The natvis schema can be found [here](natvis.xsd).