2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015, by the GROMACS development team, led by
7 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8 * and including many others, as listed in the AUTHORS file in the
9 * top-level source directory and at http://www.gromacs.org.
11 * GROMACS is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public License
13 * as published by the Free Software Foundation; either version 2.1
14 * of the License, or (at your option) any later version.
16 * GROMACS is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with GROMACS; if not, see
23 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 * If you want to redistribute modifications to GROMACS, please
27 * consider that scientific software is very special. Version
28 * control is crucial - bugs must be traceable. We will be happy to
29 * consider code for inclusion in the official distribution, but
30 * derived work must not be called official GROMACS. Details are found
31 * in the README & COPYING files - if they are missing, get the
32 * official version at http://www.gromacs.org.
34 * To help us fund GROMACS development, we humbly ask that you cite
35 * the research papers on the package. Check out http://www.gromacs.org.
37 #ifndef GMX_FILEIO_GMXFIO_XDR_H
38 #define GMX_FILEIO_GMXFIO_XDR_H
40 #include "gromacs/fileio/xdrf.h"
41 #include "gromacs/math/vectypes.h"
42 #include "gromacs/utility/basedefinitions.h"
43 #include "gromacs/utility/real.h"
51 void gmx_fio_setprecision(struct t_fileio
*fio
, gmx_bool bDouble
);
52 /* Select the floating point precision for reading and writing files */
54 XDR
*gmx_fio_getxdr(struct t_fileio
*fio
);
55 /* Return the file pointer itself */
57 gmx_bool
gmx_fio_writee_string(struct t_fileio
*fio
, const char *item
,
58 const char *desc
, const char *srcfile
, int line
);
60 /* reading or writing, depending on the file's opening mode string */
61 gmx_bool
gmx_fio_doe_real(struct t_fileio
*fio
, real
*item
,
62 const char *desc
, const char *srcfile
, int line
);
63 gmx_bool
gmx_fio_doe_float(struct t_fileio
*fio
, float *item
,
64 const char *desc
, const char *srcfile
, int line
);
65 gmx_bool
gmx_fio_doe_double(struct t_fileio
*fio
, double *item
,
66 const char *desc
, const char *srcfile
, int line
);
67 gmx_bool
gmx_fio_doe_gmx_bool(struct t_fileio
*fio
, gmx_bool
*item
,
68 const char *desc
, const char *srcfile
, int line
);
69 gmx_bool
gmx_fio_doe_int(struct t_fileio
*fio
, int *item
,
70 const char *desc
, const char *srcfile
, int line
);
71 gmx_bool
gmx_fio_doe_int64(struct t_fileio
*fio
, gmx_int64_t
*item
,
72 const char *desc
, const char *srcfile
, int line
);
73 gmx_bool
gmx_fio_doe_uchar(struct t_fileio
*fio
, unsigned char *item
,
74 const char *desc
, const char *srcfile
, int line
);
75 gmx_bool
gmx_fio_doe_ushort(struct t_fileio
*fio
, unsigned short *item
,
76 const char *desc
, const char *srcfile
, int line
);
77 gmx_bool
gmx_fio_doe_rvec(struct t_fileio
*fio
, rvec
*item
,
78 const char *desc
, const char *srcfile
, int line
);
79 gmx_bool
gmx_fio_doe_ivec(struct t_fileio
*fio
, ivec
*item
,
80 const char *desc
, const char *srcfile
, int line
);
81 gmx_bool
gmx_fio_doe_string(struct t_fileio
*fio
, char *item
,
82 const char *desc
, const char *srcfile
, int line
);
84 /* array reading & writing */
85 gmx_bool
gmx_fio_ndoe_real(struct t_fileio
*fio
, real
*item
, int n
,
86 const char *desc
, const char *srcfile
, int line
);
87 gmx_bool
gmx_fio_ndoe_float(struct t_fileio
*fio
, float *item
, int n
,
88 const char *desc
, const char *srcfile
, int line
);
89 gmx_bool
gmx_fio_ndoe_double(struct t_fileio
*fio
, double *item
, int n
,
90 const char *desc
, const char *srcfile
, int line
);
91 gmx_bool
gmx_fio_ndoe_gmx_bool(struct t_fileio
*fio
, gmx_bool
*item
, int n
,
92 const char *desc
, const char *srcfile
, int line
);
93 gmx_bool
gmx_fio_ndoe_int(struct t_fileio
*fio
, int *item
, int n
,
94 const char *desc
, const char *srcfile
, int line
);
95 gmx_bool
gmx_fio_ndoe_int64(struct t_fileio
*fio
, gmx_int64_t
*item
, int n
,
96 const char *desc
, const char *srcfile
,
98 gmx_bool
gmx_fio_ndoe_uchar(struct t_fileio
*fio
, unsigned char *item
, int n
,
99 const char *desc
, const char *srcfile
, int line
);
100 gmx_bool
gmx_fio_ndoe_ushort(struct t_fileio
*fio
, unsigned short *item
, int n
,
101 const char *desc
, const char *srcfile
, int line
);
102 gmx_bool
gmx_fio_ndoe_rvec(struct t_fileio
*fio
, rvec
*item
, int n
,
103 const char *desc
, const char *srcfile
, int line
);
104 gmx_bool
gmx_fio_ndoe_ivec(struct t_fileio
*fio
, ivec
*item
, int n
,
105 const char *desc
, const char *srcfile
, int line
);
106 gmx_bool
gmx_fio_ndoe_string(struct t_fileio
*fio
, char *item
[], int n
,
107 const char *desc
, const char *srcfile
, int line
);
111 /* convenience macros */
112 #define gmx_fio_write_string(fio, item) gmx_fio_writee_string(fio, item, (#item), __FILE__, __LINE__)
114 #define gmx_fio_do_real(fio, item) gmx_fio_doe_real(fio, &item, (#item), __FILE__, __LINE__)
115 #define gmx_fio_do_float(fio, item) gmx_fio_doe_float(fio, &item, (#item), __FILE__, __LINE__)
116 #define gmx_fio_do_double(fio, item) gmx_fio_doe_double(fio, &item, (#item), __FILE__, __LINE__)
117 #define gmx_fio_do_gmx_bool(fio, item) gmx_fio_doe_gmx_bool(fio, &item, (#item), __FILE__, __LINE__)
118 #define gmx_fio_do_int(fio, item) gmx_fio_doe_int(fio, &item, (#item), __FILE__, __LINE__)
119 #define gmx_fio_do_int64(fio, item) gmx_fio_doe_int64(fio, &item, (#item), __FILE__, __LINE__)
120 #define gmx_fio_do_uchar(fio, item) gmx_fio_doe_uchar(fio, &item, (#item), __FILE__, __LINE__)
121 #define gmx_fio_do_ushort(fio, item) gmx_fio_doe_ushort(fio, &item, (#item), __FILE__, __LINE__)
122 #define gmx_fio_do_rvec(fio, item) gmx_fio_doe_rvec(fio, &item, (#item), __FILE__, __LINE__)
123 #define gmx_fio_do_ivec(fio, item) gmx_fio_doe_ivec(fio, &item, (#item), __FILE__, __LINE__)
124 #define gmx_fio_do_string(fio, item) gmx_fio_doe_string(fio, item, (#item), __FILE__, __LINE__)
127 #define gmx_fio_ndo_real(fio, item, n) gmx_fio_ndoe_real(fio, item, n, (#item), __FILE__, __LINE__)
128 #define gmx_fio_ndo_float(fio, item, n) gmx_fio_ndoe_float(fio, item, n, (#item), __FILE__, __LINE__)
129 #define gmx_fio_ndo_double(fio, item, n) gmx_fio_ndoe_double(fio, item, n, (#item), __FILE__, __LINE__)
130 #define gmx_fio_ndo_gmx_bool(fio, item, n) gmx_fio_ndoe_gmx_bool(fio, item, n, (#item), __FILE__, __LINE__)
131 #define gmx_fio_ndo_int(fio, item, n) gmx_fio_ndoe_int(fio, item, n, (#item), __FILE__, __LINE__)
132 #define gmx_fio_ndo_int64(fio, item, n) gmx_fio_ndoe_int64(fio, item, n, (#item), __FILE__, __LINE__)
133 #define gmx_fio_ndo_uchar(fio, item, n) gmx_fio_ndoe_uchar(fio, item, n, (#item), __FILE__, __LINE__)
134 #define gmx_fio_ndo_ushort(fio, item, n) gmx_fio_ndoe_ushort(fio, item, n, (#item), __FILE__, __LINE__)
135 #define gmx_fio_ndo_rvec(fio, item, n) gmx_fio_ndoe_rvec(fio, item, n, (#item), __FILE__, __LINE__)
136 #define gmx_fio_ndo_ivec(fio, item, n) gmx_fio_ndoe_ivec(fio, item, n, (#item), __FILE__, __LINE__)
137 #define gmx_fio_ndo_string(fio, item, n) gmx_fio_ndoe_string(fio, item, n, (#item), __FILE__, __LINE__)