src/gromacs/utility/errorformat.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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  * Declares an internal helper function for formatting standard error messages.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #ifndef GMX_UTILITY_ERRORFORMAT_H
  43 #define GMX_UTILITY_ERRORFORMAT_H
  44
  45 #include <cstdio>
  46
  47 namespace gmx
  48 {
  49
  50 /*! \cond internal */
  51 namespace internal
  52 {
  53
  54 /*! \brief
  55  * Formats a common header for fatal error messages.
  56  *
  57  * Does not throw.
  58  *
  59  * \ingroup module_utility
  60  */
  61 void printFatalErrorHeader(FILE *fp, const char *title,
  62                            const char *func, const char *file, int line);
  63 /*! \brief
  64  * Formats a line of fatal error message text.
  65  *
  66  * Does not throw.
  67  *
  68  * \ingroup module_utility
  69  */
  70 void printFatalErrorMessageLine(FILE *fp, const char *text, int indent);
  71 /*! \brief
  72  * Formats a common footer for fatal error messages.
  73  *
  74  * Does not throw.
  75  *
  76  * \ingroup module_utility
  77  */
  78 void printFatalErrorFooter(FILE *fp);
  79
  80 }   // namespace internal
  81 //! \endcond
  82
  83 } // namespace gmx
  84
  85 #endif