| blob | 5c132f6896961bbf07cb6c5b6655493615725e26 |
1 /*
2 * This file is part of the GROMACS molecular simulation package.
3 *
4 * Copyright (c) 2010,2011,2012,2013,2014,2015,2016,2017,2018,2019, 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 /*! \defgroup module_utility Low-Level Utilities (utility)
36 * \ingroup group_utilitymodules
37 * \brief
38 * Provides low-level utilities for error handling and other tasks.
39 *
40 * This module provides various low-level utilities for tasks such as error
41 * handling and string formatting, as well as helper classes and common custom
42 * containers to simplify implementation of other code. Contents of the module
43 * are discussed in more details under the different headings below.
44 * Some of the code in installed headers in the module is intended for use
45 * directly from code outside the \Gromacs library, but a significant portion
46 * is exposed only because other public headers depend on it.
47 *
48 * Since this module implements error handling, it should be at the lowest
49 * level: it should not depend on other modules. Any functionality needed by
50 * the error handling code should also be kept in this module.
51 *
52 * <H3>Error handling</H3>
53 *
54 * Exception classes used in the library are declared in the exceptions.h header
55 * file. Most \Gromacs-specific exceptions derive from gmx::GromacsException.
56 *
57 * This header also declares a ::GMX_THROW macro that should be used for
58 * throwing exceptions. ::GMX_THROW_WITH_ERRNO is also provided for reporting
59 * syscall errors, but its use should be mostly limited to within the library.
60 * This header also declares helper functions printFatalErrorMessage(),
61 * formatExceptionMessageToString(), and formatExceptionMessageToFile() for
62 * creating standard error messages. processExceptionAtExit() provides
63 * clean-up code before exiting the program after an exception.
64 * To help in cases where bottom-up conversion to C++ is appropriate, macro
65 * ::GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR is also provided to catch all
66 * exceptions at C++ to C boundary.
67 *
68 * Header file gmxassert.h is also provided for assertions. It declares macros
69 * ::GMX_ASSERT and ::GMX_RELEASE_ASSERT that should be used for assertions.
70 *
71 * \if internal
72 * Internally, functions from errorformat.h are used for all the above cases to
73 * format error messages to \c stderr. errorcodes.h provides some common
74 * functionality for classifying errors.
75 * \endif
76 *
77 *
78 * \if libapi
79 *
80 * <H3>Basic file handling and streams</H3>
81 *
82 * The header textstream.h declares interfaces for simple text format streams.
83 * Headers filestream.h and stringstream.h provide implementations for these
84 * streams for reading/writing files and for writing to in-memory strings.
85 *
86 * The header fileredirector.h provides interfaces for redirecting file input
87 * and/or output to alternative streams, for use in testing, as well as default
88 * implementations for these interfaces that just use the file system.
89 *
90 * The header textwriter.h provides gmx::TextWriter for more formatting support
91 * when writing to a text stream. Similarly, textreader.h provides more
92 * formatting support when reading from a text stream.
93 *
94 * The header path.h declares helpers for manipulating paths as strings and for
95 * managing directories and files.
96 * The fate of this header depends on what is decided in Redmine issue #950.
97 *
98 * <H3>Logging</H3>
99 *
100 * The headers logger.h and loggerbuilder.h provide interfaces and classes for
101 * writing log files (or logging to other targets). See \ref page_logging for
102 * an overview.
103 *
104 * \endif
105 *
106 * <H3>Implementation helpers</H3>
107 *
108 * The header basedefinitions.h contains common definitions and macros used
109 * throughout \Gromacs. It includes `gmx_bool` for C code, some macros for
110 * compiler-specific attributes, and ::GMX_UNUSED_VALUE and ::GMX_IGNORE_RETURN_VALUE
111 * for handling warnings about unused values.
112 *
113 * The header classhelpers.h implements a gmx::PrivateImplPointer template for easily
114 * writing classes that use the private implementation idiom. This header also
115 * declares ::GMX_DISALLOW_COPY_AND_ASSIGN and ::GMX_DISALLOW_ASSIGN macros for
116 * class declarations.
117 *
118 * The header flags.h implements a gmx::FlagsTemplate template for better type
119 * safety when using bit flag fields.
120 *
121 *
122 * <H3>Other functionality</H3>
123 *
124 * The header init.h declares gmx::init() and gmx::finalize() for initializing
125 * and deinitializing the \Gromacs library.
126 *
127 * The header arrayref.h implements a gmx::ArrayRef class for exposing a
128 * C array or part of a std::vector (basically, any continuous stretch of
129 * memory) throuh a std::vector-like interface.
130 *
131 * The header stringutil.h declares various string utility routines.
132 *
133 * \if libapi
134 *
135 * The header strconvert.h declares string parsing routines.
136 *
137 * The header gmxmpi.h abstracts away the mechanism of including either MPI or
138 * thread-MPI headers depending on compilation options.
139 * Similarly, gmxomp.h removes the need to use conditional compilation for code
140 * that needs to include omp.h for OpenMP functions.
141 *
142 * The header messagestringcollector.h declares a gmx::MessageStringCollector
143 * class for composing messages with context information.
144 *
145 * The header sysinfo.h declares gmx_getpid() for getting the current process
146 * id.
147 *
148 * The header programcontext.h declares a gmx::IProgramContext that is
149 * used to
150 * initialize and access information about the running program, such as the
151 * name and path of the executable. This information is used, e.g., by the
152 * error handling code in formatting standard error messages.
153 *
154 * The header qsort_threadsafe.h provides a guaranteed threadsafe
155 * implementation for qsort().
156 *
157 * \endif
158 *
159 * \author Teemu Murtola <teemu.murtola@gmail.com>
160 */
161 /*! \file
162 * \brief
163 * Public API convenience header for low-level utilities.
164 *
165 * \author Teemu Murtola <teemu.murtola@gmail.com>
166 * \inpublicapi
167 * \ingroup module_utility
168 */
169 #ifndef GMX_UTILITY_H
170 #define GMX_UTILITY_H
178 #endif