String.h

Go to the documentation of this file.

#ifndef OSMSCOUT_UTIL_STRING_H
#define OSMSCOUT_UTIL_STRING_H
 
/*
  This source is part of the libosmscout library
  Copyright (C) 2009  Tim Teulings
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library 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.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/
 
#include <limits>
#include <list>
#include <memory>
#include <string>
#include <chrono>
#include <optional>
#include <utility>
 
#include <osmscout/lib/CoreFeatures.h>
#include <osmscout/lib/CoreImportExport.h>
 
#include <osmscout/system/Assert.h>
 
#include <osmscout/util/Time.h>
#include <osmscout/util/Locale.h>
 
#include <osmscout/OSMScoutTypes.h>
 
namespace osmscout {


  extern OSMSCOUT_API bool StringToBool(const char* string, bool& value);

  extern OSMSCOUT_API const char* BoolToString(bool value);

  extern OSMSCOUT_API std::string NumberToString(long value, const Locale &locale);

  extern OSMSCOUT_API std::string FloatToString(double value, const Locale &locale, uint32_t precision = 3);

  extern OSMSCOUT_API bool GetDigitValue(char digit,
                                         size_t& result);
 
  template<typename N>
  size_t NumberDigits(const N& number,
                      size_t base=10)
  {
    N      value(number);
    size_t res=0;
 
    if (std::numeric_limits<N>::is_signed) {
      if (value<0) {
        res++;
      }
    }
 
    while (value!=0) {
      res++;
      value=value/(N)base;
    }
 
    return res;
  }
 
  template<typename N>
  bool StringToNumberSigned(const std::string& string,
                            N& number,
                            size_t base=10)
  {
    assert(base<=16);
 
    std::string::size_type pos=0;
    bool                   minus=false;
 
    number=0;
 
    if (string.empty()) {
      return false;
    }
 
    /*
      Special handling for the first symbol/digit (could be negative)
      */
    if (base==10 && string[0]=='-') {
      minus=true;
      pos=1;
    }
    else {
      size_t digitValue;
 
      if (!GetDigitValue(string[pos],
                         digitValue)) {
        return false;
      }
 
      if (digitValue>=base) {
        return false;
      }
 
      /*
        For signed values with base!=10 we assume a negative value
      */
      if (digitValue==base-1 &&
          string.length()==NumberDigits(std::numeric_limits<N>::max())) {
        minus=true;
        number=(N)(base/2);
      }
      else {
        number=(N)digitValue;
      }
 
      pos=1;
    }
 
    while (pos<string.length()) {
      size_t digitValue;
 
      if (!GetDigitValue(string[pos],digitValue)) {
        return false;
      }
 
      if (digitValue>=base) {
        return false;
      }
 
      if (std::numeric_limits<N>::max()/(N)base-(N)digitValue<number) {
        return false;
      }
 
      number=(N)(number*base+digitValue);
 
      pos++;
    }
 
    if (minus) {
      number=-number;
    }
 
    return true;
  }
 
  template<typename N>
  bool StringToNumberUnsigned(const std::string& string,
                              N& number,
                              size_t base=10)
  {
    assert(base<=16);
 
    std::string::size_type pos=0;
 
    number=0;
 
    if (string.empty()) {
      return false;
    }
 
    if (string[0]=='-') {
      return false;
    }
 
    /*
      Special handling for the first symbol/digit (could be negative)
      */
    size_t digitValue;
 
    if (!GetDigitValue(string[pos],digitValue)) {
      return false;
    }
 
    if (digitValue>=base) {
      return false;
    }
 
    number=(N)digitValue;
 
    pos=1;
 
    while (pos<string.length()) {
      size_t digitValue;
 
      if (!GetDigitValue(string[pos],
                         digitValue)) {
        return false;
      }
 
      if (digitValue>=base) {
        return false;
      }
 
      if (std::numeric_limits<N>::max()/(N)base-(N)digitValue<number) {
        return false;
      }
 
      number=(N)(number*base+digitValue);
 
      pos++;
    }
 
    return true;
  }
 
  template<bool is_signed, typename N>
  struct StringToNumberTemplated
  {
  };
 
  template<typename N>
  struct StringToNumberTemplated<true, N>
  {
    static inline bool f(const std::string& string,
                                 N& number,
                                 size_t base=10)
    {
      return StringToNumberSigned<N>(string,number,base);
    }
  };
 
  template<typename N>
  struct StringToNumberTemplated<false, N>
  {
    static inline bool f(const std::string& string,
                                 N& number,
                                 size_t base=10)
    {
      return StringToNumberUnsigned<N>(string,number,base);
    }
  };

  template<typename N>
  inline bool StringToNumber(const std::string& string,
                             N& number,
                             size_t base=10)
  {
    return StringToNumberTemplated<std::numeric_limits<N>::is_signed, N>
      ::f(string,number,base);
  }

  extern OSMSCOUT_API bool StringToNumber(const char* string, double& value);

  extern OSMSCOUT_API bool StringToNumber(const std::string& string, double& value);

 
  extern OSMSCOUT_API size_t CountWords(const std::string& text);

  extern OSMSCOUT_API std::list<std::string> SplitStringAtSpace(const std::string& input);

  extern OSMSCOUT_API std::list<std::string> SplitString(const std::string& stringList,
                                                         const std::string& separator,
                                                         int maxSize=-1);

  extern OSMSCOUT_API std::string ReplaceString(const std::string &in,
                                                const std::string &search,
                                                const std::string &replacement);

  extern OSMSCOUT_API std::optional<std::pair<std::string,std::string>> SplitStringToPair(const std::string& str,
                                                                                          const std::string& separator);

  extern OSMSCOUT_API std::string GetFirstInStringList(const std::string& stringList,
                                                       const std::string& divider);

  extern OSMSCOUT_API void TokenizeString(const std::string& input,
                                          std::list<std::string>& tokens);

  extern OSMSCOUT_API void SimplifyTokenList(std::list<std::string>& tokens);
 
  extern OSMSCOUT_API std::string GetTokensFromStart(const std::list<std::string>& tokens,
                                                    size_t count);
 
  extern OSMSCOUT_API std::string GetTokensFromEnd(const std::list<std::string>& tokens,
                                                   size_t count);

  extern OSMSCOUT_API void GroupStringListToStrings(std::list<std::string>::const_iterator token,
                                                    size_t listSize,
                                                    size_t parts,
                                                    std::list<std::list<std::string> >& lists);
 

  extern OSMSCOUT_API std::string ByteSizeToString(FileOffset size, const Locale &locale = Locale::ByEnvironmentSafe());
  extern OSMSCOUT_API std::string ByteSizeToString(double size, const Locale &locale = Locale::ByEnvironmentSafe());

  extern OSMSCOUT_API std::wstring LocaleStringToWString(const std::string& text);

  extern OSMSCOUT_API std::string WStringToLocaleString(const std::wstring& text);

  extern OSMSCOUT_API std::wstring UTF8StringToWString(const std::string& text);

  extern OSMSCOUT_API std::u32string UTF8StringToU32String(const std::string& text);

  extern OSMSCOUT_API std::string WStringToUTF8String(const std::wstring& text);

  extern OSMSCOUT_API std::string LocaleStringToUTF8String(const std::string& text);

  extern OSMSCOUT_API std::string UTF8StringToLocaleString(const std::string& text);

  extern OSMSCOUT_API std::string UTF8StringToUpper(const std::string& text);

  extern OSMSCOUT_API std::string UTF8StringToLower(const std::string& text);

  extern OSMSCOUT_API std::string UTF8NormForLookup(const std::string& text);

  extern OSMSCOUT_API std::string UTF8Transliterate(const std::string& text);

  extern OSMSCOUT_API bool ParseISO8601TimeString(const std::string &timeStr, Timestamp &timestamp);

  extern OSMSCOUT_API std::string TimestampToISO8601TimeString(const Timestamp &timestamp);
 
  extern OSMSCOUT_API std::string DurationString(const Duration &duration);

  extern OSMSCOUT_API std::string Trim(const std::string &str, char trimmedChar=' ');
}
 
#endif