src/programs/view/view.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,2019,2020, 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 "view.h"
  40
  41 #include "config.h"
  42
  43 #include <cstdio>
  44
  45 #include <string>
  46
  47 #include "gromacs/commandline/pargs.h"
  48 #include "gromacs/fileio/confio.h"
  49 #include "gromacs/fileio/oenv.h"
  50 #include "gromacs/fileio/tpxio.h"
  51 #include "gromacs/trajectory/trajectoryframe.h"
  52 #include "gromacs/utility/arraysize.h"
  53 #include "gromacs/utility/coolstuff.h"
  54 #include "gromacs/utility/fatalerror.h"
  55 #include "gromacs/utility/smalloc.h"
  56
  57 #if GMX_X11
  58
  59 #    include "gromacs/fileio/writeps.h"
  60
  61 #    include "Xstuff.h"
  62 #    include "dialogs.h"
  63 #    include "gromacs.bm"
  64 #    include "molps.h"
  65 #    include "nmol.h"
  66 #    include "xutil.h"
  67
  68 static void dump_it(t_manager* man)
  69 {
  70     t_psdata ps;
  71
  72     ps = ps_open("view.ps", 0, 0, man->molw->wd.width, man->molw->wd.height);
  73     ps_draw_mol(&ps, man);
  74     ps_close(&ps);
  75 }
  76
  77 static void done_gmx(t_x11* x11, t_gmx* gmx)
  78 {
  79     done_logo(x11, gmx->logo);
  80     done_pd(x11, gmx->pd);
  81     done_man(x11, gmx->man);
  82     done_dlgs(gmx);
  83     x11->UnRegisterCallback(x11, gmx->wd->self);
  84 }
  85
  86 static void move_gmx(t_x11* x11, t_gmx* gmx, int width, int height, bool bSizePD)
  87 {
  88     int y0, wl, hl;
  89 #    ifdef DEBUG
  90     std::fprintf(stderr, "Move gmx %dx%d\n", width, height);
  91 #    endif
  92     y0 = XTextHeight(x11->font);
  93     /* Resize PD-Menu */
  94     if (bSizePD)
  95     {
  96         XResizeWindow(x11->disp, gmx->pd->wd.self, width, y0);
  97     }
  98
  99     XMoveWindow(x11->disp, gmx->man->wd.self, 0, y0 + 1);
 100     XResizeWindow(x11->disp, gmx->man->wd.self, width, height - y0 - 1);
 101
 102     wl = gmx->logo->wd.width;
 103     hl = gmx->logo->wd.height;
 104     XMoveWindow(x11->disp, gmx->logo->wd.self, (width - wl) / 2, (height - y0 - hl) / 2);
 105 }
 106
 107 static bool HandleClient(t_x11* x11, int ID, t_gmx* gmx)
 108 {
 109     t_pulldown* pd;
 110
 111     pd = gmx->pd;
 112
 113     switch (ID)
 114     {
 115         /* File Menu */
 116         case IDDUMPWIN: write_gmx(x11, gmx, IDDODUMP); break;
 117         case IDDODUMP:
 118             if (gmx->man->bAnimate)
 119             {
 120                 hide_but(x11, gmx->man->vbox);
 121             }
 122             dump_it(gmx->man);
 123             if (gmx->man->bAnimate)
 124             {
 125                 show_but(x11, gmx->man->vbox);
 126             }
 127             break;
 128         case IDCLOSE:
 129         case IDIMPORT:
 130         case IDEXPORT: ShowDlg(gmx->dlgs[edExport]); break;
 131         case IDDOEXPORT:
 132             write_sto_conf(gmx->confout,
 133                            *gmx->man->top.name,
 134                            &(gmx->man->top.atoms),
 135                            gmx->man->x,
 136                            nullptr,
 137                            gmx->man->molw->pbcType,
 138                            gmx->man->box);
 139             break;
 140         case IDQUIT: show_mb(gmx, emQuit); break;
 141         case IDTERM: done_gmx(x11, gmx); return true;
 142
 143         /* Edit Menu */
 144         case IDEDITTOP: edit_file("topol.gmx"); break;
 145         case IDEDITCOORDS: edit_file("confin.gmx"); break;
 146         case IDEDITPARAMS: edit_file("mdparin.gmx"); break;
 147
 148         /* Display Menu */
 149         case IDFILTER:
 150             if (gmx->filter)
 151             {
 152                 ShowDlg(gmx->dlgs[edFilter]);
 153             }
 154             break;
 155         case IDDOFILTER: do_filter(x11, gmx->man, gmx->filter); break;
 156         case IDANIMATE: check_pd_item(pd, IDANIMATE, toggle_animate(x11, gmx->man)); break;
 157         case IDLABELSOFF: no_labels(x11, gmx->man); break;
 158         case IDRESETVIEW:
 159             reset_view(gmx->man->view);
 160             ExposeWin(x11->disp, gmx->man->molw->wd.self);
 161             break;
 162         case IDPHOTO: show_mb(gmx, emNotImplemented); break;
 163         case IDBONDOPTS: ShowDlg(gmx->dlgs[edBonds]); break;
 164         case IDTHIN: set_bond_type(x11, gmx->man->molw, eBThin); break;
 165         case IDFAT: set_bond_type(x11, gmx->man->molw, eBFat); break;
 166         case IDVERYFAT: set_bond_type(x11, gmx->man->molw, eBVeryFat); break;
 167         case IDBALLS: set_bond_type(x11, gmx->man->molw, eBSpheres); break;
 168         case IDNOBOX: set_box_type(x11, gmx->man->molw, esbNone); break;
 169         case IDRECTBOX: set_box_type(x11, gmx->man->molw, esbRect); break;
 170         case IDTRIBOX: set_box_type(x11, gmx->man->molw, esbTri); break;
 171         case IDTOBOX: set_box_type(x11, gmx->man->molw, esbTrunc); break;
 172
 173         /* Analysis Menu */
 174         case IDBOND:
 175         case IDANGLE:
 176         case IDDIH:
 177         case IDRMS:
 178         case IDRDF:
 179         case IDENERGIES:
 180         case IDCORR: show_mb(gmx, emNotImplemented); break;
 181
 182         /* Help Menu */
 183         case IDHELP: show_mb(gmx, emHelp); break;
 184         case IDABOUT: show_logo(x11, gmx->logo); break;
 185
 186         default: break;
 187     }
 188     return false;
 189 }
 190
 191 static bool MainCallBack(t_x11* x11, XEvent* event, Window /*w*/, void* data)
 192 {
 193     t_gmx* gmx;
 194     int    nsel, width, height;
 195     bool   result;
 196
 197     result = false;
 198     gmx    = (t_gmx*)data;
 199     switch (event->type)
 200     {
 201         case ButtonRelease: hide_pd(x11, gmx->pd); break;
 202         case ConfigureNotify:
 203             width  = event->xconfigure.width;
 204             height = event->xconfigure.height;
 205             if ((width != gmx->wd->width) || (height != gmx->wd->height))
 206             {
 207                 move_gmx(x11, gmx, width, height, true);
 208             }
 209             break;
 210         case ClientMessage:
 211             hide_pd(x11, gmx->pd);
 212             nsel   = event->xclient.data.l[0];
 213             result = HandleClient(x11, nsel, gmx);
 214             break;
 215         default: break;
 216     }
 217     return result;
 218 }
 219
 220 static t_mentry FileMenu[] = { { 0, IDEXPORT, false, "Export..." },
 221                                { 0, IDDUMPWIN, false, "Print" },
 222                                { 0, IDQUIT, false, "Quit" } };
 223
 224 static t_mentry DispMenu[] = { { 0, IDFILTER, false, "Filter..." },
 225                                { 0, IDANIMATE, false, "Animate" },
 226                                { 0, IDLABELSOFF, false, "Labels Off" },
 227                                { 0, IDRESETVIEW, false, "Reset View" },
 228                                { 0, IDBONDOPTS, false, "Options..." } };
 229
 230 static t_mentry HelpMenu[] = { { 0, IDHELP, false, "Help" },
 231                                { 0, IDABOUT, false, "About GROMACS..." } };
 232
 233 static t_mentry* gmx_pd[] = { FileMenu, DispMenu, HelpMenu };
 234
 235 #    define MSIZE asize(gmx_pd)
 236
 237 static int gmx_pd_size[MSIZE] = { asize(FileMenu), asize(DispMenu), asize(HelpMenu) };
 238
 239 static const char* MenuTitle[MSIZE] = { "File", "Display", "Help" };
 240
 241 static void init_gmx(t_x11* x11, char* program, int nfile, t_filenm fnm[], gmx_output_env_t* oenv)
 242 {
 243     Pixmap       pm;
 244     t_gmx*       gmx;
 245     XSizeHints   hints;
 246     int          w0, h0;
 247     int          natom, natom_trx;
 248     t_topology   top;
 249     PbcType      pbcType;
 250     matrix       box;
 251     t_trxframe   fr;
 252     t_trxstatus* status;
 253
 254     snew(gmx, 1);
 255     snew(gmx->wd, 1);
 256
 257     pbcType = read_tpx_top(ftp2fn(efTPR, nfile, fnm), nullptr, box, &natom, nullptr, nullptr, &top);
 258
 259     read_first_frame(oenv, &status, ftp2fn(efTRX, nfile, fnm), &fr, TRX_DONT_SKIP);
 260     close_trx(status);
 261     natom_trx = fr.natoms;
 262
 263     /* Creates a simple window */
 264     w0 = DisplayWidth(x11->disp, x11->screen) - 132;
 265     h0 = DisplayHeight(x11->disp, x11->screen) - 140;
 266     InitWin(gmx->wd, 0, 0, w0, h0, 3, gmx::bromacs().c_str());
 267     gmx->wd->self = XCreateSimpleWindow(
 268             x11->disp, x11->root, gmx->wd->x, gmx->wd->y, gmx->wd->width, gmx->wd->height, gmx->wd->bwidth, WHITE, BLACK);
 269     pm = XCreatePixmapFromBitmapData(
 270             x11->disp, x11->root, (char*)gromacs_bits, gromacs_width, gromacs_height, WHITE, BLACK, 1);
 271     hints.flags      = PMinSize;
 272     hints.min_width  = 2 * EWIDTH + 40;
 273     hints.min_height = EHEIGHT + LDHEIGHT + LEGHEIGHT + 40;
 274     XSetStandardProperties(x11->disp, gmx->wd->self, gmx->wd->text, program, pm, nullptr, 0, &hints);
 275
 276     x11->RegisterCallback(x11, gmx->wd->self, x11->root, MainCallBack, gmx);
 277     x11->SetInputMask(x11,
 278                       gmx->wd->self,
 279                       ButtonPressMask | ButtonReleaseMask | OwnerGrabButtonMask | ExposureMask
 280                               | StructureNotifyMask);
 281
 282     /* The order of creating windows is important here! */
 283     /* Manager */
 284     gmx->man  = init_man(x11, gmx->wd->self, 0, 0, 1, 1, WHITE, BLACK, pbcType, box, oenv);
 285     gmx->logo = init_logo(x11, gmx->wd->self, false);
 286
 287     /* Now put all windows in the proper place */
 288     move_gmx(x11, gmx, w0, h0, false);
 289
 290     XMapWindow(x11->disp, gmx->wd->self);
 291     map_man(x11, gmx->man);
 292
 293     /* Pull Down menu */
 294     gmx->pd = init_pd(
 295             x11, gmx->wd->self, gmx->wd->width, x11->fg, x11->bg, MSIZE, gmx_pd_size, gmx_pd, MenuTitle);
 296
 297     /* Dialogs & Filters */
 298
 299     gmx->filter = init_filter(&(top.atoms), ftp2fn_null(efNDX, nfile, fnm), natom_trx);
 300
 301     init_dlgs(x11, gmx);
 302
 303     /* Now do file operations */
 304     set_file(x11, gmx->man, ftp2fn(efTRX, nfile, fnm), ftp2fn(efTPR, nfile, fnm));
 305
 306     ShowDlg(gmx->dlgs[edFilter]);
 307 }
 308 #endif
 309
 310 int gmx_view(int argc, char* argv[])
 311 {
 312     const char* desc[] = {
 313         "[THISMODULE] is the GROMACS trajectory viewer. This program reads a",
 314         "trajectory file, a run input file and an index file and plots a",
 315         "3D structure of your molecule on your standard X Window",
 316         "screen. No need for a high end graphics workstation, it even",
 317         "works on Monochrome screens.[PAR]",
 318         "The following features have been implemented:",
 319         "3D view, rotation, translation and scaling of your molecule(s),",
 320         "labels on atoms, animation of trajectories,",
 321         "hardcopy in PostScript format, user defined atom-filters",
 322         "runs on MIT-X (real X), open windows and motif,",
 323         "user friendly menus, option to remove periodicity, option to",
 324         "show computational box.[PAR]",
 325         "Some of the more common X command line options can be used: ",
 326         "[TT]-bg[tt], [TT]-fg[tt] change colors, [TT]-font fontname[tt] changes the font."
 327     };
 328     const char* bugs[] = { "Balls option does not work",
 329                            "Some times dumps core without a good reason" };
 330
 331     gmx_output_env_t* oenv;
 332     t_filenm          fnm[] = { { efTRX, "-f", nullptr, ffREAD },
 333                        { efTPR, nullptr, nullptr, ffREAD },
 334                        { efNDX, nullptr, nullptr, ffOPTRD } };
 335 #define NFILE asize(fnm)
 336
 337     if (parse_common_args(
 338                 &argc, argv, PCA_CAN_TIME, NFILE, fnm, 0, nullptr, asize(desc), desc, asize(bugs), bugs, &oenv))
 339     {
 340 #if !GMX_X11
 341         std::fprintf(stderr, "Compiled without X-Windows - can not run viewer.\n");
 342 #else
 343         t_x11* x11;
 344
 345         if ((x11 = GetX11(&argc, argv)) == nullptr)
 346         {
 347             std::fprintf(stderr,
 348                          "Can't connect to X Server.\n"
 349                          "Check your DISPLAY environment variable\n");
 350         }
 351         else
 352         {
 353             init_gmx(x11, argv[0], NFILE, fnm, oenv);
 354             x11->MainLoop(x11);
 355             x11->CleanUp(x11);
 356         }
 357 #endif
 358     }
 359     return 0;
 360 }