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/textstream.h"
  51
  52 namespace gmx
  53 {
  54
  55 class TextWriter::Impl
  56 {
  57     public:
  58         explicit Impl(const TextOutputStreamPointer &stream)
  59             : stream_(stream)
  60         {
  61         }
  62
  63         TextOutputStreamPointer stream_;
  64 };
  65
  66 // static
  67 void TextWriter::writeFileFromString(const std::string &filename,
  68                                      const std::string &text)
  69 {
  70     TextWriter file(filename);
  71     file.writeString(text);
  72     file.close();
  73 }
  74
  75 TextWriter::TextWriter(const std::string &filename)
  76     : impl_(new Impl(TextOutputStreamPointer(new TextOutputFile(filename))))
  77 {
  78 }
  79
  80 TextWriter::TextWriter(FILE *fp)
  81     : impl_(new Impl(TextOutputStreamPointer(new TextOutputFile(fp))))
  82 {
  83 }
  84
  85 TextWriter::TextWriter(TextOutputStream *stream)
  86     : impl_(new Impl(TextOutputStreamPointer(stream, no_delete<TextOutputStream>())))
  87 {
  88 }
  89
  90 TextWriter::TextWriter(const TextOutputStreamPointer &stream)
  91     : impl_(new Impl(stream))
  92 {
  93 }
  94
  95 TextWriter::~TextWriter()
  96 {
  97 }
  98
  99 TextOutputStream &TextWriter::stream()
 100 {
 101     return *impl_->stream_;
 102 }
 103
 104 void TextWriter::writeString(const char *str)
 105 {
 106     impl_->stream_->write(str);
 107 }
 108
 109 void TextWriter::writeString(const std::string &str)
 110 {
 111     impl_->stream_->write(str.c_str());
 112 }
 113
 114 void TextWriter::writeLine(const char *line)
 115 {
 116     const size_t length = std::strlen(line);
 117     writeString(line);
 118     if (length == 0 || line[length-1] != '\n')
 119     {
 120         writeLine();
 121     }
 122 }
 123
 124 void TextWriter::writeLine(const std::string &line)
 125 {
 126     writeLine(line.c_str());
 127 }
 128
 129 void TextWriter::writeLine()
 130 {
 131     writeString("\n");
 132 }
 133
 134 void TextWriter::close()
 135 {
 136     impl_->stream_->close();
 137 }
 138
 139 } // namespace gmx