solidity/liblangutil/SourceReferenceFormatter.h

77 lines
2.1 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>
namespace dev
{
2015-01-13 12:20:07 +00:00
struct Exception; // forward
}
namespace langutil
{
struct SourceLocation;
class Scanner;
2014-10-23 17:22:30 +00:00
class SourceReferenceFormatter
{
2014-10-23 17:22:30 +00:00
public:
using ScannerFromSourceNameFun = std::function<langutil::Scanner const&(std::string const&)>;
explicit SourceReferenceFormatter(
std::ostream& _stream,
ScannerFromSourceNameFun _scannerFromSourceName
):
m_stream(_stream),
m_scannerFromSourceName(std::move(_scannerFromSourceName))
{}
/// Prints source location if it is given.
void printSourceLocation(langutil::SourceLocation const* _location);
void printExceptionInformation(dev::Exception const& _exception, std::string const& _name);
2017-03-29 21:40:10 +00:00
static std::string formatExceptionInformation(
dev::Exception const& _exception,
2017-03-29 21:40:10 +00:00
std::string const& _name,
ScannerFromSourceNameFun const& _scannerFromSourceName
)
{
std::ostringstream errorOutput;
SourceReferenceFormatter formatter(errorOutput, _scannerFromSourceName);
formatter.printExceptionInformation(_exception, _name);
2017-03-29 21:40:10 +00:00
return errorOutput.str();
}
private:
/// Prints source name if location is given.
void printSourceName(langutil::SourceLocation const* _location);
std::ostream& m_stream;
ScannerFromSourceNameFun m_scannerFromSourceName;
2014-10-23 17:22:30 +00:00
};
}