src/gromacs/utility/binaryinformation.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2017,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \libinternal \file
  38  * \brief Helper functionality for information about the currently running binary
  39  *
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_BINARYINFORMATION_H
  44 #define GMX_UTILITY_BINARYINFORMATION_H
  45
  46 #include <cstdio>
  47
  48 namespace gmx
  49 {
  50
  51 class IProgramContext;
  52 class TextWriter;
  53
  54 /*! \libinternal \brief
  55  * Settings for printBinaryInformation().
  56  *
  57  * This class is used to specify what printBinaryInformation() prints.
  58  *
  59  * \ingroup module_utility
  60  * \inlibraryapi
  61  */
  62 class BinaryInformationSettings
  63 {
  64 public:
  65     BinaryInformationSettings();
  66
  67     //! Set whether to print information about build settings.
  68     BinaryInformationSettings& extendedInfo(bool bEnabled)
  69     {
  70         bExtendedInfo_ = bEnabled;
  71         return *this;
  72     }
  73     //! Set whether to print copyright and license information.
  74     BinaryInformationSettings& copyright(bool bEnabled)
  75     {
  76         bCopyright_ = bEnabled;
  77         return *this;
  78     }
  79     //! Set whether to print the process ID.
  80     BinaryInformationSettings& processId(bool bEnabled)
  81     {
  82         bProcessId_ = bEnabled;
  83         return *this;
  84     }
  85     //! Set whether to print a header line with "Generated by" text (for output files).
  86     BinaryInformationSettings& generatedByHeader(bool bEnabled)
  87     {
  88         bGeneratedByHeader_ = bEnabled;
  89         return *this;
  90     }
  91     //! Prefix each line with this string.
  92     BinaryInformationSettings& linePrefix(const char* prefix)
  93     {
  94         prefix_ = prefix;
  95         return *this;
  96     }
  97     //! Suffix each line with this string.
  98     BinaryInformationSettings& lineSuffix(const char* suffix)
  99     {
 100         suffix_ = suffix;
 101         return *this;
 102     }
 103
 104 private:
 105     bool        bExtendedInfo_;
 106     bool        bCopyright_;
 107     bool        bProcessId_;
 108     bool        bGeneratedByHeader_;
 109     const char* prefix_;
 110     const char* suffix_;
 111
 112     //! Needed to read the members without otherwise unnecessary accessors.
 113     friend void printBinaryInformation(TextWriter*                      writer,
 114                                        const IProgramContext&           programContext,
 115                                        const BinaryInformationSettings& settings);
 116 };
 117
 118 /*! \brief
 119  * Print basic information about the executable.
 120  *
 121  * \param     fp             Where to print the information to.
 122  * \param[in] programContext Program information object to use.
 123  */
 124 void printBinaryInformation(FILE* fp, const IProgramContext& programContext);
 125 /*! \brief
 126  * Print basic information about the executable with custom settings.
 127  *
 128  * \param     fp             Where to print the information to.
 129  * \param[in] programContext Program information object to use.
 130  * \param[in] settings       Specifies what to print.
 131  *
 132  * \see BinaryInformationSettings
 133  */
 134 void printBinaryInformation(FILE*                            fp,
 135                             const IProgramContext&           programContext,
 136                             const BinaryInformationSettings& settings);
 137
 138 /*! \brief
 139  * Print basic information about the executable with custom settings.
 140  *
 141  * \param[out] writer         Where to print the information.
 142  * \param[in]  programContext Program information object to use.
 143  * \param[in]  settings       Specifies what to print.
 144  * \throws     std::bad_alloc if out of memory.
 145  *
 146  * \see BinaryInformationSettings
 147  */
 148 void printBinaryInformation(TextWriter*                      writer,
 149                             const IProgramContext&           programContext,
 150                             const BinaryInformationSettings& settings);
 151
 152 } // namespace gmx
 153
 154 #endif