assert_impl.h

Go to the documentation of this file.

// === assert_impl.h ===================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_CORE_BASE_DETAIL_ASSERT_IMPL_H
#define SEN_CORE_BASE_DETAIL_ASSERT_IMPL_H
 
#include "sen/core/base/source_location.h"
 
// std
#include <cstdint>
#include <functional>
#include <optional>
#include <ostream>
#include <string>
#include <string_view>
 
namespace sen::impl
{

enum class CheckType : std::uint8_t
{
  assert = 0,  
  expect = 1,  
  ensure = 2,  
};

struct CheckInfo
{
  CheckInfo(CheckType checkType, std::string_view expression, SourceLocation sourceLocation)
    : checkType_(checkType), expression_(expression), sourceLocation_(sourceLocation)
  {
  }
 
  [[nodiscard]] CheckType getCheckType() const noexcept { return checkType_; }
  [[nodiscard]] std::string_view getExpression() const noexcept { return expression_; }
  [[nodiscard]] const SourceLocation& getSourceLocation() const noexcept { return sourceLocation_; }
 
  [[nodiscard]] std::string str() const noexcept;
 
  friend std::ostream& operator<<(std::ostream& s, const CheckInfo& checkInfo) { return s << checkInfo.str(); }
 
private:
  CheckType checkType_;
  std::string_view expression_;
  SourceLocation sourceLocation_;
};
 
inline std::optional<CheckInfo> lastReportedAssertionError {std::nullopt};

using FailedCheckHandler = std::function<void(const CheckInfo&)>;

[[nodiscard]] FailedCheckHandler setFailedCheckHandler(FailedCheckHandler handler) noexcept;

void senCheckImpl(bool checkResult,
                  CheckType checkType,
                  std::string_view expression,
                  const SourceLocation& sourceLocation) noexcept;
 
}  // namespace sen::impl
 
#endif  // SEN_CORE_BASE_DETAIL_ASSERT_IMPL_H