4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// Automated Testing Framework (atf)
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// Copyright (c) 2007 The NetBSD Foundation, Inc.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// All rights reserved.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// Redistribution and use in source and binary forms, with or without
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// modification, are permitted provided that the following conditions
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// are met:
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// 1. Redistributions of source code must retain the above copyright
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// notice, this list of conditions and the following disclaimer.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// 2. Redistributions in binary form must reproduce the above copyright
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// notice, this list of conditions and the following disclaimer in the
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// documentation and/or other materials provided with the distribution.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews// IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#if !defined(TOOLS_TEXT_HPP)
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#define TOOLS_TEXT_HPP
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsextern "C" {
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#include <stdint.h>
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews}
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#include <sstream>
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#include <stdexcept>
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#include <string>
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#include <vector>
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsnamespace tools {
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsnamespace text {
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Duplicates a C string using the new[] allocator.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! Replaces the functionality of strdup by using the new[] allocator and
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! thus allowing the resulting memory to be managed by utils::auto_array.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewschar* duplicate(const char*);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Joins multiple words into a string.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! Joins a list of words into a string, separating them using the provided
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! separator. Empty words are not omitted.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewstemplate< class T >
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsstd::string
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsjoin(const T& words, const std::string& separator)
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews{
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews std::string str;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews typename T::const_iterator iter = words.begin();
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews bool done = iter == words.end();
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews while (!done) {
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews str += *iter;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews iter++;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews if (iter != words.end())
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews str += separator;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews else
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews done = true;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews }
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews return str;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews}
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Checks if the string matches a regular expression.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsbool match(const std::string&, const std::string&);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Splits a string into words.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! Splits the given string into multiple words, all separated by the
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! given delimiter. Multiple occurrences of the same delimiter are
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! not condensed so that rejoining the words later on using the same
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! delimiter results in the original string.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsstd::vector< std::string > split(const std::string&, const std::string&);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Removes whitespace from the beginning and end of a string.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsstd::string trim(const std::string&);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Converts a string to a boolean value.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsbool to_bool(const std::string&);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Converts the given string to a bytes size.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsint64_t to_bytes(std::string);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Changes the case of a string to lowercase.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! Returns a new string that is a lowercased version of the original
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! one.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsstd::string to_lower(const std::string&);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Converts the given object to a string.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! Returns a string with the representation of the given object. There
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! must exist an operator<< method for that object.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewstemplate< class T >
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsstd::string
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsto_string(const T& ob)
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews{
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews std::ostringstream ss;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews ss << ob;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews return ss.str();
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews}
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! \brief Converts the given string to another type.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! Attempts to convert the given string to the requested type. Throws
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//! an exception if the conversion failed.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews//!
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewstemplate< class T >
4a53e3c2b83c476a93148eaee0272649beb221caMark AndrewsT
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsto_type(const std::string& str)
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews{
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews std::istringstream ss(str);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews T value;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews ss >> value;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews if (!ss.eof() || (ss.eof() && (ss.fail() || ss.bad())))
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews throw std::runtime_error("Cannot convert string to requested type");
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews return value;
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews}
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews} // namespace text
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews} // namespace tools
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#endif // !defined(TOOLS_TEXT_HPP)