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,2016,2017, 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.
39 #include "gmxfio-xdr.h"
44 #include "gromacs/fileio/gmxfio.h"
45 #include "gromacs/fileio/xdrf.h"
46 #include "gromacs/utility/fatalerror.h"
47 #include "gromacs/utility/gmxassert.h"
48 #include "gromacs/utility/smalloc.h"
50 #include "gmxfio-impl.h"
52 /* Enumerated for data types in files */
54 eioREAL, eioFLOAT, eioDOUBLE, eioINT, eioINT64,
55 eioUCHAR, eioNUCHAR, eioUSHORT,
56 eioRVEC, eioNRVEC, eioIVEC, eioSTRING, eioNR
59 static const char *eioNames[eioNR] =
61 "REAL", "INT", "GMX_STE_T", "UCHAR", "NUCHAR", "USHORT", "RVEC", "NRVEC",
65 void gmx_fio_setprecision(t_fileio *fio, gmx_bool bDouble)
68 fio->bDouble = bDouble;
72 XDR *gmx_fio_getxdr(t_fileio *fio)
76 GMX_RELEASE_ASSERT( fio->xdr != nullptr, "Implementation error: NULL XDR pointers");
82 /* check the number of items given against the type */
83 static void gmx_fio_check_nitem(int eio, int nitem, const char *file, int line)
85 if ((nitem != 1) && !((eio == eioNRVEC) || (eio == eioNUCHAR)))
88 "nitem (%d) may differ from 1 only for %s or %s, not for %s"
89 "(%s, %d)", nitem, eioNames[eioNUCHAR], eioNames[eioNRVEC],
90 eioNames[eio], file, line);
94 /* output a data type error. */
95 static void gmx_fio_fe(t_fileio *fio, int eio, const char *desc,
96 const char *srcfile, int line)
98 gmx_fatal(FARGS, "Trying to %s %s type %d (%s), src %s, line %d",
99 fio->bRead ? "read" : "write", desc, eio,
100 ((eio >= 0) && (eio < eioNR)) ? eioNames[eio] : "unknown",
104 /* This is the part that reads xdr files. */
106 static gmx_bool do_xdr(t_fileio *fio, void *item, int nitem, int eio,
107 const char *desc, const char *srcfile, int line)
109 unsigned char ucdum, *ucptr;
113 int j, m, *iptr, idum;
120 GMX_RELEASE_ASSERT( fio->xdr != nullptr, "Implementation error: NULL XDR pointers");
121 gmx_fio_check_nitem(eio, nitem, srcfile, line);
127 if (item && !fio->bRead)
129 d = *((real *) item);
131 res = xdr_double(fio->xdr, &d);
134 *((real *) item) = d;
139 if (item && !fio->bRead)
141 f = *((real *) item);
143 res = xdr_float(fio->xdr, &f);
146 *((real *) item) = f;
151 if (item && !fio->bRead)
153 f = *((float *) item);
155 res = xdr_float(fio->xdr, &f);
158 *((float *) item) = f;
162 if (item && !fio->bRead)
164 d = *((double *) item);
166 res = xdr_double(fio->xdr, &d);
169 *((double *) item) = d;
173 if (item && !fio->bRead)
175 idum = *(int *) item;
177 res = xdr_int(fio->xdr, &idum);
180 *(int *) item = idum;
184 if (item && !fio->bRead)
186 sdum = *(gmx_int64_t *) item;
188 res = xdr_int64(fio->xdr, &sdum);
191 *(gmx_int64_t *) item = sdum;
195 if (item && !fio->bRead)
197 ucdum = *(unsigned char *) item;
199 res = xdr_u_char(fio->xdr, &ucdum);
202 *(unsigned char *) item = ucdum;
206 ucptr = (unsigned char *) item;
208 for (j = 0; (j < nitem) && res; j++)
210 res = xdr_u_char(fio->xdr, &(ucptr[j]));
214 if (item && !fio->bRead)
216 us = *(unsigned short *) item;
218 res = xdr_u_short(fio->xdr, (unsigned short *) &us);
221 *(unsigned short *) item = us;
227 if (item && !fio->bRead)
229 for (m = 0; (m < DIM); m++)
231 dvec[m] = ((real *) item)[m];
234 res = xdr_vector(fio->xdr, (char *) dvec, DIM,
235 static_cast<unsigned int>(sizeof(double)),
236 (xdrproc_t) xdr_double);
239 for (m = 0; (m < DIM); m++)
241 ((real *) item)[m] = dvec[m];
247 if (item && !fio->bRead)
249 for (m = 0; (m < DIM); m++)
251 fvec[m] = ((real *) item)[m];
254 res = xdr_vector(fio->xdr, (char *) fvec, DIM,
255 static_cast<unsigned int>(sizeof(float)),
256 (xdrproc_t) xdr_float);
259 for (m = 0; (m < DIM); m++)
261 ((real *) item)[m] = fvec[m];
269 for (j = 0; (j < nitem) && res; j++)
273 ptr = ((rvec *) item)[j];
275 res = do_xdr(fio, ptr, 1, eioRVEC, desc, srcfile, line);
281 for (m = 0; (m < DIM) && res; m++)
283 if (item && !fio->bRead)
287 res = xdr_int(fio->xdr, &idum);
303 slen = strlen((char *) item) + 1;
315 if (xdr_int(fio->xdr, &slen) <= 0)
317 gmx_fatal(FARGS, "wrong string length %d for string %s"
318 " (source %s, line %d)", slen, desc, srcfile, line);
320 if (!item && fio->bRead)
330 res = xdr_string(fio->xdr, &cptr, slen);
336 if (!item && fio->bRead)
343 gmx_fio_fe(fio, eio, desc, srcfile, line);
349 /*******************************************************************
351 * READ/WRITE FUNCTIONS
353 *******************************************************************/
355 gmx_bool gmx_fio_writee_string(t_fileio *fio, const char *item,
356 const char *desc, const char *srcfile, int line)
359 void *it = (void*)item; /* ugh.. */
361 ret = do_xdr(fio, it, 1, eioSTRING, desc, srcfile, line);
366 gmx_bool gmx_fio_doe_real(t_fileio *fio, real *item,
367 const char *desc, const char *srcfile, int line)
371 ret = do_xdr(fio, item, 1, eioREAL, desc, srcfile, line);
377 gmx_bool gmx_fio_doe_float(t_fileio *fio, float *item,
378 const char *desc, const char *srcfile, int line)
382 ret = do_xdr(fio, item, 1, eioFLOAT, desc, srcfile, line);
387 gmx_bool gmx_fio_doe_double(t_fileio *fio, double *item,
388 const char *desc, const char *srcfile, int line)
392 ret = do_xdr(fio, item, 1, eioDOUBLE, desc, srcfile, line);
398 gmx_bool gmx_fio_doe_gmx_bool(t_fileio *fio, gmx_bool *item,
399 const char *desc, const char *srcfile, int line)
407 ret = do_xdr(fio, &itmp, 1, eioINT, desc, srcfile, line);
413 ret = do_xdr(fio, &itmp, 1, eioINT, desc, srcfile, line);
419 gmx_bool gmx_fio_doe_int(t_fileio *fio, int *item,
420 const char *desc, const char *srcfile, int line)
424 ret = do_xdr(fio, item, 1, eioINT, desc, srcfile, line);
429 gmx_bool gmx_fio_doe_int64(t_fileio *fio, gmx_int64_t *item,
430 const char *desc, const char *srcfile, int line)
434 ret = do_xdr(fio, item, 1, eioINT64, desc, srcfile, line);
439 gmx_bool gmx_fio_doe_uchar(t_fileio *fio, unsigned char *item,
440 const char *desc, const char *srcfile, int line)
444 ret = do_xdr(fio, item, 1, eioUCHAR, desc, srcfile, line);
449 gmx_bool gmx_fio_doe_ushort(t_fileio *fio, unsigned short *item,
450 const char *desc, const char *srcfile, int line)
454 ret = do_xdr(fio, item, 1, eioUSHORT, desc, srcfile, line);
459 gmx_bool gmx_fio_doe_rvec(t_fileio *fio, rvec *item,
460 const char *desc, const char *srcfile, int line)
464 ret = do_xdr(fio, item, 1, eioRVEC, desc, srcfile, line);
469 gmx_bool gmx_fio_doe_ivec(t_fileio *fio, ivec *item,
470 const char *desc, const char *srcfile, int line)
474 ret = do_xdr(fio, item, 1, eioIVEC, desc, srcfile, line);
479 gmx_bool gmx_fio_doe_string(t_fileio *fio, char *item,
480 const char *desc, const char *srcfile, int line)
484 ret = do_xdr(fio, item, 1, eioSTRING, desc, srcfile, line);
490 /* Array reading & writing */
492 gmx_bool gmx_fio_ndoe_real(t_fileio *fio, real *item, int n,
493 const char *desc, const char *srcfile, int line)
498 for (i = 0; i < n; i++)
500 ret = ret && do_xdr(fio, &(item[i]), 1, eioREAL, desc,
509 gmx_bool gmx_fio_ndoe_float(t_fileio *fio, float *item, int n,
510 const char *desc, const char *srcfile, int line)
515 for (i = 0; i < n; i++)
517 ret = ret && do_xdr(fio, &(item[i]), 1, eioFLOAT, desc,
526 gmx_bool gmx_fio_ndoe_double(t_fileio *fio, double *item, int n,
527 const char *desc, const char *srcfile, int line)
532 for (i = 0; i < n; i++)
534 ret = ret && do_xdr(fio, &(item[i]), 1, eioDOUBLE, desc,
543 gmx_bool gmx_fio_ndoe_gmx_bool(t_fileio *fio, gmx_bool *item, int n,
544 const char *desc, const char *srcfile, int line)
550 for (i = 0; i < n; i++)
555 ret = ret && do_xdr(fio, &itmp, 1, eioINT, desc, srcfile, line);
561 ret = ret && do_xdr(fio, &itmp, 1, eioINT, desc, srcfile, line);
568 gmx_bool gmx_fio_ndoe_int(t_fileio *fio, int *item, int n,
569 const char *desc, const char *srcfile, int line)
574 for (i = 0; i < n; i++)
576 ret = ret && do_xdr(fio, &(item[i]), 1, eioINT, desc,
585 gmx_bool gmx_fio_ndoe_int64(t_fileio *fio, gmx_int64_t *item, int n,
586 const char *desc, const char *srcfile, int line)
591 for (i = 0; i < n; i++)
593 ret = ret && do_xdr(fio, &(item[i]), 1, eioINT64, desc,
602 gmx_bool gmx_fio_ndoe_uchar(t_fileio *fio, unsigned char *item, int n,
603 const char *desc, const char *srcfile, int line)
607 ret = ret && do_xdr(fio, item, n, eioNUCHAR, desc,
615 gmx_bool gmx_fio_ndoe_ushort(t_fileio *fio, unsigned short *item, int n,
616 const char *desc, const char *srcfile, int line)
621 for (i = 0; i < n; i++)
623 ret = ret && do_xdr(fio, &(item[i]), 1, eioUSHORT, desc,
632 gmx_bool gmx_fio_ndoe_rvec(t_fileio *fio, rvec *item, int n,
633 const char *desc, const char *srcfile, int line)
637 ret = ret && do_xdr(fio, item, n, eioNRVEC, desc, srcfile, line);
644 gmx_bool gmx_fio_ndoe_ivec(t_fileio *fio, ivec *item, int n,
645 const char *desc, const char *srcfile, int line)
650 for (i = 0; i < n; i++)
652 ret = ret && do_xdr(fio, &(item[i]), 1, eioIVEC, desc,
661 gmx_bool gmx_fio_ndoe_string(t_fileio *fio, char *item[], int n,
662 const char *desc, const char *srcfile, int line)
667 for (i = 0; i < n; i++)
669 ret = ret && do_xdr(fio, &(item[i]), 1, eioSTRING, desc,
679 bool FileIOXdrSerializer::reading() const
684 void FileIOXdrSerializer::doUChar(unsigned char *value)
686 gmx_fio_do_uchar(fio_, *value);
689 void FileIOXdrSerializer::doInt(int *value)
691 gmx_fio_do_int(fio_, *value);
694 void FileIOXdrSerializer::doInt64(gmx_int64_t *value)
696 gmx_fio_do_int64(fio_, *value);
699 void FileIOXdrSerializer::doFloat(float *value)
701 gmx_fio_do_float(fio_, *value);
704 void FileIOXdrSerializer::doDouble(double *value)
706 gmx_fio_do_double(fio_, *value);
709 void FileIOXdrSerializer::doString(std::string *value)
711 // TODO: Use an arbitrary length buffer (but that is not supported in
716 std::strncpy(buf, value->c_str(), STRLEN);
719 gmx_fio_do_string(fio_, buf);