StringList.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-2012.
//
// 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: Stephan Aiche$
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------

#ifndef OPENMS_DATASTRUCTURES_STRINGLIST_H
#define OPENMS_DATASTRUCTURES_STRINGLIST_H

#include <OpenMS/DATASTRUCTURES/String.h>

#ifdef OPENMS_COMPILER_MSVC
#pragma warning( push )
#pragma warning( disable : 4251 )     // disable MSVC dll-interface warning
#endif

class QStringList;

namespace OpenMS
{
  class OPENMS_DLLAPI StringList :
    public std::vector<String>
  {
public:


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



    StringList();
    StringList(const StringList & rhs);
    StringList(const std::vector<String> & rhs);
    StringList(const std::vector<std::string> & rhs);
    StringList(const QStringList & rhs);
    StringList & operator=(const StringList & rhs);
    StringList & operator=(const std::vector<String> & rhs);
    StringList & operator=(const std::vector<std::string> & rhs);



    Iterator search(const Iterator & start, const String & text, bool trim = false);

    Iterator search(const String & text, bool trim = false);

    Iterator searchSuffix(const Iterator & start, const String & text, bool trim = false);

    Iterator searchSuffix(const String & text, bool trim = false);

    ConstIterator search(const ConstIterator & start, const String & text, bool trim = false) const;

    ConstIterator search(const String & text, bool trim = false) const;

    ConstIterator searchSuffix(const ConstIterator & start, const String & text, bool trim = false) const;

    ConstIterator searchSuffix(const String & text, bool trim = false) const;

    template <typename StringType>
    StringList & operator<<(const StringType & string)
    {
      this->push_back(string);
      return *this;
    }

    static StringList create(const String & list, const char splitter = ',');
    static StringList create(const char * const * list, UInt size);
    bool contains(const String & s) const;
    void toUpper();
    void toLower();

    String concatenate(const String & glue = "") const;

    friend OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const StringList & p);

  };

} // namespace OPENMS

#ifdef OPENMS_COMPILER_MSVC
#pragma warning( pop )
#endif

#endif // OPENMS_DATASTRUCTURES_STRINGLIST_H