Program Listing for File Exception.hpp

↰ Return to documentation for file (runtime/include/Exception.hpp)

// Copyright 2023 Xanadu Quantum Technologies Inc.

// 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

// 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.

#pragma once

#include <exception>
#include <iostream>

#include <sstream>
#include <string>
#include <type_traits>
#include <utility>

#define RT_FAIL(message) Catalyst::Runtime::_abort((message), __FILE__, __LINE__, __func__)

#define RT_FAIL_IF(expression, message)                                                            \
    if ((expression)) {                                                                            \
        RT_FAIL(message);                                                                          \
    }

#define RT_ASSERT(expression) RT_FAIL_IF(!(expression), "Assertion: " #expression)

namespace Catalyst::Runtime {

class RuntimeException : public std::exception {
  private:
    const std::string err_msg;

  public:
    explicit RuntimeException(std::string msg) noexcept
        : err_msg{std::move(msg)} {}        // LCOV_EXCL_LINE
    ~RuntimeException() override = default; // LCOV_EXCL_LINE

    RuntimeException(const RuntimeException &) = default;
    RuntimeException(RuntimeException &&) noexcept = default;

    RuntimeException &operator=(const RuntimeException &) = delete;
    RuntimeException &operator=(RuntimeException &&) = delete;

    [[nodiscard]] auto what() const noexcept -> const char * override
    {
        return err_msg.c_str();
    } // LCOV_EXCL_LINE
};

[[noreturn]] inline void _abort(const char *message, const char *file_name, size_t line,
                                const char *function_name)
{
    std::stringstream sstream;
    sstream << "[" << file_name << "][Line:" << line << "][Function:" << function_name
            << "] Error in Catalyst Runtime: " << message;

    throw RuntimeException(sstream.str());
} // LCOV_EXCL_LINE

} // namespace Catalyst::Runtime

api/program_listing_file_runtime_include_Exception.hpp

 

Download Python script

 

Download Notebook

 

View on GitHub