2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
37 * Implements functions declared in errorformat.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
44 #include "errorformat.h"
50 #include "gromacs/utility/baseversion.h"
51 #include "gromacs/utility/programcontext.h"
52 #include "gromacs/utility/stringutil.h"
61 void printFatalErrorHeader(FILE *fp, const char *title,
62 const char *func, const char *file, int line)
64 // In case ProgramInfo is not initialized and there is an issue with the
65 // initialization, fall back to "GROMACS".
66 const char *programName = "GROMACS";
69 programName = getProgramContext().displayName();
71 catch (const std::exception &)
75 std::fprintf(fp, "\n-------------------------------------------------------\n");
76 std::fprintf(fp, "Program: %s, %s\n", programName, gmx_version());
79 // TODO: Check whether this works on Windows. If it doesn't, perhaps
80 // add Path::startsWith().
81 if (startsWith(file, CMAKE_SOURCE_DIR))
83 file += std::strlen(CMAKE_SOURCE_DIR);
84 if (file[0] == '/' || file[0] == '\\')
89 std::fprintf(fp, "Source file: %s (line %d)\n", file, line);
93 std::fprintf(fp, "Function: %s\n", func);
95 std::fprintf(fp, "\n");
96 std::fprintf(fp, "%s:\n", title);
99 void printFatalErrorMessageLine(FILE *fp, const char *text, int indent)
101 gmx::TextLineWrapper wrapper;
102 wrapper.settings().setLineLength(78 - indent);
103 size_t lineStart = 0;
104 size_t length = std::strlen(text);
105 while (lineStart < length)
107 size_t nextLineStart = wrapper.findNextLine(text, lineStart);
108 int lineLength = static_cast<int>(nextLineStart - lineStart);
109 while (lineLength > 0 && std::isspace(text[lineStart + lineLength - 1]))
113 std::fprintf(fp, "%*s%.*s\n", indent, "", lineLength, text + lineStart);
114 lineStart = nextLineStart;
118 void printFatalErrorFooter(FILE *fp)
120 std::fprintf(fp, "\n");
121 std::fprintf(fp, "For more information and tips for troubleshooting, please check the GROMACS\n"
122 "website at http://www.gromacs.org/Documentation/Errors");
123 std::fprintf(fp, "\n-------------------------------------------------------\n");
126 } // namespace internal