CDT Cloud Blueprint
CDT Cloud Blueprint is a template tool for building custom, web-based C/C++ tools. It is based on the Theia development tool platform and integrates several existing open source components to provide a starting point for building a custom C/C++ IDE. This includes C/C++ language features, debugging support, a memory inspector, and a tracing view.
The purpose of CDT Cloud Blueprint is two-fold:
- You can download and run it to try out several CDT Cloud components (see download page)
- You can use it as a template to start off your custom C/C++ tool (see instructions below)
Building and running
The sources including build instructions are available on the CDT Cloud Blueprint Github repository. Please follow the instructions on the Github readme to build and run CDT Cloud Blueprint as a desktop app, browser app, or in Docker.
Selection of common VS Code extensions
To provide common capabilities for developing C/C++ projects, CDT Cloud blueprint installs several open-source VS Code extensions that are typically useful in the context of C/C++ development. This includes the following and more.
- vscode-clangd: Integration of the C/C++ language server clangd
- vscode-cmake: Integration of commands and actions for interacting with CMake-based projects
- cdt-gdb-debug: Flexible and customizable debug adapter for GBD
- cdtcloud-clangd-contexts: Management of clangd configuration files in C/C++ projects using contexts
For a complete list of the used Theia extensions and VS Code extensions, please refer to the application’s package.json
.
Welcome page
To greet and guide users on initial start-up of CDT Cloud Blueprint, it provides a welcome page. The welcome page is essentially a web page in a Theia view that provides general information, but also links to relevant web resources. Users can also trigger commands directly from the welcome page, such as opening folders, settings, as well as creating example projects.
The welcome page is contributed to the product in the TheiaBlueprintGettingStartedContribution.
Example project generator
CDT Cloud Blueprint contains an example generator which allows users to create pre-defined projects based on a project template.
Projects can either be generated from the welcome page or via the command Generate CDT Cloud Blueprint Example.
Once a project is generated, a defined file – such as a readme – of this project is opened for the user.
The generator is implemented by the Theia extension blueprint-example-generator
.
The list of project types can be easily extended to add more project templates with the following steps:
- Add the project template to the folder
resources
- Add the project template name to the list of projects in the command contribution
- Optionally specify the file to be opened after generation in the
ExampleGeneratorServiceImpl