src/gromacs/commandline/viewit.cpp

   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,2017,2018,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.
  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 /* This file is completely threadsafe - keep it that way! */
  38 #include "gmxpre.h"
  39
  40 #include "viewit.h"
  41
  42 #include <cstdlib>
  43 #include <cstring>
  44
  45 #include "gromacs/commandline/filenm.h"
  46 #include "gromacs/fileio/oenv.h"
  47 #include "gromacs/utility/arraysize.h"
  48 #include "gromacs/utility/cstringutil.h"
  49 #include "gromacs/utility/fatalerror.h"
  50
  51 static const int can_view_ftp[] = { 0, efEPS, efXPM, efXVG, efPDB };
  52 #define NVIEW asize(can_view_ftp)
  53 static const char* view_program[] = { nullptr, "ghostview", "display", nullptr, "xterm -e rasmol" };
  54
  55 static int can_view(int ftp)
  56 {
  57     int i;
  58
  59     for (i = 1; i < NVIEW; i++)
  60     {
  61         if (ftp == can_view_ftp[i])
  62         {
  63             return i;
  64         }
  65     }
  66
  67     return 0;
  68 }
  69
  70 void do_view(const gmx_output_env_t* oenv, const char* fn, const char* opts)
  71 {
  72     char        buf[STRLEN], env[STRLEN];
  73     const char* cmd;
  74     int         ftp, n;
  75
  76     if (output_env_get_view(oenv) && fn)
  77     {
  78         if (getenv("DISPLAY") == nullptr)
  79         {
  80             fprintf(stderr, "Can not view %s, no DISPLAY environment variable.\n", fn);
  81         }
  82         else
  83         {
  84             ftp = fn2ftp(fn);
  85             sprintf(env, "GMX_VIEW_%s", ftp2ext(ftp));
  86             upstring(env);
  87             switch (ftp)
  88             {
  89                 case efXVG:
  90                     if (!(cmd = getenv(env)))
  91                     {
  92                         if (getenv("GMX_USE_XMGR"))
  93                         {
  94                             cmd = "xmgr";
  95                         }
  96                         else
  97                         {
  98                             cmd = "xmgrace";
  99                         }
 100                     }
 101                     break;
 102                 default:
 103                     if ((n = can_view(ftp)))
 104                     {
 105                         if (!(cmd = getenv(env)))
 106                         {
 107                             cmd = view_program[n];
 108                         }
 109                     }
 110                     else
 111                     {
 112                         fprintf(stderr, "Don't know how to view file %s", fn);
 113                         return;
 114                     }
 115             }
 116             if (strlen(cmd))
 117             {
 118                 sprintf(buf, "%s %s %s &", cmd, opts ? opts : "", fn);
 119                 fprintf(stderr, "Executing '%s'\n", buf);
 120                 if (0 != system(buf))
 121                 {
 122                     gmx_fatal(FARGS, "Failed executing command: %s", buf);
 123                 }
 124             }
 125         }
 126     }
 127 }
 128
 129 void view_all(const gmx_output_env_t* oenv, int nf, t_filenm fnm[])
 130 {
 131     int i;
 132
 133     for (i = 0; i < nf; i++)
 134     {
 135         if (can_view(fnm[i].ftp) && is_output(&(fnm[i])) && (!is_optional(&(fnm[i])) || is_set(&(fnm[i]))))
 136         {
 137             do_view(oenv, fnm[i].filenames[0].c_str(), nullptr);
 138         }
 139     }
 140 }