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
|
|
|
|
|
2014-10-16 15:56:10 +00:00
|
|
|
#include <string>
|
2015-04-30 16:06:04 +00:00
|
|
|
#include <utility>
|
2018-11-14 16:11:55 +00:00
|
|
|
#include <vector>
|
|
|
|
#include <memory>
|
2020-01-06 10:52:23 +00:00
|
|
|
#include <libsolutil/Exceptions.h>
|
|
|
|
#include <libsolutil/Assertions.h>
|
|
|
|
#include <libsolutil/CommonData.h>
|
2018-11-14 13:59:30 +00:00
|
|
|
#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
|
|
|
{
|
2015-10-14 18:37:41 +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
|
|
|
|
2017-06-21 20:50:57 +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)
|
2017-06-21 20:50:57 +00:00
|
|
|
|
|
|
|
#define solUnimplementedAssert(CONDITION, DESCRIPTION) \
|
2019-12-11 16:31:36 +00:00
|
|
|
assertThrow(CONDITION, ::solidity::langutil::UnimplementedFeatureError, DESCRIPTION)
|
2017-06-21 20:50:57 +00:00
|
|
|
|
|
|
|
#define solUnimplemented(DESCRIPTION) \
|
2019-02-13 15:56:46 +00:00
|
|
|
solUnimplementedAssert(false, DESCRIPTION)
|
2017-06-21 20:50:57 +00:00
|
|
|
|
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
|
2015-10-02 12:41:40 +00:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
enum class Type
|
|
|
|
{
|
|
|
|
DeclarationError,
|
|
|
|
DocstringParsingError,
|
|
|
|
ParserError,
|
|
|
|
TypeError,
|
2016-01-14 01:58:09 +00:00
|
|
|
SyntaxError,
|
2015-10-02 12:41:40 +00:00
|
|
|
Warning
|
|
|
|
};
|
|
|
|
|
2017-03-03 17:44:28 +00:00
|
|
|
explicit Error(
|
|
|
|
Type _type,
|
|
|
|
SourceLocation const& _location = SourceLocation(),
|
|
|
|
std::string const& _description = std::string()
|
|
|
|
);
|
2015-10-02 12:41:40 +00:00
|
|
|
|
2017-02-15 13:52:53 +00:00
|
|
|
Error(Type _type, std::string const& _description, SourceLocation const& _location = SourceLocation());
|
|
|
|
|
2015-10-14 18:37:41 +00:00
|
|
|
Type type() const { return m_type; }
|
2015-10-02 12:41:40 +00:00
|
|
|
std::string const& typeName() const { return m_typeName; }
|
|
|
|
|
2015-10-14 18:37:41 +00:00
|
|
|
/// 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)
|
2015-10-14 18:37:41 +00:00
|
|
|
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)
|
2015-10-14 18:37:41 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
2015-10-02 12:41:40 +00:00
|
|
|
private:
|
|
|
|
Type m_type;
|
|
|
|
std::string m_typeName;
|
|
|
|
};
|
2015-09-21 17:43:56 +00:00
|
|
|
|
2015-04-30 16:06:04 +00:00
|
|
|
using errorSourceLocationInfo = std::pair<std::string, SourceLocation>;
|
|
|
|
|
|
|
|
class SecondarySourceLocation
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
SecondarySourceLocation& append(std::string const& _errMsg, SourceLocation const& _sourceLocation)
|
|
|
|
{
|
2018-12-10 18:02:39 +00:00
|
|
|
infos.emplace_back(_errMsg, _sourceLocation);
|
2015-04-30 16:06:04 +00:00
|
|
|
return *this;
|
|
|
|
}
|
2019-03-18 12:04:08 +00:00
|
|
|
SecondarySourceLocation& append(SecondarySourceLocation&& _other)
|
|
|
|
{
|
|
|
|
infos += std::move(_other.infos);
|
|
|
|
return *this;
|
|
|
|
}
|
2018-11-14 16:11:55 +00:00
|
|
|
|
2017-12-12 09:10:29 +00:00
|
|
|
/// 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);
|
2018-08-08 06:55:43 +00:00
|
|
|
_message += " Truncated from " + std::to_string(occurrences) + " to the first 32 occurrences.";
|
2017-12-12 09:10:29 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-04-30 16:06:04 +00:00
|
|
|
std::vector<errorSourceLocationInfo> infos;
|
|
|
|
};
|
|
|
|
|
2015-02-23 16:14:59 +00:00
|
|
|
using errinfo_sourceLocation = boost::error_info<struct tag_sourceLocation, SourceLocation>;
|
2015-04-30 16:06:04 +00:00
|
|
|
using errinfo_secondarySourceLocation = boost::error_info<struct tag_secondarySourceLocation, SecondarySourceLocation>;
|
2014-10-15 12:45:51 +00:00
|
|
|
|
2018-11-14 16:11:55 +00:00
|
|
|
|
2014-10-16 12:08:54 +00:00
|
|
|
}
|