src/gromacs/utility/errorformat.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source 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  * Implements functions declared in errorformat.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "errorformat.h"
  45
  46 #include "config.h"
  47
  48 #include <cctype>
  49 #include <cstdio>
  50 #include <cstring>
  51
  52 #include "gromacs/utility/baseversion.h"
  53 #include "gromacs/utility/programcontext.h"
  54 #include "gromacs/utility/stringutil.h"
  55
  56 namespace gmx
  57 {
  58
  59 /*! \cond internal */
  60 namespace internal
  61 {
  62
  63 void printFatalErrorHeader(FILE *fp, const char *title,
  64                            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, %s\n", programName, gmx_version());
  79     if (file != NULL)
  80     {
  81         // TODO: Check whether this works on Windows. If it doesn't, perhaps
  82         // add Path::startsWith().
  83         if (startsWith(file, CMAKE_SOURCE_DIR))
  84         {
  85             file += std::strlen(CMAKE_SOURCE_DIR);
  86             if (file[0] == '/' || file[0] == '\\')
  87             {
  88                 ++file;
  89             }
  90         }
  91         std::fprintf(fp, "Source file: %s (line %d)\n", file, line);
  92     }
  93     if (func != NULL)
  94     {
  95         std::fprintf(fp, "Function:    %s\n", func);
  96     }
  97     std::fprintf(fp, "\n");
  98     std::fprintf(fp, "%s:\n", title);
  99 }
 100
 101 void printFatalErrorMessageLine(FILE *fp, const char *text, int indent)
 102 {
 103     gmx::TextLineWrapper wrapper;
 104     wrapper.settings().setLineLength(78 - indent);
 105     size_t               lineStart = 0;
 106     size_t               length    = std::strlen(text);
 107     while (lineStart < length)
 108     {
 109         size_t nextLineStart = wrapper.findNextLine(text, lineStart);
 110         int    lineLength    = static_cast<int>(nextLineStart - lineStart);
 111         while (lineLength > 0 && std::isspace(text[lineStart + lineLength - 1]))
 112         {
 113             --lineLength;
 114         }
 115         std::fprintf(fp, "%*s%.*s\n", indent, "", lineLength, text + lineStart);
 116         lineStart = nextLineStart;
 117     }
 118 }
 119
 120 void printFatalErrorFooter(FILE *fp)
 121 {
 122     std::fprintf(fp, "\n");
 123     std::fprintf(fp, "For more information and tips for troubleshooting, please check the GROMACS\n"
 124                  "website at http://www.gromacs.org/Documentation/Errors");
 125     std::fprintf(fp, "\n-------------------------------------------------------\n");
 126 }
 127
 128 }   // namespace internal
 129 //! \endcond
 130
 131 } // namespace gmx