src/gromacs/fileio/writeps.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 #include "gmxpre.h"
  38
  39 #include "writeps.h"
  40
  41 #include "gromacs/fileio/gmxfio.h"
  42 #include "gromacs/utility/fatalerror.h"
  43 #include "gromacs/utility/futil.h"
  44
  45 using namespace gmx;
  46
  47 const char* fontnm[efontNR] = {
  48     "Times-Roman", "Times-Italic",      "Times-Bold",     "Times-BoldItalic",
  49     "Helvetica",   "Helvetica-Oblique", "Helvetica-Bold", "Helvetica-BoldOblique",
  50     "Courier",     "Courier-Oblique",   "Courier-Bold",   "Courier-BoldOblique"
  51 };
  52
  53 t_psdata ps_open(const char* fn, real x1, real y1, real x2, real y2)
  54 {
  55     t_psdata ps;
  56
  57     ps.fp = gmx_fio_fopen(fn, "w");
  58     fprintf(ps.fp, "%%!PS-Adobe-2.0 EPSF-1.2\n");
  59     fprintf(ps.fp, "%%%%Creator: GROMACS\n");
  60     fprintf(ps.fp, "%%%%Title: %s\n", fn);
  61     fprintf(ps.fp, "%%%%BoundingBox: %g %g %g %g\n", x1, y1, x2, y2);
  62     fprintf(ps.fp, "%%%%EndComments\n");
  63     fprintf(ps.fp, "/m {moveto} bind def\n");
  64     fprintf(ps.fp, "/l {lineto} bind def\n");
  65     fprintf(ps.fp, "/rm {rmoveto} bind def\n");
  66     fprintf(ps.fp, "/r  {rlineto} bind def\n");
  67     fprintf(ps.fp, "/f {fill} bind def\n");
  68     fprintf(ps.fp, "/s {stroke} bind def\n");
  69
  70     return ps;
  71 }
  72
  73 void ps_linewidth(t_psdata* ps, int lw)
  74 {
  75     fprintf(ps->fp, "%d setlinewidth\n", lw);
  76 }
  77
  78 static void ps_defcolor(t_psdata* ps, real r, real g, real b, char* cname)
  79 {
  80     fprintf(ps->fp, "/%s {%g %g %g setrgbcolor} bind def\n", cname, r, g, b);
  81 }
  82
  83 static void ps_selcolor(t_psdata* ps, char* cname)
  84 {
  85     fprintf(ps->fp, "%s\n", cname);
  86 }
  87
  88 static gmx::index search_col(t_psdata* ps, real r, real g, real b)
  89 {
  90     for (gmx::index i = 0; ssize(ps->rgb); ++i)
  91     {
  92         if ((ps->rgb[i].r == r) && (ps->rgb[i].g == g) && (ps->rgb[i].b == b))
  93         {
  94             return i;
  95         }
  96     }
  97
  98     char buf[12];
  99     int  indexToBackElement = static_cast<int>(ssize(ps->rgb));
 100     sprintf(buf, "C%d", indexToBackElement);
 101     ps_defcolor(ps, r, g, b, buf);
 102     fprintf(ps->fp, "/B%zu {%s b} bind def\n", ps->rgb.size(), buf);
 103     ps->rgb.emplace_back(t_rgb{ r, g, b });
 104
 105     return indexToBackElement;
 106 }
 107
 108 void ps_color(t_psdata* ps, real r, real g, real b)
 109 {
 110     char buf[12];
 111     int  indexToElement = static_cast<int>(search_col(ps, r, g, b));
 112
 113     sprintf(buf, "C%d", indexToElement);
 114     ps_selcolor(ps, buf);
 115 }
 116
 117 void ps_rgb(t_psdata* ps, const t_rgb* rgb)
 118 {
 119     ps_color(ps, rgb->r, rgb->g, rgb->b);
 120 }
 121
 122
 123 void ps_init_rgb_nbox(t_psdata* ps, real xbox, real ybox)
 124 {
 125     ps->gen_ybox = ybox;
 126     fprintf(ps->fp,
 127             "/by {def currentpoint "
 128             "%g y r %g %g r %g y neg r %g %g r f y add moveto} bind def\n",
 129             0.0, xbox, 0.0, 0.0, -xbox, 0.0);
 130     /* macro bn is used in ps_rgb_nbox to draw rectangular boxes */
 131 }
 132
 133 void ps_rgb_nbox(t_psdata* ps, t_rgb* rgb, real n)
 134 {
 135     int i;
 136
 137     if (n > 2)
 138     {
 139         ps_rgb(ps, rgb);
 140         fprintf(ps->fp, "/y %g by\n", n * ps->gen_ybox);
 141         /* macro by is defined in ps_init_rgb_nbox */
 142     }
 143     else
 144     {
 145         for (i = 0; (i < n); i++)
 146         {
 147             ps_rgb_box(ps, rgb);
 148         }
 149     }
 150 }
 151
 152 void ps_init_rgb_box(t_psdata* ps, real xbox, real ybox)
 153 {
 154     fprintf(ps->fp,
 155             "/b {currentpoint "
 156             "%g %g r %g %g r %g %g r %g %g r f %g add moveto} bind def\n",
 157             0.0, ybox, xbox, 0.0, 0.0, -ybox, -xbox, 0.0, ybox);
 158     /* macro b is used in search_col to define macro B */
 159 }
 160
 161 void ps_rgb_box(t_psdata* ps, t_rgb* rgb)
 162 {
 163     fprintf(ps->fp, "B%zd\n", search_col(ps, rgb->r, rgb->g, rgb->b));
 164     /* macro B is defined in search_col from macro b */
 165 }
 166
 167 void ps_lineto(t_psdata* ps, real x, real y)
 168 {
 169     fprintf(ps->fp, "%g %g l\n", x, y);
 170 }
 171
 172 void ps_linerel(t_psdata* ps, real dx, real dy)
 173 {
 174     fprintf(ps->fp, "%g %g r\n", dx, dy);
 175 }
 176
 177 void ps_moveto(t_psdata* ps, real x, real y)
 178 {
 179     fprintf(ps->fp, "%g %g m\n", x, y);
 180 }
 181
 182 void ps_moverel(t_psdata* ps, real dx, real dy)
 183 {
 184     fprintf(ps->fp, "%g %g rm\n", dx, dy);
 185 }
 186
 187 void ps_line(t_psdata* ps, real x1, real y1, real x2, real y2)
 188 {
 189     ps_moveto(ps, x1, y1);
 190     ps_lineto(ps, x2, y2);
 191     fprintf(ps->fp, "s\n");
 192 }
 193
 194 static void do_box(t_psdata* ps, real x1, real y1, real x2, real y2)
 195 {
 196     ps_moveto(ps, x1, y1);
 197     ps_linerel(ps, 0, static_cast<real>(y2 - y1));
 198     ps_linerel(ps, static_cast<real>(x2 - x1), 0);
 199     ps_linerel(ps, 0, static_cast<real>(y1 - y2));
 200     ps_linerel(ps, static_cast<real>(x1 - x2), 0);
 201 }
 202
 203 void ps_box(t_psdata* ps, real x1, real y1, real x2, real y2)
 204 {
 205     do_box(ps, x1, y1, x2, y2);
 206     fprintf(ps->fp, "s\n");
 207 }
 208
 209 void ps_fillbox(t_psdata* ps, real x1, real y1, real x2, real y2)
 210 {
 211     do_box(ps, x1, y1, x2, y2);
 212     fprintf(ps->fp, "f\n");
 213 }
 214
 215 void ps_arc(t_psdata* ps, real x1, real y1, real rad, real a0, real a1)
 216 {
 217     fprintf(ps->fp, "%g %g %g %g %g arc s\n", x1, y1, rad, a0, a1);
 218 }
 219
 220 void ps_fillarc(t_psdata* ps, real x1, real y1, real rad, real a0, real a1)
 221 {
 222     fprintf(ps->fp, "%g %g %g %g %g arc f\n", x1, y1, rad, a0, a1);
 223 }
 224
 225 void ps_arcslice(t_psdata* ps, real xc, real yc, real rad1, real rad2, real a0, real a1)
 226 {
 227     fprintf(ps->fp, "newpath %g %g %g %g %g arc %g %g %g %g %g arcn closepath s\n", xc, yc, rad1,
 228             a0, a1, xc, yc, rad2, a1, a0);
 229 }
 230
 231 void ps_fillarcslice(t_psdata* ps, real xc, real yc, real rad1, real rad2, real a0, real a1)
 232 {
 233     fprintf(ps->fp, "newpath %g %g %g %g %g arc %g %g %g %g %g arcn closepath f\n", xc, yc, rad1,
 234             a0, a1, xc, yc, rad2, a1, a0);
 235 }
 236
 237 void ps_circle(t_psdata* ps, real x1, real y1, real rad)
 238 {
 239     ps_arc(ps, x1, y1, rad, 0, 360);
 240 }
 241
 242 void ps_font(t_psdata* ps, int font, real size)
 243 {
 244
 245     if ((font < 0) || (font > efontNR))
 246     {
 247         fprintf(stderr, "Invalid Font: %d, using %s\n", font, fontnm[0]);
 248         font = 0;
 249     }
 250     fprintf(ps->fp, "/%s findfont\n", fontnm[font]);
 251     fprintf(ps->fp, "%g scalefont setfont\n", size);
 252 }
 253
 254 void ps_strfont(t_psdata* ps, char* font, real size)
 255 {
 256     fprintf(ps->fp, "/%s findfont\n", font);
 257     fprintf(ps->fp, "%g scalefont setfont\n", size);
 258 }
 259
 260 void ps_text(t_psdata* ps, real x1, real y1, const std::string& str)
 261 {
 262     ps_moveto(ps, x1, y1);
 263     fprintf(ps->fp, "(%s) show\n", str.c_str());
 264 }
 265
 266 void ps_flip(t_psdata* ps, gmx_bool bPlus)
 267 {
 268     if (bPlus)
 269     {
 270         fprintf(ps->fp, "612.5 0 translate 90 rotate\n");
 271     }
 272     else
 273     {
 274         fprintf(ps->fp, "-90 rotate -612.5 0 translate\n");
 275     }
 276 }
 277
 278 void ps_rotate(t_psdata* ps, real angle)
 279 {
 280     fprintf(ps->fp, "%f rotate\n", angle);
 281 }
 282
 283 void ps_ctext(t_psdata* ps, real x1, real y1, const std::string& str, int expos)
 284 {
 285     if (expos == eXLeft)
 286     {
 287         ps_text(ps, x1, y1, str);
 288         return;
 289     }
 290     ps_moveto(ps, x1, y1);
 291     fprintf(ps->fp, "(%s) stringwidth\n", str.c_str());
 292     switch (expos)
 293     {
 294         case eXLeft: fprintf(ps->fp, "exch 0 exch pop exch\n"); break;
 295         case eXCenter: fprintf(ps->fp, "exch 2 div neg exch\n"); break;
 296         case eXRight: fprintf(ps->fp, "exch neg exch\n"); break;
 297         default: gmx_fatal(FARGS, "invalid position index (expos=%d)", expos);
 298     }
 299     fprintf(ps->fp, "rmoveto (%s) show\n", str.c_str());
 300 }
 301
 302 void ps_translate(t_psdata* ps, real x, real y)
 303 {
 304     fprintf(ps->fp, "%g %g translate\n", x, y);
 305 }
 306
 307 void ps_setorigin(t_psdata* ps)
 308 {
 309     fprintf(ps->fp, "currentpoint dup 3 -1 roll dup 4 1 roll exch translate\n");
 310     ps->ostack++;
 311 }
 312
 313 void ps_unsetorigin(t_psdata* ps)
 314 {
 315     if (ps->ostack <= 0)
 316     {
 317         gmx_fatal(FARGS, "No origin on stack!\n");
 318     }
 319     fprintf(ps->fp, "neg exch neg exch translate\n");
 320     ps->ostack--;
 321 }
 322
 323 void ps_close(t_psdata* ps)
 324 {
 325     fprintf(ps->fp, "%%showpage\n");
 326     fprintf(ps->fp, "%%%%EOF\n");
 327     gmx_fio_fclose(ps->fp);
 328 }
 329
 330 void ps_comment(t_psdata* ps, const char* s)
 331 {
 332     fprintf(ps->fp, "%%%% %s\n", s);
 333 }