solidity/liblangutil/Exceptions.h

142 lines
3.8 KiB
C
Raw Normal View History

2014-10-15 12:45:51 +00:00
/*
2019-02-13 15:56:46 +00:00
This file is part of solidity.
2014-10-15 12:45:51 +00:00
2019-02-13 15:56:46 +00:00
solidity 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.
2014-10-15 12:45:51 +00:00
2019-02-13 15:56:46 +00:00
solidity 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.
2014-10-15 12:45:51 +00:00
2019-02-13 15:56:46 +00:00
You should have received a copy of the GNU General Public License
along with solidity. If not, see <http://www.gnu.org/licenses/>.
2014-10-15 12:45:51 +00:00
*/
/**
* @author Christian <c@ethdev.com>
* @date 2014
* Solidity exception hierarchy.
*/
#pragma once
#include <string>
#include <utility>
#include <vector>
#include <memory>
#include <libsolutil/Exceptions.h>
#include <libsolutil/Assertions.h>
#include <libsolutil/CommonData.h>
#include <liblangutil/SourceLocation.h>
2014-10-15 12:45:51 +00:00
2019-12-11 16:31:36 +00:00
namespace solidity::langutil
2014-10-16 12:08:54 +00:00
{
class Error;
using ErrorList = std::vector<std::shared_ptr<Error const>>;
2019-12-11 16:31:36 +00:00
struct CompilerError: virtual util::Exception {};
struct InternalCompilerError: virtual util::Exception {};
struct FatalError: virtual util::Exception {};
struct UnimplementedFeatureError: virtual util::Exception {};
2019-09-11 19:16:35 +00:00
struct InvalidAstError: virtual util::Exception {};
2015-09-21 17:43:56 +00:00
/// Assertion that throws an InternalCompilerError containing the given description if it is not met.
#define solAssert(CONDITION, DESCRIPTION) \
2019-12-11 16:31:36 +00:00
assertThrow(CONDITION, ::solidity::langutil::InternalCompilerError, DESCRIPTION)
#define solUnimplementedAssert(CONDITION, DESCRIPTION) \
2019-12-11 16:31:36 +00:00
assertThrow(CONDITION, ::solidity::langutil::UnimplementedFeatureError, DESCRIPTION)
#define solUnimplemented(DESCRIPTION) \
2019-02-13 15:56:46 +00:00
solUnimplementedAssert(false, DESCRIPTION)
2019-09-11 19:16:35 +00:00
#define astAssert(CONDITION, DESCRIPTION) \
assertThrow(CONDITION, ::solidity::langutil::InvalidAstError, DESCRIPTION)
2019-12-11 16:31:36 +00:00
class Error: virtual public util::Exception
{
public:
enum class Type
{
DeclarationError,
DocstringParsingError,
ParserError,
TypeError,
SyntaxError,
Warning
};
2017-03-03 17:44:28 +00:00
explicit Error(
Type _type,
SourceLocation const& _location = SourceLocation(),
std::string const& _description = std::string()
);
2017-02-15 13:52:53 +00:00
Error(Type _type, std::string const& _description, SourceLocation const& _location = SourceLocation());
Type type() const { return m_type; }
std::string const& typeName() const { return m_typeName; }
/// helper functions
static Error const* containsErrorOfType(ErrorList const& _list, Error::Type _type)
{
for (auto e: _list)
{
2015-10-15 14:08:02 +00:00
if (e->type() == _type)
return e.get();
}
return nullptr;
}
static bool containsOnlyWarnings(ErrorList const& _list)
{
for (auto e: _list)
{
2015-10-15 14:08:02 +00:00
if (e->type() != Type::Warning)
return false;
}
return true;
}
private:
Type m_type;
std::string m_typeName;
};
2015-09-21 17:43:56 +00:00
using errorSourceLocationInfo = std::pair<std::string, SourceLocation>;
class SecondarySourceLocation
{
public:
SecondarySourceLocation& append(std::string const& _errMsg, SourceLocation const& _sourceLocation)
{
infos.emplace_back(_errMsg, _sourceLocation);
return *this;
}
2019-03-18 12:04:08 +00:00
SecondarySourceLocation& append(SecondarySourceLocation&& _other)
{
infos += std::move(_other.infos);
return *this;
}
/// Limits the number of secondary source locations to 32 and appends a notice to the
/// error message.
void limitSize(std::string& _message)
{
size_t occurrences = infos.size();
if (occurrences > 32)
{
infos.resize(32);
_message += " Truncated from " + std::to_string(occurrences) + " to the first 32 occurrences.";
}
}
std::vector<errorSourceLocationInfo> infos;
};
using errinfo_sourceLocation = boost::error_info<struct tag_sourceLocation, SourceLocation>;
using errinfo_secondarySourceLocation = boost::error_info<struct tag_secondarySourceLocation, SecondarySourceLocation>;
2014-10-15 12:45:51 +00:00
2014-10-16 12:08:54 +00:00
}