macros.hpp

Go to the documentation of this file.

// Copyright (c) 2019-2024 Simons Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0.txt
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Authors: Thomas Hahn, Olivier Parcollet, Nils Wentzell
 
#ifndef LIBH5_MACROS_HPP
#define LIBH5_MACROS_HPP
 
#include <iostream>
#include <exception>
 
// ---------------- Stringify ----------------
 
#define H5_AS_STRING(...) H5_AS_STRING2(__VA_ARGS__)
#define H5_AS_STRING2(...) #__VA_ARGS__
 
// ---------------- Requires ----------------
 
#ifdef __clang__
#define H5_REQUIRES(...) __attribute__((enable_if(__VA_ARGS__, H5_AS_STRING2(__VA_ARGS__))))
#elif __GNUC__
#define H5_REQUIRES(...) requires(__VA_ARGS__)
#endif
 
// ---------------- Print ----------------
 
#define H5_PRINT(X) std::cerr << H5_AS_STRING(X) << " = " << X << "      at " << __FILE__ << ":" << __LINE__ << '\n'
 
// ---------------- Inline ----------------
 
#define H5_FORCEINLINE __inline__ __attribute__((always_inline))
 
// ---------------- Debugging ----------------
 
#define H5_EXPECTS(X)                                                                                                                                \
  if (!(X)) {                                                                                                                                        \
    std::cerr << "Precondition " << H5_AS_STRING(X) << " violated at " << __FILE__ << ":" << __LINE__ << "\n";                                       \
    std::terminate();                                                                                                                                \
  }
#define H5_ASSERT(X)                                                                                                                                 \
  if (!(X)) {                                                                                                                                        \
    std::cerr << "Assertion " << H5_AS_STRING(X) << " violated at " << __FILE__ << ":" << __LINE__ << "\n";                                          \
    std::terminate();                                                                                                                                \
  }
#define H5_ENSURES(X)                                                                                                                                \
  if (!(X)) {                                                                                                                                        \
    std::cerr << "Postcondition " << H5_AS_STRING(X) << " violated at " << __FILE__ << ":" << __LINE__ << "\n";                                      \
    std::terminate();                                                                                                                                \
  }
 
#endif // LIBH5_MACROS_HPP