Google Git
Sign in
fuchsia / third_party / github.com / google / cppdap / a4b9640ffcf16b169f36cd3160be58d497d7100f
commita4b9640ffcf16b169f36cd3160be58d497d7100f[log] [tgz]
authorBen Clayton <bclayton@google.com>Fri Nov 08 22:35:41 2019 +0000
committerBen Clayton <bclayton@google.com>Thu Nov 14 00:09:46 2019 +0000
treee803891d30122efacd5d4bf25769f2a9859e3743
parent2dfd15462fab2dbf047a3aea9115c78e54421f83 [diff]
Add Kokoro presubmit scripts
9 files changed
tree: e803891d30122efacd5d4bf25769f2a9859e3743
  1. .vscode/
  2. examples/
  3. include/
  4. kokoro/
  5. src/
  6. third_party/
  7. tools/
  8. .clang-format
  9. .gitignore
  10. .gitmodules
  11. CMakeLists.txt
  12. CONTRIBUTING
  13. LICENSE
  14. README.md
README.md

cppdap

About

cppdap is a C++11 library (“SDK”) implementation of the Debug Adapter Protocol, providing an API for implementing a DAP client or server.

cppdap provides C++ type-safe structures for the full DAP specification, and provides a simple way to add custom protocol messages.

Fetching dependencies

cppdap provides CMake build files to build the library, unit tests and examples.

cppdap depends on the nlohmann/json library, and the unit tests depend on the googletest library. Both are referenced as a git submodules.

Before building, fetch the git submodules with:

cd <path-to-cppdap>
git submodule update --init

Building

Linux and macOS

Next, generate the build files:

cd <path-to-cppdap>
mkdir build
cd build
cmake ..

You may wish to suffix the cmake .. line with any of the following flags:

  • -DCPPDAP_BUILD_TESTS=1 - Builds the cppdap unit tests
  • -DCPPDAP_BUILD_EXAMPLES=1 - Builds the cppdap examples
  • -DCPPDAP_INSTALL_VSCODE_EXAMPLES=1 - Installs the cppdap examples as Visual Studio Code extensions
  • -DCPPDAP_WARNINGS_AS_ERRORS=1 - Treats all compiler warnings as errors.

Finally, build the project:

make

Windows

cppdap can be built using Visual Studio 2019's CMake integration.

Using cppdap in your CMake project

You can build and link cppdap using add_subdirectory() in your project's CMakeLists.txt file:

set(CPPDAP_DIR <path-to-cppdap>) # example <path-to-cppdap>: "${CMAKE_CURRENT_SOURCE_DIR}/third_party/cppdap"
add_subdirectory(${CPPDAP_DIR})

This will define the cppdap library target, which you can pass to target_link_libraries():

target_link_libraries(<target> cppdap) # replace <target> with the name of your project's target

You will also want to add the cppdap public headers to your project's include search paths so you can #include the cppdap headers:

target_include_directories($<target> PRIVATE "${CPPDAP_DIR}/include") # replace <target> with the name of your project's target

Note: This is not an officially supported Google product