2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
5 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 * others, as listed in the AUTHORS file in the top-level source
7 * 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.
35 /*! \defgroup module_utility Low-level Utility Module
36 * \ingroup group_utilitymodules
38 * Provides various low-level utilities.
40 * <H3>Handling fatal errors</H3>
42 * Exception classes used in the library are defined in the exceptions.h header
43 * file. This header also declares a ::GMX_THROW macro that should be used for
44 * throwing exceptions. It also declares helper functions formatErrorMessage()
45 * and translateException() for creating standard error messages and
46 * translating exceptions to error return codes.
48 * Use of error return codes should be avoided in new code except in C wrappers
49 * and similar, but for compatibility, facilities for handling them are
50 * provided by the errorcodes.h header file. It provides a set of error codes
51 * (the enum \ref gmx::ErrorCode) that should be used for return codes in functions.
52 * It also provides macros ::GMX_ERROR and ::GMX_ERROR_NORET that should be
53 * used for returning an error code. setFatalErrorHandler() is provided to
54 * alter the behavior of ::GMX_ERROR and ::GMX_ERROR_NORET. The default
55 * handler prints the reason of the error to standard error and aborts the
58 * Header file gmxassert.h is also provided for assertions. It declares macros
59 * ::GMX_ASSERT and ::GMX_RELEASE_ASSERT that should be used for assertions.
61 * \author Teemu Murtola <teemu.murtola@gmail.com>
65 * Public API convenience header for low-level utilities.
67 * \author Teemu Murtola <teemu.murtola@gmail.com>
69 * \ingroup module_utility
74 #include "utility/errorcodes.h"
75 #include "utility/exceptions.h"
76 #include "utility/gmxassert.h"