src/gromacs/utility/niceheader.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018, 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 functions from niceheader.h.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "niceheader.h"
  45
  46 #include "gromacs/utility/stringutil.h"
  47 #include "gromacs/utility/sysinfo.h"
  48 #include "gromacs/utility/textwriter.h"
  49
  50 namespace gmx
  51 {
  52
  53 void niceHeader(TextWriter *writer, const char *fn, char commentChar)
  54 {
  55     int            uid;
  56     char           userbuf[256];
  57     char           hostbuf[256];
  58     char           timebuf[256];
  59
  60     /* Write a nice header for an output file */
  61     writer->writeLine(formatString("%c", commentChar));
  62     writer->writeLine(formatString("%c\tFile '%s' was generated", commentChar, fn ? fn : "unknown"));
  63
  64     uid  = gmx_getuid();
  65     gmx_getusername(userbuf, 256);
  66     gmx_gethostname(hostbuf, 256);
  67     gmx_format_current_time(timebuf, 256);
  68
  69     writer->writeLine(formatString("%c\tBy user: %s (%d)", commentChar, userbuf, uid));
  70     writer->writeLine(formatString("%c\tOn host: %s", commentChar, hostbuf));
  71     writer->writeLine(formatString("%c\tAt date: %s", commentChar, timebuf));
  72     writer->writeLine(formatString("%c", commentChar));
  73 }
  74
  75 }  // namespace gmx