-->Check out other C/C++ tools
Choose from a variety of cross-platform mobile templates under Visual C to get a head start on your cross-platform needs. Co-development with Xcode Seamlessly develop your iOS application in Visual Studio and Xcode. Share, reuse, build, deploy, and debug your cross-platform C mobile code. Create projects from templates for Android Native-Activity applications, or create high-performance shared libraries to include in other solutions. You can also bring your existing C code to mobile platforms with minimal work.
Visual Studio C and C++ development isn't just for Windows anymore. This tutorial shows how to use Visual Studio for C++ cross platform development on Windows and Linux. It's based on CMake, so you don't have to create or generate Visual Studio projects. When you open a folder that contains a CMakeLists.txt file, Visual Studio configures the IntelliSense and build settings automatically. You can quickly start editing, building, and debugging your code locally on Windows. Then, switch your configuration to do the same on Linux, all from within Visual Studio.
In this tutorial, you learn how to:
- clone an open-source CMake project from GitHub
- open the project in Visual Studio
- build and debug an executable target on Windows
- add a connection to a Linux machine
- build and debug the same target on Linux
Prerequisites
- Set up Visual Studio for Cross Platform C++ Development
- First, install Visual Studio and choose the Desktop development with C++ and Linux development with C++ workloads. This minimal install is only 3 GB. Depending on your download speed, installation shouldn't take more than 10 minutes.
- Set up a Linux machine for Cross Platform C++ Development
- Visual Studio doesn't require any specific distribution of Linux. The OS can be running on a physical machine, in a VM, or in the cloud. You could also use the Windows Subsystem for Linux (WSL). However, for this tutorial a graphical environment is required. WSL isn't recommended here, because it's intended primarily for command-line operations.
- Visual Studio requires these tools on the Linux machine: C++ compilers, gdb, ssh, rsync, ninja, and zip. On Debian-based systems, you can use this command to install these dependencies:
- Visual Studio requires a recent version of CMake on the Linux machine that has server mode enabled (at least 3.8). Microsoft produces a universal build of CMake that you can install on any Linux distro. We recommend you use this build to ensure that you have the latest features. You can get the CMake binaries from the Microsoft fork of the CMake repo on GitHub. Go to that page and download the version that matches the system architecture on your Linux machine, then mark it as an executable:
- You can see the options for running the script with
-–help
. We recommend that you use the–prefix
option to specify installing in the /usr path, because /usr/bin is the default location where Visual Studio looks for CMake. The following example shows the Linux-x86_64 script. Change it as needed if you're using a different target platform.
- Git for windows installed on your Windows machine.
- A GitHub account.
Clone an open-source CMake project from GitHub
This tutorial uses the Bullet Physics SDK on GitHub. It provides collision detection and physics simulations for many applications. The SDK includes sample executable programs that compile and run without having to write additional code. This tutorial doesn't modify any of the source code or build scripts. To start, clone the bullet3 repository from GitHub on the machine where you have Visual Studio installed.
- On the Visual Studio main menu, choose File > Open > CMake. Navigate to the CMakeLists.txt file in the root of the bullet3 repo you just downloaded.As soon as you open the folder, your folder structure becomes visible in the Solution Explorer.This view shows you exactly what is on disk, not a logical or filtered view. By default, it doesn't show hidden files.
- Choose the Show all files button to see all the files in the folder.
Switch to targets view
When you open a folder that uses CMake, Visual Studio automatically generates the CMake cache. This operation might take a few moments, depending on the size of your project.
- In the Output Window, select Show output from and then choose CMake to monitor the status of the cache generation process. When the operation is complete, it says 'Target info extraction done'.After this operation completes, IntelliSense is configured. You can build the project, and debug the application. Visual Studio now shows a logical view of the solution, based on the targets specified in the CMakeLists files.
- Use the Solutions and Folders button in the Solution Explorer to switch to CMake Targets View.Here is what that view looks like for the Bullet SDK:Targets view provides a more intuitive view of what is in this source base. You can see some targets are libraries and others are executables.
- Expand a node in CMake Targets View to see its source code files, wherever those files might be located on disk.
Add an explicit Windows x64-Debug configuration
Visual Studio creates a default x64-Debug configuration for Windows. Configurations are how Visual Studio understands what platform target it's going to use for CMake. The default configuration isn't represented on disk. When you explicitly add a configuration, Visual Studio creates a file called CMakeSettings.json. It's populated with settings for all the configurations you specify.
- Add a new configuration. Open the Configuration drop-down in the toolbar and select Manage Configurations.The CMake Settings Editor opens. Select the green plus sign on the left-hand side of the editor to add a new configuration. The Add Configuration to CMakeSettings dialog appears.This dialog shows all the configurations included with Visual Studio, plus any custom configurations that you create. If you want to continue to use a x64-Debug configuration, that should be the first one you add. Select x64-Debug, and then choose the Select button. Visual Studio creates the CMakeSettings.json file with a configuration for x64-Debug, and saves it to disk. You can use whatever names you like for your configurations by changing the name parameter directly in CMakeSettings.json.
Set a breakpoint, build, and run on Windows
In this step, we'll debug an example program that demonstrates the Bullet Physics library.
- In Solution Explorer, select AppBasicExampleGui and expand it.
- Open the file
BasicExample.cpp
. - Set a breakpoint that gets hit when you click in the running application. The click event is handled in a method within a helper class. To quickly get there:
- Select
CommonRigidBodyBase
that the structBasicExample
is derived from. It's around line 30. - Right-click and choose Go to Definition. Now you're in the header CommonRigidBodyBase.h.
- In the browser view above your source, you should see that you're in the
CommonRigidBodyBase
. To the right, you can select members to examine. Open the drop-down and selectmouseButtonCallback
to go to the definition of that function in the header.
- Place a breakpoint on the first line within this function. It gets hit when you click a mouse button within the window of the application, when run under the Visual Studio debugger.
- To launch the application, select the launch drop-down in the toolbar. It's the one with the green play icon that says 'Select Startup Item'. In the drop-down, select AppBasicExampleGui.exe. The executable name now displays on the launch button:
- Choose the launch button to build the application and necessary dependencies, then launch it with the Visual Studio debugger attached. After a few moments, the running application appears:
- Move your mouse into the application window, then click a button to trigger the breakpoint. The breakpoint brings Visual Studio back to the foreground, and the editor shows the line where execution is paused. You can inspect the application variables, objects, threads, and memory, or step through your code interactively. Choose Continue to let the application resume, and then exit it normally. Or, halt execution within Visual Studio by using the stop button.
Add a Linux configuration and connect to the remote machine
- Add a Linux configuration. Right-click the CMakeSettings.json file in the Solution Explorer view and select Add Configuration. You see the same Add Configuration to CMakeSettings dialog as before. Select Linux-Debug this time, then save the CMakeSettings.json file (ctrl + s).
- Select Linux-Debug in the configuration drop-down.If it's the first time you're connecting to a Linux system, the Connect to Remote System dialog appears.If you've already added a remote connection, you can open this window by navigating to Tools > Options > Cross Platform > Connection Manager.
- Provide the connection information to your Linux machine and choose Connect. Visual Studio adds that machine as to CMakeSettings.json as your default connection for Linux-Debug. It also pulls down the headers from your remote machine, so you get IntelliSense specific to that remote connection. Next, Visual Studio sends your files to the remote machine and generates the CMake cache on the remote system. These steps may take some time, depending on the speed of your network and power of your remote machine. You'll know it's complete when the message 'Target info extraction done' appears in the CMake output window.
Set a breakpoint, build, and run on Linux
Because it's a desktop application, you need to provide some additional configuration information to the debug configuration.
- In the CMake Targets view, right-click AppBasicExampleGui and choose Debug and Launch Settings to open the launch.vs.json file that's in the hidden .vs subfolder. This file is local to your development environment. You can move it into the root of your project if you wish to check it in and save it with your team. In this file, a configuration has been added for AppBasicExampleGui. These default settings work in most cases, but not here. Because it's a desktop application, you need to provide some additional information to launch the program so you can see it on your Linux machine.
- To find the value of the environment variable
DISPLAY
on your Linux machine, run this command:In the configuration for AppBasicExampleGui, there's a parameter array, 'pipeArgs'. It contains a line: '${debuggerCommand}'. It's the command that launches gdb on the remote machine. Visual Studio must export the display into this context before that command runs. For example, if the value of your display is:1
, modify that line as follows: - Launch and debug your application. Open the Select Startup Item drop-down in the toolbar and choose AppBasicExampleGui. Next, either choose the green play icon in the toolbar, or press F5. The application and its dependencies are built on the remote Linux machine, then launched with the Visual Studio debugger attached. On your remote Linux machine, you should see an application window appear.
- Move your mouse into the application window, and click a button. The breakpoint is hit. Program execution pauses, Visual Studio comes back to the foreground, and you see your breakpoint. You should also see a Linux Console Window appear in Visual Studio. The window provides output from the remote Linux machine, and it can also accept input for
stdin
. Like any Visual Studio window, you can dock it where you prefer to see it. Its position is persisted in future sessions. - You can inspect the application variables, objects, threads, memory, and step through your code interactively using Visual Studio. But this time, you're doing it all on a remote Linux machine instead of your local Windows environment. You can choose Continue to let the application resume and exit normally, or you can choose the stop button, just as with local execution.
- Look at the Call Stack window and view the Calls to
x11OpenGLWindow
since Visual Studio launched the application on Linux.
What you learned
In this tutorial, you cloned a code base directly from GitHub. You built, ran, and debugged it on Windows without modifications. Then you used the same code base, with minor configuration changes, to build, run, and debug on a remote Linux machine.
Next steps
Learn more about configuring and debugging CMake projects in Visual Studio:
CMake Projects in Visual Studio
Configure a Linux CMake project
Connect to your remote Linux computer
Customize CMake build settings
Configure CMake debugging sessions
Deploy, run, and debug your Linux project
CMake predefined configuration reference
Configure a Linux CMake project
Connect to your remote Linux computer
Customize CMake build settings
Configure CMake debugging sessions
Deploy, run, and debug your Linux project
CMake predefined configuration reference
Matt Godbolt
Compiler Explorer
CLion takes a lot of the toil out of C++,
allowing me to concentrate on the interesting
part: problem solving.
allowing me to concentrate on the interesting
part: problem solving.
Matt Godbolt
Compiler Explorer
CLion takes a lot of the toil out of C++,
allowing me to concentrate on the interesting
part: problem solving.
allowing me to concentrate on the interesting
part: problem solving.
Smart C and C++ editor
Thanks to native C and C++ support, including modern C++ standards, libc++ and Boost, CLion knows your code through and through and takes care of the routine while you focus on the important things.
Navigation
Instantly navigate to a symbol's declaration or context usages, search through the whole project for a class, file or symbol by its name, find your way through the code base with structure and hierarchical views.
Code generation
Add class members, override/implement functions, generate constructors/destructors, getters/setters, equality, relational and stream output operators, wrap a block of code with a statement, or generate a declaration from actual usage - all via simple keyboard shortcuts.
Refactoring
Rename symbols, move members up/down the hierarchy, change function signature, and be sure CLion’s automated refactorings will accurately propagate the appropriate changes throughout your code.
With CLion, you can create code that's beautiful and correct at the same time. Potential code issues are identified instantly...
...and fixed as you type! Be sure all the proper changes are handled automatically by CLion.
CLion also performs Data Flow analysis to find out all the cases of the unreachable code, infinite recursion and more.
Integrated debugger
Investigate and solve problems with ease through CLion's friendly debugger user interface with GDB or LLDB available as a backend.
Attach to local processes or debug remotely. Check disassembly view when sources are not available.
Inline variable view
Get the complete view of your project with variable values shown right in the editor as you debug.
Watches and variables view
Inspect the state of all the variable for a chosen function in the stack frame, or monitor variable/expression changes during the debug session.
Evaluate expression
Evaluate result of a function call or some complicated expression when stop at some execution point in the debug session.
Project models
CLion works with CMake, Gradle C++ and compilation database project models, using all the information from there during code editing and refactorings.
Keyboard-centric approach
Cross-platform C++ Dev Setup Download
To help you focus on code and raise your productivity, CLion has keyboard shortcuts for nearly all its features, actions and commands.
Vim fans are welcome to install the Vim-emulation plugin.
Everything you need in one place
Everything you need for your everyday development is included: all popular VCS (Subversion, Git, GitHub, Mercurial, CVS, and Perforce), Google Test, Boost.Test and Catch frameworks for unit testing, Doxygen and Database tools.
Local and remote work
With embedded terminal, run any command without leaving the IDE: locally or remotely using the SSH protocol.
After editing your code locally, build, run or debug your application or unit tests locally or remotely.
CUDA support
For projects using CUDA C and C++, CLion can now do a lot more than parsing and highlighting the code correctly. It includes a new option in the New Project wizard, supports CUDA file extensions and CMake targets, and adds code completion suggestions for angle brackets for kernel calls.
Mac Dev Setup
Clang tools update
Code completion now works in Clangd-only mode, and Data Flow Analysis has been ported to the Clangd-based engine.
For both Clang-Tidy and ClangFormat, CLion now automatically detects the config files in the project folder and automatically switches to them.
Run/Debug Configurations
In CMake, Custom Target, and Gradle Applications configurations, we have enabled Macros and Path Variables. They work nicely with a new input redirection ability added to these configurations. Additionally, Remote GDB Server and Embedded GDB Server configurations now work with custom targets.
CLion is fantastic, finally the C++ high quality cross-platform IDE with CMake as first class build system we were waiting for.
Both of these tools (CLion and Rider) help our team on a daily basis, allowing developers to perform their tasks quickly and efficiently, all the while seamlessly integrating with numerous parts of our pipeline.
I would like to take this moment to say, CLion has quickly become my favorite IDE for C/C++. It just works. #jetbrains #CLion
Dev C++ Setup Free Download
Really liking @clion_ide for a new C++ project: lightweight, responsive, useful, good integrations. And most important, great vi emulation.
Companies worldwide trust JetBrains IDEs. Join the club!
Setup Dev Environment
Check out other C/C++ tools
from JetBrains
Pick up the right tool for C and C++ development depending on your preferred toolchains and other requirements: