solidity/liblangutil/SourceReferenceFormatter.h

86 lines
2.3 KiB
C
Raw Normal View History

/*
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
2014-10-23 17:22:30 +00:00
* Formatting functions for errors referencing positions and locations in the source.
*/
2014-10-23 17:22:30 +00:00
#pragma once
2014-10-23 17:22:30 +00:00
#include <ostream>
2017-03-29 21:40:10 +00:00
#include <sstream>
2016-02-22 01:13:41 +00:00
#include <functional>
#include <liblangutil/Exceptions.h>
#include <liblangutil/SourceReferenceExtractor.h>
2019-12-11 16:31:36 +00:00
namespace solidity::util
{
2015-01-13 12:20:07 +00:00
struct Exception; // forward
}
2019-12-11 16:31:36 +00:00
namespace solidity::langutil
{
struct SourceLocation;
class Scanner;
2014-10-23 17:22:30 +00:00
class SourceReferenceFormatter
{
2014-10-23 17:22:30 +00:00
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);
2019-12-11 16:31:36 +00:00
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"
);
}
2017-03-29 21:40:10 +00:00
static std::string formatExceptionInformation(
2019-12-11 16:31:36 +00:00
util::Exception const& _exception,
std::string const& _name
2017-03-29 21:40:10 +00:00
)
{
std::ostringstream errorOutput;
SourceReferenceFormatter formatter(errorOutput);
formatter.printExceptionInformation(_exception, _name);
2017-03-29 21:40:10 +00:00
return errorOutput.str();
}
protected:
/// Prints source name if location is given.
void printSourceName(SourceReference const& _ref);
std::ostream& m_stream;
2014-10-23 17:22:30 +00:00
};
}