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,2019, 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_FILETYPES_H
38 #define GMX_FILEIO_FILETYPES_H
40 #include "gromacs/utility/basedefinitions.h"
42 /* this enum should correspond to the array deffile in filetypes.cpp */
90 const char* ftp2ext(int ftp);
91 /* Return extension for filetype */
93 const char* ftp2ext_generic(int ftp);
94 /* Return extension for filetype, and a generic name for generic types
97 const char* ftp2ext_with_dot(int ftp);
98 /* Return extension for filetype with a leading dot */
100 int ftp2generic_count(int ftp);
101 /* Return the number of filetypes for a generic filetype */
103 const int* ftp2generic_list(int ftp);
104 /* Return the list of filetypes for a generic filetype */
106 const char* ftp2desc(int ftp);
107 /* Return description for file type */
109 const char* ftp2defnm(int ftp);
110 /* Return default file name for file type */
112 const char* ftp2defopt(int ftp);
113 /* Return default option name for file type */
115 gmx_bool ftp_is_text(int ftp);
116 gmx_bool ftp_is_xdr(int ftp);
118 int fn2ftp(const char* fn);
119 /* Return the filetype corrsponding to filename */