src/gromacs/gmxpreprocess/xlate.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, 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 #ifdef HAVE_CONFIG_H
  38 #include <config.h>
  39 #endif
  40
  41 #include <ctype.h>
  42 #include <string.h>
  43 #include "typedefs.h"
  44 #include "gromacs/utility/cstringutil.h"
  45 #include "gromacs/utility/smalloc.h"
  46 #include "symtab.h"
  47 #include "index.h"
  48 #include "gromacs/fileio/futil.h"
  49 #include "fflibutil.h"
  50 #include "hackblock.h"
  51 #include "gmx_fatal.h"
  52 #include "xlate.h"
  53
  54 #include "gromacs/fileio/strdb.h"
  55
  56 typedef struct {
  57     char *filebase;
  58     char *res;
  59     char *atom;
  60     char *replace;
  61 } t_xlate_atom;
  62
  63 static void get_xlatoms(const char *fn, FILE *fp,
  64                         int *nptr, t_xlate_atom **xlptr)
  65 {
  66     char          filebase[STRLEN];
  67     char          line[STRLEN];
  68     char          abuf[1024], rbuf[1024], repbuf[1024], dumbuf[1024];
  69     char         *_ptr;
  70     int           n, na, idum;
  71     t_xlate_atom *xl;
  72
  73     fflib_filename_base(fn, filebase, STRLEN);
  74
  75     n  = *nptr;
  76     xl = *xlptr;
  77
  78     while (get_a_line(fp, line, STRLEN))
  79     {
  80         na = sscanf(line, "%s%s%s%s", rbuf, abuf, repbuf, dumbuf);
  81         /* Check if we are reading an old format file with the number of items
  82          * on the first line.
  83          */
  84         if (na == 1 && n == *nptr && sscanf(rbuf, "%d", &idum) == 1)
  85         {
  86             continue;
  87         }
  88         if (na != 3)
  89         {
  90             gmx_fatal(FARGS, "Expected a residue name and two atom names in file '%s', not '%s'", fn, line);
  91         }
  92
  93         srenew(xl, n+1);
  94         xl[n].filebase = strdup(filebase);
  95
  96         /* Use wildcards... */
  97         if (strcmp(rbuf, "*") != 0)
  98         {
  99             xl[n].res = strdup(rbuf);
 100         }
 101         else
 102         {
 103             xl[n].res = NULL;
 104         }
 105
 106         /* Replace underscores in the string by spaces */
 107         while ((_ptr = strchr(abuf, '_')) != 0)
 108         {
 109             *_ptr = ' ';
 110         }
 111
 112         xl[n].atom    = strdup(abuf);
 113         xl[n].replace = strdup(repbuf);
 114         n++;
 115     }
 116
 117     *nptr  = n;
 118     *xlptr = xl;
 119 }
 120
 121 static void done_xlatom(int nxlate, t_xlate_atom *xlatom)
 122 {
 123     int i;
 124
 125     for (i = 0; (i < nxlate); i++)
 126     {
 127         sfree(xlatom[i].filebase);
 128         if (xlatom[i].res != NULL)
 129         {
 130             sfree(xlatom[i].res);
 131         }
 132         sfree(xlatom[i].atom);
 133         sfree(xlatom[i].replace);
 134     }
 135     sfree(xlatom);
 136 }
 137
 138 void rename_atoms(const char *xlfile, const char *ffdir,
 139                   t_atoms *atoms, t_symtab *symtab, const t_restp *restp,
 140                   gmx_bool bResname, gmx_residuetype_t rt, gmx_bool bReorderNum,
 141                   gmx_bool bVerbose)
 142 {
 143     FILE         *fp;
 144     int           nxlate, a, i, resind;
 145     t_xlate_atom *xlatom;
 146     int           nf;
 147     char        **f;
 148     char          c, *rnm, atombuf[32], *ptr0, *ptr1;
 149     gmx_bool      bReorderedNum, bRenamed, bMatch;
 150     gmx_bool      bStartTerm, bEndTerm;
 151
 152     nxlate = 0;
 153     xlatom = NULL;
 154     if (xlfile != NULL)
 155     {
 156         fp = libopen(xlfile);
 157         get_xlatoms(xlfile, fp, &nxlate, &xlatom);
 158         fclose(fp);
 159     }
 160     else
 161     {
 162         nf = fflib_search_file_end(ffdir, ".arn", FALSE, &f);
 163         for (i = 0; i < nf; i++)
 164         {
 165             fp = fflib_open(f[i]);
 166             get_xlatoms(f[i], fp, &nxlate, &xlatom);
 167             gmx_ffclose(fp);
 168             sfree(f[i]);
 169         }
 170         sfree(f);
 171     }
 172
 173     for (a = 0; (a < atoms->nr); a++)
 174     {
 175         resind = atoms->atom[a].resind;
 176
 177         bStartTerm = (resind == 0) || atoms->resinfo[resind].chainnum != atoms->resinfo[resind-1].chainnum;
 178         bEndTerm   = (resind >= atoms->nres-1) || atoms->resinfo[resind].chainnum != atoms->resinfo[resind+1].chainnum;
 179
 180         if (bResname)
 181         {
 182             rnm = *(atoms->resinfo[resind].name);
 183         }
 184         else
 185         {
 186             rnm = *(atoms->resinfo[resind].rtp);
 187         }
 188
 189         strcpy(atombuf, *(atoms->atomname[a]));
 190         bReorderedNum = FALSE;
 191         if (bReorderNum)
 192         {
 193             if (isdigit(atombuf[0]))
 194             {
 195                 c = atombuf[0];
 196                 for (i = 0; ((size_t)i < strlen(atombuf)-1); i++)
 197                 {
 198                     atombuf[i] = atombuf[i+1];
 199                 }
 200                 atombuf[i]    = c;
 201                 bReorderedNum = TRUE;
 202             }
 203         }
 204         bRenamed = FALSE;
 205         for (i = 0; (i < nxlate) && !bRenamed; i++)
 206         {
 207             /* Check if the base file name of the rtp and arn entry match */
 208             if (restp == NULL ||
 209                 gmx_strcasecmp(restp[resind].filebase, xlatom[i].filebase) == 0)
 210             {
 211                 /* Match the residue name */
 212                 bMatch = (xlatom[i].res == NULL ||
 213                           (gmx_strcasecmp("protein-nterm", xlatom[i].res) == 0 &&
 214                            gmx_residuetype_is_protein(rt, rnm) && bStartTerm) ||
 215                           (gmx_strcasecmp("protein-cterm", xlatom[i].res) == 0 &&
 216                            gmx_residuetype_is_protein(rt, rnm) && bEndTerm) ||
 217                           (gmx_strcasecmp("protein", xlatom[i].res) == 0 &&
 218                            gmx_residuetype_is_protein(rt, rnm)) ||
 219                           (gmx_strcasecmp("DNA", xlatom[i].res) == 0 &&
 220                            gmx_residuetype_is_dna(rt, rnm)) ||
 221                           (gmx_strcasecmp("RNA", xlatom[i].res) == 0 &&
 222                            gmx_residuetype_is_rna(rt, rnm)));
 223                 if (!bMatch)
 224                 {
 225                     ptr0 = rnm;
 226                     ptr1 = xlatom[i].res;
 227                     while (ptr0[0] != '\0' && ptr1[0] != '\0' &&
 228                            (ptr0[0] == ptr1[0] || ptr1[0] == '?'))
 229                     {
 230                         ptr0++;
 231                         ptr1++;
 232                     }
 233                     bMatch = (ptr0[0] == '\0' && ptr1[0] == '\0');
 234                 }
 235                 if (bMatch && strcmp(atombuf, xlatom[i].atom) == 0)
 236                 {
 237                     /* We have a match. */
 238                     /* Don't free the old atomname,
 239                      * since it might be in the symtab.
 240                      */
 241                     ptr0 = strdup(xlatom[i].replace);
 242                     if (bVerbose)
 243                     {
 244                         printf("Renaming atom '%s' in residue %d %s to '%s'\n",
 245                                *atoms->atomname[a],
 246                                atoms->resinfo[resind].nr,
 247                                *atoms->resinfo[resind].name,
 248                                ptr0);
 249                     }
 250                     atoms->atomname[a] = put_symtab(symtab, ptr0);
 251                     bRenamed           = TRUE;
 252                 }
 253             }
 254         }
 255         if (bReorderedNum && !bRenamed)
 256         {
 257             atoms->atomname[a] = put_symtab(symtab, atombuf);
 258         }
 259     }
 260
 261     done_xlatom(nxlate, xlatom);
 262 }