Add some obnoxiously loud warnings to deprecated APIs

Author: Matt Woodward

c/BUILD.bazel

@@ -80,6 +80,9 @@ swift_cc_test(
     includes = [
         "include/libsbp",
     ],
+    copts = [
+      "-Wno-deprecated-declarations",
+    ],
     type = UNIT,
     deps = [
         ":sbp",
@@ -146,6 +149,9 @@ swift_cc_test(
     data = [
         "test/legacy/cpp/sbp_data/gnss_data.sbp",
     ],
+    copts = [
+      "-Wno-deprecated-declarations",
+    ],
     type = UNIT,
     deps = [
         ":sbp",

c/include/libsbp/legacy/acquisition.h

@@ -25,6 +25,12 @@
 
 #include <libsbp/common.h>
 
+SBP_MESSAGE(
+    "The legacy libsbp API has been deprecated. This file and all symbols "
+    "contained will "
+    "be removed in version 6. You should immediately switch over to the modern "
+    "libsbp API.")
+
 #include <libsbp/acquisition_macros.h>
 #include <libsbp/legacy/gnss.h>
 
@@ -38,7 +44,7 @@ SBP_PACK_START
  * the best carrier-to-noise (CN/0) ratio.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   float cn0;             /**< CN/0 of best point [dB Hz] */
   float cp;              /**< Code phase of best point [chips] */
   float cf;              /**< Carrier frequency of best point [hz] */
@@ -51,7 +57,7 @@ typedef struct SBP_ATTR_PACKED {
  * Deprecated.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   float cn0;             /**< CN/0 of best point [dB Hz] */
   float cp;              /**< Code phase of best point [chips] */
   float cf;              /**< Carrier frequency of best point [hz] */
@@ -64,7 +70,7 @@ typedef struct SBP_ATTR_PACKED {
  * Deprecated.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   float snr; /**< SNR of best point. Currently in arbitrary SNR points, but
                   will be in units of dB Hz in a later revision of this
                   message. */
@@ -79,7 +85,7 @@ typedef struct SBP_ATTR_PACKED {
  * Deprecated.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   float snr; /**< SNR of best point. Currently dimensionless, but will have
                   units of dB Hz in the revision of this message. */
   float cp;  /**< Code phase of best point [chips] */
@@ -95,7 +101,7 @@ typedef struct SBP_ATTR_PACKED {
  * the performance.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   u8 job_type; /**< SV search job type (deep, fallback, etc) */
   u8 status;   /**< Acquisition status 1 is Success, 0 is Failure */
   u16 cn0;     /**< CN0 value. Only valid if status is '1' [dB-Hz*10] */
@@ -118,7 +124,7 @@ typedef struct SBP_ATTR_PACKED {
  * Deprecated.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   u8 job_type; /**< SV search job type (deep, fallback, etc) */
   u8 status;   /**< Acquisition status 1 is Success, 0 is Failure */
   u16 cn0;     /**< CN0 value. Only valid if status is '1' [dB-Hz*10] */
@@ -142,7 +148,7 @@ typedef struct SBP_ATTR_PACKED {
  * is used to debug and measure the performance.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   acq_sv_profile_t
       acq_sv_profile[0]; /**< SV profiles during acquisition time */
 } msg_acq_sv_profile_t;
@@ -152,7 +158,7 @@ typedef struct SBP_ATTR_PACKED {
  * Deprecated.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   acq_sv_profile_dep_t acq_sv_profile[0]; /**< SV profiles during acquisition
                                                time */
 } msg_acq_sv_profile_dep_t;

c/include/libsbp/legacy/api.h

@@ -16,6 +16,10 @@
 #include <libsbp/common.h>
 #include <libsbp/legacy/callbacks.h>
 
+SBP_MESSAGE(
+  "The legacy libsbp API has been deprecated. This file and all symbols contained will "
+  "be removed in version 6. You should immediately switch over to the modern libsbp API.")
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -36,7 +40,7 @@ extern "C" {
  *         `SBP_CALLBACK_ERROR` if the callback was already
  *         registered for that message type.
  */
-SBP_EXPORT s8 sbp_payload_callback_register(sbp_state_t* s, u16 msg_type, sbp_msg_callback_t cb, void* context,
+SBP_EXPORT SBP_DEPRECATED s8 sbp_payload_callback_register(sbp_state_t* s, u16 msg_type, sbp_msg_callback_t cb, void* context,
                          sbp_msg_callbacks_node_t *node);
 
  /** Register a frame callback for a msg_type.
@@ -51,7 +55,7 @@ SBP_EXPORT s8 sbp_payload_callback_register(sbp_state_t* s, u16 msg_type, sbp_ms
  *         `SBP_CALLBACK_ERROR` if the if callback was already
  *         registered for that message type.
  */
-SBP_EXPORT s8 sbp_frame_callback_register(sbp_state_t* s, u16 msg_type,
+SBP_EXPORT SBP_DEPRECATED s8 sbp_frame_callback_register(sbp_state_t* s, u16 msg_type,
                                sbp_frame_callback_t cb, void* context,
                                sbp_msg_callbacks_node_t *node);
 
@@ -64,7 +68,7 @@ SBP_EXPORT s8 sbp_frame_callback_register(sbp_state_t* s, u16 msg_type,
  * \return `SBP_OK` (0) if successful, `SBP_NULL_ERROR` if a usage error,
  *         `SBP_CALLBACK_ERROR` if the node already exists
  */
-SBP_EXPORT s8 sbp_all_payload_callback_register(sbp_state_t *s, sbp_frame_callback_t cb,
+SBP_EXPORT SBP_DEPRECATED s8 sbp_all_payload_callback_register(sbp_state_t *s, sbp_frame_callback_t cb,
                                  void *context, sbp_msg_callbacks_node_t *node);
 
 /** Directly process an SBP frame.
@@ -87,7 +91,7 @@ SBP_EXPORT s8 sbp_all_payload_callback_register(sbp_state_t *s, sbp_frame_callba
  *          SBP_OK_CALLBACK_UNDEFINED` (2) if message decoded with no
  *          associated callback.
  */
-SBP_EXPORT s8 sbp_frame_process(sbp_state_t *s, u16 sender_id, u16 msg_type,
+SBP_EXPORT SBP_DEPRECATED s8 sbp_frame_process(sbp_state_t *s, u16 sender_id, u16 msg_type,
                      u8 payload_len, u8 payload[], u16 frame_len, u8 frame[], u8 cb_mask);
 
 /** Directly process an SBP message.
@@ -103,7 +107,7 @@ SBP_EXPORT s8 sbp_frame_process(sbp_state_t *s, u16 sender_id, u16 msg_type,
  *         `SBP_OK_CALLBACK_UNDEFINED` (2) if message decoded with no associated
  *         callback.
  */
-SBP_EXPORT s8 sbp_payload_process(sbp_state_t *s, u16 sender_id, u16 msg_type, u8 msg_len,
+SBP_EXPORT SBP_DEPRECATED s8 sbp_payload_process(sbp_state_t *s, u16 sender_id, u16 msg_type, u8 msg_len,
     u8 payload[]);
 
 /** Send SBP messages.
@@ -135,7 +139,7 @@ SBP_EXPORT s8 sbp_payload_process(sbp_state_t *s, u16 sender_id, u16 msg_type, u
  * \return `SBP_OK` (0) if successful, `SBP_WRITE_ERROR` if the message could
  *         not be sent or was only partially sent.
  */
-SBP_EXPORT s8 sbp_payload_send(sbp_state_t *s, u16 msg_type, u16 sender_id, u8 len, u8 *payload,
+SBP_EXPORT SBP_DEPRECATED s8 sbp_payload_send(sbp_state_t *s, u16 msg_type, u16 sender_id, u8 len, u8 *payload,
                     sbp_write_fn_t write);
 
 #ifdef __cplusplus

c/include/libsbp/legacy/bootload.h

@@ -29,6 +29,12 @@
 
 #include <libsbp/common.h>
 
+SBP_MESSAGE(
+    "The legacy libsbp API has been deprecated. This file and all symbols "
+    "contained will "
+    "be removed in version 6. You should immediately switch over to the modern "
+    "libsbp API.")
+
 #include <libsbp/bootload_macros.h>
 
 SBP_PACK_START
@@ -48,7 +54,7 @@ SBP_PACK_START
  * number and the SBP protocol version number.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   u32 flags;       /**< Bootloader flags */
   char version[0]; /**< Bootloader version number */
 } msg_bootloader_handshake_resp_t;
@@ -58,7 +64,7 @@ typedef struct SBP_ATTR_PACKED {
  * The host initiates the bootloader to jump to the application.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   u8 jump; /**< Ignored by the device */
 } msg_bootloader_jump_to_app_t;
 
@@ -82,7 +88,7 @@ typedef struct SBP_ATTR_PACKED {
  * number.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   u8 dna[8]; /**< 57-bit SwiftNAP FPGA Device ID. Remaining bits are padded on
                   the right. */
 } msg_nap_device_dna_resp_t;
@@ -92,7 +98,7 @@ typedef struct SBP_ATTR_PACKED {
  * Deprecated.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   u8 handshake[0]; /**< Version number string (not NULL terminated) */
 } msg_bootloader_handshake_dep_a_t;
 

c/include/libsbp/legacy/compat.h

@@ -16,6 +16,10 @@
 #include <libsbp/common.h>
 #include <libsbp/legacy/api.h>
 
+SBP_MESSAGE(
+  "The legacy libsbp API has been deprecated. This file and all symbols contained will "
+  "be removed in version 6. You should immediately switch over to the modern libsbp API.")
+
 
 #ifdef __cplusplus
 extern "C" {

c/include/libsbp/legacy/cpp/frame_handler.h

@@ -20,6 +20,10 @@
 #include <libsbp/cpp/state.h>
 #include <libsbp/legacy/cpp/message_traits.h>
 
+SBP_MESSAGE(
+  "The legacy libsbp API has been deprecated. This file and all symbols contained will "
+  "be removed in version 6. You should immediately switch over to the modern libsbp API.")
+
 namespace sbp {
 
 /**
@@ -92,7 +96,7 @@ inline void sbp_frame_cb_passthrough(uint16_t sender_id, uint16_t msg_type,
  * @tparam MsgTypes List of SBP message types to register callbacks for
  */
 template<typename ...MsgTypes>
-class FrameHandler {
+class SBP_DEPRECATED FrameHandler {
     static constexpr std::size_t kMsgCount = sizeof...(MsgTypes);
 
     State &state_;
@@ -165,7 +169,7 @@ class FrameHandler {
  * };
  *
  */
-class AllFrameHandler {
+class SBP_DEPRECATED AllFrameHandler {
     State &state_;
     sbp_msg_callbacks_node_t callback_node_;
 

c/include/libsbp/legacy/cpp/payload_handler.h

@@ -68,7 +68,7 @@ namespace details {
  * @tparam OtherTypes Other types to recursively define interfaces for
  */
 template<typename MsgType, typename... OtherTypes>
-class PayloadCallbackInterface : PayloadCallbackInterface<OtherTypes...> {
+class SBP_DEPRECATED PayloadCallbackInterface : PayloadCallbackInterface<OtherTypes...> {
  public:
   PayloadCallbackInterface() = default;
   ~PayloadCallbackInterface() override = default;
@@ -88,7 +88,7 @@ class PayloadCallbackInterface : PayloadCallbackInterface<OtherTypes...> {
 };
 
 template<typename MsgType>
-class PayloadCallbackInterface<MsgType> {
+class SBP_DEPRECATED PayloadCallbackInterface<MsgType> {
  public:
   PayloadCallbackInterface() = default;
   virtual ~PayloadCallbackInterface() = default;
@@ -144,7 +144,7 @@ class PayloadCallbackInterface<MsgType> {
  * @tparam MsgTypes List of SBP message types to register callbacks for
  */
 template<typename... MsgTypes>
-class PayloadHandler : public details::PayloadCallbackInterface<MsgTypes...> {
+class SBP_DEPRECATED PayloadHandler : public details::PayloadCallbackInterface<MsgTypes...> {
     static constexpr std::size_t kMsgCount = sizeof...(MsgTypes);
 
     State &state_;

c/include/libsbp/legacy/ext_events.h

@@ -26,6 +26,12 @@
 
 #include <libsbp/common.h>
 
+SBP_MESSAGE(
+    "The legacy libsbp API has been deprecated. This file and all symbols "
+    "contained will "
+    "be removed in version 6. You should immediately switch over to the modern "
+    "libsbp API.")
+
 #include <libsbp/ext_events_macros.h>
 
 SBP_PACK_START
@@ -36,7 +42,7 @@ SBP_PACK_START
  * it was and whether it was rising or falling.
  */
 
-typedef struct SBP_ATTR_PACKED {
+typedef struct SBP_ATTR_PACKED SBP_DEPRECATED {
   u16 wn;  /**< GPS week number [weeks] */
   u32 tow; /**< GPS time of week rounded to the nearest millisecond [ms] */
   s32 ns_residual; /**< Nanosecond residual of millisecond-rounded TOW