1 /* Id: term_ps.c,v 1.55 2014/01/05 19:10:56 joerg Exp */
3 * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #include <sys/types.h>
37 /* These work the buffer used by the header and footer. */
38 #define PS_BUFSLOP 128
40 /* Convert PostScript point "x" to an AFM unit. */
41 #define PNT2AFM(p, x) /* LINTED */ \
42 (size_t)((double)(x) * (1000.0 / (double)(p)->ps->scale))
44 /* Convert an AFM unit "x" to a PostScript points */
45 #define AFM2PNT(p, x) /* LINTED */ \
46 ((double)(x) / (1000.0 / (double)(p)->ps->scale))
49 unsigned short wx
; /* WX in AFM */
53 const char *name
; /* FontName in AFM */
54 #define MAXCHAR 95 /* total characters we can handle */
55 struct glyph gly
[MAXCHAR
]; /* glyph metrics */
60 #define PS_INLINE (1 << 0) /* we're in a word */
61 #define PS_MARGINS (1 << 1) /* we're in the margins */
62 #define PS_NEWPAGE (1 << 2) /* new page, no words yet */
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
; /* character buffer */
69 enum termfont lastf
; /* last set font */
70 size_t scale
; /* font scaling factor */
71 size_t pages
; /* number of pages shown */
72 size_t lineheight
; /* line height (AFM units) */
73 size_t top
; /* body top (AFM units) */
74 size_t bottom
; /* body bottom (AFM units) */
75 size_t height
; /* page height (AFM units */
76 size_t width
; /* page width (AFM units) */
77 size_t left
; /* body left (AFM units) */
78 size_t header
; /* header pos (AFM units) */
79 size_t footer
; /* footer pos (AFM units) */
80 size_t pdfbytes
; /* current output byte */
81 size_t pdflastpg
; /* byte of last page mark */
82 size_t pdfbody
; /* start of body object */
83 size_t *pdfobjs
; /* table of object offsets */
84 size_t pdfobjsz
; /* size of pdfobjs */
87 static double ps_hspan(const struct termp
*,
88 const struct roffsu
*);
89 static size_t ps_width(const struct termp
*, int);
90 static void ps_advance(struct termp
*, size_t);
91 static void ps_begin(struct termp
*);
92 static void ps_closepage(struct termp
*);
93 static void ps_end(struct termp
*);
94 static void ps_endline(struct termp
*);
95 static void ps_fclose(struct termp
*);
96 static void ps_growbuf(struct termp
*, size_t);
97 static void ps_letter(struct termp
*, int);
98 static void ps_pclose(struct termp
*);
99 static void ps_pletter(struct termp
*, int);
100 #if __GNUC__ - 0 >= 4
101 __attribute__((__format__ (__printf__
, 2, 3)))
103 static void ps_printf(struct termp
*, const char *, ...);
104 static void ps_putchar(struct termp
*, char);
105 static void ps_setfont(struct termp
*, enum termfont
);
106 static struct termp
*pspdf_alloc(char *);
107 static void pdf_obj(struct termp
*, size_t);
110 * We define, for the time being, three fonts: bold, oblique/italic, and
111 * normal (roman). The following table hard-codes the font metrics for
112 * ASCII, i.e., 32--127.
115 static const struct font fonts
[TERMFONT__MAX
] = {
410 pdf_alloc(char *outopts
)
414 if (NULL
!= (p
= pspdf_alloc(outopts
)))
415 p
->type
= TERMTYPE_PDF
;
421 ps_alloc(char *outopts
)
425 if (NULL
!= (p
= pspdf_alloc(outopts
)))
426 p
->type
= TERMTYPE_PS
;
431 static struct termp
*
432 pspdf_alloc(char *outopts
)
435 unsigned int pagex
, pagey
;
436 size_t marginx
, marginy
, lineheight
;
441 p
= mandoc_calloc(1, sizeof(struct termp
));
442 p
->enc
= TERMENC_ASCII
;
443 p
->ps
= mandoc_calloc(1, sizeof(struct termp_ps
));
445 p
->advance
= ps_advance
;
448 p
->endline
= ps_endline
;
450 p
->letter
= ps_letter
;
458 while (outopts
&& *outopts
)
459 switch (getsubopt(&outopts
, UNCONST(toks
), &v
)) {
467 /* Default to US letter (millimetres). */
473 * The ISO-269 paper sizes can be calculated automatically, but
474 * it would require bringing in -lm for pow() and I'd rather not
475 * do that. So just do it the easy way for now. Since this
476 * only happens once, I'm not terribly concerned.
479 if (pp
&& strcasecmp(pp
, "letter")) {
480 if (0 == strcasecmp(pp
, "a3")) {
483 } else if (0 == strcasecmp(pp
, "a4")) {
486 } else if (0 == strcasecmp(pp
, "a5")) {
489 } else if (0 == strcasecmp(pp
, "legal")) {
492 } else if (2 != sscanf(pp
, "%ux%u", &pagex
, &pagey
))
493 fprintf(stderr
, "%s: Unknown paper\n", pp
);
497 * This MUST be defined before any PNT2AFM or AFM2PNT
498 * calculations occur.
503 /* Remember millimetres -> AFM units. */
505 pagex
= PNT2AFM(p
, ((double)pagex
* 2.834));
506 pagey
= PNT2AFM(p
, ((double)pagey
* 2.834));
508 /* Margins are 1/9 the page x and y. */
510 marginx
= /* LINTED */
511 (size_t)((double)pagex
/ 9.0);
512 marginy
= /* LINTED */
513 (size_t)((double)pagey
/ 9.0);
515 /* Line-height is 1.4em. */
517 lineheight
= PNT2AFM(p
, ((double)p
->ps
->scale
* 1.4));
519 p
->ps
->width
= (size_t)pagex
;
520 p
->ps
->height
= (size_t)pagey
;
521 p
->ps
->header
= pagey
- (marginy
/ 2) - (lineheight
/ 2);
522 p
->ps
->top
= pagey
- marginy
;
523 p
->ps
->footer
= (marginy
/ 2) - (lineheight
/ 2);
524 p
->ps
->bottom
= marginy
;
525 p
->ps
->left
= marginx
;
526 p
->ps
->lineheight
= lineheight
;
528 p
->defrmargin
= pagex
- (marginx
* 2);
534 pspdf_free(void *arg
)
538 p
= (struct termp
*)arg
;
543 free(p
->ps
->pdfobjs
);
551 ps_printf(struct termp
*p
, const char *fmt
, ...)
559 * If we're running in regular mode, then pipe directly into
560 * vprintf(). If we're processing margins, then push the data
561 * into our growable margin buffer.
564 if ( ! (PS_MARGINS
& p
->ps
->flags
)) {
565 len
= vprintf(fmt
, ap
);
567 p
->ps
->pdfbytes
+= /* LINTED */
568 len
< 0 ? 0 : (size_t)len
;
573 * XXX: I assume that the in-margin print won't exceed
574 * PS_BUFSLOP (128 bytes), which is reasonable but still an
575 * assumption that will cause pukeage if it's not the case.
578 ps_growbuf(p
, PS_BUFSLOP
);
580 pos
= (int)p
->ps
->psmargcur
;
581 vsnprintf(&p
->ps
->psmarg
[pos
], PS_BUFSLOP
, fmt
, ap
);
585 p
->ps
->psmargcur
= strlen(p
->ps
->psmarg
);
590 ps_putchar(struct termp
*p
, char c
)
594 /* See ps_printf(). */
596 if ( ! (PS_MARGINS
& p
->ps
->flags
)) {
605 pos
= (int)p
->ps
->psmargcur
++;
606 p
->ps
->psmarg
[pos
++] = c
;
607 p
->ps
->psmarg
[pos
] = '\0';
612 pdf_obj(struct termp
*p
, size_t obj
)
617 if ((obj
- 1) >= p
->ps
->pdfobjsz
) {
618 p
->ps
->pdfobjsz
= obj
+ 128;
619 p
->ps
->pdfobjs
= realloc
621 p
->ps
->pdfobjsz
* sizeof(size_t));
622 if (NULL
== p
->ps
->pdfobjs
) {
624 exit((int)MANDOCLEVEL_SYSERR
);
628 p
->ps
->pdfobjs
[(int)obj
- 1] = p
->ps
->pdfbytes
;
629 ps_printf(p
, "%zu 0 obj\n", obj
);
634 ps_closepage(struct termp
*p
)
640 * Close out a page that we've already flushed to output. In
641 * PostScript, we simply note that the page must be showed. In
642 * PDF, we must now create the Length, Resource, and Page node
643 * for the page contents.
646 assert(p
->ps
->psmarg
&& p
->ps
->psmarg
[0]);
647 ps_printf(p
, "%s", p
->ps
->psmarg
);
649 if (TERMTYPE_PS
!= p
->type
) {
650 ps_printf(p
, "ET\n");
652 len
= p
->ps
->pdfbytes
- p
->ps
->pdflastpg
;
653 base
= p
->ps
->pages
* 4 + p
->ps
->pdfbody
;
655 ps_printf(p
, "endstream\nendobj\n");
657 /* Length of content. */
658 pdf_obj(p
, base
+ 1);
659 ps_printf(p
, "%zu\nendobj\n", len
);
661 /* Resource for content. */
662 pdf_obj(p
, base
+ 2);
663 ps_printf(p
, "<<\n/ProcSet [/PDF /Text]\n");
664 ps_printf(p
, "/Font <<\n");
665 for (i
= 0; i
< (int)TERMFONT__MAX
; i
++)
666 ps_printf(p
, "/F%d %d 0 R\n", i
, 3 + i
);
667 ps_printf(p
, ">>\n>>\n");
670 pdf_obj(p
, base
+ 3);
671 ps_printf(p
, "<<\n");
672 ps_printf(p
, "/Type /Page\n");
673 ps_printf(p
, "/Parent 2 0 R\n");
674 ps_printf(p
, "/Resources %zu 0 R\n", base
+ 2);
675 ps_printf(p
, "/Contents %zu 0 R\n", base
);
676 ps_printf(p
, ">>\nendobj\n");
678 ps_printf(p
, "showpage\n");
681 p
->ps
->psrow
= p
->ps
->top
;
682 assert( ! (PS_NEWPAGE
& p
->ps
->flags
));
683 p
->ps
->flags
|= PS_NEWPAGE
;
689 ps_end(struct termp
*p
)
691 size_t i
, xref
, base
;
694 * At the end of the file, do one last showpage. This is the
695 * same behaviour as groff(1) and works for multiple pages as
699 if ( ! (PS_NEWPAGE
& p
->ps
->flags
)) {
700 assert(0 == p
->ps
->flags
);
701 assert('\0' == p
->ps
->last
);
705 if (TERMTYPE_PS
== p
->type
) {
706 ps_printf(p
, "%%%%Trailer\n");
707 ps_printf(p
, "%%%%Pages: %zu\n", p
->ps
->pages
);
708 ps_printf(p
, "%%%%EOF\n");
713 ps_printf(p
, "<<\n/Type /Pages\n");
714 ps_printf(p
, "/MediaBox [0 0 %zu %zu]\n",
715 (size_t)AFM2PNT(p
, p
->ps
->width
),
716 (size_t)AFM2PNT(p
, p
->ps
->height
));
718 ps_printf(p
, "/Count %zu\n", p
->ps
->pages
);
719 ps_printf(p
, "/Kids [");
721 for (i
= 0; i
< p
->ps
->pages
; i
++)
722 ps_printf(p
, " %zu 0 R", i
* 4 +
725 base
= (p
->ps
->pages
- 1) * 4 +
728 ps_printf(p
, "]\n>>\nendobj\n");
730 ps_printf(p
, "<<\n");
731 ps_printf(p
, "/Type /Catalog\n");
732 ps_printf(p
, "/Pages 2 0 R\n");
733 ps_printf(p
, ">>\n");
734 xref
= p
->ps
->pdfbytes
;
735 ps_printf(p
, "xref\n");
736 ps_printf(p
, "0 %zu\n", base
+ 1);
737 ps_printf(p
, "0000000000 65535 f \n");
739 for (i
= 0; i
< base
; i
++)
740 ps_printf(p
, "%.10zu 00000 n \n",
741 p
->ps
->pdfobjs
[(int)i
]);
743 ps_printf(p
, "trailer\n");
744 ps_printf(p
, "<<\n");
745 ps_printf(p
, "/Size %zu\n", base
+ 1);
746 ps_printf(p
, "/Root %zu 0 R\n", base
);
747 ps_printf(p
, "/Info 1 0 R\n");
748 ps_printf(p
, ">>\n");
749 ps_printf(p
, "startxref\n");
750 ps_printf(p
, "%zu\n", xref
);
751 ps_printf(p
, "%%%%EOF\n");
756 ps_begin(struct termp
*p
)
762 * Print margins into margin buffer. Nothing gets output to the
763 * screen yet, so we don't need to initialise the primary state.
767 assert(p
->ps
->psmargsz
);
768 p
->ps
->psmarg
[0] = '\0';
771 /*p->ps->pdfbytes = 0;*/
772 p
->ps
->psmargcur
= 0;
773 p
->ps
->flags
= PS_MARGINS
;
774 p
->ps
->pscol
= p
->ps
->left
;
775 p
->ps
->psrow
= p
->ps
->header
;
777 ps_setfont(p
, TERMFONT_NONE
);
779 (*p
->headf
)(p
, p
->argf
);
782 p
->ps
->pscol
= p
->ps
->left
;
783 p
->ps
->psrow
= p
->ps
->footer
;
785 (*p
->footf
)(p
, p
->argf
);
788 p
->ps
->flags
&= ~PS_MARGINS
;
790 assert(0 == p
->ps
->flags
);
791 assert(p
->ps
->psmarg
);
792 assert('\0' != p
->ps
->psmarg
[0]);
795 * Print header and initialise page state. Following this,
796 * stuff gets printed to the screen, so make sure we're sane.
801 if (TERMTYPE_PS
== p
->type
) {
802 ps_printf(p
, "%%!PS-Adobe-3.0\n");
803 ps_printf(p
, "%%%%CreationDate: %s", ctime(&t
));
804 ps_printf(p
, "%%%%DocumentData: Clean7Bit\n");
805 ps_printf(p
, "%%%%Orientation: Portrait\n");
806 ps_printf(p
, "%%%%Pages: (atend)\n");
807 ps_printf(p
, "%%%%PageOrder: Ascend\n");
808 ps_printf(p
, "%%%%DocumentMedia: "
809 "Default %zu %zu 0 () ()\n",
810 (size_t)AFM2PNT(p
, p
->ps
->width
),
811 (size_t)AFM2PNT(p
, p
->ps
->height
));
812 ps_printf(p
, "%%%%DocumentNeededResources: font");
814 for (i
= 0; i
< (int)TERMFONT__MAX
; i
++)
815 ps_printf(p
, " %s", fonts
[i
].name
);
817 ps_printf(p
, "\n%%%%EndComments\n");
819 ps_printf(p
, "%%PDF-1.1\n");
821 ps_printf(p
, "<<\n");
822 ps_printf(p
, ">>\n");
823 ps_printf(p
, "endobj\n");
825 for (i
= 0; i
< (int)TERMFONT__MAX
; i
++) {
826 pdf_obj(p
, (size_t)i
+ 3);
827 ps_printf(p
, "<<\n");
828 ps_printf(p
, "/Type /Font\n");
829 ps_printf(p
, "/Subtype /Type1\n");
830 ps_printf(p
, "/Name /F%d\n", i
);
831 ps_printf(p
, "/BaseFont /%s\n", fonts
[i
].name
);
832 ps_printf(p
, ">>\n");
836 p
->ps
->pdfbody
= (size_t)TERMFONT__MAX
+ 3;
837 p
->ps
->pscol
= p
->ps
->left
;
838 p
->ps
->psrow
= p
->ps
->top
;
839 p
->ps
->flags
|= PS_NEWPAGE
;
840 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",
859 ps_printf(p
, "/%s %zu selectfont\n",
860 fonts
[(int)p
->ps
->lastf
].name
,
863 pdf_obj(p
, p
->ps
->pdfbody
+
865 ps_printf(p
, "<<\n");
866 ps_printf(p
, "/Length %zu 0 R\n",
869 ps_printf(p
, ">>\nstream\n");
871 p
->ps
->pdflastpg
= p
->ps
->pdfbytes
;
872 p
->ps
->flags
&= ~PS_NEWPAGE
;
876 * If we're not in a PostScript "word" context, then open one
877 * now at the current cursor.
880 if ( ! (PS_INLINE
& p
->ps
->flags
)) {
881 if (TERMTYPE_PS
!= p
->type
) {
882 ps_printf(p
, "BT\n/F%d %zu Tf\n",
885 ps_printf(p
, "%.3f %.3f Td\n(",
886 AFM2PNT(p
, p
->ps
->pscol
),
887 AFM2PNT(p
, p
->ps
->psrow
));
889 ps_printf(p
, "%.3f %.3f moveto\n(",
890 AFM2PNT(p
, p
->ps
->pscol
),
891 AFM2PNT(p
, p
->ps
->psrow
));
892 p
->ps
->flags
|= PS_INLINE
;
895 assert( ! (PS_NEWPAGE
& p
->ps
->flags
));
898 * We need to escape these characters as per the PostScript
899 * specification. We would also escape non-graphable characters
900 * (like tabs), but none of them would get to this point and
901 * it's superfluous to abort() on them.
916 /* Write the character and adjust where we are on the page. */
918 f
= (int)p
->ps
->lastf
;
920 if (c
<= 32 || (c
- 32 >= MAXCHAR
)) {
922 p
->ps
->pscol
+= (size_t)fonts
[f
].gly
[0].wx
;
926 ps_putchar(p
, (char)c
);
928 p
->ps
->pscol
+= (size_t)fonts
[f
].gly
[c
].wx
;
933 ps_pclose(struct termp
*p
)
937 * Spit out that we're exiting a word context (this is a
938 * "partial close" because we don't check the last-char buffer
942 if ( ! (PS_INLINE
& p
->ps
->flags
))
945 if (TERMTYPE_PS
!= p
->type
) {
946 ps_printf(p
, ") Tj\nET\n");
948 ps_printf(p
, ") show\n");
950 p
->ps
->flags
&= ~PS_INLINE
;
955 ps_fclose(struct termp
*p
)
959 * Strong closure: if we have a last-char, spit it out after
960 * checking that we're in the right font mode. This will of
961 * course open a new scope, if applicable.
963 * Following this, close out any scope that's open.
966 if ('\0' != p
->ps
->last
) {
967 if (p
->ps
->lastf
!= TERMFONT_NONE
) {
969 ps_setfont(p
, TERMFONT_NONE
);
971 ps_pletter(p
, p
->ps
->last
);
975 if ( ! (PS_INLINE
& p
->ps
->flags
))
983 ps_letter(struct termp
*p
, int arg
)
988 c
= arg
>= 128 || arg
<= 0 ? '?' : arg
;
991 * State machine dictates whether to buffer the last character
992 * or not. Basically, encoded words are detected by checking if
993 * we're an "8" and switching on the buffer. Then we put "8" in
994 * our buffer, and on the next charater, flush both character
995 * and buffer. Thus, "regular" words are detected by having a
996 * regular character and a regular buffer character.
999 if ('\0' == p
->ps
->last
) {
1003 } else if (8 == p
->ps
->last
) {
1006 } else if (8 == c
) {
1007 assert(8 != p
->ps
->last
);
1008 if ('_' == p
->ps
->last
) {
1009 if (p
->ps
->lastf
!= TERMFONT_UNDER
) {
1011 ps_setfont(p
, TERMFONT_UNDER
);
1013 } else if (p
->ps
->lastf
!= TERMFONT_BOLD
) {
1015 ps_setfont(p
, TERMFONT_BOLD
);
1020 if (p
->ps
->lastf
!= TERMFONT_NONE
) {
1022 ps_setfont(p
, TERMFONT_NONE
);
1034 ps_advance(struct termp
*p
, size_t len
)
1038 * Advance some spaces. This can probably be made smarter,
1039 * i.e., to have multiple space-separated words in the same
1040 * scope, but this is easier: just close out the current scope
1041 * and readjust our column settings.
1045 p
->ps
->pscol
+= len
;
1050 ps_endline(struct termp
*p
)
1053 /* Close out any scopes we have open: we're at eoln. */
1058 * If we're in the margin, don't try to recalculate our current
1059 * row. XXX: if the column tries to be fancy with multiple
1060 * lines, we'll do nasty stuff.
1063 if (PS_MARGINS
& p
->ps
->flags
)
1068 p
->ps
->pscol
= p
->ps
->left
;
1070 /* If we haven't printed anything, return. */
1072 if (PS_NEWPAGE
& p
->ps
->flags
)
1076 * Put us down a line. If we're at the page bottom, spit out a
1077 * showpage and restart our row.
1080 if (p
->ps
->psrow
>= p
->ps
->lineheight
+
1082 p
->ps
->psrow
-= p
->ps
->lineheight
;
1091 ps_setfont(struct termp
*p
, enum termfont f
)
1094 assert(f
< TERMFONT__MAX
);
1098 * If we're still at the top of the page, let the font-setting
1099 * be delayed until we actually have stuff to print.
1102 if (PS_NEWPAGE
& p
->ps
->flags
)
1105 if (TERMTYPE_PS
== p
->type
)
1106 ps_printf(p
, "/%s %zu selectfont\n",
1110 ps_printf(p
, "/F%d %zu Tf\n",
1118 ps_width(const struct termp
*p
, int c
)
1121 if (c
<= 32 || c
- 32 >= MAXCHAR
)
1122 return((size_t)fonts
[(int)TERMFONT_NONE
].gly
[0].wx
);
1125 return((size_t)fonts
[(int)TERMFONT_NONE
].gly
[c
].wx
);
1130 ps_hspan(const struct termp
*p
, const struct roffsu
*su
)
1135 * All of these measurements are derived by converting from the
1136 * native measurement to AFM units.
1141 r
= PNT2AFM(p
, su
->scale
* 28.34);
1144 r
= PNT2AFM(p
, su
->scale
* 72);
1147 r
= PNT2AFM(p
, su
->scale
* 12);
1150 r
= PNT2AFM(p
, su
->scale
* 100);
1154 fonts
[(int)TERMFONT_NONE
].gly
[109 - 32].wx
;
1157 r
= PNT2AFM(p
, su
->scale
* 2.834);
1161 fonts
[(int)TERMFONT_NONE
].gly
[110 - 32].wx
;
1164 r
= su
->scale
* p
->ps
->lineheight
;
1175 ps_growbuf(struct termp
*p
, size_t sz
)
1177 if (p
->ps
->psmargcur
+ sz
<= p
->ps
->psmargsz
)
1180 if (sz
< PS_BUFSLOP
)
1183 p
->ps
->psmargsz
+= sz
;
1185 p
->ps
->psmarg
= mandoc_realloc
1186 (p
->ps
->psmarg
, p
->ps
->psmargsz
);