String.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * 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.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// 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 ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS 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.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/OpenMSConfig.h>

#include <string>
#include <cstring>
#include <vector>

class QString;

namespace OpenMS
{
  class DataValue;
  template <typename FloatingPointType>
  struct PrecisionWrapper;
  class String :
    public std::string
  {
public:

    OPENMS_DLLAPI static const String EMPTY;

    typedef iterator    Iterator;
    typedef const_iterator  ConstIterator;
    typedef reverse_iterator    ReverseIterator;
    typedef const_reverse_iterator  ConstReverseIterator;
    typedef size_type   SizeType;

    enum QuotingMethod {NONE, ESCAPE, DOUBLE};


    OPENMS_DLLAPI String();
    OPENMS_DLLAPI String(const String&) = default;
    OPENMS_DLLAPI String(String&&) = default;
    OPENMS_DLLAPI String(const std::string& s);
    OPENMS_DLLAPI String(const std::string_view& sv);
    OPENMS_DLLAPI String(const QString& s);
    OPENMS_DLLAPI String(const char* s);
    OPENMS_DLLAPI String(const char c);
    OPENMS_DLLAPI String(const char* s, SizeType length);
    OPENMS_DLLAPI String(size_t len, char c);
    template <class InputIterator>
    String(InputIterator first, InputIterator last) :
      std::string(first, last)
    {
    }

    OPENMS_DLLAPI String(int i);
    OPENMS_DLLAPI String(unsigned int i);
    OPENMS_DLLAPI String(short int i);
    OPENMS_DLLAPI String(short unsigned int i);
    OPENMS_DLLAPI String(long int i);
    OPENMS_DLLAPI String(long unsigned int i);
    OPENMS_DLLAPI String(long long unsigned int i);
    OPENMS_DLLAPI String(long long signed int i);
    OPENMS_DLLAPI String(float f, bool full_precision = true);
    OPENMS_DLLAPI String(double d, bool full_precision = true);
    OPENMS_DLLAPI String(long double ld, bool full_precision = true);
    OPENMS_DLLAPI String(const DataValue& d, bool full_precision = true);


    OPENMS_DLLAPI bool hasPrefix(const String& string) const;

    OPENMS_DLLAPI bool hasSuffix(const String& string) const;

    OPENMS_DLLAPI bool hasSubstring(const String& string) const;

    OPENMS_DLLAPI bool has(Byte byte) const;

    OPENMS_DLLAPI String& operator=(const String&) = default;
    OPENMS_DLLAPI String& operator=(String&&) & = default;

    OPENMS_DLLAPI String prefix(SizeType length) const;

    OPENMS_DLLAPI String suffix(SizeType length) const;

    OPENMS_DLLAPI String prefix(Int length) const;

    OPENMS_DLLAPI String suffix(Int length) const;

    OPENMS_DLLAPI String prefix(char delim) const;

    OPENMS_DLLAPI String suffix(char delim) const;

    OPENMS_DLLAPI String substr(size_t pos = 0, size_t n = npos) const;

    OPENMS_DLLAPI String chop(Size n) const;



    OPENMS_DLLAPI String& reverse();

    OPENMS_DLLAPI String& trim();

    OPENMS_DLLAPI bool isQuoted(char q = '"');

    OPENMS_DLLAPI String& quote(char q = '"', QuotingMethod method = ESCAPE);

    OPENMS_DLLAPI String& unquote(char q = '"', QuotingMethod method = ESCAPE);

    OPENMS_DLLAPI String& simplify();

    OPENMS_DLLAPI String& fillLeft(char c, UInt size);

    OPENMS_DLLAPI String& fillRight(char c, UInt size);

    OPENMS_DLLAPI String& toUpper();

    OPENMS_DLLAPI String& toLower();

    OPENMS_DLLAPI String& firstToUpper();

    OPENMS_DLLAPI String& substitute(char from, char to);

    OPENMS_DLLAPI String& substitute(const String& from, const String& to);

    OPENMS_DLLAPI String& remove(char what);

    OPENMS_DLLAPI String& ensureLastChar(char end);

    OPENMS_DLLAPI String& removeWhitespaces();


    OPENMS_DLLAPI Int toInt() const;

    OPENMS_DLLAPI float toFloat() const;

    OPENMS_DLLAPI double toDouble() const;

    OPENMS_DLLAPI QString toQString() const;


    OPENMS_DLLAPI String operator+(int i) const;
    OPENMS_DLLAPI String operator+(unsigned int i) const;
    OPENMS_DLLAPI String operator+(short int i) const;
    OPENMS_DLLAPI String operator+(short unsigned int i) const;
    OPENMS_DLLAPI String operator+(long int i) const;
    OPENMS_DLLAPI String operator+(long unsigned int i) const;
    OPENMS_DLLAPI String operator+(long long unsigned int i) const;
    OPENMS_DLLAPI String operator+(float f) const;
    OPENMS_DLLAPI String operator+(double d) const;
    OPENMS_DLLAPI String operator+(long double ld) const;
    OPENMS_DLLAPI String operator+(char c) const;
    OPENMS_DLLAPI String operator+(const char* s) const;
    OPENMS_DLLAPI String operator+(const String& s) const;
    OPENMS_DLLAPI String operator+(const std::string& s) const;

    OPENMS_DLLAPI String& operator+=(int i);
    OPENMS_DLLAPI String& operator+=(unsigned int i);
    OPENMS_DLLAPI String& operator+=(short int i);
    OPENMS_DLLAPI String& operator+=(short unsigned int i);
    OPENMS_DLLAPI String& operator+=(long int i);
    OPENMS_DLLAPI String& operator+=(long unsigned int i);
    OPENMS_DLLAPI String& operator+=(long long unsigned int i);
    OPENMS_DLLAPI String& operator+=(float f);
    OPENMS_DLLAPI String& operator+=(double d);
    OPENMS_DLLAPI String& operator+=(long double d);
    OPENMS_DLLAPI String& operator+=(char c);
    OPENMS_DLLAPI String& operator+=(const char* s);
    OPENMS_DLLAPI String& operator+=(const String& s);
    OPENMS_DLLAPI String& operator+=(const std::string& s);

    OPENMS_DLLAPI static String random(UInt length);

    OPENMS_DLLAPI static String number(double d, UInt n);

    OPENMS_DLLAPI static String numberLength(double d, UInt n);

    OPENMS_DLLAPI bool split(const char splitter, std::vector<String>& substrings, bool quote_protect = false) const;

    OPENMS_DLLAPI bool split(const String& splitter, std::vector<String>& substrings) const;

    OPENMS_DLLAPI bool split_quoted(const String& splitter, std::vector<String>& substrings,
                                    char q = '"', QuotingMethod method = ESCAPE) const;

    template <class StringIterator>
    void concatenate(StringIterator first, StringIterator last, const String& glue = "")
    {
      //empty container
      if (first == last)
      {
        std::string::clear();
        return;
      }

      std::string::operator=(*first);
      for (StringIterator it = ++first; it != last; ++it)
      {
        std::string::operator+=(glue + (*it));
      }
    }
  };
  OPENMS_DLLAPI ::size_t hash_value(OpenMS::String const& s);
} // namespace OpenMS

namespace std
{
  template <> struct hash<OpenMS::String> //hash for String
  {
    std::size_t operator()( OpenMS::String const& s) const
    {
      return std::hash<string>()(static_cast<string>(s));
    }
  };
} // namespace std