Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cpp: support linking statically on Windows #1229

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

cpp: support linking statically on Windows #1229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
030e9fe
cpp: support building and linking against mcap library statically on …
Sep 2, 2024
db769ad
cpp: update README on how to build/link against MCAP static/shared li…
Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions cpp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,22 @@
If your project does not need `lz4` or `zstd` support, you can optionally disable these by defining
`MCAP_COMPRESSION_NO_LZ4` or `MCAP_COMPRESSION_NO_ZSTD` respectively.

The C++ implementation of MCAP can also be compiled into a static or shared library.
When compiling for Windows, the correct `dllexport` and `dllimport` storage-class attributes need to be set.

Check failure on line 90 in cpp/README.md

View workflow job for this annotation

GitHub Actions / spellcheck 

Unknown word (dllexport)

Check failure on line 90 in cpp/README.md

View workflow job for this annotation

GitHub Actions / spellcheck 

Unknown word (dllimport)
This is handled in [mcap/visibility.hpp](https://github.com/foxglove/mcap/blob/main/cpp/mcap/include/mcap/visibility.hpp).

There are two `#defines` that need (not) to be set depending on whether using MCAP as static or shared library and whether we are compiling the MCAP library itself or linking against it:

| Static library | `MCAP_IMPLEMENTATION` | `MCAP_STATIC_DEFINE` |
| -------------- | -------------------- | -------------------- |
| Compiling | Set | Set |
| Link against | Not set | Set |

| Shared library | `MCAP_IMPLEMENTATION` | `MCAP_STATIC_DEFINE` |
| -------------- | -------------------- | -------------------- |
| Compiling | Set | Not set |
| Link against | Not set | Not set |

### Conan

To simplify installation of dependencies, the [Conan](https://conan.io/) package
Expand Down
24 changes: 14 additions & 10 deletions cpp/mcap/include/mcap/visibility.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
#pragma once

#if defined _WIN32 || defined __CYGWIN__
# ifdef __GNUC__
# define MCAP_EXPORT __attribute__((dllexport))
# define MCAP_IMPORT __attribute__((dllimport))
# ifndef MCAP_STATIC_DEFINE
# ifdef __GNUC__
# define MCAP_EXPORT __attribute__((dllexport))
# define MCAP_IMPORT __attribute__((dllimport))
# else
# define MCAP_EXPORT __declspec(dllexport)
# define MCAP_IMPORT __declspec(dllimport)
# endif
# ifdef MCAP_IMPLEMENTATION
# define MCAP_PUBLIC MCAP_EXPORT
# else
# define MCAP_PUBLIC MCAP_IMPORT
# endif
# else
# define MCAP_EXPORT __declspec(dllexport)
# define MCAP_IMPORT __declspec(dllimport)
# endif
# ifdef MCAP_IMPLEMENTATION
# define MCAP_PUBLIC MCAP_EXPORT
# else
# define MCAP_PUBLIC MCAP_IMPORT
# define MCAP_PUBLIC
# endif
#else
# define MCAP_EXPORT __attribute__((visibility("default")))
Expand Down
Loading