1 /* $Id: term_ps.c,v 1.62 2014/08/01 19:25:52 schwarze Exp $ */
3 * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
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.
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.
22 #include <sys/types.h>
34 #include "mandoc_aux.h"
39 /* These work the buffer used by the header and footer. */
40 #define PS_BUFSLOP 128
42 /* Convert PostScript point "x" to an AFM unit. */
43 #define PNT2AFM(p, x) \
44 (size_t)((double)(x) * (1000.0 / (double)(p)->ps->scale))
46 /* Convert an AFM unit "x" to a PostScript points */
47 #define AFM2PNT(p, x) \
48 ((double)(x) / (1000.0 / (double)(p)->ps->scale))
51 unsigned short wx; /* WX in AFM */
55 const char *name; /* FontName in AFM */
56 #define MAXCHAR 95 /* total characters we can handle */
57 struct glyph gly[MAXCHAR]; /* glyph metrics */
62 #define PS_INLINE (1 << 0) /* we're in a word */
63 #define PS_MARGINS (1 << 1) /* we're in the margins */
64 #define PS_NEWPAGE (1 << 2) /* new page, no words yet */
65 size_t pscol; /* visible column (AFM units) */
66 size_t psrow; /* visible row (AFM units) */
67 char *psmarg; /* margin buf */
68 size_t psmargsz; /* margin buf size */
69 size_t psmargcur; /* cur index in margin buf */
70 char last; /* character buffer */
71 enum termfont lastf; /* last set font */
72 size_t scale; /* font scaling factor */
73 size_t pages; /* number of pages shown */
74 size_t lineheight; /* line height (AFM units) */
75 size_t top; /* body top (AFM units) */
76 size_t bottom; /* body bottom (AFM units) */
77 size_t height; /* page height (AFM units */
78 size_t width; /* page width (AFM units) */
79 size_t lastwidth; /* page width before last ll */
80 size_t left; /* body left (AFM units) */
81 size_t header; /* header pos (AFM units) */
82 size_t footer; /* footer pos (AFM units) */
83 size_t pdfbytes; /* current output byte */
84 size_t pdflastpg; /* byte of last page mark */
85 size_t pdfbody; /* start of body object */
86 size_t *pdfobjs; /* table of object offsets */
87 size_t pdfobjsz; /* size of pdfobjs */
90 static double ps_hspan(const struct termp *,
91 const struct roffsu *);
92 static size_t ps_width(const struct termp *, int);
93 static void ps_advance(struct termp *, size_t);
94 static void ps_begin(struct termp *);
95 static void ps_closepage(struct termp *);
96 static void ps_end(struct termp *);
97 static void ps_endline(struct termp *);
98 static void ps_fclose(struct termp *);
99 static void ps_growbuf(struct termp *, size_t);
100 static void ps_letter(struct termp *, int);
101 static void ps_pclose(struct termp *);
102 static void ps_pletter(struct termp *, int);
103 #if __GNUC__ - 0 >= 4
104 __attribute__((__format__ (__printf__, 2, 3)))
106 static void ps_printf(struct termp *, const char *, ...);
107 static void ps_putchar(struct termp *, char);
108 static void ps_setfont(struct termp *, enum termfont);
109 static void ps_setwidth(struct termp *, int, size_t);
110 static struct termp *pspdf_alloc(char *);
111 static void pdf_obj(struct termp *, size_t);
114 * We define, for the time being, three fonts: bold, oblique/italic, and
115 * normal (roman). The following table hard-codes the font metrics for
116 * ASCII, i.e., 32--127.
119 static const struct font fonts[TERMFONT__MAX] = {
414 pdf_alloc(char *outopts)
418 if (NULL != (p = pspdf_alloc(outopts)))
419 p->type = TERMTYPE_PDF;
425 ps_alloc(char *outopts)
429 if (NULL != (p = pspdf_alloc(outopts)))
430 p->type = TERMTYPE_PS;
435 static struct termp *
436 pspdf_alloc(char *outopts)
439 unsigned int pagex, pagey;
440 size_t marginx, marginy, lineheight;
445 p = mandoc_calloc(1, sizeof(struct termp));
446 p->enc = TERMENC_ASCII;
447 p->ps = mandoc_calloc(1, sizeof(struct termp_ps));
449 p->advance = ps_advance;
452 p->endline = ps_endline;
454 p->letter = ps_letter;
455 p->setwidth = ps_setwidth;
463 while (outopts && *outopts)
464 switch (getsubopt(&outopts, UNCONST(toks), &v)) {
472 /* Default to US letter (millimetres). */
478 * The ISO-269 paper sizes can be calculated automatically, but
479 * it would require bringing in -lm for pow() and I'd rather not
480 * do that. So just do it the easy way for now. Since this
481 * only happens once, I'm not terribly concerned.
484 if (pp && strcasecmp(pp, "letter")) {
485 if (0 == strcasecmp(pp, "a3")) {
488 } else if (0 == strcasecmp(pp, "a4")) {
491 } else if (0 == strcasecmp(pp, "a5")) {
494 } else if (0 == strcasecmp(pp, "legal")) {
497 } else if (2 != sscanf(pp, "%ux%u", &pagex, &pagey))
498 fprintf(stderr, "%s: Unknown paper\n", pp);
502 * This MUST be defined before any PNT2AFM or AFM2PNT
503 * calculations occur.
508 /* Remember millimetres -> AFM units. */
510 pagex = PNT2AFM(p, ((double)pagex * 2.834));
511 pagey = PNT2AFM(p, ((double)pagey * 2.834));
513 /* Margins are 1/9 the page x and y. */
515 marginx = (size_t)((double)pagex / 9.0);
516 marginy = (size_t)((double)pagey / 9.0);
518 /* Line-height is 1.4em. */
520 lineheight = PNT2AFM(p, ((double)p->ps->scale * 1.4));
522 p->ps->width = p->ps->lastwidth = (size_t)pagex;
523 p->ps->height = (size_t)pagey;
524 p->ps->header = pagey - (marginy / 2) - (lineheight / 2);
525 p->ps->top = pagey - marginy;
526 p->ps->footer = (marginy / 2) - (lineheight / 2);
527 p->ps->bottom = marginy;
528 p->ps->left = marginx;
529 p->ps->lineheight = lineheight;
531 p->defrmargin = pagex - (marginx * 2);
536 ps_setwidth(struct termp *p, int iop, size_t width)
540 lastwidth = p->ps->width;
542 p->ps->width += width;
544 p->ps->width -= width;
546 p->ps->width = width ? width : p->ps->lastwidth;
547 p->ps->lastwidth = lastwidth;
551 pspdf_free(void *arg)
555 p = (struct termp *)arg;
560 free(p->ps->pdfobjs);
567 ps_printf(struct termp *p, const char *fmt, ...)
575 * If we're running in regular mode, then pipe directly into
576 * vprintf(). If we're processing margins, then push the data
577 * into our growable margin buffer.
580 if ( ! (PS_MARGINS & p->ps->flags)) {
581 len = vprintf(fmt, ap);
583 p->ps->pdfbytes += len < 0 ? 0 : (size_t)len;
588 * XXX: I assume that the in-margin print won't exceed
589 * PS_BUFSLOP (128 bytes), which is reasonable but still an
590 * assumption that will cause pukeage if it's not the case.
593 ps_growbuf(p, PS_BUFSLOP);
595 pos = (int)p->ps->psmargcur;
596 vsnprintf(&p->ps->psmarg[pos], PS_BUFSLOP, fmt, ap);
600 p->ps->psmargcur = strlen(p->ps->psmarg);
604 ps_putchar(struct termp *p, char c)
608 /* See ps_printf(). */
610 if ( ! (PS_MARGINS & p->ps->flags)) {
618 pos = (int)p->ps->psmargcur++;
619 p->ps->psmarg[pos++] = c;
620 p->ps->psmarg[pos] = '\0';
624 pdf_obj(struct termp *p, size_t obj)
629 if ((obj - 1) >= p->ps->pdfobjsz) {
630 p->ps->pdfobjsz = obj + 128;
631 p->ps->pdfobjs = mandoc_reallocarray(p->ps->pdfobjs,
632 p->ps->pdfobjsz, sizeof(size_t));
635 p->ps->pdfobjs[(int)obj - 1] = p->ps->pdfbytes;
636 ps_printf(p, "%zu 0 obj\n", obj);
640 ps_closepage(struct termp *p)
646 * Close out a page that we've already flushed to output. In
647 * PostScript, we simply note that the page must be showed. In
648 * PDF, we must now create the Length, Resource, and Page node
649 * for the page contents.
652 assert(p->ps->psmarg && p->ps->psmarg[0]);
653 ps_printf(p, "%s", p->ps->psmarg);
655 if (TERMTYPE_PS != p->type) {
656 ps_printf(p, "ET\n");
658 len = p->ps->pdfbytes - p->ps->pdflastpg;
659 base = p->ps->pages * 4 + p->ps->pdfbody;
661 ps_printf(p, "endstream\nendobj\n");
663 /* Length of content. */
664 pdf_obj(p, base + 1);
665 ps_printf(p, "%zu\nendobj\n", len);
667 /* Resource for content. */
668 pdf_obj(p, base + 2);
669 ps_printf(p, "<<\n/ProcSet [/PDF /Text]\n");
670 ps_printf(p, "/Font <<\n");
671 for (i = 0; i < (int)TERMFONT__MAX; i++)
672 ps_printf(p, "/F%d %d 0 R\n", i, 3 + i);
673 ps_printf(p, ">>\n>>\n");
676 pdf_obj(p, base + 3);
677 ps_printf(p, "<<\n");
678 ps_printf(p, "/Type /Page\n");
679 ps_printf(p, "/Parent 2 0 R\n");
680 ps_printf(p, "/Resources %zu 0 R\n", base + 2);
681 ps_printf(p, "/Contents %zu 0 R\n", base);
682 ps_printf(p, ">>\nendobj\n");
684 ps_printf(p, "showpage\n");
687 p->ps->psrow = p->ps->top;
688 assert( ! (PS_NEWPAGE & p->ps->flags));
689 p->ps->flags |= PS_NEWPAGE;
693 ps_end(struct termp *p)
695 size_t i, xref, base;
698 * At the end of the file, do one last showpage. This is the
699 * same behaviour as groff(1) and works for multiple pages as
703 if ( ! (PS_NEWPAGE & p->ps->flags)) {
704 assert(0 == p->ps->flags);
705 assert('\0' == p->ps->last);
709 if (TERMTYPE_PS == p->type) {
710 ps_printf(p, "%%%%Trailer\n");
711 ps_printf(p, "%%%%Pages: %zu\n", p->ps->pages);
712 ps_printf(p, "%%%%EOF\n");
717 ps_printf(p, "<<\n/Type /Pages\n");
718 ps_printf(p, "/MediaBox [0 0 %zu %zu]\n",
719 (size_t)AFM2PNT(p, p->ps->width),
720 (size_t)AFM2PNT(p, p->ps->height));
722 ps_printf(p, "/Count %zu\n", p->ps->pages);
723 ps_printf(p, "/Kids [");
725 for (i = 0; i < p->ps->pages; i++)
726 ps_printf(p, " %zu 0 R", i * 4 + p->ps->pdfbody + 3);
728 base = (p->ps->pages - 1) * 4 + p->ps->pdfbody + 4;
730 ps_printf(p, "]\n>>\nendobj\n");
732 ps_printf(p, "<<\n");
733 ps_printf(p, "/Type /Catalog\n");
734 ps_printf(p, "/Pages 2 0 R\n");
735 ps_printf(p, ">>\n");
736 xref = p->ps->pdfbytes;
737 ps_printf(p, "xref\n");
738 ps_printf(p, "0 %zu\n", base + 1);
739 ps_printf(p, "0000000000 65535 f \n");
741 for (i = 0; i < base; i++)
742 ps_printf(p, "%.10zu 00000 n \n",
743 p->ps->pdfobjs[(int)i]);
745 ps_printf(p, "trailer\n");
746 ps_printf(p, "<<\n");
747 ps_printf(p, "/Size %zu\n", base + 1);
748 ps_printf(p, "/Root %zu 0 R\n", base);
749 ps_printf(p, "/Info 1 0 R\n");
750 ps_printf(p, ">>\n");
751 ps_printf(p, "startxref\n");
752 ps_printf(p, "%zu\n", xref);
753 ps_printf(p, "%%%%EOF\n");
757 ps_begin(struct termp *p)
763 * Print margins into margin buffer. Nothing gets output to the
764 * screen yet, so we don't need to initialise the primary state.
768 assert(p->ps->psmargsz);
769 p->ps->psmarg[0] = '\0';
772 /*p->ps->pdfbytes = 0;*/
773 p->ps->psmargcur = 0;
774 p->ps->flags = PS_MARGINS;
775 p->ps->pscol = p->ps->left;
776 p->ps->psrow = p->ps->header;
778 ps_setfont(p, TERMFONT_NONE);
780 (*p->headf)(p, p->argf);
783 p->ps->pscol = p->ps->left;
784 p->ps->psrow = p->ps->footer;
786 (*p->footf)(p, p->argf);
789 p->ps->flags &= ~PS_MARGINS;
791 assert(0 == p->ps->flags);
792 assert(p->ps->psmarg);
793 assert('\0' != p->ps->psmarg[0]);
796 * Print header and initialise page state. Following this,
797 * stuff gets printed to the screen, so make sure we're sane.
802 if (TERMTYPE_PS == p->type) {
803 ps_printf(p, "%%!PS-Adobe-3.0\n");
804 ps_printf(p, "%%%%CreationDate: %s", ctime(&t));
805 ps_printf(p, "%%%%DocumentData: Clean7Bit\n");
806 ps_printf(p, "%%%%Orientation: Portrait\n");
807 ps_printf(p, "%%%%Pages: (atend)\n");
808 ps_printf(p, "%%%%PageOrder: Ascend\n");
809 ps_printf(p, "%%%%DocumentMedia: "
810 "Default %zu %zu 0 () ()\n",
811 (size_t)AFM2PNT(p, p->ps->width),
812 (size_t)AFM2PNT(p, p->ps->height));
813 ps_printf(p, "%%%%DocumentNeededResources: font");
815 for (i = 0; i < (int)TERMFONT__MAX; i++)
816 ps_printf(p, " %s", fonts[i].name);
818 ps_printf(p, "\n%%%%EndComments\n");
820 ps_printf(p, "%%PDF-1.1\n");
822 ps_printf(p, "<<\n");
823 ps_printf(p, ">>\n");
824 ps_printf(p, "endobj\n");
826 for (i = 0; i < (int)TERMFONT__MAX; i++) {
827 pdf_obj(p, (size_t)i + 3);
828 ps_printf(p, "<<\n");
829 ps_printf(p, "/Type /Font\n");
830 ps_printf(p, "/Subtype /Type1\n");
831 ps_printf(p, "/Name /F%d\n", i);
832 ps_printf(p, "/BaseFont /%s\n", fonts[i].name);
833 ps_printf(p, ">>\n");
837 p->ps->pdfbody = (size_t)TERMFONT__MAX + 3;
838 p->ps->pscol = p->ps->left;
839 p->ps->psrow = p->ps->top;
840 p->ps->flags |= PS_NEWPAGE;
841 ps_setfont(p, TERMFONT_NONE);
845 ps_pletter(struct termp *p, int c)
850 * If we haven't opened a page context, then output that we're
851 * in a new page and make sure the font is correctly set.
854 if (PS_NEWPAGE & p->ps->flags) {
855 if (TERMTYPE_PS == p->type) {
856 ps_printf(p, "%%%%Page: %zu %zu\n",
857 p->ps->pages + 1, p->ps->pages + 1);
858 ps_printf(p, "/%s %zu selectfont\n",
859 fonts[(int)p->ps->lastf].name,
862 pdf_obj(p, p->ps->pdfbody +
864 ps_printf(p, "<<\n");
865 ps_printf(p, "/Length %zu 0 R\n",
866 p->ps->pdfbody + 1 + p->ps->pages * 4);
867 ps_printf(p, ">>\nstream\n");
869 p->ps->pdflastpg = p->ps->pdfbytes;
870 p->ps->flags &= ~PS_NEWPAGE;
874 * If we're not in a PostScript "word" context, then open one
875 * now at the current cursor.
878 if ( ! (PS_INLINE & p->ps->flags)) {
879 if (TERMTYPE_PS != p->type) {
880 ps_printf(p, "BT\n/F%d %zu Tf\n",
881 (int)p->ps->lastf, p->ps->scale);
882 ps_printf(p, "%.3f %.3f Td\n(",
883 AFM2PNT(p, p->ps->pscol),
884 AFM2PNT(p, p->ps->psrow));
886 ps_printf(p, "%.3f %.3f moveto\n(",
887 AFM2PNT(p, p->ps->pscol),
888 AFM2PNT(p, p->ps->psrow));
889 p->ps->flags |= PS_INLINE;
892 assert( ! (PS_NEWPAGE & p->ps->flags));
895 * We need to escape these characters as per the PostScript
896 * specification. We would also escape non-graphable characters
897 * (like tabs), but none of them would get to this point and
898 * it's superfluous to abort() on them.
913 /* Write the character and adjust where we are on the page. */
915 f = (int)p->ps->lastf;
917 if (c <= 32 || c - 32 >= MAXCHAR)
920 ps_putchar(p, (char)c);
922 p->ps->pscol += (size_t)fonts[f].gly[c].wx;
926 ps_pclose(struct termp *p)
930 * Spit out that we're exiting a word context (this is a
931 * "partial close" because we don't check the last-char buffer
935 if ( ! (PS_INLINE & p->ps->flags))
938 if (TERMTYPE_PS != p->type) {
939 ps_printf(p, ") Tj\nET\n");
941 ps_printf(p, ") show\n");
943 p->ps->flags &= ~PS_INLINE;
947 ps_fclose(struct termp *p)
951 * Strong closure: if we have a last-char, spit it out after
952 * checking that we're in the right font mode. This will of
953 * course open a new scope, if applicable.
955 * Following this, close out any scope that's open.
958 if ('\0' != p->ps->last) {
959 if (p->ps->lastf != TERMFONT_NONE) {
961 ps_setfont(p, TERMFONT_NONE);
963 ps_pletter(p, p->ps->last);
967 if ( ! (PS_INLINE & p->ps->flags))
974 ps_letter(struct termp *p, int arg)
978 c = arg >= 128 || arg <= 0 ? '?' : arg;
981 * State machine dictates whether to buffer the last character
982 * or not. Basically, encoded words are detected by checking if
983 * we're an "8" and switching on the buffer. Then we put "8" in
984 * our buffer, and on the next charater, flush both character
985 * and buffer. Thus, "regular" words are detected by having a
986 * regular character and a regular buffer character.
989 if ('\0' == p->ps->last) {
993 } else if (8 == p->ps->last) {
997 assert(8 != p->ps->last);
998 if ('_' == p->ps->last) {
999 if (p->ps->lastf != TERMFONT_UNDER) {
1001 ps_setfont(p, TERMFONT_UNDER);
1003 } else if (p->ps->lastf != TERMFONT_BOLD) {
1005 ps_setfont(p, TERMFONT_BOLD);
1010 if (p->ps->lastf != TERMFONT_NONE) {
1012 ps_setfont(p, TERMFONT_NONE);
1023 ps_advance(struct termp *p, size_t len)
1027 * Advance some spaces. This can probably be made smarter,
1028 * i.e., to have multiple space-separated words in the same
1029 * scope, but this is easier: just close out the current scope
1030 * and readjust our column settings.
1034 p->ps->pscol += len;
1038 ps_endline(struct termp *p)
1041 /* Close out any scopes we have open: we're at eoln. */
1046 * If we're in the margin, don't try to recalculate our current
1047 * row. XXX: if the column tries to be fancy with multiple
1048 * lines, we'll do nasty stuff.
1051 if (PS_MARGINS & p->ps->flags)
1056 p->ps->pscol = p->ps->left;
1058 /* If we haven't printed anything, return. */
1060 if (PS_NEWPAGE & p->ps->flags)
1064 * Put us down a line. If we're at the page bottom, spit out a
1065 * showpage and restart our row.
1068 if (p->ps->psrow >= p->ps->lineheight + p->ps->bottom) {
1069 p->ps->psrow -= p->ps->lineheight;
1077 ps_setfont(struct termp *p, enum termfont f)
1080 assert(f < TERMFONT__MAX);
1084 * If we're still at the top of the page, let the font-setting
1085 * be delayed until we actually have stuff to print.
1088 if (PS_NEWPAGE & p->ps->flags)
1091 if (TERMTYPE_PS == p->type)
1092 ps_printf(p, "/%s %zu selectfont\n",
1093 fonts[(int)f].name, p->ps->scale);
1095 ps_printf(p, "/F%d %zu Tf\n",
1096 (int)f, p->ps->scale);
1100 ps_width(const struct termp *p, int c)
1103 if (c <= 32 || c - 32 >= MAXCHAR)
1108 return((size_t)fonts[(int)TERMFONT_NONE].gly[c].wx);
1112 ps_hspan(const struct termp *p, const struct roffsu *su)
1117 * All of these measurements are derived by converting from the
1118 * native measurement to AFM units.
1123 r = PNT2AFM(p, su->scale * 28.34);
1126 r = PNT2AFM(p, su->scale * 72.0);
1129 r = PNT2AFM(p, su->scale * 12.0);
1132 r = PNT2AFM(p, su->scale * 100.0);
1136 fonts[(int)TERMFONT_NONE].gly[109 - 32].wx;
1139 r = PNT2AFM(p, su->scale * 2.834);
1143 fonts[(int)TERMFONT_NONE].gly[110 - 32].wx;
1146 r = su->scale * p->ps->lineheight;
1157 ps_growbuf(struct termp *p, size_t sz)
1159 if (p->ps->psmargcur + sz <= p->ps->psmargsz)
1162 if (sz < PS_BUFSLOP)
1165 p->ps->psmargsz += sz;
1166 p->ps->psmarg = mandoc_realloc(p->ps->psmarg, p->ps->psmargsz);