solidity/libsolutil/Whiskers.cpp

231 lines
5.8 KiB
C++
Raw Normal View History

2017-06-20 12:26:19 +00:00
/*
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
2017-06-20 12:26:19 +00:00
/** @file Whiskers.cpp
* @author Chris <chis@ethereum.org>
* @date 2017
*
* Moustache-like templates.
*/
#include <libsolutil/Whiskers.h>
2017-06-20 12:26:19 +00:00
#include <libsolutil/Assertions.h>
2017-06-20 12:26:19 +00:00
#include <regex>
2017-06-20 12:26:19 +00:00
using namespace std;
2019-12-11 16:31:36 +00:00
using namespace solidity::util;
2017-06-20 12:26:19 +00:00
2019-05-07 10:45:49 +00:00
Whiskers::Whiskers(string _template):
m_template(move(_template))
2017-06-20 12:26:19 +00:00
{
}
2019-05-07 10:45:49 +00:00
Whiskers& Whiskers::operator()(string _parameter, string _value)
2017-06-20 12:26:19 +00:00
{
checkParameterValid(_parameter);
2019-05-07 12:40:53 +00:00
checkParameterUnknown(_parameter);
checkTemplateContainsTags(_parameter, {""});
2019-05-07 10:45:49 +00:00
m_parameters[move(_parameter)] = move(_value);
2017-06-20 12:26:19 +00:00
return *this;
}
2019-05-07 12:41:42 +00:00
Whiskers& Whiskers::operator()(string _parameter, bool _value)
{
checkParameterValid(_parameter);
2019-05-07 12:41:42 +00:00
checkParameterUnknown(_parameter);
checkTemplateContainsTags(_parameter, {"?", "/"});
2019-05-07 12:41:42 +00:00
m_conditions[move(_parameter)] = _value;
return *this;
}
2019-05-07 10:45:49 +00:00
Whiskers& Whiskers::operator()(
string _listParameter,
vector<map<string, string>> _values
2017-06-20 12:26:19 +00:00
)
{
checkParameterValid(_listParameter);
2019-05-07 12:40:53 +00:00
checkParameterUnknown(_listParameter);
checkTemplateContainsTags(_listParameter, {"#", "/"});
for (auto const& element: _values)
for (auto const& val: element)
checkParameterValid(val.first);
2019-05-07 10:45:49 +00:00
m_listParameters[move(_listParameter)] = move(_values);
2017-06-20 12:26:19 +00:00
return *this;
}
string Whiskers::render() const
{
2019-05-07 12:41:42 +00:00
return replace(m_template, m_parameters, m_conditions, m_listParameters);
2017-06-20 12:26:19 +00:00
}
void Whiskers::checkParameterValid(string const& _parameter) const
{
static regex validParam("^" + paramRegex() + "$");
assertThrow(
regex_match(_parameter, validParam),
WhiskersError,
"Parameter" + _parameter + " contains invalid characters."
);
}
void Whiskers::checkParameterUnknown(string const& _parameter) const
2019-05-07 12:40:53 +00:00
{
assertThrow(
!m_parameters.count(_parameter),
WhiskersError,
_parameter + " already set as value parameter."
);
2019-05-07 12:41:42 +00:00
assertThrow(
!m_conditions.count(_parameter),
WhiskersError,
_parameter + " already set as condition parameter."
);
2019-05-07 12:40:53 +00:00
assertThrow(
!m_listParameters.count(_parameter),
WhiskersError,
_parameter + " already set as list parameter."
);
}
void Whiskers::checkTemplateContainsTags(string const& _parameter, vector<string> const& _prefixes) const
{
for (auto const& prefix: _prefixes)
{
string tag{"<" + prefix + _parameter + ">"};
assertThrow(
m_template.find(tag) != string::npos,
WhiskersError,
"Tag '" + tag + "' not found in template:\n" + m_template
);
}
}
namespace
{
template<class ReplaceCallback>
string regex_replace(
string const& _source,
regex const& _pattern,
ReplaceCallback _replace,
regex_constants::match_flag_type _flags = regex_constants::match_default
)
{
sregex_iterator curMatch(_source.begin(), _source.end(), _pattern, _flags);
sregex_iterator matchEnd;
string::const_iterator lastMatchedPos(_source.cbegin());
string result;
while (curMatch != matchEnd)
{
result.append(curMatch->prefix().first, curMatch->prefix().second);
result.append(_replace(*curMatch));
lastMatchedPos = (*curMatch)[0].second;
++curMatch;
}
result.append(lastMatchedPos, _source.cend());
return result;
}
}
2017-06-20 12:26:19 +00:00
string Whiskers::replace(
string const& _template,
StringMap const& _parameters,
2019-05-07 12:41:42 +00:00
map<string, bool> const& _conditions,
2017-06-20 12:26:19 +00:00
map<string, vector<StringMap>> const& _listParameters
)
{
2020-04-23 14:29:17 +00:00
static regex listOrTag(
"<(" + paramRegex() + ")>|"
"<#(" + paramRegex() + ")>((?:.|\\r|\\n)*?)</\\2>|"
"<\\?(\\+?" + paramRegex() + ")>((?:.|\\r|\\n)*?)(<!\\4>((?:.|\\r|\\n)*?))?</\\4>"
);
2017-06-20 12:26:19 +00:00
return regex_replace(_template, listOrTag, [&](match_results<string::const_iterator> _match) -> string
{
string tagName(_match[1]);
2019-05-07 12:41:42 +00:00
string listName(_match[2]);
string conditionName(_match[4]);
2017-06-20 12:26:19 +00:00
if (!tagName.empty())
{
2017-09-19 08:25:01 +00:00
assertThrow(
_parameters.count(tagName),
WhiskersError,
"Value for tag " + tagName + " not provided.\n" +
"Template:\n" +
_template
);
2017-06-20 12:26:19 +00:00
return _parameters.at(tagName);
}
2019-05-07 12:41:42 +00:00
else if (!listName.empty())
2017-06-20 12:26:19 +00:00
{
string templ(_match[3]);
assertThrow(
_listParameters.count(listName),
WhiskersError, "List parameter " + listName + " not set."
);
string replacement;
for (auto const& parameters: _listParameters.at(listName))
2019-05-07 12:41:42 +00:00
replacement += replace(templ, joinMaps(_parameters, parameters), _conditions);
2017-06-20 12:26:19 +00:00
return replacement;
}
2019-05-07 12:41:42 +00:00
else
{
assertThrow(!conditionName.empty(), WhiskersError, "");
2020-04-23 14:29:17 +00:00
bool conditionValue = false;
if (conditionName[0] == '+')
{
string tag = conditionName.substr(1);
assertThrow(
_parameters.count(tag),
WhiskersError, "Tag " + tag + " used as condition but was not set."
);
conditionValue = !_parameters.at(tag).empty();
}
else
{
assertThrow(
_conditions.count(conditionName),
WhiskersError, "Condition parameter " + conditionName + " not set."
);
conditionValue = _conditions.at(conditionName);
}
2019-05-07 12:41:42 +00:00
return replace(
2020-04-23 14:29:17 +00:00
conditionValue ? _match[5] : _match[7],
2019-05-07 12:41:42 +00:00
_parameters,
_conditions,
_listParameters
);
}
2017-06-20 12:26:19 +00:00
});
}
Whiskers::StringMap Whiskers::joinMaps(
Whiskers::StringMap const& _a,
Whiskers::StringMap const& _b
)
{
Whiskers::StringMap ret = _a;
for (auto const& x: _b)
assertThrow(
ret.insert(x).second,
WhiskersError,
"Parameter collision"
);
return ret;
}