api/legacy/include/gromacs/fileio/filetypes.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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,2020 by the GROMACS development team.
   7  * Copyright (c) 2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #ifndef GMX_FILEIO_FILETYPES_H
  39 #define GMX_FILEIO_FILETYPES_H
  40
  41 #include "gromacs/utility/basedefinitions.h"
  42
  43 /* this enum should correspond to the array deffile in filetypes.cpp */
  44 enum GromacsFileType
  45 {
  46     efMDP,
  47     efTRX,
  48     efTRO,
  49     efTRN,
  50     efTRR,
  51     efCOMPRESSED,
  52     efXTC,
  53     efTNG,
  54     efEDR,
  55     efSTX,
  56     efSTO,
  57     efGRO,
  58     efG96,
  59     efPDB,
  60     efBRK,
  61     efENT,
  62     efESP,
  63     efPQR,
  64     efCPT,
  65     efLOG,
  66     efXVG,
  67     efOUT,
  68     efNDX,
  69     efTOP,
  70     efITP,
  71     efTPS,
  72     efTPR,
  73     efTEX,
  74     efRTP,
  75     efATP,
  76     efHDB,
  77     efDAT,
  78     efDLG,
  79     efMAP,
  80     efEPS,
  81     efMAT,
  82     efM2P,
  83     efMTX,
  84     efEDI,
  85     efCUB,
  86     efXPM,
  87     efRND,
  88     efCSV,
  89     efQMI,
  90     efNR
  91 };
  92
  93 const char* ftp2ext(int ftp);
  94 /* Return extension for filetype */
  95
  96 const char* ftp2ext_generic(int ftp);
  97 /* Return extension for filetype, and a generic name for generic types
  98    (e.g. trx)*/
  99
 100 const char* ftp2ext_with_dot(int ftp);
 101 /* Return extension for filetype with a leading dot */
 102
 103 int ftp2generic_count(int ftp);
 104 /* Return the number of filetypes for a generic filetype */
 105
 106 const int* ftp2generic_list(int ftp);
 107 /* Return the list of filetypes for a generic filetype */
 108
 109 const char* ftp2desc(int ftp);
 110 /* Return description for file type */
 111
 112 const char* ftp2defnm(int ftp);
 113 /* Return default file name for file type */
 114
 115 const char* ftp2defopt(int ftp);
 116 /* Return default option name for file type */
 117
 118 gmx_bool ftp_is_text(int ftp);
 119 gmx_bool ftp_is_xdr(int ftp);
 120
 121 int fn2ftp(const char* fn);
 122 /* Return the filetype corrsponding to filename */
 123
 124 #endif