In this tutorial, you configure Visual Studio Code on macOS to use the Clang/LLVM compiler and debugger.
C# (pronounced 'c-sharp') is a great coding language that works across Mac and PC. Programmers use it to build a variety of software applications, especially in the Windows environment. Choose C/C clang build active file to build the file that is currently displayed (active) in the editor. 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.
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.
If you have any trouble, feel free to file an issue for this tutorial in the VS Code documentation repository.
Prerequisites
To successfully complete this tutorial, you must do the following:
Ensure Clang is installed
Clang may already be installed on your Mac. To verify that it is, open a macOS Terminal window and enter the following command:
Create Hello World
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:
Add hello world source code file
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).
Explore IntelliSense
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.
Build helloworld.cpp
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.
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:
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. How to download mac os x iso file.
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.
Running the build
Modifying tasks.json
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' ).
Debug helloworld.cpp
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.
Start a debugging session
Step through the code
Now you're ready to start stepping through the code.
Set a watch
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.
C/C++ configuration
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.
Compiler pathcompilerPath 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:
Mac framework path
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
Reusing your C++ configuration
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.
TroubleshootingCompiler and linking errors![]()
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.
Next steps
In this tutorial, you configure Visual Studio Code to use the Microsoft Visual C++ compiler and debugger on Windows.
After configuring VS Code, you will compile and debug a simple Hello World program in VS Code. This tutorial does not teach you details about the Microsoft C++ toolset or the C++ language. For those subjects, there are many good resources available on the Web.
If you have any problems, feel free to file an issue for this tutorial in the VS Code documentation repository.
Prerequisites
To successfully complete this tutorial, you must do the following:
Note: You can use the C++ toolset from Visual Studio Build Tools along with Visual Studio Code to compile, build, and verify any C++ codebase as long as you also have a valid Visual Studio license (either Community, Pro, or Enterprise) that you are actively using to develop that C++ codebase. Fps for mac free download.
Check your Microsoft Visual C++ installation
To use MSVC from a command line or VS Code, you must run from a Developer Command Prompt for Visual Studio. An ordinary shell such as PowerShell, Bash, or the Windows command prompt does not have the necessary path environment variables set.
To open the Developer Command Prompt for VS, start typing 'developer' in the Windows Start menu, and you should see it appear in the list of suggestions. The exact name depends on which version of Visual Studio or the Visual Studio Build Tools you have installed. Click on the item to open the prompt.
You can test that you have the C++ compiler,
cl.exe , installed correctly by typing 'cl' and you should see a copyright message with the version and basic usage description.
If the Developer Command Prompt is using the BuildTools location as the starting directory (you wouldn't want to put projects there), navigate to your user folder (
C:users{your username} ) before you start creating new projects.
Create Hello World
From the Developer Command Prompt, 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 (
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 see three files created in a
.vscode folder in the workspace:
Add a source code file
In the File Explorer title bar, select the New File button and name the file
helloworld.cpp .
Add hello world source code
Now paste in this source code:
Now press ⌘S (Windows, Linux Ctrl+S) to save the file. Notice how the file you just added appears 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 far left 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).
Explore IntelliSense
In your new
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 Readyshare mac os agent download. key to insert the selected member; then, when you add the opening parenthesis, you will see information about any arguments that the function requires.
Build helloworld.cpp
Next, you will create a
tasks.json file to tell VS Code how to build (compile) the program. This task will invoke the Microsoft C++ compiler to create an executable file based on the source code.
https://cleverwarrior940.weebly.com/blog/canon-quick-toolbox-download-mac-us-maxify. From the main menu, choose Terminal > Configure Default Build Task. In the dropdown, which will display a tasks dropdown listing various predefined build tasks for C++ compilers. Choose cl.exe build active file, which will build the file that is currently displayed (active) in the editor.
This will create a
tasks.json file in a .vscode folder and open it in the editor.
Windows via bootcamp mac download. Your new
tasks.json file should look similar to the JSON below:
The
command setting specifies the program to run; in this case that is 'cl.exe'. The args array specifies the command-line arguments that will be passed to cl.exe. These arguments must be specified in the order expected by the compiler. This task tells the C++ compiler to take the active file (${file} ), compile it, and create an executable file (/Fe: switch) in the current directory (${fileDirname} ) with the same name as the active file but with the .exe extension (${fileBasenameNoExtension}.exe ), resulting in helloworld.exe for our example.
Note: You can learn more about
task.json variables in the variables reference.
The
label value is what you will see in the tasks list; you can name this whatever you like.
Mac os x high sierra direct download. The
problemMatcher value selects the output parser to use for finding errors and warnings in the compiler output. For cl.exe, you'll get the best results if you use the $msCompile 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 run it from the Terminal menu with Tasks: Run Build Task.
Running the build
Note: You might need to press Enter a couple of times initially to see the PowerShell prompt in the terminal. This issue should be fixed in a future release of Windows.
Modifying tasks.json
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}.exe' with a hard-coded filename (for example '${workspaceFolder}myProgram.exe' ).
Debug helloworld.cpp
Next, you'll create a
launch.json file to configure VS Code to launch the Microsoft C++ debugger when you press F5 to debug the program. From the main menu, choose Run > Add Configuration. and then choose C++ (Windows).
C++ File Download Library
You'll then see a dropdown for various predefined debugging configurations. Choose cl.exe build and debug active file.
VS Code creates a
launch.json file, opens it in the editor, and builds and runs 'helloworld'.
The
program setting specifies the program you want to debug. Here it is set to the active file folder ${fileDirname} and active filename with the .exe extension ${fileBasenameNoExtension}.exe , which if helloworld.cpp is the active file will be helloworld.exe .
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.
Start a debugging session
How To Download C++ Files On Mac High SierraStep through the code
Now you're ready to start stepping through the code.
Set a watchHow To Download C++ Files On Mac Os
Sometimes 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.
C/C++ configurations
If you want more control over the C/C++ extension, you can create a
c_cpp_properties.json file, which will allow you to change settings such as the path to the compiler, include paths, C++ standard (default is C++17), and more.
How To Download Files On Mac
You can 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. When you make changes here, VS Code writes them to a file called
c_cpp_properties.json in the .vscode folder.
Visual Studio Code places these settings in
.vscodec_cpp_properties.json . If you open that file directly, it should look something like this:
You only need to add to the Include path array setting if your program includes header files that are not in your workspace or in the standard library path.
Compiler path
The
compilerPath setting is an important setting in your configuration. 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 extension looks in several common compiler locations.
The
compilerPath search order is:
If you have g++ or WSL installed, you might need to change
compilerPath to match the preferred compiler for your project. For Microsoft C++, the path should look something like this, depending on which specific version you have installed: 'C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/VC/Tools/MSVC/14.16.27023/bin/Hostx64/x64/cl.exe'.
Reusing your C++ configuration
VS Code is now configured to use the Microsoft C++ compiler. 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.
TroubleshootingThe term 'cl.exe' is not recognized
If you see the error 'The term 'cl.exe' is not recognized as the name of a cmdlet, function, script file, or operable program.', this usually means you are running VS Code outside of a Developer Command Prompt for Visual Studio and VS Code doesn't know the path to the
cl.exe compiler.
You can always check that you are running VS Code in the context of the Developer Command Prompt by opening a new Terminal (⌃⇧` (Windows, Linux Ctrl+Shift+`)) and typing 'cl' to verify
cl.exe is available to VS Code.
Next steps
Comments are closed.
|
AuthorWrite something about yourself. No need to be fancy, just an overview. Archives
December 2020
Categories |