solidity/libdevcore/Whiskers.h

112 lines
3.5 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/>.
*/
/** @file Whiskers.h
* @author Chris <chis@ethereum.org>
* @date 2017
*
* Moustache-like templates.
*/
#pragma once
#include <libdevcore/Exceptions.h>
#include <string>
#include <map>
#include <vector>
namespace dev
{
DEV_SIMPLE_EXCEPTION(WhiskersError);
2019-05-07 12:41:42 +00:00
/**
* Moustache-like templates.
*
* Usage:
* std::vector<std::map<std::string, std::string>> listValues(2);
* listValues[0]["k"] = "key1";
* listValues[0]["v"] = "value1";
* listValues[1]["k"] = "key2";
* listValues[1]["v"] = "value2";
* auto s = Whiskers("<?c><p1><!c>y</c>\n<#list><k> -> <v>\n</list>")
* ("p1", "HEAD")
* ("c", true)
* ("list", listValues)
* .render();
*
* results in s == "HEAD\nkey1 -> value1\nkey2 -> value2\n"
*
* Note that lists cannot themselves contain lists - this would be a future feature.
*
* The elements are:
* - Regular parameter: <name>
* just replaced
* - Condition parameter: <?name>...<!name>...</name>, where "<!name>" is optional
* replaced (and recursively expanded) by the first part if the condition is true
* and by the second (or empty string if missing) if the condition is false
* - List parameter: <#list>...</list>
* The part between the tags is repeated as often as values are provided
* in the mapping. Each list element can have its own parameter -> value mapping.
*/
2017-06-20 12:26:19 +00:00
class Whiskers
{
public:
using StringMap = std::map<std::string, std::string>;
using StringListMap = std::map<std::string, std::vector<StringMap>>;
2019-05-07 10:45:49 +00:00
explicit Whiskers(std::string _template);
2017-06-20 12:26:19 +00:00
2019-05-07 12:41:42 +00:00
/// Sets a single regular parameter, <paramName>.
2019-05-07 10:45:49 +00:00
Whiskers& operator()(std::string _parameter, std::string _value);
2019-05-07 12:41:42 +00:00
Whiskers& operator()(std::string _parameter, char const* _value) { return (*this)(_parameter, std::string{_value}); }
/// Sets a condition parameter, <?paramName>...<!paramName>...</paramName>
Whiskers& operator()(std::string _parameter, bool _value);
2017-06-20 12:26:19 +00:00
/// Sets a list parameter, <#listName> </listName>.
Whiskers& operator()(
2019-05-07 10:45:49 +00:00
std::string _listParameter,
std::vector<StringMap> _values
2017-06-20 12:26:19 +00:00
);
std::string render() const;
private:
// Prevent implicit cast to bool
Whiskers& operator()(std::string _parameter, long long);
void checkParameterValid(std::string const& _parameter) const;
void checkParameterUnknown(std::string const& _parameter) const;
2019-05-07 12:40:53 +00:00
2017-06-20 12:26:19 +00:00
static std::string replace(
std::string const& _template,
StringMap const& _parameters,
2019-05-07 12:41:42 +00:00
std::map<std::string, bool> const& _conditions,
2017-06-20 12:26:19 +00:00
StringListMap const& _listParameters = StringListMap()
);
static std::string paramRegex() { return "[a-zA-Z0-9_$-]+"; }
2017-06-20 12:26:19 +00:00
/// Joins the two maps throwing an exception if two keys are equal.
static StringMap joinMaps(StringMap const& _a, StringMap const& _b);
std::string m_template;
StringMap m_parameters;
2019-05-07 12:41:42 +00:00
std::map<std::string, bool> m_conditions;
2017-06-20 12:26:19 +00:00
StringListMap m_listParameters;
};
}