src/gromacs/utility/errorformat.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010-2017, The GROMACS development team.
   5  * Copyright (c) 2019, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Implements functions declared in errorformat.h.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_utility
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "errorformat.h"
  46
  47 #include <cctype>
  48 #include <cstdio>
  49 #include <cstring>
  50
  51 #include "gromacs/utility/basenetwork.h"
  52 #include "gromacs/utility/baseversion.h"
  53 #include "gromacs/utility/path.h"
  54 #include "gromacs/utility/programcontext.h"
  55 #include "gromacs/utility/stringutil.h"
  56
  57 namespace gmx
  58 {
  59
  60 /*! \cond internal */
  61 namespace internal
  62 {
  63
  64 void printFatalErrorHeader(FILE* fp, const char* title, const char* func, const char* file, int line)
  65 {
  66     // In case ProgramInfo is not initialized and there is an issue with the
  67     // initialization, fall back to "GROMACS".
  68     const char* programName = "GROMACS";
  69     try
  70     {
  71         programName = getProgramContext().displayName();
  72     }
  73     catch (const std::exception&)
  74     {
  75     }
  76
  77     std::fprintf(fp, "\n-------------------------------------------------------\n");
  78     std::fprintf(fp, "Program:     %s, version %s\n", programName, gmx_version());
  79     if (file != nullptr)
  80     {
  81         std::fprintf(fp, "Source file: %s (line %d)\n", Path::stripSourcePrefix(file), line);
  82     }
  83     if (func != nullptr)
  84     {
  85         std::fprintf(fp, "Function:    %s\n", func);
  86     }
  87     if (gmx_node_num() > 1)
  88     {
  89         std::fprintf(fp, "MPI rank:    %d (out of %d)\n", gmx_node_rank(), gmx_node_num());
  90     }
  91     std::fprintf(fp, "\n");
  92     std::fprintf(fp, "%s:\n", title);
  93 }
  94
  95 void printFatalErrorMessageLine(FILE* fp, const char* text, int indent)
  96 {
  97     gmx::TextLineWrapper wrapper;
  98     wrapper.settings().setLineLength(78 - indent);
  99     size_t lineStart = 0;
 100     size_t length    = std::strlen(text);
 101     while (lineStart < length)
 102     {
 103         size_t nextLineStart = wrapper.findNextLine(text, lineStart);
 104         int    lineLength    = static_cast<int>(nextLineStart - lineStart);
 105         while (lineLength > 0 && std::isspace(text[lineStart + lineLength - 1]))
 106         {
 107             --lineLength;
 108         }
 109         std::fprintf(fp, "%*s%.*s\n", indent, "", lineLength, text + lineStart);
 110         lineStart = nextLineStart;
 111     }
 112 }
 113
 114 void printFatalErrorFooter(FILE* fp)
 115 {
 116     std::fprintf(fp, "\n");
 117     std::fprintf(fp,
 118                  "For more information and tips for troubleshooting, please check the GROMACS\n"
 119                  "website at http://www.gromacs.org/Documentation/Errors");
 120     std::fprintf(fp, "\n-------------------------------------------------------\n");
 121 }
 122
 123 } // namespace internal
 124 //! \endcond
 125
 126 } // namespace gmx