Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / utility / errorformat.cpp
index a9cbfaf74264fe13f72ad1c4946f2d4d6faeffa2..a8f7159c296e910c5ee7c90380928a15ba1fda06 100644 (file)
@@ -1,48 +1,57 @@
 /*
+ * This file is part of the GROMACS molecular simulation package.
  *
- *                This source code is part of
+ * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
  *
- *                 G   R   O   M   A   C   S
- *
- *          GROningen MAchine for Chemical Simulations
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
  *
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  *
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
  *
  * To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
  */
 /*! \internal \file
  * \brief
  * Implements functions declared in errorformat.h.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \ingroup module_utility
  */
-#include "gromacs/utility/errorformat.h"
+#include "gmxpre.h"
+
+#include "errorformat.h"
 
-#include <string>
+#include "config.h"
 
-#include "gromacs/legacyheaders/copyrite.h"
+#include <cctype>
+#include <cstdio>
+#include <cstring>
 
-#include "gromacs/utility/format.h"
-#include "gromacs/utility/programinfo.h"
+#include "gromacs/utility/baseversion.h"
+#include "gromacs/utility/programcontext.h"
+#include "gromacs/utility/stringutil.h"
 
 namespace gmx
 {
@@ -51,34 +60,72 @@ namespace gmx
 namespace internal
 {
 
-std::string formatFatalError(const char *title, const char *details,
-                             const char *func, const char *file, int line)
+void printFatalErrorHeader(FILE *fp, const char *title,
+                           const char *func, const char *file, int line)
 {
-    std::string result;
-    result.append("\n-------------------------------------------------------\n");
-    const char *programName = ProgramInfo::getInstance().programName().c_str();
-    result.append(formatString("Program %s, %s\n", programName, GromacsVersion()));
-    if (func != NULL)
+    // In case ProgramInfo is not initialized and there is an issue with the
+    // initialization, fall back to "GROMACS".
+    const char *programName = "GROMACS";
+    try
+    {
+        programName = getProgramContext().displayName();
+    }
+    catch (const std::exception &)
     {
-        result.append(formatString("In function %s\n", func));
     }
-    // TODO: Strip away absolute paths from file names (CMake seems to generate those)
+
+    std::fprintf(fp, "\n-------------------------------------------------------\n");
+    std::fprintf(fp, "Program:     %s, %s\n", programName, gmx_version());
     if (file != NULL)
     {
-        result.append(formatString("Source file %s, line %d\n\n", file, line));
+        // TODO: Check whether this works on Windows. If it doesn't, perhaps
+        // add Path::startsWith().
+        if (startsWith(file, CMAKE_SOURCE_DIR))
+        {
+            file += std::strlen(CMAKE_SOURCE_DIR);
+            if (file[0] == '/' || file[0] == '\\')
+            {
+                ++file;
+            }
+        }
+        std::fprintf(fp, "Source file: %s (line %d)\n", file, line);
     }
-    else
+    if (func != NULL)
     {
-        result.append("\n");
+        std::fprintf(fp, "Function:    %s\n", func);
     }
-    result.append(formatString("%s:\n%s\n", title, details));
-    result.append("For more information and tips for troubleshooting, please check the GROMACS\n"
-                  "website at http://www.gromacs.org/Documentation/Errors");
-    result.append("\n-------------------------------------------------------\n");
-    return result;
+    std::fprintf(fp, "\n");
+    std::fprintf(fp, "%s:\n", title);
+}
+
+void printFatalErrorMessageLine(FILE *fp, const char *text, int indent)
+{
+    gmx::TextLineWrapper wrapper;
+    wrapper.settings().setLineLength(78 - indent);
+    size_t               lineStart = 0;
+    size_t               length    = std::strlen(text);
+    while (lineStart < length)
+    {
+        size_t nextLineStart = wrapper.findNextLine(text, lineStart);
+        int    lineLength    = static_cast<int>(nextLineStart - lineStart);
+        while (lineLength > 0 && std::isspace(text[lineStart + lineLength - 1]))
+        {
+            --lineLength;
+        }
+        std::fprintf(fp, "%*s%.*s\n", indent, "", lineLength, text + lineStart);
+        lineStart = nextLineStart;
+    }
+}
+
+void printFatalErrorFooter(FILE *fp)
+{
+    std::fprintf(fp, "\n");
+    std::fprintf(fp, "For more information and tips for troubleshooting, please check the GROMACS\n"
+                 "website at http://www.gromacs.org/Documentation/Errors");
+    std::fprintf(fp, "\n-------------------------------------------------------\n");
 }
 
-} // namespace internal
+}   // namespace internal
 //! \endcond
 
 } // namespace gmx