src/gromacs/legacyheaders/copyrite.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, 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 #ifndef _copyrite_h
  38 #define _copyrite_h
  39
  40 #include <cstdio>
  41
  42 /* For both bromacs() and cool_quote() you have to provide a pointer to
  43  * a string of reasonable length (say 256) and the string length. This
  44  * is necessary to make the routines threadsafe and avoid allocating
  45  * a new string each time. The retstring pointer will be the return value.
  46  */
  47 void
  48 bromacs(char *retstring, int retsize);
  49
  50 /* For cool_quote, the number of the quote used will be returned in cqnum
  51  * if it is non-NULL.
  52  */
  53 void
  54 cool_quote(char *retstring, int retsize, int *cqnum);
  55
  56 void
  57 please_cite(FILE *fp, const char *key);
  58 /* Print a message asking to cite something... */
  59
  60 namespace gmx
  61 {
  62
  63 class IProgramContext;
  64
  65 /*! \brief
  66  * Settings for printBinaryInformation().
  67  *
  68  * This class is used to specify what printBinaryInformation() prints.
  69  */
  70 class BinaryInformationSettings
  71 {
  72     public:
  73         BinaryInformationSettings();
  74
  75         //! Print information about build settings.
  76         BinaryInformationSettings &extendedInfo(bool bEnabled)
  77         {
  78             bExtendedInfo_ = bEnabled;
  79             return *this;
  80         }
  81         //! Print copyright and license information.
  82         BinaryInformationSettings &copyright(bool bEnabled)
  83         {
  84             bCopyright_ = bEnabled;
  85             return *this;
  86         }
  87         //! Print a header line with "Generated by" text (for output files).
  88         BinaryInformationSettings &generatedByHeader(bool bEnabled)
  89         {
  90             bGeneratedByHeader_ = bEnabled;
  91             return *this;
  92         }
  93         //! Prefix each line with this string.
  94         BinaryInformationSettings &linePrefix(const char *prefix)
  95         {
  96             prefix_ = prefix;
  97             return *this;
  98         }
  99         //! Suffix each line with this string.
 100         BinaryInformationSettings &lineSuffix(const char *suffix)
 101         {
 102             suffix_ = suffix;
 103             return *this;
 104         }
 105
 106     private:
 107         bool        bExtendedInfo_;
 108         bool        bCopyright_;
 109         bool        bGeneratedByHeader_;
 110         const char *prefix_;
 111         const char *suffix_;
 112
 113         //! Needed to read the members without otherwise unnecessary accessors.
 114         friend void printBinaryInformation(
 115             FILE *fp, const IProgramContext &programContext,
 116             const BinaryInformationSettings &settings);
 117 };
 118
 119 /*! \brief
 120  * Print basic information about the executable.
 121  *
 122  * \param     fp             Where to print the information to.
 123  * \param[in] programContext Program information object to use.
 124  */
 125 void printBinaryInformation(FILE                          *fp,
 126                             const IProgramContext         &programContext);
 127 /*! \brief
 128  * Print basic information about the executable with custom settings.
 129  *
 130  * \param     fp             Where to print the information to.
 131  * \param[in] programContext Program information object to use.
 132  * \param[in] settings       Specifies what to print.
 133  *
 134  * \see BinaryInformationSettings
 135  */
 136 void printBinaryInformation(FILE                            *fp,
 137                             const IProgramContext           &programContext,
 138                             const BinaryInformationSettings &settings);
 139
 140 }     // namespace gmx
 141
 142 #endif