path: root/BaseTypes.h

/*
    This file is part of cpp-ethereum.

    cpp-ethereum 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.

    cpp-ethereum 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 cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @date 2014
 * Some elementary types for the parser.
 */

#pragma once

#include <memory>
#include <string>
#include <ostream>

namespace dev
{
namespace solidity
{

/**
 * Representation of an interval of source positions.
 * The interval includes start and excludes end.
 */
struct Location
{
    Location(int _start, int _end, std::shared_ptr<std::string const> _sourceName):
        start(_start), end(_end), sourceName(_sourceName) { }
    Location(): start(-1), end(-1) { }

    bool isEmpty() const { return start == -1 && end == -1; }

    int start;
    int end;
    std::shared_ptr<std::string const> sourceName;
};

/// Stream output for Location (used e.g. in boost exceptions).
inline std::ostream& operator<<(std::ostream& _out, Location const& _location)
{
    if (_location.isEmpty())
        return _out << "NO_LOCATION_SPECIFIED";
    return _out << *_location.sourceName << "[" << _location.start << "," << _location.end << ")";
}

}
}