contrib/mdocml/term_ps.c

   1 /*      $Id: term_ps.c,v 1.69 2014/11/20 13:56:20 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4  * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
   5  *
   6  * Permission to use, copy, modify, and distribute this software for any
   7  * purpose with or without fee is hereby granted, provided that the above
   8  * copyright notice and this permission notice appear in all copies.
   9  *
  10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17  */
  18 #include "config.h"
  19
  20 #include <sys/types.h>
  21
  22 #include <assert.h>
  23 #include <stdarg.h>
  24 #include <stdint.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <unistd.h>
  29
  30 #include "mandoc.h"
  31 #include "mandoc_aux.h"
  32 #include "out.h"
  33 #include "main.h"
  34 #include "term.h"
  35
  36 /* These work the buffer used by the header and footer. */
  37 #define PS_BUFSLOP        128
  38
  39 /* Convert PostScript point "x" to an AFM unit. */
  40 #define PNT2AFM(p, x) \
  41         (size_t)((double)(x) * (1000.0 / (double)(p)->ps->scale))
  42
  43 /* Convert an AFM unit "x" to a PostScript points */
  44 #define AFM2PNT(p, x) \
  45         ((double)(x) / (1000.0 / (double)(p)->ps->scale))
  46
  47 struct  glyph {
  48         unsigned short    wx; /* WX in AFM */
  49 };
  50
  51 struct  font {
  52         const char       *name; /* FontName in AFM */
  53 #define MAXCHAR           95 /* total characters we can handle */
  54         struct glyph      gly[MAXCHAR]; /* glyph metrics */
  55 };
  56
  57 struct  termp_ps {
  58         int               flags;
  59 #define PS_INLINE        (1 << 0)       /* we're in a word */
  60 #define PS_MARGINS       (1 << 1)       /* we're in the margins */
  61 #define PS_NEWPAGE       (1 << 2)       /* new page, no words yet */
  62 #define PS_BACKSP        (1 << 3)       /* last character was backspace */
  63         size_t            pscol;        /* visible column (AFM units) */
  64         size_t            psrow;        /* visible row (AFM units) */
  65         char             *psmarg;       /* margin buf */
  66         size_t            psmargsz;     /* margin buf size */
  67         size_t            psmargcur;    /* cur index in margin buf */
  68         char              last;         /* last non-backspace seen */
  69         enum termfont     lastf;        /* last set font */
  70         enum termfont     nextf;        /* building next font here */
  71         size_t            scale;        /* font scaling factor */
  72         size_t            pages;        /* number of pages shown */
  73         size_t            lineheight;   /* line height (AFM units) */
  74         size_t            top;          /* body top (AFM units) */
  75         size_t            bottom;       /* body bottom (AFM units) */
  76         size_t            height;       /* page height (AFM units */
  77         size_t            width;        /* page width (AFM units) */
  78         size_t            lastwidth;    /* page width before last ll */
  79         size_t            left;         /* body left (AFM units) */
  80         size_t            header;       /* header pos (AFM units) */
  81         size_t            footer;       /* footer pos (AFM units) */
  82         size_t            pdfbytes;     /* current output byte */
  83         size_t            pdflastpg;    /* byte of last page mark */
  84         size_t            pdfbody;      /* start of body object */
  85         size_t           *pdfobjs;      /* table of object offsets */
  86         size_t            pdfobjsz;     /* size of pdfobjs */
  87 };
  88
  89 static  double            ps_hspan(const struct termp *,
  90                                 const struct roffsu *);
  91 static  size_t            ps_width(const struct termp *, int);
  92 static  void              ps_advance(struct termp *, size_t);
  93 static  void              ps_begin(struct termp *);
  94 static  void              ps_closepage(struct termp *);
  95 static  void              ps_end(struct termp *);
  96 static  void              ps_endline(struct termp *);
  97 static  void              ps_fclose(struct termp *);
  98 static  void              ps_growbuf(struct termp *, size_t);
  99 static  void              ps_letter(struct termp *, int);
 100 static  void              ps_pclose(struct termp *);
 101 static  void              ps_pletter(struct termp *, int);
 102 #if __GNUC__ - 0 >= 4
 103 __attribute__((__format__ (__printf__, 2, 3)))
 104 #endif
 105 static  void              ps_printf(struct termp *, const char *, ...);
 106 static  void              ps_putchar(struct termp *, char);
 107 static  void              ps_setfont(struct termp *, enum termfont);
 108 static  void              ps_setwidth(struct termp *, int, size_t);
 109 static  struct termp     *pspdf_alloc(const struct mchars *, char *);
 110 static  void              pdf_obj(struct termp *, size_t);
 111
 112 /*
 113  * We define, for the time being, three fonts: bold, oblique/italic, and
 114  * normal (roman).  The following table hard-codes the font metrics for
 115  * ASCII, i.e., 32--127.
 116  */
 117
 118 static  const struct font fonts[TERMFONT__MAX] = {
 119         { "Times-Roman", {
 120                 { 250 },
 121                 { 333 },
 122                 { 408 },
 123                 { 500 },
 124                 { 500 },
 125                 { 833 },
 126                 { 778 },
 127                 { 333 },
 128                 { 333 },
 129                 { 333 },
 130                 { 500 },
 131                 { 564 },
 132                 { 250 },
 133                 { 333 },
 134                 { 250 },
 135                 { 278 },
 136                 { 500 },
 137                 { 500 },
 138                 { 500 },
 139                 { 500 },
 140                 { 500 },
 141                 { 500 },
 142                 { 500 },
 143                 { 500 },
 144                 { 500 },
 145                 { 500 },
 146                 { 278 },
 147                 { 278 },
 148                 { 564 },
 149                 { 564 },
 150                 { 564 },
 151                 { 444 },
 152                 { 921 },
 153                 { 722 },
 154                 { 667 },
 155                 { 667 },
 156                 { 722 },
 157                 { 611 },
 158                 { 556 },
 159                 { 722 },
 160                 { 722 },
 161                 { 333 },
 162                 { 389 },
 163                 { 722 },
 164                 { 611 },
 165                 { 889 },
 166                 { 722 },
 167                 { 722 },
 168                 { 556 },
 169                 { 722 },
 170                 { 667 },
 171                 { 556 },
 172                 { 611 },
 173                 { 722 },
 174                 { 722 },
 175                 { 944 },
 176                 { 722 },
 177                 { 722 },
 178                 { 611 },
 179                 { 333 },
 180                 { 278 },
 181                 { 333 },
 182                 { 469 },
 183                 { 500 },
 184                 { 333 },
 185                 { 444 },
 186                 { 500 },
 187                 { 444 },
 188                 {  500},
 189                 {  444},
 190                 {  333},
 191                 {  500},
 192                 {  500},
 193                 {  278},
 194                 {  278},
 195                 {  500},
 196                 {  278},
 197                 {  778},
 198                 {  500},
 199                 {  500},
 200                 {  500},
 201                 {  500},
 202                 {  333},
 203                 {  389},
 204                 {  278},
 205                 {  500},
 206                 {  500},
 207                 {  722},
 208                 {  500},
 209                 {  500},
 210                 {  444},
 211                 {  480},
 212                 {  200},
 213                 {  480},
 214                 {  541},
 215         } },
 216         { "Times-Bold", {
 217                 { 250  },
 218                 { 333  },
 219                 { 555  },
 220                 { 500  },
 221                 { 500  },
 222                 { 1000 },
 223                 { 833  },
 224                 { 333  },
 225                 { 333  },
 226                 { 333  },
 227                 { 500  },
 228                 { 570  },
 229                 { 250  },
 230                 { 333  },
 231                 { 250  },
 232                 { 278  },
 233                 { 500  },
 234                 { 500  },
 235                 { 500  },
 236                 { 500  },
 237                 { 500  },
 238                 { 500  },
 239                 { 500  },
 240                 { 500  },
 241                 { 500  },
 242                 { 500  },
 243                 { 333  },
 244                 { 333  },
 245                 { 570  },
 246                 { 570  },
 247                 { 570  },
 248                 { 500  },
 249                 { 930  },
 250                 { 722  },
 251                 { 667  },
 252                 { 722  },
 253                 { 722  },
 254                 { 667  },
 255                 { 611  },
 256                 { 778  },
 257                 { 778  },
 258                 { 389  },
 259                 { 500  },
 260                 { 778  },
 261                 { 667  },
 262                 { 944  },
 263                 { 722  },
 264                 { 778  },
 265                 { 611  },
 266                 { 778  },
 267                 { 722  },
 268                 { 556  },
 269                 { 667  },
 270                 { 722  },
 271                 { 722  },
 272                 { 1000 },
 273                 { 722  },
 274                 { 722  },
 275                 { 667  },
 276                 { 333  },
 277                 { 278  },
 278                 { 333  },
 279                 { 581  },
 280                 { 500  },
 281                 { 333  },
 282                 { 500  },
 283                 { 556  },
 284                 { 444  },
 285                 {  556 },
 286                 {  444 },
 287                 {  333 },
 288                 {  500 },
 289                 {  556 },
 290                 {  278 },
 291                 {  333 },
 292                 {  556 },
 293                 {  278 },
 294                 {  833 },
 295                 {  556 },
 296                 {  500 },
 297                 {  556 },
 298                 {  556 },
 299                 {  444 },
 300                 {  389 },
 301                 {  333 },
 302                 {  556 },
 303                 {  500 },
 304                 {  722 },
 305                 {  500 },
 306                 {  500 },
 307                 {  444 },
 308                 {  394 },
 309                 {  220 },
 310                 {  394 },
 311                 {  520 },
 312         } },
 313         { "Times-Italic", {
 314                 { 250  },
 315                 { 333  },
 316                 { 420  },
 317                 { 500  },
 318                 { 500  },
 319                 { 833  },
 320                 { 778  },
 321                 { 333  },
 322                 { 333  },
 323                 { 333  },
 324                 { 500  },
 325                 { 675  },
 326                 { 250  },
 327                 { 333  },
 328                 { 250  },
 329                 { 278  },
 330                 { 500  },
 331                 { 500  },
 332                 { 500  },
 333                 { 500  },
 334                 { 500  },
 335                 { 500  },
 336                 { 500  },
 337                 { 500  },
 338                 { 500  },
 339                 { 500  },
 340                 { 333  },
 341                 { 333  },
 342                 { 675  },
 343                 { 675  },
 344                 { 675  },
 345                 { 500  },
 346                 { 920  },
 347                 { 611  },
 348                 { 611  },
 349                 { 667  },
 350                 { 722  },
 351                 { 611  },
 352                 { 611  },
 353                 { 722  },
 354                 { 722  },
 355                 { 333  },
 356                 { 444  },
 357                 { 667  },
 358                 { 556  },
 359                 { 833  },
 360                 { 667  },
 361                 { 722  },
 362                 { 611  },
 363                 { 722  },
 364                 { 611  },
 365                 { 500  },
 366                 { 556  },
 367                 { 722  },
 368                 { 611  },
 369                 { 833  },
 370                 { 611  },
 371                 { 556  },
 372                 { 556  },
 373                 { 389  },
 374                 { 278  },
 375                 { 389  },
 376                 { 422  },
 377                 { 500  },
 378                 { 333  },
 379                 { 500  },
 380                 { 500  },
 381                 { 444  },
 382                 {  500 },
 383                 {  444 },
 384                 {  278 },
 385                 {  500 },
 386                 {  500 },
 387                 {  278 },
 388                 {  278 },
 389                 {  444 },
 390                 {  278 },
 391                 {  722 },
 392                 {  500 },
 393                 {  500 },
 394                 {  500 },
 395                 {  500 },
 396                 {  389 },
 397                 {  389 },
 398                 {  278 },
 399                 {  500 },
 400                 {  444 },
 401                 {  667 },
 402                 {  444 },
 403                 {  444 },
 404                 {  389 },
 405                 {  400 },
 406                 {  275 },
 407                 {  400 },
 408                 {  541 },
 409         } },
 410         { "Times-BoldItalic", {
 411                 {  250 },
 412                 {  389 },
 413                 {  555 },
 414                 {  500 },
 415                 {  500 },
 416                 {  833 },
 417                 {  778 },
 418                 {  333 },
 419                 {  333 },
 420                 {  333 },
 421                 {  500 },
 422                 {  570 },
 423                 {  250 },
 424                 {  333 },
 425                 {  250 },
 426                 {  278 },
 427                 {  500 },
 428                 {  500 },
 429                 {  500 },
 430                 {  500 },
 431                 {  500 },
 432                 {  500 },
 433                 {  500 },
 434                 {  500 },
 435                 {  500 },
 436                 {  500 },
 437                 {  333 },
 438                 {  333 },
 439                 {  570 },
 440                 {  570 },
 441                 {  570 },
 442                 {  500 },
 443                 {  832 },
 444                 {  667 },
 445                 {  667 },
 446                 {  667 },
 447                 {  722 },
 448                 {  667 },
 449                 {  667 },
 450                 {  722 },
 451                 {  778 },
 452                 {  389 },
 453                 {  500 },
 454                 {  667 },
 455                 {  611 },
 456                 {  889 },
 457                 {  722 },
 458                 {  722 },
 459                 {  611 },
 460                 {  722 },
 461                 {  667 },
 462                 {  556 },
 463                 {  611 },
 464                 {  722 },
 465                 {  667 },
 466                 {  889 },
 467                 {  667 },
 468                 {  611 },
 469                 {  611 },
 470                 {  333 },
 471                 {  278 },
 472                 {  333 },
 473                 {  570 },
 474                 {  500 },
 475                 {  333 },
 476                 {  500 },
 477                 {  500 },
 478                 {  444 },
 479                 {  500 },
 480                 {  444 },
 481                 {  333 },
 482                 {  500 },
 483                 {  556 },
 484                 {  278 },
 485                 {  278 },
 486                 {  500 },
 487                 {  278 },
 488                 {  778 },
 489                 {  556 },
 490                 {  500 },
 491                 {  500 },
 492                 {  500 },
 493                 {  389 },
 494                 {  389 },
 495                 {  278 },
 496                 {  556 },
 497                 {  444 },
 498                 {  667 },
 499                 {  500 },
 500                 {  444 },
 501                 {  389 },
 502                 {  348 },
 503                 {  220 },
 504                 {  348 },
 505                 {  570 },
 506         } },
 507 };
 508
 509 void *
 510 pdf_alloc(const struct mchars *mchars, char *outopts)
 511 {
 512         struct termp    *p;
 513
 514         if (NULL != (p = pspdf_alloc(mchars, outopts)))
 515                 p->type = TERMTYPE_PDF;
 516
 517         return(p);
 518 }
 519
 520 void *
 521 ps_alloc(const struct mchars *mchars, char *outopts)
 522 {
 523         struct termp    *p;
 524
 525         if (NULL != (p = pspdf_alloc(mchars, outopts)))
 526                 p->type = TERMTYPE_PS;
 527
 528         return(p);
 529 }
 530
 531 static struct termp *
 532 pspdf_alloc(const struct mchars *mchars, char *outopts)
 533 {
 534         struct termp    *p;
 535         unsigned int     pagex, pagey;
 536         size_t           marginx, marginy, lineheight;
 537         const char      *toks[2];
 538         const char      *pp;
 539         char            *v;
 540
 541         p = mandoc_calloc(1, sizeof(struct termp));
 542         p->symtab = mchars;
 543         p->enc = TERMENC_ASCII;
 544         p->ps = mandoc_calloc(1, sizeof(struct termp_ps));
 545
 546         p->advance = ps_advance;
 547         p->begin = ps_begin;
 548         p->end = ps_end;
 549         p->endline = ps_endline;
 550         p->hspan = ps_hspan;
 551         p->letter = ps_letter;
 552         p->setwidth = ps_setwidth;
 553         p->width = ps_width;
 554
 555         toks[0] = "paper";
 556         toks[1] = NULL;
 557
 558         pp = NULL;
 559
 560         while (outopts && *outopts)
 561                 switch (getsubopt(&outopts, UNCONST(toks), &v)) {
 562                 case 0:
 563                         pp = v;
 564                         break;
 565                 default:
 566                         break;
 567                 }
 568
 569         /* Default to US letter (millimetres). */
 570
 571         pagex = 216;
 572         pagey = 279;
 573
 574         /*
 575          * The ISO-269 paper sizes can be calculated automatically, but
 576          * it would require bringing in -lm for pow() and I'd rather not
 577          * do that.  So just do it the easy way for now.  Since this
 578          * only happens once, I'm not terribly concerned.
 579          */
 580
 581         if (pp && strcasecmp(pp, "letter")) {
 582                 if (0 == strcasecmp(pp, "a3")) {
 583                         pagex = 297;
 584                         pagey = 420;
 585                 } else if (0 == strcasecmp(pp, "a4")) {
 586                         pagex = 210;
 587                         pagey = 297;
 588                 } else if (0 == strcasecmp(pp, "a5")) {
 589                         pagex = 148;
 590                         pagey = 210;
 591                 } else if (0 == strcasecmp(pp, "legal")) {
 592                         pagex = 216;
 593                         pagey = 356;
 594                 } else if (2 != sscanf(pp, "%ux%u", &pagex, &pagey))
 595                         fprintf(stderr, "%s: Unknown paper\n", pp);
 596         }
 597
 598         /*
 599          * This MUST be defined before any PNT2AFM or AFM2PNT
 600          * calculations occur.
 601          */
 602
 603         p->ps->scale = 11;
 604
 605         /* Remember millimetres -> AFM units. */
 606
 607         pagex = PNT2AFM(p, ((double)pagex * 2.834));
 608         pagey = PNT2AFM(p, ((double)pagey * 2.834));
 609
 610         /* Margins are 1/9 the page x and y. */
 611
 612         marginx = (size_t)((double)pagex / 9.0);
 613         marginy = (size_t)((double)pagey / 9.0);
 614
 615         /* Line-height is 1.4em. */
 616
 617         lineheight = PNT2AFM(p, ((double)p->ps->scale * 1.4));
 618
 619         p->ps->width = p->ps->lastwidth = (size_t)pagex;
 620         p->ps->height = (size_t)pagey;
 621         p->ps->header = pagey - (marginy / 2) - (lineheight / 2);
 622         p->ps->top = pagey - marginy;
 623         p->ps->footer = (marginy / 2) - (lineheight / 2);
 624         p->ps->bottom = marginy;
 625         p->ps->left = marginx;
 626         p->ps->lineheight = lineheight;
 627
 628         p->defrmargin = pagex - (marginx * 2);
 629         return(p);
 630 }
 631
 632 static void
 633 ps_setwidth(struct termp *p, int iop, size_t width)
 634 {
 635         size_t   lastwidth;
 636
 637         lastwidth = p->ps->width;
 638         if (iop > 0)
 639                 p->ps->width += width;
 640         else if (iop == 0)
 641                 p->ps->width = width ? width : p->ps->lastwidth;
 642         else if (p->ps->width > width)
 643                 p->ps->width -= width;
 644         else
 645                 p->ps->width = 0;
 646         p->ps->lastwidth = lastwidth;
 647 }
 648
 649 void
 650 pspdf_free(void *arg)
 651 {
 652         struct termp    *p;
 653
 654         p = (struct termp *)arg;
 655
 656         if (p->ps->psmarg)
 657                 free(p->ps->psmarg);
 658         if (p->ps->pdfobjs)
 659                 free(p->ps->pdfobjs);
 660
 661         free(p->ps);
 662         term_free(p);
 663 }
 664
 665 static void
 666 ps_printf(struct termp *p, const char *fmt, ...)
 667 {
 668         va_list          ap;
 669         int              pos, len;
 670
 671         va_start(ap, fmt);
 672
 673         /*
 674          * If we're running in regular mode, then pipe directly into
 675          * vprintf().  If we're processing margins, then push the data
 676          * into our growable margin buffer.
 677          */
 678
 679         if ( ! (PS_MARGINS & p->ps->flags)) {
 680                 len = vprintf(fmt, ap);
 681                 va_end(ap);
 682                 p->ps->pdfbytes += len < 0 ? 0 : (size_t)len;
 683                 return;
 684         }
 685
 686         /*
 687          * XXX: I assume that the in-margin print won't exceed
 688          * PS_BUFSLOP (128 bytes), which is reasonable but still an
 689          * assumption that will cause pukeage if it's not the case.
 690          */
 691
 692         ps_growbuf(p, PS_BUFSLOP);
 693
 694         pos = (int)p->ps->psmargcur;
 695         vsnprintf(&p->ps->psmarg[pos], PS_BUFSLOP, fmt, ap);
 696
 697         va_end(ap);
 698
 699         p->ps->psmargcur = strlen(p->ps->psmarg);
 700 }
 701
 702 static void
 703 ps_putchar(struct termp *p, char c)
 704 {
 705         int              pos;
 706
 707         /* See ps_printf(). */
 708
 709         if ( ! (PS_MARGINS & p->ps->flags)) {
 710                 putchar(c);
 711                 p->ps->pdfbytes++;
 712                 return;
 713         }
 714
 715         ps_growbuf(p, 2);
 716
 717         pos = (int)p->ps->psmargcur++;
 718         p->ps->psmarg[pos++] = c;
 719         p->ps->psmarg[pos] = '\0';
 720 }
 721
 722 static void
 723 pdf_obj(struct termp *p, size_t obj)
 724 {
 725
 726         assert(obj > 0);
 727
 728         if ((obj - 1) >= p->ps->pdfobjsz) {
 729                 p->ps->pdfobjsz = obj + 128;
 730                 p->ps->pdfobjs = mandoc_reallocarray(p->ps->pdfobjs,
 731                     p->ps->pdfobjsz, sizeof(size_t));
 732         }
 733
 734         p->ps->pdfobjs[(int)obj - 1] = p->ps->pdfbytes;
 735         ps_printf(p, "%zu 0 obj\n", obj);
 736 }
 737
 738 static void
 739 ps_closepage(struct termp *p)
 740 {
 741         int              i;
 742         size_t           len, base;
 743
 744         /*
 745          * Close out a page that we've already flushed to output.  In
 746          * PostScript, we simply note that the page must be showed.  In
 747          * PDF, we must now create the Length, Resource, and Page node
 748          * for the page contents.
 749          */
 750
 751         assert(p->ps->psmarg && p->ps->psmarg[0]);
 752         ps_printf(p, "%s", p->ps->psmarg);
 753
 754         if (TERMTYPE_PS != p->type) {
 755                 ps_printf(p, "ET\n");
 756
 757                 len = p->ps->pdfbytes - p->ps->pdflastpg;
 758                 base = p->ps->pages * 4 + p->ps->pdfbody;
 759
 760                 ps_printf(p, "endstream\nendobj\n");
 761
 762                 /* Length of content. */
 763                 pdf_obj(p, base + 1);
 764                 ps_printf(p, "%zu\nendobj\n", len);
 765
 766                 /* Resource for content. */
 767                 pdf_obj(p, base + 2);
 768                 ps_printf(p, "<<\n/ProcSet [/PDF /Text]\n");
 769                 ps_printf(p, "/Font <<\n");
 770                 for (i = 0; i < (int)TERMFONT__MAX; i++)
 771                         ps_printf(p, "/F%d %d 0 R\n", i, 3 + i);
 772                 ps_printf(p, ">>\n>>\n");
 773
 774                 /* Page node. */
 775                 pdf_obj(p, base + 3);
 776                 ps_printf(p, "<<\n");
 777                 ps_printf(p, "/Type /Page\n");
 778                 ps_printf(p, "/Parent 2 0 R\n");
 779                 ps_printf(p, "/Resources %zu 0 R\n", base + 2);
 780                 ps_printf(p, "/Contents %zu 0 R\n", base);
 781                 ps_printf(p, ">>\nendobj\n");
 782         } else
 783                 ps_printf(p, "showpage\n");
 784
 785         p->ps->pages++;
 786         p->ps->psrow = p->ps->top;
 787         assert( ! (PS_NEWPAGE & p->ps->flags));
 788         p->ps->flags |= PS_NEWPAGE;
 789 }
 790
 791 static void
 792 ps_end(struct termp *p)
 793 {
 794         size_t           i, xref, base;
 795
 796         /*
 797          * At the end of the file, do one last showpage.  This is the
 798          * same behaviour as groff(1) and works for multiple pages as
 799          * well as just one.
 800          */
 801
 802         if ( ! (PS_NEWPAGE & p->ps->flags)) {
 803                 assert(0 == p->ps->flags);
 804                 assert('\0' == p->ps->last);
 805                 ps_closepage(p);
 806         }
 807
 808         if (TERMTYPE_PS == p->type) {
 809                 ps_printf(p, "%%%%Trailer\n");
 810                 ps_printf(p, "%%%%Pages: %zu\n", p->ps->pages);
 811                 ps_printf(p, "%%%%EOF\n");
 812                 return;
 813         }
 814
 815         pdf_obj(p, 2);
 816         ps_printf(p, "<<\n/Type /Pages\n");
 817         ps_printf(p, "/MediaBox [0 0 %zu %zu]\n",
 818                         (size_t)AFM2PNT(p, p->ps->width),
 819                         (size_t)AFM2PNT(p, p->ps->height));
 820
 821         ps_printf(p, "/Count %zu\n", p->ps->pages);
 822         ps_printf(p, "/Kids [");
 823
 824         for (i = 0; i < p->ps->pages; i++)
 825                 ps_printf(p, " %zu 0 R", i * 4 + p->ps->pdfbody + 3);
 826
 827         base = (p->ps->pages - 1) * 4 + p->ps->pdfbody + 4;
 828
 829         ps_printf(p, "]\n>>\nendobj\n");
 830         pdf_obj(p, base);
 831         ps_printf(p, "<<\n");
 832         ps_printf(p, "/Type /Catalog\n");
 833         ps_printf(p, "/Pages 2 0 R\n");
 834         ps_printf(p, ">>\n");
 835         xref = p->ps->pdfbytes;
 836         ps_printf(p, "xref\n");
 837         ps_printf(p, "0 %zu\n", base + 1);
 838         ps_printf(p, "0000000000 65535 f \n");
 839
 840         for (i = 0; i < base; i++)
 841                 ps_printf(p, "%.10zu 00000 n \n",
 842                     p->ps->pdfobjs[(int)i]);
 843
 844         ps_printf(p, "trailer\n");
 845         ps_printf(p, "<<\n");
 846         ps_printf(p, "/Size %zu\n", base + 1);
 847         ps_printf(p, "/Root %zu 0 R\n", base);
 848         ps_printf(p, "/Info 1 0 R\n");
 849         ps_printf(p, ">>\n");
 850         ps_printf(p, "startxref\n");
 851         ps_printf(p, "%zu\n", xref);
 852         ps_printf(p, "%%%%EOF\n");
 853 }
 854
 855 static void
 856 ps_begin(struct termp *p)
 857 {
 858         int              i;
 859
 860         /*
 861          * Print margins into margin buffer.  Nothing gets output to the
 862          * screen yet, so we don't need to initialise the primary state.
 863          */
 864
 865         if (p->ps->psmarg) {
 866                 assert(p->ps->psmargsz);
 867                 p->ps->psmarg[0] = '\0';
 868         }
 869
 870         /*p->ps->pdfbytes = 0;*/
 871         p->ps->psmargcur = 0;
 872         p->ps->flags = PS_MARGINS;
 873         p->ps->pscol = p->ps->left;
 874         p->ps->psrow = p->ps->header;
 875
 876         ps_setfont(p, TERMFONT_NONE);
 877
 878         (*p->headf)(p, p->argf);
 879         (*p->endline)(p);
 880
 881         p->ps->pscol = p->ps->left;
 882         p->ps->psrow = p->ps->footer;
 883
 884         (*p->footf)(p, p->argf);
 885         (*p->endline)(p);
 886
 887         p->ps->flags &= ~PS_MARGINS;
 888
 889         assert(0 == p->ps->flags);
 890         assert(p->ps->psmarg);
 891         assert('\0' != p->ps->psmarg[0]);
 892
 893         /*
 894          * Print header and initialise page state.  Following this,
 895          * stuff gets printed to the screen, so make sure we're sane.
 896          */
 897
 898         if (TERMTYPE_PS == p->type) {
 899                 ps_printf(p, "%%!PS-Adobe-3.0\n");
 900                 ps_printf(p, "%%%%DocumentData: Clean7Bit\n");
 901                 ps_printf(p, "%%%%Orientation: Portrait\n");
 902                 ps_printf(p, "%%%%Pages: (atend)\n");
 903                 ps_printf(p, "%%%%PageOrder: Ascend\n");
 904                 ps_printf(p, "%%%%DocumentMedia: "
 905                     "Default %zu %zu 0 () ()\n",
 906                     (size_t)AFM2PNT(p, p->ps->width),
 907                     (size_t)AFM2PNT(p, p->ps->height));
 908                 ps_printf(p, "%%%%DocumentNeededResources: font");
 909
 910                 for (i = 0; i < (int)TERMFONT__MAX; i++)
 911                         ps_printf(p, " %s", fonts[i].name);
 912
 913                 ps_printf(p, "\n%%%%EndComments\n");
 914         } else {
 915                 ps_printf(p, "%%PDF-1.1\n");
 916                 pdf_obj(p, 1);
 917                 ps_printf(p, "<<\n");
 918                 ps_printf(p, ">>\n");
 919                 ps_printf(p, "endobj\n");
 920
 921                 for (i = 0; i < (int)TERMFONT__MAX; i++) {
 922                         pdf_obj(p, (size_t)i + 3);
 923                         ps_printf(p, "<<\n");
 924                         ps_printf(p, "/Type /Font\n");
 925                         ps_printf(p, "/Subtype /Type1\n");
 926                         ps_printf(p, "/Name /F%d\n", i);
 927                         ps_printf(p, "/BaseFont /%s\n", fonts[i].name);
 928                         ps_printf(p, ">>\n");
 929                 }
 930         }
 931
 932         p->ps->pdfbody = (size_t)TERMFONT__MAX + 3;
 933         p->ps->pscol = p->ps->left;
 934         p->ps->psrow = p->ps->top;
 935         p->ps->flags |= PS_NEWPAGE;
 936         ps_setfont(p, TERMFONT_NONE);
 937 }
 938
 939 static void
 940 ps_pletter(struct termp *p, int c)
 941 {
 942         int              f;
 943
 944         /*
 945          * If we haven't opened a page context, then output that we're
 946          * in a new page and make sure the font is correctly set.
 947          */
 948
 949         if (PS_NEWPAGE & p->ps->flags) {
 950                 if (TERMTYPE_PS == p->type) {
 951                         ps_printf(p, "%%%%Page: %zu %zu\n",
 952                             p->ps->pages + 1, p->ps->pages + 1);
 953                         ps_printf(p, "/%s %zu selectfont\n",
 954                             fonts[(int)p->ps->lastf].name,
 955                             p->ps->scale);
 956                 } else {
 957                         pdf_obj(p, p->ps->pdfbody +
 958                             p->ps->pages * 4);
 959                         ps_printf(p, "<<\n");
 960                         ps_printf(p, "/Length %zu 0 R\n",
 961                             p->ps->pdfbody + 1 + p->ps->pages * 4);
 962                         ps_printf(p, ">>\nstream\n");
 963                 }
 964                 p->ps->pdflastpg = p->ps->pdfbytes;
 965                 p->ps->flags &= ~PS_NEWPAGE;
 966         }
 967
 968         /*
 969          * If we're not in a PostScript "word" context, then open one
 970          * now at the current cursor.
 971          */
 972
 973         if ( ! (PS_INLINE & p->ps->flags)) {
 974                 if (TERMTYPE_PS != p->type) {
 975                         ps_printf(p, "BT\n/F%d %zu Tf\n",
 976                             (int)p->ps->lastf, p->ps->scale);
 977                         ps_printf(p, "%.3f %.3f Td\n(",
 978                             AFM2PNT(p, p->ps->pscol),
 979                             AFM2PNT(p, p->ps->psrow));
 980                 } else
 981                         ps_printf(p, "%.3f %.3f moveto\n(",
 982                             AFM2PNT(p, p->ps->pscol),
 983                             AFM2PNT(p, p->ps->psrow));
 984                 p->ps->flags |= PS_INLINE;
 985         }
 986
 987         assert( ! (PS_NEWPAGE & p->ps->flags));
 988
 989         /*
 990          * We need to escape these characters as per the PostScript
 991          * specification.  We would also escape non-graphable characters
 992          * (like tabs), but none of them would get to this point and
 993          * it's superfluous to abort() on them.
 994          */
 995
 996         switch (c) {
 997         case '(':
 998                 /* FALLTHROUGH */
 999         case ')':
1000                 /* FALLTHROUGH */
1001         case '\\':
1002                 ps_putchar(p, '\\');
1003                 break;
1004         default:
1005                 break;
1006         }
1007
1008         /* Write the character and adjust where we are on the page. */
1009
1010         f = (int)p->ps->lastf;
1011
1012         if (c <= 32 || c - 32 >= MAXCHAR)
1013                 c = 32;
1014
1015         ps_putchar(p, (char)c);
1016         c -= 32;
1017         p->ps->pscol += (size_t)fonts[f].gly[c].wx;
1018 }
1019
1020 static void
1021 ps_pclose(struct termp *p)
1022 {
1023
1024         /*
1025          * Spit out that we're exiting a word context (this is a
1026          * "partial close" because we don't check the last-char buffer
1027          * or anything).
1028          */
1029
1030         if ( ! (PS_INLINE & p->ps->flags))
1031                 return;
1032
1033         if (TERMTYPE_PS != p->type) {
1034                 ps_printf(p, ") Tj\nET\n");
1035         } else
1036                 ps_printf(p, ") show\n");
1037
1038         p->ps->flags &= ~PS_INLINE;
1039 }
1040
1041 static void
1042 ps_fclose(struct termp *p)
1043 {
1044
1045         /*
1046          * Strong closure: if we have a last-char, spit it out after
1047          * checking that we're in the right font mode.  This will of
1048          * course open a new scope, if applicable.
1049          *
1050          * Following this, close out any scope that's open.
1051          */
1052
1053         if (p->ps->last != '\0') {
1054                 assert( ! (p->ps->flags & PS_BACKSP));
1055                 if (p->ps->nextf != p->ps->lastf) {
1056                         ps_pclose(p);
1057                         ps_setfont(p, p->ps->nextf);
1058                 }
1059                 p->ps->nextf = TERMFONT_NONE;
1060                 ps_pletter(p, p->ps->last);
1061                 p->ps->last = '\0';
1062         }
1063
1064         if ( ! (PS_INLINE & p->ps->flags))
1065                 return;
1066
1067         ps_pclose(p);
1068 }
1069
1070 static void
1071 ps_letter(struct termp *p, int arg)
1072 {
1073         size_t          savecol;
1074         char            c;
1075
1076         c = arg >= 128 || arg <= 0 ? '?' : arg;
1077
1078         /*
1079          * When receiving a backspace, merely flag it.
1080          * We don't know yet whether it is
1081          * a font instruction or an overstrike.
1082          */
1083
1084         if (c == '\b') {
1085                 assert(p->ps->last != '\0');
1086                 assert( ! (p->ps->flags & PS_BACKSP));
1087                 p->ps->flags |= PS_BACKSP;
1088                 return;
1089         }
1090
1091         /*
1092          * Decode font instructions.
1093          */
1094
1095         if (p->ps->flags & PS_BACKSP) {
1096                 if (p->ps->last == '_') {
1097                         switch (p->ps->nextf) {
1098                         case TERMFONT_BI:
1099                                 break;
1100                         case TERMFONT_BOLD:
1101                                 p->ps->nextf = TERMFONT_BI;
1102                                 break;
1103                         default:
1104                                 p->ps->nextf = TERMFONT_UNDER;
1105                         }
1106                         p->ps->last = c;
1107                         p->ps->flags &= ~PS_BACKSP;
1108                         return;
1109                 }
1110                 if (p->ps->last == c) {
1111                         switch (p->ps->nextf) {
1112                         case TERMFONT_BI:
1113                                 break;
1114                         case TERMFONT_UNDER:
1115                                 p->ps->nextf = TERMFONT_BI;
1116                                 break;
1117                         default:
1118                                 p->ps->nextf = TERMFONT_BOLD;
1119                         }
1120                         p->ps->flags &= ~PS_BACKSP;
1121                         return;
1122                 }
1123
1124                 /*
1125                  * This is not a font instruction, but rather
1126                  * the next character.  Prepare for overstrike.
1127                  */
1128
1129                 savecol = p->ps->pscol;
1130         } else
1131                 savecol = SIZE_MAX;
1132
1133         /*
1134          * We found the next character, so the font instructions
1135          * for the previous one are complete.
1136          * Use them and print it.
1137          */
1138
1139         if (p->ps->last != '\0') {
1140                 if (p->ps->nextf != p->ps->lastf) {
1141                         ps_pclose(p);
1142                         ps_setfont(p, p->ps->nextf);
1143                 }
1144                 p->ps->nextf = TERMFONT_NONE;
1145                 ps_pletter(p, p->ps->last);
1146         }
1147
1148         /*
1149          * Do not print the current character yet because font
1150          * instructions might follow; only remember it.
1151          * For the first character, nothing else is done.
1152          * The final character will get printed from ps_fclose().
1153          */
1154
1155         p->ps->last = c;
1156
1157         /*
1158          * For an overstrike, back up to the previous position.
1159          */
1160
1161         if (savecol != SIZE_MAX) {
1162                 ps_pclose(p);
1163                 p->ps->pscol = savecol;
1164                 p->ps->flags &= ~PS_BACKSP;
1165         }
1166 }
1167
1168 static void
1169 ps_advance(struct termp *p, size_t len)
1170 {
1171
1172         /*
1173          * Advance some spaces.  This can probably be made smarter,
1174          * i.e., to have multiple space-separated words in the same
1175          * scope, but this is easier:  just close out the current scope
1176          * and readjust our column settings.
1177          */
1178
1179         ps_fclose(p);
1180         p->ps->pscol += len;
1181 }
1182
1183 static void
1184 ps_endline(struct termp *p)
1185 {
1186
1187         /* Close out any scopes we have open: we're at eoln. */
1188
1189         ps_fclose(p);
1190
1191         /*
1192          * If we're in the margin, don't try to recalculate our current
1193          * row.  XXX: if the column tries to be fancy with multiple
1194          * lines, we'll do nasty stuff.
1195          */
1196
1197         if (PS_MARGINS & p->ps->flags)
1198                 return;
1199
1200         /* Left-justify. */
1201
1202         p->ps->pscol = p->ps->left;
1203
1204         /* If we haven't printed anything, return. */
1205
1206         if (PS_NEWPAGE & p->ps->flags)
1207                 return;
1208
1209         /*
1210          * Put us down a line.  If we're at the page bottom, spit out a
1211          * showpage and restart our row.
1212          */
1213
1214         if (p->ps->psrow >= p->ps->lineheight + p->ps->bottom) {
1215                 p->ps->psrow -= p->ps->lineheight;
1216                 return;
1217         }
1218
1219         ps_closepage(p);
1220 }
1221
1222 static void
1223 ps_setfont(struct termp *p, enum termfont f)
1224 {
1225
1226         assert(f < TERMFONT__MAX);
1227         p->ps->lastf = f;
1228
1229         /*
1230          * If we're still at the top of the page, let the font-setting
1231          * be delayed until we actually have stuff to print.
1232          */
1233
1234         if (PS_NEWPAGE & p->ps->flags)
1235                 return;
1236
1237         if (TERMTYPE_PS == p->type)
1238                 ps_printf(p, "/%s %zu selectfont\n",
1239                     fonts[(int)f].name, p->ps->scale);
1240         else
1241                 ps_printf(p, "/F%d %zu Tf\n",
1242                     (int)f, p->ps->scale);
1243 }
1244
1245 static size_t
1246 ps_width(const struct termp *p, int c)
1247 {
1248
1249         if (c <= 32 || c - 32 >= MAXCHAR)
1250                 c = 0;
1251         else
1252                 c -= 32;
1253
1254         return((size_t)fonts[(int)TERMFONT_NONE].gly[c].wx);
1255 }
1256
1257 static double
1258 ps_hspan(const struct termp *p, const struct roffsu *su)
1259 {
1260         double           r;
1261
1262         /*
1263          * All of these measurements are derived by converting from the
1264          * native measurement to AFM units.
1265          */
1266         switch (su->unit) {
1267         case SCALE_BU:
1268                 /*
1269                  * Traditionally, the default unit is fixed to the
1270                  * output media.  So this would refer to the point.  In
1271                  * mandoc(1), however, we stick to the default terminal
1272                  * scaling unit so that output is the same regardless
1273                  * the media.
1274                  */
1275                 r = PNT2AFM(p, su->scale * 72.0 / 240.0);
1276                 break;
1277         case SCALE_CM:
1278                 r = PNT2AFM(p, su->scale * 72.0 / 2.54);
1279                 break;
1280         case SCALE_EM:
1281                 r = su->scale *
1282                     fonts[(int)TERMFONT_NONE].gly[109 - 32].wx;
1283                 break;
1284         case SCALE_EN:
1285                 r = su->scale *
1286                     fonts[(int)TERMFONT_NONE].gly[110 - 32].wx;
1287                 break;
1288         case SCALE_IN:
1289                 r = PNT2AFM(p, su->scale * 72.0);
1290                 break;
1291         case SCALE_MM:
1292                 r = su->scale *
1293                     fonts[(int)TERMFONT_NONE].gly[109 - 32].wx / 100.0;
1294                 break;
1295         case SCALE_PC:
1296                 r = PNT2AFM(p, su->scale * 12.0);
1297                 break;
1298         case SCALE_PT:
1299                 r = PNT2AFM(p, su->scale * 1.0);
1300                 break;
1301         case SCALE_VS:
1302                 r = su->scale * p->ps->lineheight;
1303                 break;
1304         default:
1305                 r = su->scale;
1306                 break;
1307         }
1308
1309         return(r);
1310 }
1311
1312 static void
1313 ps_growbuf(struct termp *p, size_t sz)
1314 {
1315         if (p->ps->psmargcur + sz <= p->ps->psmargsz)
1316                 return;
1317
1318         if (sz < PS_BUFSLOP)
1319                 sz = PS_BUFSLOP;
1320
1321         p->ps->psmargsz += sz;
1322         p->ps->psmarg = mandoc_realloc(p->ps->psmarg, p->ps->psmargsz);
1323 }