| OpenMS 2.5.0

TextFile.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Chris Bielow $
32 // $Authors: Marc Sturm, Chris Bielow $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/StringListUtils.h>
38
39 namespace OpenMS
40 {
46 class OPENMS_DLLAPI TextFile
47 {
48
49 public:
53 typedef std::vector<String>::iterator Iterator;
56 typedef std::vector<String>::const_iterator ConstIterator;
58 typedef std::vector<String>::reverse_iterator ReverseIterator;
60 typedef std::vector<String>::const_reverse_iterator ConstReverseIterator;
62
63
65 TextFile();
66
68 virtual ~TextFile();
69
80 TextFile(const String& filename, bool trim_lines = false, Int first_n = -1, bool skip_empty_lines = false);
81
92 void load(const String& filename, bool trim_lines = false, Int first_n = -1, bool skip_empty_lines = false);
93
101 void store(const String& filename);
102
104 template <typename StringType>
105 TextFile& operator<<(const StringType& string)
106 {
107 buffer_.push_back(static_cast<String>(string));
108 return *this;
109 }
110
111 template <typename StringType>
112 void addLine(const StringType& line)
113 {
114 buffer_.push_back(static_cast<String>(line));
115 }
116
123 static std::istream& getLine(std::istream& is, std::string& t);
124
128 ConstIterator begin() const;
129
130 Iterator begin();
134 ConstIterator end() const;
135
136 Iterator end();
137
138 protected:
140 std::vector<String> buffer_;
141 };
142
143 } // namespace OpenMS
144
OpenMS::TextFile::addLine
void addLine(const StringType &line)
Definition: TextFile.h:112
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::TextFile::ConstIterator
std::vector< String >::const_iterator ConstIterator
Non-mutable iterator.
Definition: TextFile.h:56
Iterator
StringListUtils.h
OpenMS::TextFile::buffer_
std::vector< String > buffer_
Internal buffer storing the lines before writing them to the file.
Definition: TextFile.h:140
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::TextFile::Iterator
std::vector< String >::iterator Iterator
Mutable iterator.
Definition: TextFile.h:54
int
OpenMS::TextFile::ConstReverseIterator
std::vector< String >::const_reverse_iterator ConstReverseIterator
Non-mutable reverse iterator.
Definition: TextFile.h:60
OpenMS::TextFile::operator<<
TextFile & operator<<(const StringType &string)
Operator for appending entries with less code.
Definition: TextFile.h:105
OpenMS::TextFile
This class provides some basic file handling methods for text files.
Definition: TextFile.h:46
OpenMS::TextFile::ReverseIterator
std::vector< String >::reverse_iterator ReverseIterator
Mutable reverse iterator.
Definition: TextFile.h:58