1 /* $Id: term_ps.c,v 1.51 2011/05/17 14:38:34 kristaps Exp $ */
3 * Copyright (c) 2010 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 size_t pagex, pagey, marginx, marginy, lineheight;
437 p = mandoc_calloc(1, sizeof(struct termp));
438 p->enc = TERMENC_ASCII;
439 p->ps = mandoc_calloc(1, sizeof(struct termp_ps));
441 p->advance = ps_advance;
444 p->endline = ps_endline;
446 p->letter = ps_letter;
454 while (outopts && *outopts)
455 switch (getsubopt(&outopts, UNCONST(toks), &v)) {
463 /* Default to US letter (millimetres). */
469 * The ISO-269 paper sizes can be calculated automatically, but
470 * it would require bringing in -lm for pow() and I'd rather not
471 * do that. So just do it the easy way for now. Since this
472 * only happens once, I'm not terribly concerned.
475 if (pp && strcasecmp(pp, "letter")) {
476 if (0 == strcasecmp(pp, "a3")) {
479 } else if (0 == strcasecmp(pp, "a4")) {
482 } else if (0 == strcasecmp(pp, "a5")) {
485 } else if (0 == strcasecmp(pp, "legal")) {
488 } else if (2 != sscanf(pp, "%zux%zu", &pagex, &pagey))
489 fprintf(stderr, "%s: Unknown paper\n", pp);
490 } else if (NULL == pp)
494 * This MUST be defined before any PNT2AFM or AFM2PNT
495 * calculations occur.
500 /* Remember millimetres -> AFM units. */
502 pagex = PNT2AFM(p, ((double)pagex * 2.834));
503 pagey = PNT2AFM(p, ((double)pagey * 2.834));
505 /* Margins are 1/9 the page x and y. */
507 marginx = /* LINTED */
508 (size_t)((double)pagex / 9.0);
509 marginy = /* LINTED */
510 (size_t)((double)pagey / 9.0);
512 /* Line-height is 1.4em. */
514 lineheight = PNT2AFM(p, ((double)p->ps->scale * 1.4));
516 p->ps->width = pagex;
517 p->ps->height = pagey;
518 p->ps->header = pagey - (marginy / 2) - (lineheight / 2);
519 p->ps->top = pagey - marginy;
520 p->ps->footer = (marginy / 2) - (lineheight / 2);
521 p->ps->bottom = marginy;
522 p->ps->left = marginx;
523 p->ps->lineheight = lineheight;
525 p->defrmargin = pagex - (marginx * 2);
531 pspdf_free(void *arg)
535 p = (struct termp *)arg;
540 free(p->ps->pdfobjs);
548 ps_printf(struct termp *p, const char *fmt, ...)
556 * If we're running in regular mode, then pipe directly into
557 * vprintf(). If we're processing margins, then push the data
558 * into our growable margin buffer.
561 if ( ! (PS_MARGINS & p->ps->flags)) {
562 len = vprintf(fmt, ap);
564 p->ps->pdfbytes += /* LINTED */
565 len < 0 ? 0 : (size_t)len;
570 * XXX: I assume that the in-margin print won't exceed
571 * PS_BUFSLOP (128 bytes), which is reasonable but still an
572 * assumption that will cause pukeage if it's not the case.
575 ps_growbuf(p, PS_BUFSLOP);
577 pos = (int)p->ps->psmargcur;
578 len = vsnprintf(&p->ps->psmarg[pos], PS_BUFSLOP, fmt, ap);
582 p->ps->psmargcur = strlen(p->ps->psmarg);
587 ps_putchar(struct termp *p, char c)
591 /* See ps_printf(). */
593 if ( ! (PS_MARGINS & p->ps->flags)) {
602 pos = (int)p->ps->psmargcur++;
603 p->ps->psmarg[pos++] = c;
604 p->ps->psmarg[pos] = '\0';
609 pdf_obj(struct termp *p, size_t obj)
614 if ((obj - 1) >= p->ps->pdfobjsz) {
615 p->ps->pdfobjsz = obj + 128;
616 p->ps->pdfobjs = realloc
618 p->ps->pdfobjsz * sizeof(size_t));
619 if (NULL == p->ps->pdfobjs) {
621 exit((int)MANDOCLEVEL_SYSERR);
625 p->ps->pdfobjs[(int)obj - 1] = p->ps->pdfbytes;
626 ps_printf(p, "%zu 0 obj\n", obj);
631 ps_closepage(struct termp *p)
637 * Close out a page that we've already flushed to output. In
638 * PostScript, we simply note that the page must be showed. In
639 * PDF, we must now create the Length, Resource, and Page node
640 * for the page contents.
643 assert(p->ps->psmarg && p->ps->psmarg[0]);
644 ps_printf(p, "%s", p->ps->psmarg);
646 if (TERMTYPE_PS != p->type) {
647 ps_printf(p, "ET\n");
649 len = p->ps->pdfbytes - p->ps->pdflastpg;
650 base = p->ps->pages * 4 + p->ps->pdfbody;
652 ps_printf(p, "endstream\nendobj\n");
654 /* Length of content. */
655 pdf_obj(p, base + 1);
656 ps_printf(p, "%zu\nendobj\n", len);
658 /* Resource for content. */
659 pdf_obj(p, base + 2);
660 ps_printf(p, "<<\n/ProcSet [/PDF /Text]\n");
661 ps_printf(p, "/Font <<\n");
662 for (i = 0; i < (int)TERMFONT__MAX; i++)
663 ps_printf(p, "/F%d %d 0 R\n", i, 3 + i);
664 ps_printf(p, ">>\n>>\n");
667 pdf_obj(p, base + 3);
668 ps_printf(p, "<<\n");
669 ps_printf(p, "/Type /Page\n");
670 ps_printf(p, "/Parent 2 0 R\n");
671 ps_printf(p, "/Resources %zu 0 R\n", base + 2);
672 ps_printf(p, "/Contents %zu 0 R\n", base);
673 ps_printf(p, ">>\nendobj\n");
675 ps_printf(p, "showpage\n");
678 p->ps->psrow = p->ps->top;
679 assert( ! (PS_NEWPAGE & p->ps->flags));
680 p->ps->flags |= PS_NEWPAGE;
686 ps_end(struct termp *p)
688 size_t i, xref, base;
691 * At the end of the file, do one last showpage. This is the
692 * same behaviour as groff(1) and works for multiple pages as
696 if ( ! (PS_NEWPAGE & p->ps->flags)) {
697 assert(0 == p->ps->flags);
698 assert('\0' == p->ps->last);
702 if (TERMTYPE_PS == p->type) {
703 ps_printf(p, "%%%%Trailer\n");
704 ps_printf(p, "%%%%Pages: %zu\n", p->ps->pages);
705 ps_printf(p, "%%%%EOF\n");
710 ps_printf(p, "<<\n/Type /Pages\n");
711 ps_printf(p, "/MediaBox [0 0 %zu %zu]\n",
712 (size_t)AFM2PNT(p, p->ps->width),
713 (size_t)AFM2PNT(p, p->ps->height));
715 ps_printf(p, "/Count %zu\n", p->ps->pages);
716 ps_printf(p, "/Kids [");
718 for (i = 0; i < p->ps->pages; i++)
719 ps_printf(p, " %zu 0 R", i * 4 +
722 base = (p->ps->pages - 1) * 4 +
725 ps_printf(p, "]\n>>\nendobj\n");
727 ps_printf(p, "<<\n");
728 ps_printf(p, "/Type /Catalog\n");
729 ps_printf(p, "/Pages 2 0 R\n");
730 ps_printf(p, ">>\n");
731 xref = p->ps->pdfbytes;
732 ps_printf(p, "xref\n");
733 ps_printf(p, "0 %zu\n", base + 1);
734 ps_printf(p, "0000000000 65535 f \n");
736 for (i = 0; i < base; i++)
737 ps_printf(p, "%.10zu 00000 n \n",
738 p->ps->pdfobjs[(int)i]);
740 ps_printf(p, "trailer\n");
741 ps_printf(p, "<<\n");
742 ps_printf(p, "/Size %zu\n", base + 1);
743 ps_printf(p, "/Root %zu 0 R\n", base);
744 ps_printf(p, "/Info 1 0 R\n");
745 ps_printf(p, ">>\n");
746 ps_printf(p, "startxref\n");
747 ps_printf(p, "%zu\n", xref);
748 ps_printf(p, "%%%%EOF\n");
753 ps_begin(struct termp *p)
759 * Print margins into margin buffer. Nothing gets output to the
760 * screen yet, so we don't need to initialise the primary state.
764 assert(p->ps->psmargsz);
765 p->ps->psmarg[0] = '\0';
768 /*p->ps->pdfbytes = 0;*/
769 p->ps->psmargcur = 0;
770 p->ps->flags = PS_MARGINS;
771 p->ps->pscol = p->ps->left;
772 p->ps->psrow = p->ps->header;
774 ps_setfont(p, TERMFONT_NONE);
776 (*p->headf)(p, p->argf);
779 p->ps->pscol = p->ps->left;
780 p->ps->psrow = p->ps->footer;
782 (*p->footf)(p, p->argf);
785 p->ps->flags &= ~PS_MARGINS;
787 assert(0 == p->ps->flags);
788 assert(p->ps->psmarg);
789 assert('\0' != p->ps->psmarg[0]);
792 * Print header and initialise page state. Following this,
793 * stuff gets printed to the screen, so make sure we're sane.
798 if (TERMTYPE_PS == p->type) {
799 ps_printf(p, "%%!PS-Adobe-3.0\n");
800 ps_printf(p, "%%%%CreationDate: %s", ctime(&t));
801 ps_printf(p, "%%%%DocumentData: Clean7Bit\n");
802 ps_printf(p, "%%%%Orientation: Portrait\n");
803 ps_printf(p, "%%%%Pages: (atend)\n");
804 ps_printf(p, "%%%%PageOrder: Ascend\n");
805 ps_printf(p, "%%%%DocumentMedia: "
806 "Default %zu %zu 0 () ()\n",
807 (size_t)AFM2PNT(p, p->ps->width),
808 (size_t)AFM2PNT(p, p->ps->height));
809 ps_printf(p, "%%%%DocumentNeededResources: font");
811 for (i = 0; i < (int)TERMFONT__MAX; i++)
812 ps_printf(p, " %s", fonts[i].name);
814 ps_printf(p, "\n%%%%EndComments\n");
816 ps_printf(p, "%%PDF-1.1\n");
818 ps_printf(p, "<<\n");
819 ps_printf(p, ">>\n");
820 ps_printf(p, "endobj\n");
822 for (i = 0; i < (int)TERMFONT__MAX; i++) {
823 pdf_obj(p, (size_t)i + 3);
824 ps_printf(p, "<<\n");
825 ps_printf(p, "/Type /Font\n");
826 ps_printf(p, "/Subtype /Type1\n");
827 ps_printf(p, "/Name /F%zu\n", i);
828 ps_printf(p, "/BaseFont /%s\n", fonts[i].name);
829 ps_printf(p, ">>\n");
833 p->ps->pdfbody = (size_t)TERMFONT__MAX + 3;
834 p->ps->pscol = p->ps->left;
835 p->ps->psrow = p->ps->top;
836 p->ps->flags |= PS_NEWPAGE;
837 ps_setfont(p, TERMFONT_NONE);
842 ps_pletter(struct termp *p, int c)
847 * If we haven't opened a page context, then output that we're
848 * in a new page and make sure the font is correctly set.
851 if (PS_NEWPAGE & p->ps->flags) {
852 if (TERMTYPE_PS == p->type) {
853 ps_printf(p, "%%%%Page: %zu %zu\n",
856 ps_printf(p, "/%s %zu selectfont\n",
857 fonts[(int)p->ps->lastf].name,
860 pdf_obj(p, p->ps->pdfbody +
862 ps_printf(p, "<<\n");
863 ps_printf(p, "/Length %zu 0 R\n",
866 ps_printf(p, ">>\nstream\n");
868 p->ps->pdflastpg = p->ps->pdfbytes;
869 p->ps->flags &= ~PS_NEWPAGE;
873 * If we're not in a PostScript "word" context, then open one
874 * now at the current cursor.
877 if ( ! (PS_INLINE & p->ps->flags)) {
878 if (TERMTYPE_PS != p->type) {
879 ps_printf(p, "BT\n/F%d %zu Tf\n",
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)) {
919 p->ps->pscol += (size_t)fonts[f].gly[0].wx;
923 ps_putchar(p, (char)c);
925 p->ps->pscol += (size_t)fonts[f].gly[c].wx;
930 ps_pclose(struct termp *p)
934 * Spit out that we're exiting a word context (this is a
935 * "partial close" because we don't check the last-char buffer
939 if ( ! (PS_INLINE & p->ps->flags))
942 if (TERMTYPE_PS != p->type) {
943 ps_printf(p, ") Tj\nET\n");
945 ps_printf(p, ") show\n");
947 p->ps->flags &= ~PS_INLINE;
952 ps_fclose(struct termp *p)
956 * Strong closure: if we have a last-char, spit it out after
957 * checking that we're in the right font mode. This will of
958 * course open a new scope, if applicable.
960 * Following this, close out any scope that's open.
963 if ('\0' != p->ps->last) {
964 if (p->ps->lastf != TERMFONT_NONE) {
966 ps_setfont(p, TERMFONT_NONE);
968 ps_pletter(p, p->ps->last);
972 if ( ! (PS_INLINE & p->ps->flags))
980 ps_letter(struct termp *p, int arg)
985 c = arg >= 128 || arg <= 0 ? '?' : arg;
988 * State machine dictates whether to buffer the last character
989 * or not. Basically, encoded words are detected by checking if
990 * we're an "8" and switching on the buffer. Then we put "8" in
991 * our buffer, and on the next charater, flush both character
992 * and buffer. Thus, "regular" words are detected by having a
993 * regular character and a regular buffer character.
996 if ('\0' == p->ps->last) {
1000 } else if (8 == p->ps->last) {
1003 } else if (8 == c) {
1004 assert(8 != p->ps->last);
1005 if ('_' == p->ps->last) {
1006 if (p->ps->lastf != TERMFONT_UNDER) {
1008 ps_setfont(p, TERMFONT_UNDER);
1010 } else if (p->ps->lastf != TERMFONT_BOLD) {
1012 ps_setfont(p, TERMFONT_BOLD);
1017 if (p->ps->lastf != TERMFONT_NONE) {
1019 ps_setfont(p, TERMFONT_NONE);
1031 ps_advance(struct termp *p, size_t len)
1035 * Advance some spaces. This can probably be made smarter,
1036 * i.e., to have multiple space-separated words in the same
1037 * scope, but this is easier: just close out the current scope
1038 * and readjust our column settings.
1042 p->ps->pscol += len;
1047 ps_endline(struct termp *p)
1050 /* Close out any scopes we have open: we're at eoln. */
1055 * If we're in the margin, don't try to recalculate our current
1056 * row. XXX: if the column tries to be fancy with multiple
1057 * lines, we'll do nasty stuff.
1060 if (PS_MARGINS & p->ps->flags)
1065 p->ps->pscol = p->ps->left;
1067 /* If we haven't printed anything, return. */
1069 if (PS_NEWPAGE & p->ps->flags)
1073 * Put us down a line. If we're at the page bottom, spit out a
1074 * showpage and restart our row.
1077 if (p->ps->psrow >= p->ps->lineheight +
1079 p->ps->psrow -= p->ps->lineheight;
1088 ps_setfont(struct termp *p, enum termfont f)
1091 assert(f < TERMFONT__MAX);
1095 * If we're still at the top of the page, let the font-setting
1096 * be delayed until we actually have stuff to print.
1099 if (PS_NEWPAGE & p->ps->flags)
1102 if (TERMTYPE_PS == p->type)
1103 ps_printf(p, "/%s %zu selectfont\n",
1107 ps_printf(p, "/F%d %zu Tf\n",
1115 ps_width(const struct termp *p, int c)
1118 if (c <= 32 || c - 32 >= MAXCHAR)
1119 return((size_t)fonts[(int)TERMFONT_NONE].gly[0].wx);
1122 return((size_t)fonts[(int)TERMFONT_NONE].gly[c].wx);
1127 ps_hspan(const struct termp *p, const struct roffsu *su)
1132 * All of these measurements are derived by converting from the
1133 * native measurement to AFM units.
1138 r = PNT2AFM(p, su->scale * 28.34);
1141 r = PNT2AFM(p, su->scale * 72);
1144 r = PNT2AFM(p, su->scale * 12);
1147 r = PNT2AFM(p, su->scale * 100);
1151 fonts[(int)TERMFONT_NONE].gly[109 - 32].wx;
1154 r = PNT2AFM(p, su->scale * 2.834);
1158 fonts[(int)TERMFONT_NONE].gly[110 - 32].wx;
1161 r = su->scale * p->ps->lineheight;
1172 ps_growbuf(struct termp *p, size_t sz)
1174 if (p->ps->psmargcur + sz <= p->ps->psmargsz)
1177 if (sz < PS_BUFSLOP)
1180 p->ps->psmargsz += sz;
1182 p->ps->psmarg = mandoc_realloc
1183 (p->ps->psmarg, p->ps->psmargsz);