mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
86 lines
2.3 KiB
C++
86 lines
2.3 KiB
C++
/*
|
|
This file is part of solidity.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with solidity. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
/**
|
|
* @author Christian <c@ethdev.com>
|
|
* @date 2014
|
|
* Formatting functions for errors referencing positions and locations in the source.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <ostream>
|
|
#include <sstream>
|
|
#include <functional>
|
|
#include <liblangutil/Exceptions.h>
|
|
#include <liblangutil/SourceReferenceExtractor.h>
|
|
|
|
namespace solidity::util
|
|
{
|
|
struct Exception; // forward
|
|
}
|
|
|
|
namespace solidity::langutil
|
|
{
|
|
struct SourceLocation;
|
|
class Scanner;
|
|
|
|
class SourceReferenceFormatter
|
|
{
|
|
public:
|
|
explicit SourceReferenceFormatter(std::ostream& _stream):
|
|
m_stream(_stream)
|
|
{}
|
|
|
|
virtual ~SourceReferenceFormatter() = default;
|
|
|
|
/// Prints source location if it is given.
|
|
virtual void printSourceLocation(SourceReference const& _ref);
|
|
virtual void printExceptionInformation(SourceReferenceExtractor::Message const& _msg);
|
|
|
|
virtual void printSourceLocation(SourceLocation const* _location);
|
|
virtual void printExceptionInformation(util::Exception const& _exception, std::string const& _category);
|
|
virtual void printErrorInformation(Error const& _error);
|
|
|
|
static std::string formatErrorInformation(Error const& _error)
|
|
{
|
|
return formatExceptionInformation(
|
|
_error,
|
|
(_error.type() == Error::Type::Warning) ? "Warning" : "Error"
|
|
);
|
|
}
|
|
|
|
static std::string formatExceptionInformation(
|
|
util::Exception const& _exception,
|
|
std::string const& _name
|
|
)
|
|
{
|
|
std::ostringstream errorOutput;
|
|
|
|
SourceReferenceFormatter formatter(errorOutput);
|
|
formatter.printExceptionInformation(_exception, _name);
|
|
return errorOutput.str();
|
|
}
|
|
|
|
protected:
|
|
/// Prints source name if location is given.
|
|
void printSourceName(SourceReference const& _ref);
|
|
|
|
std::ostream& m_stream;
|
|
};
|
|
|
|
}
|