solidity/libsolidity/interface/ImportRemapper.cpp

/*
	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
#include <libsolidity/interface/ImportRemapper.h>
#include <libsolutil/CommonIO.h>
#include <liblangutil/Exceptions.h>

using std::equal;
using std::find;
using std::move;
using std::nullopt;
using std::optional;
using std::string;
using std::string_view;
using std::vector;

namespace solidity::frontend
{

void ImportRemapper::setRemappings(vector<Remapping> _remappings)
{
	for (auto const& remapping: _remappings)
		solAssert(!remapping.prefix.empty(), "");
	m_remappings = std::move(_remappings);
}

SourceUnitName ImportRemapper::apply(ImportPath const& _path, string const& _context) const
{
	// Try to find the longest prefix match in all remappings that are active in the current context.
	auto isPrefixOf = [](string const& _a, string const& _b)
	{
		if (_a.length() > _b.length())
			return false;
		return equal(_a.begin(), _a.end(), _b.begin());
	};

	size_t longestPrefix = 0;
	size_t longestContext = 0;
	string bestMatchTarget;

	for (auto const& redir: m_remappings)
	{
		string context = util::sanitizePath(redir.context);
		string prefix = util::sanitizePath(redir.prefix);

		// Skip if current context is closer
		if (context.length() < longestContext)
			continue;
		// Skip if redir.context is not a prefix of _context
		if (!isPrefixOf(context, _context))
			continue;
		// Skip if we already have a closer prefix match.
		if (prefix.length() < longestPrefix && context.length() == longestContext)
			continue;
		// Skip if the prefix does not match.
		if (!isPrefixOf(prefix, _path))
			continue;

		longestContext = context.length();
		longestPrefix = prefix.length();
		bestMatchTarget = util::sanitizePath(redir.target);
	}
	string path = bestMatchTarget;
	path.append(_path.begin() + static_cast<string::difference_type>(longestPrefix), _path.end());
	return path;
}

bool ImportRemapper::isRemapping(string_view _input)
{
	return _input.find("=") != string::npos;
}

optional<ImportRemapper::Remapping> ImportRemapper::parseRemapping(string_view _input)
{
	auto equals = find(_input.cbegin(), _input.cend(), '=');
	if (equals == _input.end())
		return nullopt;

	auto const colon = find(_input.cbegin(), equals, ':');

	Remapping remapping{
		(colon == equals ? "" : string(_input.cbegin(), colon)),
		(colon == equals ? string(_input.cbegin(), equals) : string(colon + 1, equals)),
		string(equals + 1, _input.cend()),
	};

	if (remapping.prefix.empty())
		return nullopt;

	return remapping;
}

}