aboutsummaryrefslogtreecommitdiffstats
path: root/libdevcore/Whiskers.h
blob: 21d46af4cd7ab2288b07962adcf73fd32f757080 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*
    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);

///
/// 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("<p1>\n<#list><k> -> <v>\n</list>")
///         ("p1", "HEAD")
///         ("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.
class Whiskers
{
public:
    using StringMap = std::map<std::string, std::string>;
    using StringListMap = std::map<std::string, std::vector<StringMap>>;

    explicit Whiskers(std::string const& _template);

    /// Sets a single parameter, <paramName>.
    Whiskers& operator()(std::string const& _parameter, std::string const& _value);
    /// Sets a list parameter, <#listName> </listName>.
    Whiskers& operator()(
        std::string const& _listParameter,
        std::vector<StringMap> const& _values
    );

    std::string render() const;

private:
    static std::string replace(
        std::string const& _template,
        StringMap const& _parameters,
        StringListMap const& _listParameters = StringListMap()
    );

    /// 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;
    StringListMap m_listParameters;
};

}