In this tutorial, you configure Visual Studio Code on macOS to use the Clang/LLVM compiler and debugger.
Use the Visual Studio debugger to quickly find and fix bugs across languages. The Visual Studio for Mac debugger lets you step inside your code by setting Breakpoints, Step Over statements, Step Into and Out of functions, and inspect the current state of the code stack through powerful visualizations. Visual Studio IDE Visual Studio for Mac Visual Studio Code To continue downloading, click here Visual Studio Live Share Visual Studio 2020-09-16T10:57:17-07:00.
After configuring VS Code, you will compile and debug a simple C++ program in VS Code. This tutorial does not teach you about Clang or the C++ language. For those subjects, there are many good resources available on the Web.
Parallel desktop 11 for mac. If you have any trouble, feel free to file an issue for this tutorial in the VS Code documentation repository.
Look to the left of the software and you’ll see checkboxes that detail the types of files the software is finding. Wd drive for mac.
To successfully complete this tutorial, you must do the following:
Install Visual Studio Code on macOS.
Install the C++ extension for VS Code. You can install the C/C++ extension by searching for 'c++' in the Extensions view (⇧⌘X (Windows, Linux Ctrl+Shift+X)).
Clang may already be installed on your Mac. To verify that it is, open a macOS Terminal window and enter the following command:
From the macOS Terminal, create an empty folder called projects
where you can store all your VS Code projects, then create a subfolder called helloworld
, navigate into it, and open VS Code in that folder by entering the following commands:
The code .
command opens VS Code in the current working folder, which becomes your 'workspace'. As you go through the tutorial, you will create three files in a .vscode
folder in the workspace:
tasks.json
(compiler build settings)launch.json
(debugger settings)c_cpp_properties.json
(compiler path and IntelliSense settings)In the File Explorer title bar, select New File and name the file helloworld.cpp
.
Paste in the following source code:
Now press ⌘S (Windows, Linux Ctrl+S) to save the file. Notice that your files are listed in the File Explorer view (⇧⌘E (Windows, Linux Ctrl+Shift+E)) in the side bar of VS Code:
You can also enable Auto Save to automatically save your file changes, by checking Auto Save in the main File menu.
The Activity Bar on the edge of Visual Studio Code lets you open different views such as Search, Source Control, and Run. You'll look at the Run view later in this tutorial. You can find out more about the other views in the VS Code User Interface documentation.
Note: When you save or open a C++ file, you may see a notification from the C/C++ extension about the availability of an Insiders version, which lets you test new features and fixes. You can ignore this notification by selecting the X
(Clear Notification).
In the helloworld.cpp
file, hover over vector
or string
to see type information. After the declaration of the msg
variable, start typing msg.
as you would when calling a member function. You should immediately see a completion list that shows all the member functions, and a window that shows the type information for the msg
object:
You can press the Tab key to insert the selected member. Then, when you add the opening parenthesis, you'll see information about arguments that the function requires.
Next, you'll create a tasks.json
file to tell VS Code how to build (compile) the program. This task will invoke the Clang C++ compiler to create an executable file from the source code.
It's important to have helloworld.cpp
open in the editor because the next step uses the active file in the editor as context to create the build task in the next step.
From the main menu, choose Terminal > Configure Default Build Task. A dropdown will appear listing various predefined build tasks for the compilers that VS Code found on your machine. Choose C/C++ clang++ build active file to build the file that is currently displayed (active) in the editor.
Word for mac free. This will create a tasks.json
file in the .vscode
folder and open it in the editor.
Replace the contents of that file with the following:
The JSON above differs from the default template JSON in the following ways:
'args'
is updated to compile with C++17 because our helloworld.cpp
uses C++17 language features.'cwd'
) to the folder where helloworld.cpp
is.The command
setting specifies the program to run. In this case, 'clang++'
is the driver that causes the Clang compiler to expect C++ code and link against the C++ standard library.
The args
array specifies the command-line arguments that will be passed to clang++. These arguments must be specified in the order expected by the compiler.
This task tells the C++ compiler to compile the active file (${file}
), and create an output file (-o
switch) in the current directory (${fileDirname}
) with the same name as the active file (${fileBasenameNoExtension}
), resulting in helloworld
for our example.
The label
value is what you will see in the tasks list. Name this whatever you like.
The problemMatcher
value selects the output parser to use for finding errors and warnings in the compiler output. For clang++, you'll get the best results if you use the $gcc
problem matcher.
The 'isDefault': true
value in the group
object specifies that this task will be run when you press ⇧⌘B (Windows, Linux Ctrl+Shift+B). This property is for convenience only; if you set it to false
, you can still build from the Terminal menu with Terminal > Run Build Task.
Note: You can learn more about task.json
variables in the variables reference.
Go back to helloworld.cpp
. Because we want to build helloworld.cpp
it is important that this file be the one that is active in the editor for the next step.
To run the build task that you defined in tasks.json, press ⇧⌘B (Windows, Linux Ctrl+Shift+B) or from the Terminal main menu choose Run Build Task.
When the task starts, you should see the Integrated Terminal window appear below the code editor. After the task completes, the terminal shows output from the compiler that indicates whether the build succeeded or failed. For a successful Clang build, the output looks something like this:
Create a new terminal using the + button and you'll have a new terminal with the helloworld
folder as the working directory. Run ls
and you should now see the executable helloworld
along with the debugging file (helloworld.dSYM
).
You can run helloworld
in the terminal by typing ./helloworld
.
You can modify your tasks.json
to build multiple C++ files by using an argument like '${workspaceFolder}/*.cpp'
instead of ${file}
. This will build all .cpp
files in your current folder. You can also modify the output filename by replacing '${fileDirname}/${fileBasenameNoExtension}'
with a hard-coded filename (for example '${workspaceFolder}/myProgram.out'
).
Next, you'll create a launch.json
file to configure VS Code to launch the LLDB debugger when you press F5 to debug the program.
From the main menu, choose Run > Add Configuration.. and then choose C++ (GDB/LLDB).
You'll then see a dropdown for predefined debugging configurations. Choose clang++ build and debug active file.
VS Code creates a launch.json
file, opens it in the editor, and builds and runs 'helloworld'. Your launch.json
file will look something like this:
The program
setting specifies the program you want to debug. Here it is set to the active file folder ${fileDirname}
and active filename ${fileBasenameNoExtension}
, which if helloworld.cpp
is the active file will be helloworld
.
By default, the C++ extension won't add any breakpoints to your source code and the stopAtEntry
value is set to false
.
Change the stopAtEntry
value to true
to cause the debugger to stop on the main
method when you start debugging.
Ensure that the preLaunchTask
value matches the label
of the build task in the task.json
file.
helloworld.cpp
so that it is the active file in the editor. This is important because VS Code uses the active file to determine what you want to debug.The Integrated Terminal appears at the bottom of the source code editor. In the Debug Output tab, you see output that indicates the debugger is up and running.
The editor highlights the first statement in the main
method. This is a breakpoint that the C++ extension automatically sets for you:
The Run view on the left shows debugging information. You'll see an example later in the tutorial.
At the top of the code editor, a debugging control panel appears. You can move this around the screen by grabbing the dots on the left side.
Now you're ready to start stepping through the code.
Click or press the Step over icon in the debugging control panel so that the for (const string& word : msg)
statement is highlighted.
The Step Over command skips over all the internal function calls within the vector
and string
classes that are invoked when the msg
variable is created and initialized. Notice the change in the Variables window. The contents of msg
are visible because that statement has completed.
Press Step over again to advance to the next statement (skipping over all the internal code that is executed to initialize the loop). Now, the Variables window shows information about the loop variable.
Press Step over again to execute the cout
statement. Note As of the March 2019 version of the extension, no output will appear in the DEBUG CONSOLE until the last cout
completes.
You might want to keep track of the value of a variable as your program executes. You can do this by setting a watch on the variable.
Place the insertion point inside the loop. In the Watch window, click the plus sign and in the text box, type word
, which is the name of the loop variable. Now view the Watch window as you step through the loop.
To quickly view the value of any variable while execution is paused, you can hover over it with the mouse pointer.
For more control over the C/C++ extension, create a c_cpp_properties.json
file, which allows you to change settings such as the path to the compiler, include paths, which C++ standard to compile against (such as C++17), and more.
View the C/C++ configuration UI by running the command C/C++: Edit Configurations (UI) from the Command Palette (⇧⌘P (Windows, Linux Ctrl+Shift+P)).
This opens the C/C++ Configurations page.
Visual Studio Code places these settings in .vscode/c_cpp_properties.json
. If you open that file directly, it should look something like this:
You only need to modify the Include path setting if your program includes header files that are not in your workspace or the standard library path.
compilerPath
is an important configuration setting. The extension uses it to infer the path to the C++ standard library header files. When the extension knows where to find those files, it can provide useful features like smart completions and Go to Definition navigation.
The C/C++ extension attempts to populate compilerPath
with the default compiler location based on what it finds on your system. The compilerPath
search order is:
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/
On the C/C++ Configuration screen, scroll down and expand Advanced Settings and ensure that Mac framework path points to the system header files. For example: /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks
VS Code is now configured to use Clang on macOS. The configuration applies to the current workspace. To reuse the configuration, just copy the JSON files to a .vscode
folder in a new project folder (workspace) and change the names of the source file(s) and executable as needed.
The most common cause of errors (such as undefined _main
, or attempting to link with file built for unknown-unsupported file format
, and so on) occurs when helloworld.cpp
is not the active file when you start a build or start debugging. This is because the compiler is trying to compile something that isn't source code, like your launch.json
, tasks.json
, or c_cpp_properties.json
file.
In this article, you'll learn how to install .NET Core on macOS. .NET Core is made up of the runtime and the SDK. The runtime is used to run a .NET Core app and may or may not be included with the app. The SDK is used to create .NET Core apps and libraries. The .NET Core runtime is always installed with the SDK.
The latest version of .NET Core is 3.1.
The following table is a list of currently supported .NET Core releases and the versions of macOS they're supported on. These versions remain supported either the version of .NET Core reaches end-of-support.
Operating System | .NET Core 2.1 | .NET Core 3.1 | .NET 5 Preview |
---|---|---|---|
macOS 10.15 'Catalina' | ✔️ 2.1 (Release notes) | ✔️ 3.1 (Release notes) | ✔️ 5.0 Preview (Release notes) |
macOS 10.14 'Mojave' | ✔️ 2.1 (Release notes) | ✔️ 3.1 (Release notes) | ✔️ 5.0 Preview (Release notes) |
macOS 10.13 'High Sierra' | ✔️ 2.1 (Release notes) | ✔️ 3.1 (Release notes) | ✔️ 5.0 Preview (Release notes) |
macOS 10.12 'Sierra' | ✔️ 2.1 (Release notes) | ❌ 3.1 (Release notes) | ❌ 5.0 Preview (Release notes) |
The following versions of .NET Core are ❌ no longer supported. The downloads for these still remain published:
The runtime is used to run apps created with .NET Core. When an app author publishes an app, they can include the runtime with their app. If they don't include the runtime, it's up to the user to install the runtime.
There are three different runtimes you can install on macOS:
ASP.NET Core runtime
Runs ASP.NET Core apps. Includes the .NET Core runtime.
.NET Core runtime
This runtime is the simplest runtime and doesn't include any other runtime. It's highly recommended that you install ASP.NET Core runtime for the best compatibility with .NET Core apps.
The SDK is used to build and publish .NET Core apps and libraries. Installing the SDK includes both runtimes: ASP.NET Core and .NET Core.
.NET Core is supported on the following macOS releases:
.NET Core Version | macOS | Architectures | |
---|---|---|---|
3.1 | High Sierra (10.13+) | x64 | More information |
3.0 | High Sierra (10.13+) | x64 | More information |
2.2 | Sierra (10.12+) | x64 | More information |
2.1 | Sierra (10.12+) | x64 | More information |
Beginning with macOS Catalina (version 10.15), all software built after June 1, 2019 that is distributed with Developer ID, must be notarized. This requirement applies to the .NET Core runtime, .NET Core SDK, and software created with .NET Core.
The installers for .NET Core (both runtime and SDK) versions 3.1, 3.0, and 2.1, have been notarized since February 18, 2020. Prior released versions aren't notarized. If you run a non-notarized app, you'll see an error similar to the following image:
For more information about how enforced-notarization affects .NET Core (and your .NET Core apps), see Working with macOS Catalina Notarization.
.NET Core applications that use the System.Drawing.Common assembly require libgdiplus to be installed.
An easy way to obtain libgdiplus is by using the Homebrew ('brew') package manager for macOS. After installing brew, install libgdiplus by executing the following commands at a Terminal (command) prompt:
macOS has standalone installers that can be used to install the .NET Core 3.1 SDK:
As an alternative to the macOS installers for .NET Core, you can download and manually install the SDK and runtime. Manual install is usually performed as part of continuous integration testing. For a developer or user, it's generally better to use an installer.
If you install .NET Core SDK, you don't need to install the corresponding runtime. First, download a binary release for either the SDK or the runtime from one of the following sites:
Next, extract the downloaded file and use the export
command to set variables used by .NET Core and then ensure .NET Core is in PATH.
To extract the runtime and make the .NET Core CLI commands available at the terminal, first download a .NET Core binary release. Then, open a terminal and run the following commands from the directory where the file was saved. The archive file name may be different depending on what you downloaded.
Use the following command to extract the runtime:
Use the following command to extract the SDK:
Tip
The preceding export
commands only make the .NET Core CLI commands available for the terminal session in which it was run.
You can edit your shell profile to permanently add the commands. There are a number of different shells available for Linux and each has a different profile. For example:
Edit the appropriate source file for your shell and add :$HOME/dotnet
to the end of the existing PATH
statement. If no PATH
statement is included, add a new line with export PATH=$PATH:$HOME/dotnet
.
Also, add export DOTNET_ROOT=$HOME/dotnet
to the end of the file.
This approach lets you install different versions into separate locations and choose explicitly which one to use by which application.
Visual Studio for Mac installs the .NET Core SDK when the .NET Core workload is selected. To get started with .NET Core development on macOS, see Install Visual Studio 2019 for Mac. For the latest release, .NET Core 3.1, you must use the Visual Studio for Mac 8.4.
Visual Studio Code is a powerful and lightweight source code editor that runs on your desktop. Visual Studio Code is available for Windows, macOS, and Linux.
While Visual Studio Code doesn't come with an automated .NET Core installer like Visual Studio does, adding .NET Core support is simple.
The dotnet-install scripts are used for automation and non-admin installs of the runtime. You can download the script from the dotnet-install script reference page.
The script defaults to installing the latest long term support (LTS) version, which is .NET Core 3.1. You can choose a specific release by specifying the current
switch. Include the runtime
switch to install a runtime. Otherwise, the script installs the SDK.
Note
The command above installs the ASP.NET Core runtime for maximum compatability. The ASP.NET Core runtime also includes the standard .NET Core runtime.
Containers provide a lightweight way to isolate your application from the rest of the host system. Containers on the same machine share just the kernel and use resources given to your application.
.NET Core can run in a Docker container. Official .NET Core Docker images are published to the Microsoft Container Registry (MCR) and are discoverable at the Microsoft .NET Core Docker Hub repository. Each repository contains images for different combinations of the .NET (SDK or Runtime) and OS that you can use.
Microsoft provides images that are tailored for specific scenarios. For example, the ASP.NET Core repository provides images that are built for running ASP.NET Core apps in production.
For more information about using .NET Core in a Docker container, see Introduction to .NET and Docker and Samples.