aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/interface/SourceReferenceFormatter.cpp
blob: 256adccc79f8e104a5075cc8aa45bec202aebb06 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
    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.
 */

#include <libsolidity/interface/SourceReferenceFormatter.h>
#include <libsolidity/parsing/Scanner.h>
#include <libsolidity/interface/Exceptions.h>

using namespace std;

namespace dev
{
namespace solidity
{

void SourceReferenceFormatter::printSourceLocation(
    ostream& _stream,
    SourceLocation const* _location,
    function<Scanner const&(string const&)> const& _scannerFromSourceName
)
{
    if (!_location || !_location->sourceName)
        return; // Nothing we can print here
    auto const& scanner = _scannerFromSourceName(*_location->sourceName);
    int startLine;
    int startColumn;
    tie(startLine, startColumn) = scanner.translatePositionToLineColumn(_location->start);
    int endLine;
    int endColumn;
    tie(endLine, endColumn) = scanner.translatePositionToLineColumn(_location->end);
    if (startLine == endLine)
    {
        string line = scanner.lineAtPosition(_location->start);

        int locationLength = endColumn - startColumn;
        if (locationLength > 150)
        {
            line = line.substr(0, startColumn + 75) + " ... " + line.substr(endColumn);
            endColumn = startColumn + 80;
            locationLength = 80;
        }
        if (line.length() > 150)
        {
            line = " ... " + line.substr(startColumn, locationLength) + " ... ";
            startColumn = 5;
            endColumn = startColumn + locationLength;
        }

        _stream << line << endl;
        for_each(
            line.cbegin(),
            line.cbegin() + startColumn,
            [&_stream](char const& ch) { _stream << (ch == '\t' ? '\t' : ' '); }
        );
        _stream << "^";
        if (endColumn > startColumn + 2)
            _stream << string(endColumn - startColumn - 2, '-');
        if (endColumn > startColumn + 1)
            _stream << "^";
        _stream << endl;
    }
    else
        _stream <<
            scanner.lineAtPosition(_location->start) <<
            endl <<
            string(startColumn, ' ') <<
            "^\n" <<
            "Spanning multiple lines.\n";
}

void SourceReferenceFormatter::printSourceName(
    ostream& _stream,
    SourceLocation const* _location,
    function<Scanner const&(string const&)> const& _scannerFromSourceName
)
{
    if (!_location || !_location->sourceName)
        return; // Nothing we can print here
    auto const& scanner = _scannerFromSourceName(*_location->sourceName);
    int startLine;
    int startColumn;
    tie(startLine, startColumn) = scanner.translatePositionToLineColumn(_location->start);
    _stream << *_location->sourceName << ":" << (startLine + 1) << ":" << (startColumn + 1) << ": ";
}

void SourceReferenceFormatter::printExceptionInformation(
    ostream& _stream,
    Exception const& _exception,
    string const& _name,
    function<Scanner const&(string const&)> const& _scannerFromSourceName
)
{
    SourceLocation const* location = boost::get_error_info<errinfo_sourceLocation>(_exception);
    auto secondarylocation = boost::get_error_info<errinfo_secondarySourceLocation>(_exception);

    printSourceName(_stream, location, _scannerFromSourceName);

    _stream << _name;
    if (string const* description = boost::get_error_info<errinfo_comment>(_exception))
        _stream << ": " << *description << endl;
    else
        _stream << endl;

    printSourceLocation(_stream, location, _scannerFromSourceName);

    if (secondarylocation && !secondarylocation->infos.empty())
    {
        for (auto info: secondarylocation->infos)
        {
            printSourceName(_stream, &info.second, _scannerFromSourceName);
            _stream << info.first << endl;
            printSourceLocation(_stream, &info.second, _scannerFromSourceName);
        }
        _stream << endl;
    }
}

}
}