azure_assert.hpp

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#pragma once
 
#include "azure/core/platform.hpp"
 
#include <cstdlib>
#include <string>
 
#if defined(NDEBUG)
 
/*
 * NDEBUG = defined = Build is on Release
 * Define AZURE_ASSERT to call abort directly on exp == false
 */
 
#define AZURE_ASSERT(exp) \
  do \
  { \
    if (!(exp)) \
    { \
      std::abort(); \
    } \
  } while (0)
 
#define AZURE_ASSERT_MSG(exp, msg) AZURE_ASSERT(exp)
 
#else
 
/*
 * NDEBUG = NOT defined = Build is on Debug
 * Define AZURE_ASSERT to call assert to provide better debug experience.
 */
 
#include <cassert>
 
#define AZURE_ASSERT(exp) assert((exp))
#define AZURE_ASSERT_MSG(exp, msg) assert(((void)msg, (exp)))
 
#endif
 
namespace Azure { namespace Core { namespace _internal {
  [[noreturn]] void AzureNoReturnPath(std::string const& msg);
}}} // namespace Azure::Core::_internal
 
#define AZURE_ASSERT_FALSE(exp) AZURE_ASSERT(!(exp))
#define AZURE_UNREACHABLE_CODE() ::Azure::Core::_internal::AzureNoReturnPath("unreachable code!")
#define AZURE_NOT_IMPLEMENTED() ::Azure::Core::_internal::AzureNoReturnPath("not implemented code!")
 
#if __cplusplus >= 201703L
// C++17 or later - use [[nodiscard]].
#define _azure_NODISCARD [[nodiscard]]
#else
#if defined(_MSC_VER)
// MSVC >= 1911, use [[nodiscard]]
#if _MSC_VER >= 1911
#define _azure_NODISCARD [[nodiscard]]
#else
// MSVC < 1911, use _Check_return_
#define _azure_NODISCARD _Check_return_
#endif
#elif defined(__GNUC__) && __GNUC__ >= 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
// GCC 3.4 or higher, use __attribute__((warn_unused_result)).
#define _azure_NODISCARD __attribute__((__warn_unused_result__))
#elif defined(__clang__)
#define _azure_NODISCARD __attribute__(__warn_unused_result__)
#else
#define _azure_NODISCARD
#endif
#endif // __cplusplus >= 201703L