Non-legacy headers shouldn't be including legacy api headers

swift-nav · Nov 23, 2023 · b30d570 · b30d570
1 parent 1220a7b
commit b30d570
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/.github/workflows/c.yaml b/.github/workflows/c.yaml
@@ -126,7 +126,7 @@ jobs:
           sudo apt-get -qq install gcc-multilib-mips-linux-gnu gcc-mips-linux-gnu qemu-user g++-mips-linux-gnu
 
       - name: Run big endian tests
-        run: make test-c-v4
+        run: make test-c
         env:
           CC: mips-linux-gnu-gcc
           CXX: mips-linux-gnu-g++

diff --git a/c/include/libsbp/cpp/state.h b/c/include/libsbp/cpp/state.h
@@ -15,7 +15,6 @@
 
 #include <libsbp/sbp.h>
 #include <libsbp/cpp/message_traits.h>
-#include <libsbp/legacy/compat.h>
 
 namespace sbp {
 

diff --git a/c/include/libsbp/legacy/cpp/legacy_state.h b/c/include/libsbp/legacy/cpp/legacy_state.h
@@ -14,6 +14,7 @@
 #define SBP_LEGACY_CPP_LEGACY_STATE_H
 
 #include <libsbp/cpp/state.h>
+#include <libsbp/legacy/compat.h>
 
 SBP_MESSAGE(
   "The legacy libsbp API has been deprecated. This file and all symbols contained will "

diff --git a/c/test/check_sbp.c b/c/test/check_sbp.c
@@ -11,10 +11,18 @@
  */
 
 #include <check.h>
-#include <libsbp/legacy/compat.h>
 #include <sbp.h>
 #include <stdio.h>
 
+// Obviously we don't normally want to silence this message, but we also need to
+// still test the legacy implementation for as long as it exists. By silencing
+// these messages here we can get a less noisy build in libsbp
+#ifdef SBP_MESSAGE
+#undef SBP_MESSAGE
+#define SBP_MESSAGE(x)
+#endif
+#include <libsbp/legacy/compat.h>
+
 int DUMMY_MEMORY_FOR_CALLBACKS = (int)0xdeadbeef;
 int DUMMY_MEMORY_FOR_IO = (int)0xdead0000;