This file is indexed.

/usr/include/gromacs/utility.h is in libgromacs-dev 2018.1-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

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

#include "gromacs/utility/baseversion.h"
#include "gromacs/utility/exceptions.h"
#include "gromacs/utility/gmxassert.h"
#include "gromacs/utility/init.h"
#include "gromacs/utility/programcontext.h"

#endif