Loading...
Searching...
No Matches
OpmInputError.hpp
/*
Copyright 2020 Equinor ASA.
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OPM 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 for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPM_ERROR_HPP
#define OPM_ERROR_HPP
#include <opm/common/OpmLog/KeywordLocation.hpp>
#include <stdexcept>
#include <string>
#include <utility>
#include <vector>
namespace Opm {
// The OpmInputError is a custom exception class which can be used to signal
// errors in input handling. The importance of the OpmInputError exception
// is *not* the tecnical functionality it provides, but rather the
// convention surrounding it, when and how it should be used.
//
// The OpmInputError should be used in situations which are "close to user
// input", the root cause can either be incorrect user input or a
// bug/limitation in opm. OpmInputError should only be used in situations
// where we have a good understanding of the underlying issue, and can
// provide a good error message.
//
// The local error handling should be complete when the OpmInputError is
// instantiated, it should not be caught and rethrown in order to e.g. add
// additional context or log messages. In order to avoid inadvertendly
// catching this exception in a catch all block.
class OpmInputError : public std::exception
{
public:
// The message string will be used as format string in the fmt::format()
// function as, and optional {} markers can be used to inject keyword,
// filename and line numbers into the final what() message. The
// placeholders may use one or more of the following named arguments
//
// {keyword} -> location.keyword
// {file} -> location.filename
// {line} -> location.lineno
//
// Furthermore, the message can contain any number of positional
// arguments to add further context to the message.
//
// KeywordLocation loc("KW", "file.inc", 100);
// OpmInputError("Error at line {line} in file {file} - keyword: {keyword} ignored", location);
// OpmInputError("Error at line {line} in file {file} - keyword: {keyword} has invalid argument {}", invalid_argument);
template <typename... Args>
OpmInputError(const std::string& reason,
const KeywordLocation& location,
Args&&... furtherLocations)
: locations { location, std::forward<Args>(furtherLocations)... }
, m_what {
(locations.size() == 1)
? formatSingle(reason, locations.front())
: formatMultiple(reason, locations)
}
{}
// Allows for the initialisation of an OpmInputError from another exception.
//
// Usage:
//
// try {
// .
// .
// .
// } catch (const Opm::OpmInputError&) {
// throw;
// } catch (const std::exception& e) {
// std::throw_with_nested(Opm::OpmInputError(e, location));
// }
OpmInputError(const std::exception& error, const KeywordLocation& location)
: locations { location }
, m_what { formatException(error, locations.front()) }
{}
const char* what() const noexcept override
{
return this->m_what.c_str();
}
static std::string format(const std::string& msg_format, const KeywordLocation& loc);
private:
// The location member is here for debugging; depending on the msg_fmt
// passed in the constructor we might not have captured all the
// information in the location argument passed to the constructor.
std::vector<KeywordLocation> locations;
std::string m_what;
static std::string formatException(const std::exception& e, const KeywordLocation& loc);
static std::string formatSingle(const std::string& reason, const KeywordLocation&);
static std::string formatMultiple(const std::string& reason, const std::vector<KeywordLocation>&);
};
} // namespace Opm
#endif // OPM_ERROR_HPP
Opm::KeywordLocation
Definition KeywordLocation.hpp:27
Opm::OpmInputError
Definition OpmInputError.hpp:49
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30