2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2015,2016,2017,2018,2019,2021, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
37 * Implements gmx::TextWriter.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
44 #include "textwriter.h"
48 #include "gromacs/utility/filestream.h"
49 #include "gromacs/utility/nodelete.h"
50 #include "gromacs/utility/stringutil.h"
51 #include "gromacs/utility/textstream.h"
56 class TextWriter::Impl
59 explicit Impl(const TextOutputStreamPointer& stream) :
60 stream_(stream), newLineCount_(2), currentLineLength_(0), pendingNewLine_(false)
62 wrapper_.settings().setKeepFinalSpaces(true);
65 void writeRawString(const char* str)
67 if (pendingNewLine_ && str[0] != '\n')
71 pendingNewLine_ = false;
72 const char* lastNewLine = std::strrchr(str, '\n');
73 if (lastNewLine == nullptr)
76 currentLineLength_ += std::strlen(str);
78 else if (lastNewLine[1] != '\0')
81 currentLineLength_ += std::strlen(lastNewLine + 1);
85 currentLineLength_ = 0;
87 while (lastNewLine >= str && *lastNewLine == '\n')
92 if (lastNewLine >= str)
96 newLineCount_ += newLineCount;
100 void writeRawString(const std::string& str) { writeRawString(str.c_str()); }
102 void writeWrappedString(const std::string& str)
104 if (newLineCount_ > 0)
106 writeRawString(wrapper_.wrapToString(str));
114 TextOutputStreamPointer stream_;
115 TextLineWrapper wrapper_;
117 int currentLineLength_;
118 bool pendingNewLine_;
122 void TextWriter::writeFileFromString(const std::string& filename, const std::string& text)
124 TextWriter file(filename);
125 file.writeString(text);
129 TextWriter::TextWriter(const std::string& filename) :
130 impl_(new Impl(TextOutputStreamPointer(new TextOutputFile(filename))))
134 TextWriter::TextWriter(FILE* fp) : impl_(new Impl(TextOutputStreamPointer(new TextOutputFile(fp))))
138 TextWriter::TextWriter(TextOutputStream* stream) :
139 impl_(new Impl(TextOutputStreamPointer(stream, no_delete<TextOutputStream>())))
143 TextWriter::TextWriter(const TextOutputStreamPointer& stream) : impl_(new Impl(stream)) {}
145 TextWriter::~TextWriter() {}
147 TextLineWrapperSettings& TextWriter::wrapperSettings()
149 return impl_->wrapper_.settings();
152 void TextWriter::writeString(const char* str)
154 if (impl_->wrapper_.isTrivial())
156 impl_->writeRawString(str);
160 impl_->writeWrappedString(str);
164 void TextWriter::writeString(const std::string& str)
166 impl_->writeWrappedString(str);
169 void TextWriter::writeStringFormatted(const char* fmt, ...)
174 writeString(formatStringV(fmt, ap));
178 void TextWriter::writeLine(const char* line)
184 void TextWriter::writeLine(const std::string& line)
190 void TextWriter::writeLineFormatted(const char* fmt, ...)
195 writeString(formatStringV(fmt, ap));
200 void TextWriter::writeLine()
202 impl_->writeRawString("\n");
205 void TextWriter::ensureLineBreak()
207 if (impl_->newLineCount_ == 0)
209 impl_->writeRawString("\n");
213 void TextWriter::ensureEmptyLine()
216 if (impl_->newLineCount_ < 2)
218 impl_->pendingNewLine_ = true;
222 void TextWriter::close()
224 impl_->stream_->close();