src/gromacs/mdrunutility/logging.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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 /*! \libinternal \file
  36  *
  37  * \brief Declares the MD log file handling routines.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_mdrunutility
  42  */
  43 #ifndef GMX_MDRUNUTILITY_LOGGING_H
  44 #define GMX_MDRUNUTILITY_LOGGING_H
  45
  46 #include <memory>
  47
  48 #include "gromacs/utility/basedefinitions.h"
  49 #include "gromacs/utility/unique_cptr.h"
  50
  51 struct t_fileio;
  52
  53 namespace gmx
  54 {
  55
  56 /*! \brief Close the log file */
  57 void closeLogFile(t_fileio *logfio);
  58
  59 //! Simple guard pointer See unique_cptr for details.
  60 using LogFilePtr = std::unique_ptr < t_fileio, functor_wrapper < t_fileio, closeLogFile>>;
  61
  62 /*! \brief Open the log file for writing/appending.
  63  *
  64  * \throws FileIOError when the log file cannot be opened. */
  65 LogFilePtr openLogFile(const char *lognm,
  66                        bool        appendFiles);
  67
  68 /*! \brief Prepare to use the open log file when appending.
  69  *
  70  * Does not throw.
  71  */
  72 void prepareLogAppending(FILE *fplog);
  73
  74 }    // namespace gmx
  75
  76 #endif