Error.hpp

/* Copyright 2025 Axel Huebl, Franz Poeschel, Luca Fedeli
 *
 * This file is part of openPMD-api.
 *
 * openPMD-api is free software: you can redistribute it and/or modify
 * it under the terms of of either the GNU General Public License or
 * the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * openPMD-api is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with openPMD-api.
 * If not, see <http://www.gnu.org/licenses/>.
 */
#pragma once
 
#include "openPMD/ThrowError.hpp"
 
#include <exception>
#include <optional>
#include <string>
#include <utility>
#include <vector>
 
namespace openPMD
{
class Error : public std::exception
{
private:
    std::string m_what;
 
protected:
    Error(std::string what) : m_what(what)
    {}
 
public:
    virtual const char *what() const noexcept;
 
    Error(Error const &) = default;
    Error(Error &&) = default;
 
    Error &operator=(Error const &) = default;
    Error &operator=(Error &&) = default;
 
    virtual ~Error() noexcept = default;
};
 
namespace error
{
    class OperationUnsupportedInBackend : public Error
    {
    public:
        std::string backend;
        OperationUnsupportedInBackend(
            std::string backend_in, std::string const &what);
    };

    class WrongAPIUsage : public Error
    {
    public:
        WrongAPIUsage(std::string const &what);
    };
 
    class BackendConfigSchema : public Error
    {
    public:
        std::vector<std::string> errorLocation;
 
        BackendConfigSchema(std::vector<std::string>, std::string what);
    };

    class Internal : public Error
    {
    public:
        Internal(std::string const &what);
    };
 
    /*
     * Read error concerning a specific object.
     */
    class ReadError : public Error
    {
    public:
        AffectedObject affectedObject;
        Reason reason;
        // If empty, then the error is thrown by the frontend
        std::optional<std::string> backend;
        std::string description; // object path, further details, ...
 
        ReadError(
            AffectedObject,
            Reason,
            std::optional<std::string> backend_in,
            std::string description_in);
    };
 
    class NoSuchAttribute : public Error
    {
    public:
        NoSuchAttribute(std::string attributeName);
    };
 
    class IllegalInOpenPMDStandard : public Error
    {
    public:
        IllegalInOpenPMDStandard(std::string what);
    };
} // namespace error

using no_such_file_error = error::ReadError;

using unsupported_data_error = error::OperationUnsupportedInBackend;

using no_such_attribute_error = error::NoSuchAttribute;
} // namespace openPMD