/*
|
* Copyright (c) 2011-2014, Intel Corporation
|
* All rights reserved.
|
*
|
* Redistribution and use in source and binary forms, with or without modification,
|
* are permitted provided that the following conditions are met:
|
*
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
* list of conditions and the following disclaimer.
|
*
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
* this list of conditions and the following disclaimer in the documentation and/or
|
* other materials provided with the distribution.
|
*
|
* 3. Neither the name of the copyright holder nor the names of its contributors
|
* may be used to endorse or promote products derived from this software without
|
* specific prior written permission.
|
*
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
*/
|
|
#pragma once
|
|
#include <string>
|
#include <list>
|
#include <map>
|
#include <sstream>
|
#include <numeric>
|
#include <type_traits>
|
|
namespace utility
|
{
|
|
/** Join all elements in [first, last[ with op.
|
*
|
* If their is no element to join, return empty.
|
*
|
* Example (joining strings):
|
* @verbatim
|
* let op = [](auto l, auto r){ return l + "|" + r; }
|
* let [first, last[ = list<string>{"1", "2", "3"}
|
* then join(first, last, op) == "1|2|3"
|
* @endverbatim
|
*/
|
template <class T, class InputIt, class BinaryOperation>
|
T join(InputIt first, InputIt last, BinaryOperation op, T empty = T{})
|
{
|
if (first == last) {
|
return empty;
|
}
|
auto init = *first++;
|
|
return std::accumulate(first, last, init, op);
|
}
|
|
/**
|
* Format the items of a sequence container of strings into a string.
|
*
|
* @tparam Sequence the string sequence container (e.g. list or vector)
|
* @param[in] lstr A list of strings
|
* @param[in] separator The separator to use between each item
|
*
|
* @return the concatenated elements.
|
*/
|
template <class Sequence>
|
std::string asString(const Sequence &lstr, const std::string &separator = "\n")
|
{
|
static_assert(std::is_same<typename Sequence::value_type, std::string>::value,
|
"asString called on a sequence container that does not contains strings");
|
|
return join<std::string>(
|
begin(lstr), end(lstr),
|
[separator](std::string acc, std::string right) { return acc + separator + right; });
|
}
|
|
/**
|
* Format the items of a map into a string as a list of key-value pairs. The map must be
|
* composed of pairs of strings.
|
*
|
* @param[in] mapStr A map of strings
|
* @param[in] strItemSeparator The separator to use between each item (key-value pair)
|
* @param[in] strKeyValueSeparator The separator to use between key and value
|
*
|
* @returns the pretty-printed map
|
*/
|
std::string asString(const std::map<std::string, std::string> &mapStr,
|
const std::string &strItemSeparator = ", ",
|
const std::string &strKeyValueSeparator = ":");
|
|
/** Utility to underline */
|
void appendTitle(std::string &strTo, const std::string &strTitle);
|
|
/**
|
* Checks if a string has the written representation of an hexadecimal
|
* number (Which is the prefix "0x" or "0X" in C++).
|
*
|
* @param[in] strValue value as string
|
*
|
* @return true if the string is written as hexa, false otherwise.
|
*/
|
bool isHexadecimal(const std::string &strValue);
|
|
} // namespace utility
|
