src/gromacs/fileio/filenm.c

   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, 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.
  10  *
  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.
  15  *
  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.
  20  *
  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.
  25  *
  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.
  33  *
  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.
  36  */
  37 #include "gmxpre.h"
  38
  39 #include "filenm.h"
  40
  41 #include <stdio.h>
  42 #include <string.h>
  43
  44 #include "gromacs/legacyheaders/macros.h"
  45 #include "gromacs/legacyheaders/types/commrec.h"
  46 #include "gromacs/utility/basedefinitions.h"
  47 #include "gromacs/utility/cstringutil.h"
  48 #include "gromacs/utility/fatalerror.h"
  49 #include "gromacs/utility/smalloc.h"
  50
  51 /* Use bitflag ... */
  52 #define IS_SET(fn) ((fn.flag & ffSET) != 0)
  53 #define IS_OPT(fn) ((fn.flag & ffOPT) != 0)
  54
  55 enum
  56 {
  57     eftASC, eftXDR, eftTNG, eftGEN, eftNR
  58 };
  59
  60 /* To support multiple file types with one general (eg TRX) we have
  61  * these arrays.
  62  */
  63 static const int trxs[] =
  64 {
  65     efXTC, efTRR, efCPT,
  66     efGRO, efG96, efPDB, efTNG
  67 };
  68 #define NTRXS asize(trxs)
  69
  70 static const int trcompressed[] =
  71 {
  72     efXTC,
  73     efTNG
  74 };
  75 #define NTRCOMPRESSED asize(trcompressed)
  76
  77 static const int tros[] =
  78 {
  79     efXTC, efTRR,
  80     efGRO, efG96, efPDB, efTNG
  81 };
  82 #define NTROS asize(tros)
  83
  84 static const int trns[] =
  85 {
  86     efTRR, efCPT,
  87     efTNG
  88 };
  89 #define NTRNS asize(trns)
  90
  91 static const int stos[] =
  92 { efGRO, efG96, efPDB, efBRK, efENT, efESP };
  93 #define NSTOS asize(stos)
  94
  95 static const int stxs[] =
  96 {
  97     efGRO, efG96, efPDB, efBRK, efENT, efESP,
  98     efTPR
  99 };
 100 #define NSTXS asize(stxs)
 101
 102 static const int tpss[] =
 103 {
 104     efTPR,
 105     efGRO, efG96, efPDB, efBRK, efENT
 106 };
 107 #define NTPSS asize(tpss)
 108
 109 typedef struct
 110 {
 111     int         ftype;
 112     const char *ext;
 113     const char *defnm;
 114     const char *defopt;
 115     const char *descr;
 116     int         ntps;
 117     const int  *tps;
 118 } t_deffile;
 119
 120 /* this array should correspond to the enum in filenm.h */
 121 static const t_deffile
 122     deffile[efNR] =
 123 {
 124     { eftASC, ".mdp", "grompp", "-f", "grompp input file with MD parameters" },
 125     { eftGEN, ".???", "traj", "-f", "Trajectory", NTRXS, trxs },
 126     { eftGEN, ".???", "trajout", "-f", "Trajectory", NTROS, tros },
 127     { eftGEN, ".???", "traj", NULL,
 128       "Full precision trajectory", NTRNS, trns },
 129     { eftXDR, ".trr", "traj", NULL, "Trajectory in portable xdr format" },
 130     { eftGEN, ".???", "traj_comp", NULL,
 131       "Compressed trajectory (tng format or portable xdr format)", NTRCOMPRESSED, trcompressed},
 132     { eftXDR, ".xtc", "traj", NULL,
 133       "Compressed trajectory (portable xdr format): xtc" },
 134     { eftTNG, ".tng", "traj", NULL,
 135       "Trajectory file (tng format)" },
 136     { eftXDR, ".edr", "ener",   NULL, "Energy file"},
 137     { eftGEN, ".???", "conf", "-c", "Structure file", NSTXS, stxs },
 138     { eftGEN, ".???", "out", "-o", "Structure file", NSTOS, stos },
 139     { eftASC, ".gro", "conf", "-c", "Coordinate file in Gromos-87 format" },
 140     { eftASC, ".g96", "conf", "-c", "Coordinate file in Gromos-96 format" },
 141     { eftASC, ".pdb", "eiwit",  "-f", "Protein data bank file"},
 142     { eftASC, ".brk", "eiwit",  "-f", "Brookhaven data bank file"},
 143     { eftASC, ".ent", "eiwit", "-f", "Entry in the protein date bank" },
 144     { eftASC, ".esp", "conf", "-f", "Coordinate file in Espresso format" },
 145     { eftASC, ".pqr", "state",  "-o", "Coordinate file for MEAD"},
 146     { eftXDR, ".cpt", "state",  "-cp", "Checkpoint file"},
 147     { eftASC, ".log", "run",    "-l", "Log file"},
 148     { eftASC, ".xvg", "graph",  "-o", "xvgr/xmgr file"},
 149     { eftASC, ".out", "hello",  "-o", "Generic output file"},
 150     { eftASC, ".ndx", "index",  "-n", "Index file", },
 151     { eftASC, ".top", "topol",  "-p", "Topology file"},
 152     { eftASC, ".itp", "topinc", NULL, "Include file for topology"},
 153     { eftGEN, ".???", "topol", "-s", "Structure+mass(db)", NTPSS, tpss },
 154     { eftXDR, ".tpr", "topol",  "-s", "Portable xdr run input file"},
 155     { eftASC, ".tex", "doc",    "-o", "LaTeX file"},
 156     { eftASC, ".rtp", "residue", NULL, "Residue Type file used by pdb2gmx" },
 157     { eftASC, ".atp", "atomtp", NULL, "Atomtype file used by pdb2gmx" },
 158     { eftASC, ".hdb", "polar",  NULL, "Hydrogen data base"},
 159     { eftASC, ".dat", "nnnice", NULL, "Generic data file"},
 160     { eftASC, ".dlg", "user",   NULL, "Dialog Box data for ngmx"},
 161     { eftASC, ".map", "ss", NULL, "File that maps matrix data to colors" },
 162     { eftASC, ".eps", "plot", NULL, "Encapsulated PostScript (tm) file" },
 163     { eftASC, ".mat", "ss",     NULL, "Matrix Data file"},
 164     { eftASC, ".m2p", "ps",     NULL, "Input file for mat2ps"},
 165     { eftXDR, ".mtx", "hessian", "-m", "Hessian matrix"},
 166     { eftASC, ".edi", "sam",    NULL, "ED sampling input"},
 167     { eftASC, ".cub", "pot",  NULL, "Gaussian cube file" },
 168     { eftASC, ".xpm", "root", NULL, "X PixMap compatible matrix file" },
 169     { eftASC, "", "rundir", NULL, "Run directory" }
 170 };
 171
 172 #define NZEXT 2
 173 static const char *z_ext[NZEXT] =
 174 { ".gz", ".Z" };
 175
 176 const char *ftp2ext(int ftp)
 177 {
 178     if ((0 <= ftp) && (ftp < efNR))
 179     {
 180         return deffile[ftp].ext[0] != '\0' ? deffile[ftp].ext + 1 : "";
 181     }
 182     else
 183     {
 184         return "unknown";
 185     }
 186 }
 187
 188 const char *ftp2ext_generic(int ftp)
 189 {
 190     if ((0 <= ftp) && (ftp < efNR))
 191     {
 192         switch (ftp)
 193         {
 194             case efTRX:
 195                 return "trx";
 196             case efTRN:
 197                 return "trn";
 198             case efSTO:
 199                 return "sto";
 200             case efSTX:
 201                 return "stx";
 202             case efTPS:
 203                 return "tps";
 204             default:
 205                 return ftp2ext(ftp);
 206         }
 207     }
 208     else
 209     {
 210         return "unknown";
 211     }
 212 }
 213
 214 const char *ftp2ext_with_dot(int ftp)
 215 {
 216     if ((0 <= ftp) && (ftp < efNR))
 217     {
 218         return deffile[ftp].ext;
 219     }
 220     else
 221     {
 222         return "unknown";
 223     }
 224 }
 225
 226 int ftp2generic_count(int ftp)
 227 {
 228     if ((0 <= ftp) && (ftp < efNR))
 229     {
 230         return deffile[ftp].ntps;
 231     }
 232     else
 233     {
 234         return 0;
 235     }
 236 }
 237
 238 const int *ftp2generic_list(int ftp)
 239 {
 240     if ((0 <= ftp) && (ftp < efNR))
 241     {
 242         return deffile[ftp].tps;
 243     }
 244     else
 245     {
 246         return 0;
 247     }
 248 }
 249
 250 const char *ftp2desc(int ftp)
 251 {
 252     if ((0 <= ftp) && (ftp < efNR))
 253     {
 254         return deffile[ftp].descr;
 255     }
 256     else
 257     {
 258         return "unknown filetype";
 259     }
 260 }
 261
 262 const char *ftp2ftype(int ftp)
 263 {
 264     if ((ftp >= 0) && (ftp < efNR))
 265     {
 266         switch (deffile[ftp].ftype)
 267         {
 268             case eftASC:
 269                 return "ASCII";
 270             case eftXDR:
 271                 return "XDR portable";
 272             case eftTNG:
 273                 return "TNG";
 274             case eftGEN:
 275                 return "";
 276             default:
 277                 gmx_fatal(FARGS, "Unknown filetype %d in ftp2ftype", deffile[ftp].ftype);
 278                 break;
 279         }
 280     }
 281     return "unknown";
 282 }
 283
 284 const char *ftp2defnm(int ftp)
 285 {
 286     if ((0 <= ftp) && (ftp < efNR))
 287     {
 288         return deffile[ftp].defnm;
 289     }
 290     else
 291     {
 292         return NULL;
 293     }
 294 }
 295
 296 const char *ftp2defopt(int ftp)
 297 {
 298     if ((0 <= ftp) && (ftp < efNR))
 299     {
 300         return deffile[ftp].defopt;
 301     }
 302     else
 303     {
 304         return NULL;
 305     }
 306 }
 307
 308 int fn2ftp(const char *fn)
 309 {
 310     int         i, len;
 311     const char *feptr;
 312     const char *eptr;
 313
 314     if (!fn)
 315     {
 316         return efNR;
 317     }
 318
 319     len = strlen(fn);
 320     if ((len >= 4) && (fn[len - 4] == '.'))
 321     {
 322         feptr = &(fn[len - 4]);
 323     }
 324     else
 325     {
 326         return efNR;
 327     }
 328
 329     for (i = 0; (i < efNR); i++)
 330     {
 331         if ((eptr = deffile[i].ext) != NULL)
 332         {
 333             if (gmx_strcasecmp(feptr, eptr) == 0)
 334             {
 335                 break;
 336             }
 337         }
 338     }
 339
 340     return i;
 341 }
 342
 343 const char *opt2fn(const char *opt, int nfile, const t_filenm fnm[])
 344 {
 345     int i;
 346
 347     for (i = 0; (i < nfile); i++)
 348     {
 349         if (strcmp(opt, fnm[i].opt) == 0)
 350         {
 351             return fnm[i].fns[0];
 352         }
 353     }
 354
 355     fprintf(stderr, "No option %s\n", opt);
 356
 357     return NULL;
 358 }
 359
 360 const char *opt2fn_master(const char *opt, int nfile, const t_filenm fnm[],
 361                           t_commrec *cr)
 362 {
 363     return SIMMASTER(cr) ? opt2fn(opt, nfile, fnm) : NULL;
 364 }
 365
 366 int opt2fns(char **fns[], const char *opt, int nfile, const t_filenm fnm[])
 367 {
 368     int i;
 369
 370     for (i = 0; (i < nfile); i++)
 371     {
 372         if (strcmp(opt, fnm[i].opt) == 0)
 373         {
 374             *fns = fnm[i].fns;
 375             return fnm[i].nfiles;
 376         }
 377     }
 378
 379     fprintf(stderr, "No option %s\n", opt);
 380     return 0;
 381 }
 382
 383 const char *ftp2fn(int ftp, int nfile, const t_filenm fnm[])
 384 {
 385     int i;
 386
 387     for (i = 0; (i < nfile); i++)
 388     {
 389         if (ftp == fnm[i].ftp)
 390         {
 391             return fnm[i].fns[0];
 392         }
 393     }
 394
 395     fprintf(stderr, "ftp2fn: No filetype %s\n", deffile[ftp].ext);
 396     return NULL;
 397 }
 398
 399 int ftp2fns(char **fns[], int ftp, int nfile, const t_filenm fnm[])
 400 {
 401     int i;
 402
 403     for (i = 0; (i < nfile); i++)
 404     {
 405         if (ftp == fnm[i].ftp)
 406         {
 407             *fns = fnm[i].fns;
 408             return fnm[i].nfiles;
 409         }
 410     }
 411
 412     fprintf(stderr, "ftp2fn: No filetype %s\n", deffile[ftp].ext);
 413     return 0;
 414 }
 415
 416 gmx_bool ftp2bSet(int ftp, int nfile, const t_filenm fnm[])
 417 {
 418     int i;
 419
 420     for (i = 0; (i < nfile); i++)
 421     {
 422         if (ftp == fnm[i].ftp)
 423         {
 424             return (gmx_bool) IS_SET(fnm[i]);
 425         }
 426     }
 427
 428     fprintf(stderr, "ftp2bSet: No filetype %s\n", deffile[ftp].ext);
 429
 430     return FALSE;
 431 }
 432
 433 gmx_bool opt2bSet(const char *opt, int nfile, const t_filenm fnm[])
 434 {
 435     int i;
 436
 437     for (i = 0; (i < nfile); i++)
 438     {
 439         if (strcmp(opt, fnm[i].opt) == 0)
 440         {
 441             return (gmx_bool) IS_SET(fnm[i]);
 442         }
 443     }
 444
 445     fprintf(stderr, "No option %s\n", opt);
 446
 447     return FALSE;
 448 }
 449
 450 const char *opt2fn_null(const char *opt, int nfile, const t_filenm fnm[])
 451 {
 452     int i;
 453
 454     for (i = 0; (i < nfile); i++)
 455     {
 456         if (strcmp(opt, fnm[i].opt) == 0)
 457         {
 458             if (IS_OPT(fnm[i]) && !IS_SET(fnm[i]))
 459             {
 460                 return NULL;
 461             }
 462             else
 463             {
 464                 return fnm[i].fns[0];
 465             }
 466         }
 467     }
 468     fprintf(stderr, "No option %s\n", opt);
 469     return NULL;
 470 }
 471
 472 const char *ftp2fn_null(int ftp, int nfile, const t_filenm fnm[])
 473 {
 474     int i;
 475
 476     for (i = 0; (i < nfile); i++)
 477     {
 478         if (ftp == fnm[i].ftp)
 479         {
 480             if (IS_OPT(fnm[i]) && !IS_SET(fnm[i]))
 481             {
 482                 return NULL;
 483             }
 484             else
 485             {
 486                 return fnm[i].fns[0];
 487             }
 488         }
 489     }
 490     fprintf(stderr, "ftp2fn: No filetype %s\n", deffile[ftp].ext);
 491     return NULL;
 492 }
 493
 494 gmx_bool is_optional(const t_filenm *fnm)
 495 {
 496     return ((fnm->flag & ffOPT) == ffOPT);
 497 }
 498
 499 gmx_bool is_output(const t_filenm *fnm)
 500 {
 501     return ((fnm->flag & ffWRITE) == ffWRITE);
 502 }
 503
 504 gmx_bool is_set(const t_filenm *fnm)
 505 {
 506     return ((fnm->flag & ffSET) == ffSET);
 507 }
 508
 509 int add_suffix_to_output_names(t_filenm *fnm, int nfile, const char *suffix)
 510 {
 511     int   i, j, pos;
 512     char  buf[STRLEN], newname[STRLEN];
 513     char *extpos;
 514
 515     for (i = 0; i < nfile; i++)
 516     {
 517         if (is_output(&fnm[i]) && fnm[i].ftp != efCPT)
 518         {
 519             /* We never use multiple _outputs_, but we might as well check
 520                for it, just in case... */
 521             for (j = 0; j < fnm[i].nfiles; j++)
 522             {
 523                 strncpy(buf, fnm[i].fns[j], STRLEN - 1);
 524                 extpos  = strrchr(buf, '.');
 525                 *extpos = '\0';
 526                 sprintf(newname, "%s%s.%s", buf, suffix, extpos + 1);
 527                 sfree(fnm[i].fns[j]);
 528                 fnm[i].fns[j] = gmx_strdup(newname);
 529             }
 530         }
 531     }
 532     return 0;
 533 }
 534
 535 t_filenm *dup_tfn(int nf, const t_filenm tfn[])
 536 {
 537     int       i, j;
 538     t_filenm *ret;
 539
 540     snew(ret, nf);
 541     for (i = 0; i < nf; i++)
 542     {
 543         ret[i] = tfn[i]; /* just directly copy all non-string fields */
 544         if (tfn[i].opt)
 545         {
 546             ret[i].opt = gmx_strdup(tfn[i].opt);
 547         }
 548         else
 549         {
 550             ret[i].opt = NULL;
 551         }
 552
 553         if (tfn[i].fn)
 554         {
 555             ret[i].fn = gmx_strdup(tfn[i].fn);
 556         }
 557         else
 558         {
 559             ret[i].fn = NULL;
 560         }
 561
 562         if (tfn[i].nfiles > 0)
 563         {
 564             snew(ret[i].fns, tfn[i].nfiles);
 565             for (j = 0; j < tfn[i].nfiles; j++)
 566             {
 567                 ret[i].fns[j] = gmx_strdup(tfn[i].fns[j]);
 568             }
 569         }
 570     }
 571     return ret;
 572 }
 573
 574 void done_filenms(int nf, t_filenm fnm[])
 575 {
 576     int i, j;
 577
 578     for (i = 0; i < nf; ++i)
 579     {
 580         for (j = 0; j < fnm[i].nfiles; ++j)
 581         {
 582             sfree(fnm[i].fns[j]);
 583         }
 584         sfree(fnm[i].fns);
 585         fnm[i].fns = NULL;
 586     }
 587 }