TextFile.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-2018.
//
// 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: Chris Bielow $
// $Authors: Marc Sturm, Chris Bielow $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/DATASTRUCTURES/StringListUtils.h>

namespace OpenMS
{
  class OPENMS_DLLAPI TextFile
  {

public:
    typedef std::vector<String>::iterator Iterator;
    typedef std::vector<String>::const_iterator ConstIterator;
    typedef std::vector<String>::reverse_iterator ReverseIterator;
    typedef std::vector<String>::const_reverse_iterator ConstReverseIterator;


    TextFile();

    virtual ~TextFile();

    TextFile(const String& filename, bool trim_lines = false, Int first_n = -1, bool skip_empty_lines = false);

    void load(const String& filename, bool trim_lines = false, Int first_n = -1, bool skip_empty_lines = false);

    void store(const String& filename);

    template <typename StringType>
    TextFile& operator<<(const StringType& string)
    {
      buffer_.push_back(static_cast<String>(string));
      return *this;
    }

    template <typename StringType>
    void addLine(const StringType& line)
    {
      buffer_.push_back(static_cast<String>(line));
    }

    ConstIterator begin() const;

    Iterator begin();
    ConstIterator end() const;

    Iterator end();

protected:
    std::vector<String> buffer_;
  };

} // namespace OpenMS