Add __attribute__((sentinel)) to all _vanew function declarations

fixes: libical#604
cyrusimap · May 6, 2024 · e16b366 · e16b366
1 parent 9f712bf
commit e16b366
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 2 deletions.
diff --git a/scripts/mkderivedproperties.pl b/scripts/mkderivedproperties.pl
@@ -302,7 +302,7 @@ sub insert_code
 LIBICAL_ICAL_EXPORT $type icalproperty_get_${lc}(const icalproperty *prop);";
 
       if ($include_vanew) {
-        print "\nLIBICAL_ICAL_EXPORT icalproperty *icalproperty_vanew_${lc}($type v, ...);\n";
+        print "\nLIBICAL_ICAL_EXPORT LIBICAL_SENTINEL icalproperty *icalproperty_vanew_${lc}($type v, ...);\n";
       }
 
     }

diff --git a/src/libical/CMakeLists.txt b/src/libical/CMakeLists.txt
@@ -432,6 +432,7 @@ install(FILES
   icaltypes.h
   icalvalue.h
   libical_deprecated.h
+  libical_sentinel.h
   libical_ical_export.h
   pvl.h
   sspm.h

diff --git a/src/libical/icalcomponent.h b/src/libical/icalcomponent.h
@@ -16,6 +16,7 @@
 #define ICALCOMPONENT_H
 
 #include "libical_deprecated.h"
+#include "libical_sentinel.h"
 #include "libical_ical_export.h"
 #include "icalenums.h"  /* Defines icalcomponent_kind */
 #include "icalproperty.h"
@@ -51,7 +52,7 @@ LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_from_string(const char *str
  *
  * Make sure to pass NULL (not 0) as the final argument!
  */
-LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_vanew(icalcomponent_kind kind, ...);
+LIBICAL_ICAL_EXPORT LIBICAL_SENTINEL icalcomponent *icalcomponent_vanew(icalcomponent_kind kind, ...);
 
 /** @brief Constructor
  */

diff --git a/src/libical/icalderivedproperty.h.in b/src/libical/icalderivedproperty.h.in
@@ -11,6 +11,7 @@
 #ifndef ICALDERIVEDPROPERTY_H
 #define ICALDERIVEDPROPERTY_H
 
+#include "libical_sentinel.h"
 #include "icalparameter.h"
 #include "icalderivedvalue.h"
 #include "icalrecur.h"

diff --git a/src/libical/libical_sentinel.h b/src/libical/libical_sentinel.h
@@ -0,0 +1,23 @@
+/**
+  SPDX-FileCopyrightText: Allen Winter <[email protected]>
+  SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
+*/
+
+#ifndef LIBICAL_SENTINEL_H
+#define LIBICAL_SENTINEL_H
+
+/* sentinel attribute macro */
+#if defined(NO_SENTINEL_WARNINGS)
+#define LIBICAL_SENTINEL
+#else
+#if !defined(LIBICAL_SENTINEL)
+#if defined(__GNUC__) || defined(__clang__)
+#define LIBICAL_SENTINEL __attribute__((sentinel))
+#else
+/* sentinel attributes are unknown to MSVC */
+#define LIBICAL_SENTINEL
+#endif
+#endif
+#endif
+
+#endif