]>
git.cameronkatri.com Git - mandoc.git/blob - term_ps.c
1 /* $Id: term_ps.c,v 1.53 2011/09/18 14:14:15 schwarze 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 static void ps_printf(struct termp
*, const char *, ...);
101 static void ps_putchar(struct termp
*, char);
102 static void ps_setfont(struct termp
*, enum termfont
);
103 static struct termp
*pspdf_alloc(char *);
104 static void pdf_obj(struct termp
*, size_t);
107 * We define, for the time being, three fonts: bold, oblique/italic, and
108 * normal (roman). The following table hard-codes the font metrics for
109 * ASCII, i.e., 32--127.
112 static const struct font fonts
[TERMFONT__MAX
] = {
407 pdf_alloc(char *outopts
)
411 if (NULL
!= (p
= pspdf_alloc(outopts
)))
412 p
->type
= TERMTYPE_PDF
;
418 ps_alloc(char *outopts
)
422 if (NULL
!= (p
= pspdf_alloc(outopts
)))
423 p
->type
= TERMTYPE_PS
;
428 static struct termp
*
429 pspdf_alloc(char *outopts
)
432 unsigned int pagex
, pagey
;
433 size_t marginx
, marginy
, lineheight
;
438 p
= mandoc_calloc(1, sizeof(struct termp
));
439 p
->enc
= TERMENC_ASCII
;
440 p
->ps
= mandoc_calloc(1, sizeof(struct termp_ps
));
442 p
->advance
= ps_advance
;
445 p
->endline
= ps_endline
;
447 p
->letter
= ps_letter
;
455 while (outopts
&& *outopts
)
456 switch (getsubopt(&outopts
, UNCONST(toks
), &v
)) {
464 /* Default to US letter (millimetres). */
470 * The ISO-269 paper sizes can be calculated automatically, but
471 * it would require bringing in -lm for pow() and I'd rather not
472 * do that. So just do it the easy way for now. Since this
473 * only happens once, I'm not terribly concerned.
476 if (pp
&& strcasecmp(pp
, "letter")) {
477 if (0 == strcasecmp(pp
, "a3")) {
480 } else if (0 == strcasecmp(pp
, "a4")) {
483 } else if (0 == strcasecmp(pp
, "a5")) {
486 } else if (0 == strcasecmp(pp
, "legal")) {
489 } else if (2 != sscanf(pp
, "%ux%u", &pagex
, &pagey
))
490 fprintf(stderr
, "%s: Unknown paper\n", pp
);
491 } else if (NULL
== pp
)
495 * This MUST be defined before any PNT2AFM or AFM2PNT
496 * calculations occur.
501 /* Remember millimetres -> AFM units. */
503 pagex
= PNT2AFM(p
, ((double)pagex
* 2.834));
504 pagey
= PNT2AFM(p
, ((double)pagey
* 2.834));
506 /* Margins are 1/9 the page x and y. */
508 marginx
= /* LINTED */
509 (size_t)((double)pagex
/ 9.0);
510 marginy
= /* LINTED */
511 (size_t)((double)pagey
/ 9.0);
513 /* Line-height is 1.4em. */
515 lineheight
= PNT2AFM(p
, ((double)p
->ps
->scale
* 1.4));
517 p
->ps
->width
= (size_t)pagex
;
518 p
->ps
->height
= (size_t)pagey
;
519 p
->ps
->header
= pagey
- (marginy
/ 2) - (lineheight
/ 2);
520 p
->ps
->top
= pagey
- marginy
;
521 p
->ps
->footer
= (marginy
/ 2) - (lineheight
/ 2);
522 p
->ps
->bottom
= marginy
;
523 p
->ps
->left
= marginx
;
524 p
->ps
->lineheight
= lineheight
;
526 p
->defrmargin
= pagex
- (marginx
* 2);
532 pspdf_free(void *arg
)
536 p
= (struct termp
*)arg
;
541 free(p
->ps
->pdfobjs
);
549 ps_printf(struct termp
*p
, const char *fmt
, ...)
557 * If we're running in regular mode, then pipe directly into
558 * vprintf(). If we're processing margins, then push the data
559 * into our growable margin buffer.
562 if ( ! (PS_MARGINS
& p
->ps
->flags
)) {
563 len
= vprintf(fmt
, ap
);
565 p
->ps
->pdfbytes
+= /* LINTED */
566 len
< 0 ? 0 : (size_t)len
;
571 * XXX: I assume that the in-margin print won't exceed
572 * PS_BUFSLOP (128 bytes), which is reasonable but still an
573 * assumption that will cause pukeage if it's not the case.
576 ps_growbuf(p
, PS_BUFSLOP
);
578 pos
= (int)p
->ps
->psmargcur
;
579 len
= vsnprintf(&p
->ps
->psmarg
[pos
], PS_BUFSLOP
, fmt
, ap
);
583 p
->ps
->psmargcur
= strlen(p
->ps
->psmarg
);
588 ps_putchar(struct termp
*p
, char c
)
592 /* See ps_printf(). */
594 if ( ! (PS_MARGINS
& p
->ps
->flags
)) {
603 pos
= (int)p
->ps
->psmargcur
++;
604 p
->ps
->psmarg
[pos
++] = c
;
605 p
->ps
->psmarg
[pos
] = '\0';
610 pdf_obj(struct termp
*p
, size_t obj
)
615 if ((obj
- 1) >= p
->ps
->pdfobjsz
) {
616 p
->ps
->pdfobjsz
= obj
+ 128;
617 p
->ps
->pdfobjs
= realloc
619 p
->ps
->pdfobjsz
* sizeof(size_t));
620 if (NULL
== p
->ps
->pdfobjs
) {
622 exit((int)MANDOCLEVEL_SYSERR
);
626 p
->ps
->pdfobjs
[(int)obj
- 1] = p
->ps
->pdfbytes
;
627 ps_printf(p
, "%zu 0 obj\n", obj
);
632 ps_closepage(struct termp
*p
)
638 * Close out a page that we've already flushed to output. In
639 * PostScript, we simply note that the page must be showed. In
640 * PDF, we must now create the Length, Resource, and Page node
641 * for the page contents.
644 assert(p
->ps
->psmarg
&& p
->ps
->psmarg
[0]);
645 ps_printf(p
, "%s", p
->ps
->psmarg
);
647 if (TERMTYPE_PS
!= p
->type
) {
648 ps_printf(p
, "ET\n");
650 len
= p
->ps
->pdfbytes
- p
->ps
->pdflastpg
;
651 base
= p
->ps
->pages
* 4 + p
->ps
->pdfbody
;
653 ps_printf(p
, "endstream\nendobj\n");
655 /* Length of content. */
656 pdf_obj(p
, base
+ 1);
657 ps_printf(p
, "%zu\nendobj\n", len
);
659 /* Resource for content. */
660 pdf_obj(p
, base
+ 2);
661 ps_printf(p
, "<<\n/ProcSet [/PDF /Text]\n");
662 ps_printf(p
, "/Font <<\n");
663 for (i
= 0; i
< (int)TERMFONT__MAX
; i
++)
664 ps_printf(p
, "/F%d %d 0 R\n", i
, 3 + i
);
665 ps_printf(p
, ">>\n>>\n");
668 pdf_obj(p
, base
+ 3);
669 ps_printf(p
, "<<\n");
670 ps_printf(p
, "/Type /Page\n");
671 ps_printf(p
, "/Parent 2 0 R\n");
672 ps_printf(p
, "/Resources %zu 0 R\n", base
+ 2);
673 ps_printf(p
, "/Contents %zu 0 R\n", base
);
674 ps_printf(p
, ">>\nendobj\n");
676 ps_printf(p
, "showpage\n");
679 p
->ps
->psrow
= p
->ps
->top
;
680 assert( ! (PS_NEWPAGE
& p
->ps
->flags
));
681 p
->ps
->flags
|= PS_NEWPAGE
;
687 ps_end(struct termp
*p
)
689 size_t i
, xref
, base
;
692 * At the end of the file, do one last showpage. This is the
693 * same behaviour as groff(1) and works for multiple pages as
697 if ( ! (PS_NEWPAGE
& p
->ps
->flags
)) {
698 assert(0 == p
->ps
->flags
);
699 assert('\0' == p
->ps
->last
);
703 if (TERMTYPE_PS
== p
->type
) {
704 ps_printf(p
, "%%%%Trailer\n");
705 ps_printf(p
, "%%%%Pages: %zu\n", p
->ps
->pages
);
706 ps_printf(p
, "%%%%EOF\n");
711 ps_printf(p
, "<<\n/Type /Pages\n");
712 ps_printf(p
, "/MediaBox [0 0 %zu %zu]\n",
713 (size_t)AFM2PNT(p
, p
->ps
->width
),
714 (size_t)AFM2PNT(p
, p
->ps
->height
));
716 ps_printf(p
, "/Count %zu\n", p
->ps
->pages
);
717 ps_printf(p
, "/Kids [");
719 for (i
= 0; i
< p
->ps
->pages
; i
++)
720 ps_printf(p
, " %zu 0 R", i
* 4 +
723 base
= (p
->ps
->pages
- 1) * 4 +
726 ps_printf(p
, "]\n>>\nendobj\n");
728 ps_printf(p
, "<<\n");
729 ps_printf(p
, "/Type /Catalog\n");
730 ps_printf(p
, "/Pages 2 0 R\n");
731 ps_printf(p
, ">>\n");
732 xref
= p
->ps
->pdfbytes
;
733 ps_printf(p
, "xref\n");
734 ps_printf(p
, "0 %zu\n", base
+ 1);
735 ps_printf(p
, "0000000000 65535 f \n");
737 for (i
= 0; i
< base
; i
++)
738 ps_printf(p
, "%.10zu 00000 n \n",
739 p
->ps
->pdfobjs
[(int)i
]);
741 ps_printf(p
, "trailer\n");
742 ps_printf(p
, "<<\n");
743 ps_printf(p
, "/Size %zu\n", base
+ 1);
744 ps_printf(p
, "/Root %zu 0 R\n", base
);
745 ps_printf(p
, "/Info 1 0 R\n");
746 ps_printf(p
, ">>\n");
747 ps_printf(p
, "startxref\n");
748 ps_printf(p
, "%zu\n", xref
);
749 ps_printf(p
, "%%%%EOF\n");
754 ps_begin(struct termp
*p
)
760 * Print margins into margin buffer. Nothing gets output to the
761 * screen yet, so we don't need to initialise the primary state.
765 assert(p
->ps
->psmargsz
);
766 p
->ps
->psmarg
[0] = '\0';
769 /*p->ps->pdfbytes = 0;*/
770 p
->ps
->psmargcur
= 0;
771 p
->ps
->flags
= PS_MARGINS
;
772 p
->ps
->pscol
= p
->ps
->left
;
773 p
->ps
->psrow
= p
->ps
->header
;
775 ps_setfont(p
, TERMFONT_NONE
);
777 (*p
->headf
)(p
, p
->argf
);
780 p
->ps
->pscol
= p
->ps
->left
;
781 p
->ps
->psrow
= p
->ps
->footer
;
783 (*p
->footf
)(p
, p
->argf
);
786 p
->ps
->flags
&= ~PS_MARGINS
;
788 assert(0 == p
->ps
->flags
);
789 assert(p
->ps
->psmarg
);
790 assert('\0' != p
->ps
->psmarg
[0]);
793 * Print header and initialise page state. Following this,
794 * stuff gets printed to the screen, so make sure we're sane.
799 if (TERMTYPE_PS
== p
->type
) {
800 ps_printf(p
, "%%!PS-Adobe-3.0\n");
801 ps_printf(p
, "%%%%CreationDate: %s", ctime(&t
));
802 ps_printf(p
, "%%%%DocumentData: Clean7Bit\n");
803 ps_printf(p
, "%%%%Orientation: Portrait\n");
804 ps_printf(p
, "%%%%Pages: (atend)\n");
805 ps_printf(p
, "%%%%PageOrder: Ascend\n");
806 ps_printf(p
, "%%%%DocumentMedia: "
807 "Default %zu %zu 0 () ()\n",
808 (size_t)AFM2PNT(p
, p
->ps
->width
),
809 (size_t)AFM2PNT(p
, p
->ps
->height
));
810 ps_printf(p
, "%%%%DocumentNeededResources: font");
812 for (i
= 0; i
< (int)TERMFONT__MAX
; i
++)
813 ps_printf(p
, " %s", fonts
[i
].name
);
815 ps_printf(p
, "\n%%%%EndComments\n");
817 ps_printf(p
, "%%PDF-1.1\n");
819 ps_printf(p
, "<<\n");
820 ps_printf(p
, ">>\n");
821 ps_printf(p
, "endobj\n");
823 for (i
= 0; i
< (int)TERMFONT__MAX
; i
++) {
824 pdf_obj(p
, (size_t)i
+ 3);
825 ps_printf(p
, "<<\n");
826 ps_printf(p
, "/Type /Font\n");
827 ps_printf(p
, "/Subtype /Type1\n");
828 ps_printf(p
, "/Name /F%zu\n", i
);
829 ps_printf(p
, "/BaseFont /%s\n", fonts
[i
].name
);
830 ps_printf(p
, ">>\n");
834 p
->ps
->pdfbody
= (size_t)TERMFONT__MAX
+ 3;
835 p
->ps
->pscol
= p
->ps
->left
;
836 p
->ps
->psrow
= p
->ps
->top
;
837 p
->ps
->flags
|= PS_NEWPAGE
;
838 ps_setfont(p
, TERMFONT_NONE
);
843 ps_pletter(struct termp
*p
, int c
)
848 * If we haven't opened a page context, then output that we're
849 * in a new page and make sure the font is correctly set.
852 if (PS_NEWPAGE
& p
->ps
->flags
) {
853 if (TERMTYPE_PS
== p
->type
) {
854 ps_printf(p
, "%%%%Page: %zu %zu\n",
857 ps_printf(p
, "/%s %zu selectfont\n",
858 fonts
[(int)p
->ps
->lastf
].name
,
861 pdf_obj(p
, p
->ps
->pdfbody
+
863 ps_printf(p
, "<<\n");
864 ps_printf(p
, "/Length %zu 0 R\n",
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",
883 ps_printf(p
, "%.3f %.3f Td\n(",
884 AFM2PNT(p
, p
->ps
->pscol
),
885 AFM2PNT(p
, p
->ps
->psrow
));
887 ps_printf(p
, "%.3f %.3f moveto\n(",
888 AFM2PNT(p
, p
->ps
->pscol
),
889 AFM2PNT(p
, p
->ps
->psrow
));
890 p
->ps
->flags
|= PS_INLINE
;
893 assert( ! (PS_NEWPAGE
& p
->ps
->flags
));
896 * We need to escape these characters as per the PostScript
897 * specification. We would also escape non-graphable characters
898 * (like tabs), but none of them would get to this point and
899 * it's superfluous to abort() on them.
914 /* Write the character and adjust where we are on the page. */
916 f
= (int)p
->ps
->lastf
;
918 if (c
<= 32 || (c
- 32 >= MAXCHAR
)) {
920 p
->ps
->pscol
+= (size_t)fonts
[f
].gly
[0].wx
;
924 ps_putchar(p
, (char)c
);
926 p
->ps
->pscol
+= (size_t)fonts
[f
].gly
[c
].wx
;
931 ps_pclose(struct termp
*p
)
935 * Spit out that we're exiting a word context (this is a
936 * "partial close" because we don't check the last-char buffer
940 if ( ! (PS_INLINE
& p
->ps
->flags
))
943 if (TERMTYPE_PS
!= p
->type
) {
944 ps_printf(p
, ") Tj\nET\n");
946 ps_printf(p
, ") show\n");
948 p
->ps
->flags
&= ~PS_INLINE
;
953 ps_fclose(struct termp
*p
)
957 * Strong closure: if we have a last-char, spit it out after
958 * checking that we're in the right font mode. This will of
959 * course open a new scope, if applicable.
961 * Following this, close out any scope that's open.
964 if ('\0' != p
->ps
->last
) {
965 if (p
->ps
->lastf
!= TERMFONT_NONE
) {
967 ps_setfont(p
, TERMFONT_NONE
);
969 ps_pletter(p
, p
->ps
->last
);
973 if ( ! (PS_INLINE
& p
->ps
->flags
))
981 ps_letter(struct termp
*p
, int arg
)
986 c
= arg
>= 128 || arg
<= 0 ? '?' : arg
;
989 * State machine dictates whether to buffer the last character
990 * or not. Basically, encoded words are detected by checking if
991 * we're an "8" and switching on the buffer. Then we put "8" in
992 * our buffer, and on the next charater, flush both character
993 * and buffer. Thus, "regular" words are detected by having a
994 * regular character and a regular buffer character.
997 if ('\0' == p
->ps
->last
) {
1001 } else if (8 == p
->ps
->last
) {
1004 } else if (8 == c
) {
1005 assert(8 != p
->ps
->last
);
1006 if ('_' == p
->ps
->last
) {
1007 if (p
->ps
->lastf
!= TERMFONT_UNDER
) {
1009 ps_setfont(p
, TERMFONT_UNDER
);
1011 } else if (p
->ps
->lastf
!= TERMFONT_BOLD
) {
1013 ps_setfont(p
, TERMFONT_BOLD
);
1018 if (p
->ps
->lastf
!= TERMFONT_NONE
) {
1020 ps_setfont(p
, TERMFONT_NONE
);
1032 ps_advance(struct termp
*p
, size_t len
)
1036 * Advance some spaces. This can probably be made smarter,
1037 * i.e., to have multiple space-separated words in the same
1038 * scope, but this is easier: just close out the current scope
1039 * and readjust our column settings.
1043 p
->ps
->pscol
+= len
;
1048 ps_endline(struct termp
*p
)
1051 /* Close out any scopes we have open: we're at eoln. */
1056 * If we're in the margin, don't try to recalculate our current
1057 * row. XXX: if the column tries to be fancy with multiple
1058 * lines, we'll do nasty stuff.
1061 if (PS_MARGINS
& p
->ps
->flags
)
1066 p
->ps
->pscol
= p
->ps
->left
;
1068 /* If we haven't printed anything, return. */
1070 if (PS_NEWPAGE
& p
->ps
->flags
)
1074 * Put us down a line. If we're at the page bottom, spit out a
1075 * showpage and restart our row.
1078 if (p
->ps
->psrow
>= p
->ps
->lineheight
+
1080 p
->ps
->psrow
-= p
->ps
->lineheight
;
1089 ps_setfont(struct termp
*p
, enum termfont f
)
1092 assert(f
< TERMFONT__MAX
);
1096 * If we're still at the top of the page, let the font-setting
1097 * be delayed until we actually have stuff to print.
1100 if (PS_NEWPAGE
& p
->ps
->flags
)
1103 if (TERMTYPE_PS
== p
->type
)
1104 ps_printf(p
, "/%s %zu selectfont\n",
1108 ps_printf(p
, "/F%d %zu Tf\n",
1116 ps_width(const struct termp
*p
, int c
)
1119 if (c
<= 32 || c
- 32 >= MAXCHAR
)
1120 return((size_t)fonts
[(int)TERMFONT_NONE
].gly
[0].wx
);
1123 return((size_t)fonts
[(int)TERMFONT_NONE
].gly
[c
].wx
);
1128 ps_hspan(const struct termp
*p
, const struct roffsu
*su
)
1133 * All of these measurements are derived by converting from the
1134 * native measurement to AFM units.
1139 r
= PNT2AFM(p
, su
->scale
* 28.34);
1142 r
= PNT2AFM(p
, su
->scale
* 72);
1145 r
= PNT2AFM(p
, su
->scale
* 12);
1148 r
= PNT2AFM(p
, su
->scale
* 100);
1152 fonts
[(int)TERMFONT_NONE
].gly
[109 - 32].wx
;
1155 r
= PNT2AFM(p
, su
->scale
* 2.834);
1159 fonts
[(int)TERMFONT_NONE
].gly
[110 - 32].wx
;
1162 r
= su
->scale
* p
->ps
->lineheight
;
1173 ps_growbuf(struct termp
*p
, size_t sz
)
1175 if (p
->ps
->psmargcur
+ sz
<= p
->ps
->psmargsz
)
1178 if (sz
< PS_BUFSLOP
)
1181 p
->ps
->psmargsz
+= sz
;
1183 p
->ps
->psmarg
= mandoc_realloc
1184 (p
->ps
->psmarg
, p
->ps
->psmargsz
);