Replace BOND_NORETURN with [[noreturn]]

chwarr · web-flow · commit 8d0fe6c00cbc · 2020-10-13T20:15:34.000-07:00
Bond requires a C++11 compiler, The `[[noreturn]]` attribute is part of
C++11 and is supported by all of the minimum versions of the compilers
Bond supports.

Replace the `BOND_NORETURN` macro with the `[[noreturn]]` attribute.

The platform/compiler adapter macros are considered implementation
details of Bond. The removal of `BOND_NORETURN` is not considered a
breaking change.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,18 @@ tag versions. The Bond compiler (`gbc`) and
 different versioning scheme, following the Haskell community's
 [package versioning policy](https://wiki.haskell.org/Package_versioning_policy).
 
+## Unreleased ##
+
+* IDL core version: TBD
+* C++ version: TBD, bug fix bump needed
+* C# NuGet version: TBD
+* `gbc` & compiler library: TBD
+
+### C++ ###
+
+* Bond now uses the `[[noreturn]]` attribute to annotate functions that do
+  not return. Previously, it used compiler-specific annotations.
+
 ## 9.0.3: 2020-08-06 ##
 
 * IDL core version: 3.0
diff --git a/cpp/inc/bond/core/config.h b/cpp/inc/bond/core/config.h
@@ -58,7 +58,6 @@
 #define BOND_NOEXCEPT           BOOST_NOEXCEPT_OR_NOTHROW
 #define BOND_NOEXCEPT_IF        BOOST_NOEXCEPT_IF
 #define BOND_NOEXCEPT_EXPR      BOOST_NOEXCEPT_EXPR
-#define BOND_NORETURN           BOOST_NORETURN
 #define BOND_CONSTEXPR          BOOST_CONSTEXPR
 #define BOND_CONSTEXPR_OR_CONST BOOST_CONSTEXPR_OR_CONST
 #define BOND_STATIC_CONSTEXPR   BOOST_STATIC_CONSTEXPR
diff --git a/cpp/inc/bond/core/detail/validate.h b/cpp/inc/bond/core/detail/validate.h
@@ -235,7 +235,7 @@ class SchemaValidator
     }
 
     template <typename T>
-    BOND_NORETURN bool UnknownField(uint16_t id, const T&) const
+    [[noreturn]] bool UnknownField(uint16_t id, const T&) const
     {
         UnknownSchemaDefException(id);
     }
diff --git a/cpp/inc/bond/core/exception.h b/cpp/inc/bond/core/exception.h
@@ -53,15 +53,15 @@ struct CoreException
 };
 
 
-BOND_NORETURN inline void MergerContainerException(uint32_t payload, uint32_t obj)
+[[noreturn]] inline void MergerContainerException(uint32_t payload, uint32_t obj)
 {
     BOND_THROW(CoreException,
           "Merge failed: container mismatch, length in the payload: "
           << payload << " length in the object: " << obj);
 }
 
 
-BOND_NORETURN inline void InvalidKeyTypeException()
+[[noreturn]] inline void InvalidKeyTypeException()
 {
     BOND_THROW(CoreException,
         "Map key type not valid");
@@ -71,7 +71,7 @@ BOND_NORETURN inline void InvalidKeyTypeException()
 namespace detail
 {
     template <typename Key>
-    BOND_NORETURN inline void ElementNotFoundExceptionHelper(
+    [[noreturn]] inline void ElementNotFoundExceptionHelper(
         const Key& key,
         typename boost::enable_if<is_wstring<Key>>::type* = nullptr)
     {
@@ -91,7 +91,7 @@ namespace detail
     }
 
     template <typename Key>
-    BOND_NORETURN inline void ElementNotFoundExceptionHelper(
+    [[noreturn]] inline void ElementNotFoundExceptionHelper(
         const Key& key,
         typename boost::disable_if<is_wstring<Key>>::type* = nullptr)
     {
@@ -102,56 +102,56 @@ namespace detail
 
 
 template <typename Key>
-BOND_NORETURN inline void ElementNotFoundException(const Key& key)
+[[noreturn]] inline void ElementNotFoundException(const Key& key)
 {
     detail::ElementNotFoundExceptionHelper(key);
 }
 
 
-BOND_NORETURN inline void UnknownProtocolException()
+[[noreturn]] inline void UnknownProtocolException()
 {
     BOND_THROW(CoreException,
           "Unmarshaling failed: unsupported protocol");
 }
 
 
-BOND_NORETURN inline void UnknownProtocolException(uint16_t magic)
+[[noreturn]] inline void UnknownProtocolException(uint16_t magic)
 {
     BOND_THROW(CoreException,
           "Unsupported protocol: "
           << (char)(magic & 0xFF) << (char)(magic >> 8));
 }
 
 
-BOND_NORETURN inline void NothingException()
+[[noreturn]] inline void NothingException()
 {
     BOND_THROW(CoreException,
           "Field value is 'nothing'");
 }
 
 
-BOND_NORETURN inline void InvalidEnumValueException(const char* value, const char* enum_)
+[[noreturn]] inline void InvalidEnumValueException(const char* value, const char* enum_)
 {
     BOND_THROW(bond::CoreException,
         "Unexpected value " << value << " for enum " << enum_);
 }
 
 
-BOND_NORETURN inline void InvalidEnumValueException(int32_t value, const char* enum_)
+[[noreturn]] inline void InvalidEnumValueException(int32_t value, const char* enum_)
 {
     BOND_THROW(bond::CoreException,
         "Unexpected value " << value << " for enum " << enum_);
 }
 
 
-BOND_NORETURN inline void RapidJsonException(const char* error, size_t offset)
+[[noreturn]] inline void RapidJsonException(const char* error, size_t offset)
 {
     BOND_THROW(CoreException,
         "JSON parser error: " << error << " at offset " << offset);
 }
 
 
-BOND_NORETURN inline void UnicodeConversionException()
+[[noreturn]] inline void UnicodeConversionException()
 {
     BOND_THROW(CoreException,
         "Unicode conversion exception");
@@ -176,7 +176,7 @@ struct SchemaValidateException
 };
 
 
-BOND_NORETURN
+[[noreturn]]
 inline void StructBaseDifferentException(const StructDef& src,
                                          const StructDef& dst)
 {
@@ -186,7 +186,7 @@ inline void StructBaseDifferentException(const StructDef& src,
 }
 
 
-BOND_NORETURN
+[[noreturn]]
 inline void RequiredFieldMissingException(const StructDef& s_dst,
                                           const FieldDef& f_dst)
 {
@@ -196,7 +196,7 @@ inline void RequiredFieldMissingException(const StructDef& s_dst,
 }
 
 
-BOND_NORETURN
+[[noreturn]]
 inline void OptionalToRequiredException(const StructDef& s_src,
                                         const StructDef& s_dst,
                                         const FieldDef& f_src,
@@ -209,7 +209,7 @@ inline void OptionalToRequiredException(const StructDef& s_src,
 }
 
 
-BOND_NORETURN
+[[noreturn]]
 inline void FieldTypeIncompatibleException(const StructDef& s_src,
                                            const StructDef& s_dst,
                                            const FieldDef& f_src,
@@ -222,7 +222,7 @@ inline void FieldTypeIncompatibleException(const StructDef& s_src,
 }
 
 
-BOND_NORETURN inline void UnknownSchemaDefException(uint16_t id)
+[[noreturn]] inline void UnknownSchemaDefException(uint16_t id)
 {
     BOND_THROW(SchemaValidateException,
         "Failed to validate schema compatibility; "
diff --git a/cpp/inc/bond/core/maybe.h b/cpp/inc/bond/core/maybe.h
@@ -20,7 +20,7 @@ namespace bond
 {
 
 
-BOND_NORETURN void NothingException();
+[[noreturn]] void NothingException();
 
 namespace detail
 {
diff --git a/cpp/inc/bond/core/stl_containers.h b/cpp/inc/bond/core/stl_containers.h
@@ -23,7 +23,7 @@ namespace bond
 {
 
 template <typename Key>
-BOND_NORETURN void ElementNotFoundException(const Key& key);
+[[noreturn]] void ElementNotFoundException(const Key& key);
 
 // is_string<std::basic_string<char, T, A> >
 template<typename T, typename A> struct
diff --git a/cpp/inc/bond/core/transforms.h b/cpp/inc/bond/core/transforms.h
@@ -424,7 +424,7 @@ class RequiredFieldValiadator
     {}
 
 private:
-    BOND_NORETURN void MissingFieldException() const;
+    [[noreturn]] void MissingFieldException() const;
 
     mutable uint16_t _required;
 };
@@ -599,7 +599,7 @@ class To
         }
     }
 
-    BOND_NORETURN void UnexpectedStructStopException() const
+    [[noreturn]] void UnexpectedStructStopException() const
     {
         // Force instantiation of template statics
         (void)typename schema<T>::type();
diff --git a/cpp/inc/bond/ext/grpc/win_thread_pool.h b/cpp/inc/bond/ext/grpc/win_thread_pool.h
@@ -25,7 +25,7 @@ namespace bond { namespace ext { namespace grpc
 {
     namespace detail
     {
-        BOND_NORETURN void Win32Exception(const char* message)
+        [[noreturn]] void Win32Exception(const char* message)
         {
             throw std::system_error{
                 std::error_code{ static_cast<int>(::GetLastError()), std::system_category() },
diff --git a/cpp/inc/bond/stream/input_buffer.h b/cpp/inc/bond/stream/input_buffer.h
@@ -223,7 +223,7 @@ class InputBuffer
     }
 
 protected:
-    BOND_NORETURN void EofException(uint32_t size) const
+    [[noreturn]] void EofException(uint32_t size) const
     {
         BOND_THROW(StreamException,
               "Read out of bounds: " << size << " bytes requested, offset: "
diff --git a/cpp/inc/bond/stream/stream_interface.h b/cpp/inc/bond/stream/stream_interface.h
@@ -51,7 +51,7 @@ class InputStream
 // Return type is not required to be specifically bond::blob.
 // See GetBufferRange for more details.
 template <typename InputBuffer>
-BOND_NORETURN inline blob GetCurrentBuffer(const InputBuffer& /*input*/)
+[[noreturn]] inline blob GetCurrentBuffer(const InputBuffer& /*input*/)
 {
     BOOST_STATIC_ASSERT_MSG(
         detail::mpl::always_false<InputBuffer>::value,
@@ -66,7 +66,7 @@ BOND_NORETURN inline blob GetCurrentBuffer(const InputBuffer& /*input*/)
 // output buffer associated with the writer (i.e. there is an overloaded Write
 // function that accepts it).
 template <typename Blob>
-BOND_NORETURN inline Blob GetBufferRange(const Blob& /*begin*/, const Blob& /*end*/)
+[[noreturn]] inline Blob GetBufferRange(const Blob& /*begin*/, const Blob& /*end*/)
 {
     BOOST_STATIC_ASSERT_MSG(
         detail::mpl::always_false<Blob>::value,
@@ -106,7 +106,7 @@ class OutputStream
 // compatible properties as the original one (e.g. while serializing
 // bonded<T> for untagged protocols).
 template <typename OutputBuffer>
-BOND_NORETURN inline OutputBuffer CreateOutputBuffer(const OutputBuffer& /*other*/)
+[[noreturn]] inline OutputBuffer CreateOutputBuffer(const OutputBuffer& /*other*/)
 {
     BOOST_STATIC_ASSERT_MSG(
         detail::mpl::always_false<OutputBuffer>::value,
diff --git a/cpp/test/compat/core/compat.cpp b/cpp/test/compat/core/compat.cpp
@@ -17,7 +17,7 @@
 #include <bond/protocol/simple_json_writer.h>
 #include <bond/stream/stdio_output_stream.h>
 
-BOND_NORETURN void die(const char* fmt, ...)
+[[noreturn]] void die(const char* fmt, ...)
 {
     va_list args;
     va_start(args, fmt);

Original file line number	Diff line number	Diff line change
`@@ -235,7 +235,7 @@ class SchemaValidator`
`235`	`235`	`}`
`236`	`236`
`237`	`237`	`template <typename T>`
`238`		`- BOND_NORETURN bool UnknownField(uint16_t id, const T&) const`
	`238`	`+ [[noreturn]] bool UnknownField(uint16_t id, const T&) const`
`239`	`239`	`{`
`240`	`240`	`UnknownSchemaDefException(id);`
`241`	`241`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,15 +53,15 @@ struct CoreException`
`53`	`53`	`};`
`54`	`54`
`55`	`55`
`56`		`-BOND_NORETURN inline void MergerContainerException(uint32_t payload, uint32_t obj)`
	`56`	`+[[noreturn]] inline void MergerContainerException(uint32_t payload, uint32_t obj)`
`57`	`57`	`{`
`58`	`58`	`BOND_THROW(CoreException,`
`59`	`59`	`"Merge failed: container mismatch, length in the payload: "`
`60`	`60`	`<< payload << " length in the object: " << obj);`
`61`	`61`	`}`
`62`	`62`
`63`	`63`
`64`		`-BOND_NORETURN inline void InvalidKeyTypeException()`
	`64`	`+[[noreturn]] inline void InvalidKeyTypeException()`
`65`	`65`	`{`
`66`	`66`	`BOND_THROW(CoreException,`
`67`	`67`	`"Map key type not valid");`
`@@ -71,7 +71,7 @@ BOND_NORETURN inline void InvalidKeyTypeException()`
`71`	`71`	`namespace detail`
`72`	`72`	`{`
`73`	`73`	`template <typename Key>`
`74`		`- BOND_NORETURN inline void ElementNotFoundExceptionHelper(`
	`74`	`+ [[noreturn]] inline void ElementNotFoundExceptionHelper(`
`75`	`75`	`const Key& key,`
`76`	`76`	`typename boost::enable_if<is_wstring<Key>>::type* = nullptr)`
`77`	`77`	`{`
`@@ -91,7 +91,7 @@ namespace detail`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`template <typename Key>`
`94`		`- BOND_NORETURN inline void ElementNotFoundExceptionHelper(`
	`94`	`+ [[noreturn]] inline void ElementNotFoundExceptionHelper(`
`95`	`95`	`const Key& key,`
`96`	`96`	`typename boost::disable_if<is_wstring<Key>>::type* = nullptr)`
`97`	`97`	`{`
`@@ -102,56 +102,56 @@ namespace detail`
`102`	`102`
`103`	`103`
`104`	`104`	`template <typename Key>`
`105`		`-BOND_NORETURN inline void ElementNotFoundException(const Key& key)`
	`105`	`+[[noreturn]] inline void ElementNotFoundException(const Key& key)`
`106`	`106`	`{`
`107`	`107`	`detail::ElementNotFoundExceptionHelper(key);`
`108`	`108`	`}`
`109`	`109`
`110`	`110`
`111`		`-BOND_NORETURN inline void UnknownProtocolException()`
	`111`	`+[[noreturn]] inline void UnknownProtocolException()`
`112`	`112`	`{`
`113`	`113`	`BOND_THROW(CoreException,`
`114`	`114`	`"Unmarshaling failed: unsupported protocol");`
`115`	`115`	`}`
`116`	`116`
`117`	`117`
`118`		`-BOND_NORETURN inline void UnknownProtocolException(uint16_t magic)`
	`118`	`+[[noreturn]] inline void UnknownProtocolException(uint16_t magic)`
`119`	`119`	`{`
`120`	`120`	`BOND_THROW(CoreException,`
`121`	`121`	`"Unsupported protocol: "`
`122`	`122`	`<< (char)(magic & 0xFF) << (char)(magic >> 8));`
`123`	`123`	`}`
`124`	`124`
`125`	`125`
`126`		`-BOND_NORETURN inline void NothingException()`
	`126`	`+[[noreturn]] inline void NothingException()`
`127`	`127`	`{`
`128`	`128`	`BOND_THROW(CoreException,`
`129`	`129`	`"Field value is 'nothing'");`
`130`	`130`	`}`
`131`	`131`
`132`	`132`
`133`		`-BOND_NORETURN inline void InvalidEnumValueException(const char* value, const char* enum_)`
	`133`	`+[[noreturn]] inline void InvalidEnumValueException(const char* value, const char* enum_)`
`134`	`134`	`{`
`135`	`135`	`BOND_THROW(bond::CoreException,`
`136`	`136`	`"Unexpected value " << value << " for enum " << enum_);`
`137`	`137`	`}`
`138`	`138`
`139`	`139`
`140`		`-BOND_NORETURN inline void InvalidEnumValueException(int32_t value, const char* enum_)`
	`140`	`+[[noreturn]] inline void InvalidEnumValueException(int32_t value, const char* enum_)`
`141`	`141`	`{`
`142`	`142`	`BOND_THROW(bond::CoreException,`
`143`	`143`	`"Unexpected value " << value << " for enum " << enum_);`
`144`	`144`	`}`
`145`	`145`
`146`	`146`
`147`		`-BOND_NORETURN inline void RapidJsonException(const char* error, size_t offset)`
	`147`	`+[[noreturn]] inline void RapidJsonException(const char* error, size_t offset)`
`148`	`148`	`{`
`149`	`149`	`BOND_THROW(CoreException,`
`150`	`150`	`"JSON parser error: " << error << " at offset " << offset);`
`151`	`151`	`}`
`152`	`152`
`153`	`153`
`154`		`-BOND_NORETURN inline void UnicodeConversionException()`
	`154`	`+[[noreturn]] inline void UnicodeConversionException()`
`155`	`155`	`{`
`156`	`156`	`BOND_THROW(CoreException,`
`157`	`157`	`"Unicode conversion exception");`
`@@ -176,7 +176,7 @@ struct SchemaValidateException`
`176`	`176`	`};`
`177`	`177`
`178`	`178`
`179`		`-BOND_NORETURN`
	`179`	`+[[noreturn]]`
`180`	`180`	`inline void StructBaseDifferentException(const StructDef& src,`
`181`	`181`	`const StructDef& dst)`
`182`	`182`	`{`
`@@ -186,7 +186,7 @@ inline void StructBaseDifferentException(const StructDef& src,`
`186`	`186`	`}`
`187`	`187`
`188`	`188`
`189`		`-BOND_NORETURN`
	`189`	`+[[noreturn]]`
`190`	`190`	`inline void RequiredFieldMissingException(const StructDef& s_dst,`
`191`	`191`	`const FieldDef& f_dst)`
`192`	`192`	`{`
`@@ -196,7 +196,7 @@ inline void RequiredFieldMissingException(const StructDef& s_dst,`
`196`	`196`	`}`
`197`	`197`
`198`	`198`
`199`		`-BOND_NORETURN`
	`199`	`+[[noreturn]]`
`200`	`200`	`inline void OptionalToRequiredException(const StructDef& s_src,`
`201`	`201`	`const StructDef& s_dst,`
`202`	`202`	`const FieldDef& f_src,`
`@@ -209,7 +209,7 @@ inline void OptionalToRequiredException(const StructDef& s_src,`
`209`	`209`	`}`
`210`	`210`
`211`	`211`
`212`		`-BOND_NORETURN`
	`212`	`+[[noreturn]]`
`213`	`213`	`inline void FieldTypeIncompatibleException(const StructDef& s_src,`
`214`	`214`	`const StructDef& s_dst,`
`215`	`215`	`const FieldDef& f_src,`
`@@ -222,7 +222,7 @@ inline void FieldTypeIncompatibleException(const StructDef& s_src,`
`222`	`222`	`}`
`223`	`223`
`224`	`224`
`225`		`-BOND_NORETURN inline void UnknownSchemaDefException(uint16_t id)`
	`225`	`+[[noreturn]] inline void UnknownSchemaDefException(uint16_t id)`
`226`	`226`	`{`
`227`	`227`	`BOND_THROW(SchemaValidateException,`
`228`	`228`	`"Failed to validate schema compatibility; "`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ namespace bond`
`20`	`20`	`{`
`21`	`21`
`22`	`22`
`23`		`-BOND_NORETURN void NothingException();`
	`23`	`+[[noreturn]] void NothingException();`
`24`	`24`
`25`	`25`	`namespace detail`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ namespace bond`
`23`	`23`	`{`
`24`	`24`
`25`	`25`	`template <typename Key>`
`26`		`-BOND_NORETURN void ElementNotFoundException(const Key& key);`
	`26`	`+[[noreturn]] void ElementNotFoundException(const Key& key);`
`27`	`27`
`28`	`28`	`// is_string<std::basic_string<char, T, A> >`
`29`	`29`	`template<typename T, typename A> struct`
Original file line number	Diff line number	Diff line change
`@@ -424,7 +424,7 @@ class RequiredFieldValiadator`
`424`	`424`	`{}`
`425`	`425`
`426`	`426`	`private:`
`427`		`- BOND_NORETURN void MissingFieldException() const;`
	`427`	`+ [[noreturn]] void MissingFieldException() const;`
`428`	`428`
`429`	`429`	`mutable uint16_t _required;`
`430`	`430`	`};`
`@@ -599,7 +599,7 @@ class To`
`599`	`599`	`}`
`600`	`600`	`}`
`601`	`601`
`602`		`- BOND_NORETURN void UnexpectedStructStopException() const`
	`602`	`+ [[noreturn]] void UnexpectedStructStopException() const`
`603`	`603`	`{`
`604`	`604`	`// Force instantiation of template statics`
`605`	`605`	`(void)typename schema<T>::type();`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ namespace bond { namespace ext { namespace grpc`
`25`	`25`	`{`
`26`	`26`	`namespace detail`
`27`	`27`	`{`
`28`		`- BOND_NORETURN void Win32Exception(const char* message)`
	`28`	`+ [[noreturn]] void Win32Exception(const char* message)`
`29`	`29`	`{`
`30`	`30`	`throw std::system_error{`
`31`	`31`	`std::error_code{ static_cast<int>(::GetLastError()), std::system_category() },`
Original file line number	Diff line number	Diff line change
`@@ -223,7 +223,7 @@ class InputBuffer`
`223`	`223`	`}`
`224`	`224`
`225`	`225`	`protected:`
`226`		`- BOND_NORETURN void EofException(uint32_t size) const`
	`226`	`+ [[noreturn]] void EofException(uint32_t size) const`
`227`	`227`	`{`
`228`	`228`	`BOND_THROW(StreamException,`
`229`	`229`	`"Read out of bounds: " << size << " bytes requested, offset: "`