1/*
2 * Copyright (c) 2011-2014, Intel Corporation
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation and/or
13 * other materials provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors
16 * may be used to endorse or promote products derived from this software without
17 * specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#pragma once
32
33#include <string>
34#include <list>
35#include <map>
36#include <sstream>
37
38class CUtility
39{
40public:
41    /**
42    * Format the items of a map into a string as a list of key-value pairs. The map must be
43    * composed of pairs of strings.
44    *
45    * @param[in] mapStr A map of strings
46    * @param[out] strOutput The output string
47    * @param[in] separator The separator to use between each item
48    */
49    static void asString(const std::list<std::string>& lstr,
50                         std::string& strOutput,
51                         const std::string& separator = "\n");
52
53    /**
54     * Format the items of a map into a string as a list of key-value pairs. The map must be
55     * composed of pairs of strings.
56     *
57     * @param[in] mapStr A map of strings
58     * @param[out] strOutput The output string
59     * @param[in] strItemSeparator The separator to use between each item (key-value pair)
60     * @param[in] strKeyValueSeparator The separator to use between key and value
61     */
62    static void asString(const std::map<std::string, std::string>& mapStr,
63                         std::string& strOutput,
64                         const std::string& strItemSeparator = ", ",
65                         const std::string& strKeyValueSeparator = ":");
66
67    /** Utility to easily convert a builtin type into string
68     *
69     * FIXME: Should be replaced by std::to_string after C++11 introduction
70     */
71    template <class T>
72    static std::string toString(T uiValue)
73    {
74        std::ostringstream ostr;
75
76        ostr << uiValue;
77
78        return ostr.str();
79    }
80
81    /** Utility to underline */
82    static void appendTitle(std::string& strTo, const std::string& strTitle);
83};
84