2 * This file is part of the GROMACS molecular simulation package.
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 by the GROMACS development team.
7 * Copyright (c) 2019,2020, by the GROMACS development team, led by
8 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
9 * and including many others, as listed in the AUTHORS file in the
10 * top-level source directory and at http://www.gromacs.org.
12 * GROMACS is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 2.1
15 * of the License, or (at your option) any later version.
17 * GROMACS is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with GROMACS; if not, see
24 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 * If you want to redistribute modifications to GROMACS, please
28 * consider that scientific software is very special. Version
29 * control is crucial - bugs must be traceable. We will be happy to
30 * consider code for inclusion in the official distribution, but
31 * derived work must not be called official GROMACS. Details are found
32 * in the README & COPYING files - if they are missing, get the
33 * official version at http://www.gromacs.org.
35 * To help us fund GROMACS development, we humbly ask that you cite
36 * the research papers on the package. Check out http://www.gromacs.org.
38 /*! \libinternal \file
39 * \brief Helper functionality for information about the currently running binary
42 * \ingroup module_utility
44 #ifndef GMX_UTILITY_BINARYINFORMATION_H
45 #define GMX_UTILITY_BINARYINFORMATION_H
52 class IProgramContext;
55 /*! \libinternal \brief
56 * Settings for printBinaryInformation().
58 * This class is used to specify what printBinaryInformation() prints.
60 * \ingroup module_utility
63 class BinaryInformationSettings
66 BinaryInformationSettings();
68 //! Set whether to print information about build settings.
69 BinaryInformationSettings& extendedInfo(bool bEnabled)
71 bExtendedInfo_ = bEnabled;
74 //! Set whether to print copyright and license information.
75 BinaryInformationSettings& copyright(bool bEnabled)
77 bCopyright_ = bEnabled;
80 //! Set whether to print the process ID.
81 BinaryInformationSettings& processId(bool bEnabled)
83 bProcessId_ = bEnabled;
86 //! Set whether to print a header line with "Generated by" text (for output files).
87 BinaryInformationSettings& generatedByHeader(bool bEnabled)
89 bGeneratedByHeader_ = bEnabled;
92 //! Prefix each line with this string.
93 BinaryInformationSettings& linePrefix(const char* prefix)
98 //! Suffix each line with this string.
99 BinaryInformationSettings& lineSuffix(const char* suffix)
109 bool bGeneratedByHeader_;
113 //! Needed to read the members without otherwise unnecessary accessors.
114 friend void printBinaryInformation(TextWriter* writer,
115 const IProgramContext& programContext,
116 const BinaryInformationSettings& settings);
120 * Print basic information about the executable.
122 * \param fp Where to print the information to.
123 * \param[in] programContext Program information object to use.
125 void printBinaryInformation(FILE* fp, const IProgramContext& programContext);
127 * Print basic information about the executable with custom settings.
129 * \param fp Where to print the information to.
130 * \param[in] programContext Program information object to use.
131 * \param[in] settings Specifies what to print.
133 * \see BinaryInformationSettings
135 void printBinaryInformation(FILE* fp,
136 const IProgramContext& programContext,
137 const BinaryInformationSettings& settings);
140 * Print basic information about the executable with custom settings.
142 * \param[out] writer Where to print the information.
143 * \param[in] programContext Program information object to use.
144 * \param[in] settings Specifies what to print.
145 * \throws std::bad_alloc if out of memory.
147 * \see BinaryInformationSettings
149 void printBinaryInformation(TextWriter* writer,
150 const IProgramContext& programContext,
151 const BinaryInformationSettings& settings);