string_util.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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 Lesser General Public License for more details.
 */
 
#ifndef __H__COMMON_STRING_UTIL__
#define __H__COMMON_STRING_UTIL__
 
#include <string>
#include <vector>
#include <algorithm> 
#include <sstream>
#include <cctype>
#include <cstdio>
#include <string>
#include <cassert>
 
#include "hash_function.h"
#include "common/ug_config.h"
#include "stringify.h"
 
namespace ug{
 
UG_API void TokenizeString( const std::string& str, std::vector<std::string>& vToken, 
                            const char delimiter=',' );
 
UG_API std::vector<std::string> TokenizeString( const std::string& str,
                                                const char delimiter=',' );
 
UG_API std::vector<std::string> TokenizeString( const char* str,
                                                const char delimiter=',' );
 
UG_API void TokenizeTrimString(const std::string& str, std::vector<std::string>& vToken,
                 const char delimiter=',');
 
UG_API std::vector<std::string> TokenizeTrimString( const std::string& str, 
                                                    const char delimiter=',' );
 
UG_API void RemoveWhitespaceFromString(std::string& string);
 
UG_API std::string TrimString(const std::string& str);
 
UG_API std::string SnipString(const std::string& str, size_t totalSize,
                              size_t replaceLast = 0, const char replace = '.');
 
UG_API std::string SnipStringFront(const std::string& str, size_t totalSize,
                                   size_t replaceFront = 0, const char replace = '.');
 
UG_API int NumberOfDigits(int n);
 
UG_API void AppendCounterToString( std::string& str, std::string indicator,
                                   int counter, int maxCounter=-1 );
 
UG_API std::string AppendSpacesToString(std::string& str, int totalLength);
 
template <> UG_API size_t hash_key(const std::string& str);
 
std::string::size_type GetDirectorySeperatorPos(const std::string &str);
 
UG_API std::string FilenameWithoutPath(const std::string &str);
 
UG_API std::string PathFromFilename(const std::string &str);
 
UG_API std::string FilenameWithoutExtension(std::string str);
 
UG_API std::string FilenameAndPathWithoutExtension(std::string str);
 
UG_API std::string GetFilenameExtension(const std::string &str);
 
UG_API std::string ReplaceAll( std::string target, const std::string& oldstr, 
                               const std::string& newstr );
 
UG_API bool StartsWith(const std::string& str, const std::string& search);
 
UG_API bool Contains(const std::string& str, const std::string& search);
 
UG_API std::string ToLower(std::string str);
 
UG_API std::string ToUpper(std::string str);
 
UG_API std::vector<std::string> FindDuplicates(const std::vector<std::string>& vec);
 
UG_API std::string repeat(char c, int nr);
 
UG_API size_t LevenshteinDistance( const std::string& s1, const std::string& s2 );
 
 
UG_API std::string GetFileLines( const char *filename, size_t fromline, size_t toline, 
                                 bool includeLineNumbers );
 
UG_API std::string GetFileLine(const char *filename, size_t line);
 
UG_API bool IsLonger(const std::string &a, const std::string &b);
 
 
template<typename T>
inline std::string ToString(const T &t)
{
    std::stringstream out;
    out << t;
    return out.str();
}
 
UG_API std::string XMLStringEscape(std::string s);
 
UG_API bool WildcardMatch(const char *str, const char *pattern);
 
UG_API std::string XMLStringEscape(std::string s);
 
// end group ugbase_common_util_strings
 
UG_API std::string ConfigShift(std::string s);
 
template<typename T>
inline std::string OstreamShift(const T &t)
{
  std::stringstream ss; ss << t;
  return ConfigShift(ss.str());
}
 
std::string GetBytesSizeString(size_t s, int length=0);
 
inline const char *TrueFalseString(bool b)
{
  return b ? "TRUE" : "FALSE";
}
 
inline const char *OnOffString(bool b)
{
  return b ? "ON" : "OFF";
}
 
 
template< typename... Args >
inline std::string GetStringPrintf( const char* format, Args... args )
{
  int length = std::snprintf( nullptr, 0, format, args... );
  assert( length >= 0 );
 
  char* buf = new char[length + 1];
  std::snprintf( buf, length + 1, format, args... );
 
  std::string str( buf );
  delete[] buf;
  return str;
}
 
} // end namespace ug
 
#endif /*__H__COMMON_STRING_UTIL__*/