commit | 4abe43c1310668dc8b9d51d8708907fcb3f00a4b | [log] [tgz] |
---|---|---|
author | Ben Clayton <bclayton@google.com> | Wed Jan 22 12:00:02 2020 +0000 |
committer | Ben Clayton <bclayton@google.com> | Fri Jan 24 07:25:33 2020 +0000 |
tree | 114217700cb2b1c732235ae6b67a5ae0562cb44d | |
parent | ced82a0501423bdce13210006bf39fe0263f0c24 [diff] |
optional: Remove the value() method that returns non-const-ref. I'm not convinced that `opt.value() = foo` is a desirable pattern, and worse still it confuses some compilers about which overload to use. Just remove it.
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.
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
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
cppdap
can be built using Visual Studio 2019's CMake integration.
cppdap
in your CMake projectYou 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
You may also wish to specify your own paths to the third party libraries used by cppdap
. You can do this by setting any of the following variables before the call to add_subdirectory()
:
set(CPPDAP_THIRD_PARTY_DIR <third-party-root-directory>) # defaults to ${CPPDAP_DIR}/third_party set(CPPDAP_JSON_DIR <path-to-nlohmann-json>) # defaults to ${CPPDAP_THIRD_PARTY_DIR}/json set(CPPDAP_GOOGLETEST_DIR <path-to-googletest>) # defaults to ${CPPDAP_THIRD_PARTY_DIR}/googletest add_subdirectory(${CPPDAP_DIR})
Note: This is not an officially supported Google product