src/gromacs/utility/textwriter.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015, 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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements gmx::TextWriter.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "textwriter.h"
  45
  46 #include <cstring>
  47
  48 #include "gromacs/utility/filestream.h"
  49 #include "gromacs/utility/nodelete.h"
  50 #include "gromacs/utility/stringutil.h"
  51 #include "gromacs/utility/textstream.h"
  52
  53 namespace gmx
  54 {
  55
  56 class TextWriter::Impl
  57 {
  58     public:
  59         explicit Impl(const TextOutputStreamPointer &stream)
  60             : stream_(stream)
  61         {
  62             wrapper_.settings().setKeepFinalSpaces(true);
  63         }
  64
  65         void writeWrappedString(const std::string &str)
  66         {
  67             stream_->write(wrapper_.wrapToString(str).c_str());
  68         }
  69
  70         TextOutputStreamPointer stream_;
  71         TextLineWrapper         wrapper_;
  72 };
  73
  74 // static
  75 void TextWriter::writeFileFromString(const std::string &filename,
  76                                      const std::string &text)
  77 {
  78     TextWriter file(filename);
  79     file.writeString(text);
  80     file.close();
  81 }
  82
  83 TextWriter::TextWriter(const std::string &filename)
  84     : impl_(new Impl(TextOutputStreamPointer(new TextOutputFile(filename))))
  85 {
  86 }
  87
  88 TextWriter::TextWriter(FILE *fp)
  89     : impl_(new Impl(TextOutputStreamPointer(new TextOutputFile(fp))))
  90 {
  91 }
  92
  93 TextWriter::TextWriter(TextOutputStream *stream)
  94     : impl_(new Impl(TextOutputStreamPointer(stream, no_delete<TextOutputStream>())))
  95 {
  96 }
  97
  98 TextWriter::TextWriter(const TextOutputStreamPointer &stream)
  99     : impl_(new Impl(stream))
 100 {
 101 }
 102
 103 TextWriter::~TextWriter()
 104 {
 105 }
 106
 107 TextOutputStream &TextWriter::stream()
 108 {
 109     return *impl_->stream_;
 110 }
 111
 112 TextLineWrapperSettings &TextWriter::wrapperSettings()
 113 {
 114     return impl_->wrapper_.settings();
 115 }
 116
 117 void TextWriter::writeString(const char *str)
 118 {
 119     if (impl_->wrapper_.isTrivial())
 120     {
 121         impl_->stream_->write(str);
 122     }
 123     else
 124     {
 125         impl_->writeWrappedString(str);
 126     }
 127 }
 128
 129 void TextWriter::writeString(const std::string &str)
 130 {
 131     impl_->writeWrappedString(str);
 132 }
 133
 134 void TextWriter::writeLine(const char *line)
 135 {
 136     writeString(line);
 137     if (!endsWith(line, "\n"))
 138     {
 139         writeLine();
 140     }
 141 }
 142
 143 void TextWriter::writeLine(const std::string &line)
 144 {
 145     writeString(line);
 146     if (!endsWith(line, "\n"))
 147     {
 148         writeLine();
 149     }
 150 }
 151
 152 void TextWriter::writeLine()
 153 {
 154     writeString("\n");
 155 }
 156
 157 void TextWriter::close()
 158 {
 159     impl_->stream_->close();
 160 }
 161
 162 } // namespace gmx