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 <cstdio>
  41
  42 #include "gromacs/legacyheaders/copyrite.h"
  43
  44 #include "gromacs/utility/programinfo.h"
  45 #include "gromacs/utility/stringutil.h"
  46
  47 namespace gmx
  48 {
  49
  50 /*! \cond internal */
  51 namespace internal
  52 {
  53
  54 void printFatalError(FILE *fp, const char *title, const char *details,
  55                      const char *func, const char *file, int line)
  56 {
  57     // In case ProgramInfo is not initialized and there is an issue with the
  58     // initialization, fall back to "GROMACS".
  59     const char *programName = "GROMACS";
  60     try
  61     {
  62         programName = ProgramInfo::getInstance().programName().c_str();
  63     }
  64     catch (const std::exception &)
  65     {
  66     }
  67
  68     std::fprintf(fp, "\n-------------------------------------------------------\n");
  69     std::fprintf(fp, "Program %s, %s\n", programName, GromacsVersion());
  70     if (func != NULL)
  71     {
  72         std::fprintf(fp, "In function: %s\n", func);
  73     }
  74     // TODO: Strip away absolute paths from file names (CMake seems to generate those)
  75     if (file != NULL)
  76     {
  77         std::fprintf(fp, "Source file %s, line %d\n", file, line);
  78     }
  79     std::fprintf(fp, "\n");
  80     std::fprintf(fp, "%s:\n", title);
  81     // TODO: Line wrapping
  82     std::fprintf(fp, "%s\n", details);
  83     std::fprintf(fp, "For more information and tips for troubleshooting, please check the GROMACS\n"
  84                      "website at http://www.gromacs.org/Documentation/Errors");
  85     std::fprintf(fp, "\n-------------------------------------------------------\n");
  86 }
  87
  88 } // namespace internal
  89 //! \endcond
  90
  91 } // namespace gmx