solidity/liblangutil/SourceReferenceFormatter.h

104 lines
3.0 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/>.
*/
// SPDX-License-Identifier: GPL-3.0
/**
* Formatting functions for errors referencing positions and locations in the source.
*/
#pragma once
2020-11-04 00:15:01 +00:00
#include <liblangutil/Exceptions.h>
#include <liblangutil/SourceReferenceExtractor.h>
#include <libsolutil/AnsiColorized.h>
#include <ostream>
#include <sstream>
#include <functional>
2019-12-11 16:31:36 +00:00
namespace solidity::langutil
{
class CharStream;
class CharStreamProvider;
2020-11-04 00:15:01 +00:00
struct SourceLocation;
2020-12-01 13:22:15 +00:00
class SourceReferenceFormatter
{
public:
2021-06-29 12:38:59 +00:00
SourceReferenceFormatter(
std::ostream& _stream,
CharStreamProvider const& _charStreamProvider,
bool _colored,
bool _withErrorIds
):
m_stream(_stream), m_charStreamProvider(_charStreamProvider), m_colored(_colored), m_withErrorIds(_withErrorIds)
{}
2020-11-04 00:15:01 +00:00
/// Prints source location if it is given.
void printSourceLocation(SourceReference const& _ref);
void printExceptionInformation(SourceReferenceExtractor::Message const& _msg);
void printExceptionInformation(util::Exception const& _exception, std::string const& _category);
2021-06-29 12:38:59 +00:00
void printErrorInformation(langutil::ErrorList const& _errors);
2020-11-04 00:15:01 +00:00
void printErrorInformation(Error const& _error);
static std::string formatExceptionInformation(
2019-12-11 16:31:36 +00:00
util::Exception const& _exception,
std::string const& _name,
2021-06-29 12:38:59 +00:00
CharStreamProvider const& _charStreamProvider,
2020-06-04 01:19:47 +00:00
bool _colored = false,
bool _withErrorIds = false
)
{
std::ostringstream errorOutput;
2021-06-29 12:38:59 +00:00
SourceReferenceFormatter formatter(errorOutput, _charStreamProvider, _colored, _withErrorIds);
formatter.printExceptionInformation(_exception, _name);
return errorOutput.str();
}
2021-06-29 12:38:59 +00:00
static std::string formatErrorInformation(
Error const& _error,
CharStreamProvider const& _charStreamProvider
)
2020-11-02 14:29:33 +00:00
{
return formatExceptionInformation(
_error,
2021-06-29 12:38:59 +00:00
(_error.type() == Error::Type::Warning) ? "Warning" : "Error",
_charStreamProvider
);
}
static std::string formatErrorInformation(Error const& _error, CharStream const& _charStream);
2020-11-02 14:29:33 +00:00
private:
2019-12-11 16:31:36 +00:00
util::AnsiColorized normalColored() const;
util::AnsiColorized frameColored() const;
util::AnsiColorized errorColored() const;
util::AnsiColorized messageColored() const;
util::AnsiColorized secondaryColored() const;
util::AnsiColorized highlightColored() const;
util::AnsiColorized diagColored() const;
private:
2020-11-04 00:15:01 +00:00
std::ostream& m_stream;
2021-06-29 12:38:59 +00:00
CharStreamProvider const& m_charStreamProvider;
bool m_colored;
2020-06-04 01:19:47 +00:00
bool m_withErrorIds;
};
}