src/gromacs/utility/errorformat.cpp

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Implements functions declared in errorformat.h.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_utility
  37  */
  38 #include "gromacs/utility/errorformat.h"
  39
  40 #include <string>
  41
  42 #include "gromacs/legacyheaders/copyrite.h"
  43 #include "gromacs/legacyheaders/statutil.h"
  44
  45 #include "gromacs/utility/format.h"
  46
  47 namespace gmx
  48 {
  49
  50 /*! \cond internal */
  51 namespace internal
  52 {
  53
  54 std::string formatFatalError(const char *title, const char *details,
  55                              const char *func, const char *file, int line)
  56 {
  57     std::string result;
  58     result.append("\n-------------------------------------------------------\n");
  59     // TODO: Make the program name work also for unit tests
  60     result.append(formatString("Program %s, %s\n", "TEST", GromacsVersion()));
  61     if (func != NULL)
  62     {
  63         result.append(formatString("In function %s\n", func));
  64     }
  65     // TODO: Strip away absolute paths from file names (CMake seems to generate those)
  66     if (file != NULL)
  67     {
  68         result.append(formatString("Source file %s, line %d\n\n", file, line));
  69     }
  70     else
  71     {
  72         result.append("\n");
  73     }
  74     result.append(formatString("%s:\n%s\n", title, details));
  75     result.append("For more information and tips for troubleshooting, please check the GROMACS\n"
  76                   "website at http://www.gromacs.org/Documentation/Errors");
  77     result.append("\n-------------------------------------------------------\n");
  78     return result;
  79 }
  80
  81 } // namespace internal
  82 //! \endcond
  83
  84 } // namespace gmx