solidity/liblangutil/CharStreamProvider.h

/*
	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
/**
 * Interface to retrieve the character stream by a source name.
 */

#pragma once

#include <liblangutil/CharStream.h>
#include <liblangutil/Exceptions.h>

#include <string>

namespace solidity::langutil
{

/**
 * Interface to retrieve a CharStream (source) from a source name.
 * Used especially for printing error information.
 */
class CharStreamProvider
{
public:
	virtual ~CharStreamProvider() = default;
	virtual CharStream const& charStream(std::string const& _sourceName) const = 0;
};

class SingletonCharStreamProvider: public CharStreamProvider
{
public:
	explicit SingletonCharStreamProvider(CharStream const& _charStream):
		m_charStream(_charStream) {}
	CharStream const& charStream(std::string const& _sourceName) const override
	{
		solAssert(m_charStream.name() == _sourceName, "");
		return m_charStream;
	}
private:
	CharStream const& m_charStream;
};

}