1 /* $Id: term_ps.c,v 1.45 2010/09/27 23:03:44 schwarze 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 /* Convert PostScript point "x" to an AFM unit. */
38 #define PNT2AFM(p, x) /* LINTED */ \
39 (size_t)((double)(x) * (1000.0 / (double)(p)->engine.ps.scale))
41 /* Convert an AFM unit "x" to a PostScript points */
42 #define AFM2PNT(p, x) /* LINTED */ \
43 ((double)(x) / (1000.0 / (double)(p)->engine.ps.scale))
46 unsigned short wx; /* WX in AFM */
50 const char *name; /* FontName in AFM */
51 #define MAXCHAR 95 /* total characters we can handle */
52 struct glyph gly[MAXCHAR]; /* glyph metrics */
56 * We define, for the time being, three fonts: bold, oblique/italic, and
57 * normal (roman). The following table hard-codes the font metrics for
58 * ASCII, i.e., 32--127.
61 static const struct font fonts[TERMFONT__MAX] = {
355 /* These work the buffer used by the header and footer. */
356 #define PS_BUFSLOP 128
359 ps_growbuf(struct termp *p, size_t sz)
361 if (p->engine.ps.psmargcur + sz <= p->engine.ps.psmargsz)
367 p->engine.ps.psmargsz += sz;
369 p->engine.ps.psmarg = realloc
370 (p->engine.ps.psmarg,
371 p->engine.ps.psmargsz);
373 if (NULL == p->engine.ps.psmarg) {
375 exit((int)MANDOCLEVEL_SYSERR);
379 static double ps_hspan(const struct termp *,
380 const struct roffsu *);
381 static size_t ps_width(const struct termp *, char);
382 static void ps_advance(struct termp *, size_t);
383 static void ps_begin(struct termp *);
384 static void ps_closepage(struct termp *);
385 static void ps_end(struct termp *);
386 static void ps_endline(struct termp *);
387 static void ps_fclose(struct termp *);
388 static void ps_letter(struct termp *, char);
389 static void ps_pclose(struct termp *);
390 static void ps_pletter(struct termp *, int);
391 static void ps_printf(struct termp *, const char *, ...);
392 static void ps_putchar(struct termp *, char);
393 static void ps_setfont(struct termp *, enum termfont);
394 static struct termp *pspdf_alloc(char *);
395 static void pdf_obj(struct termp *, size_t);
399 pdf_alloc(char *outopts)
403 if (NULL != (p = pspdf_alloc(outopts)))
404 p->type = TERMTYPE_PDF;
411 ps_alloc(char *outopts)
415 if (NULL != (p = pspdf_alloc(outopts)))
416 p->type = TERMTYPE_PS;
422 static struct termp *
423 pspdf_alloc(char *outopts)
426 size_t pagex, pagey, marginx, marginy, lineheight;
431 if (NULL == (p = term_alloc(TERMENC_ASCII)))
434 p->advance = ps_advance;
437 p->endline = ps_endline;
439 p->letter = ps_letter;
447 while (outopts && *outopts)
448 switch (getsubopt(&outopts, UNCONST(toks), &v)) {
456 /* Default to US letter (millimetres). */
462 * The ISO-269 paper sizes can be calculated automatically, but
463 * it would require bringing in -lm for pow() and I'd rather not
464 * do that. So just do it the easy way for now. Since this
465 * only happens once, I'm not terribly concerned.
468 if (pp && strcasecmp(pp, "letter")) {
469 if (0 == strcasecmp(pp, "a3")) {
472 } else if (0 == strcasecmp(pp, "a4")) {
475 } else if (0 == strcasecmp(pp, "a5")) {
478 } else if (0 == strcasecmp(pp, "legal")) {
481 } else if (2 != sscanf(pp, "%zux%zu", &pagex, &pagey))
482 fprintf(stderr, "%s: Unknown paper\n", pp);
483 } else if (NULL == pp)
487 * This MUST be defined before any PNT2AFM or AFM2PNT
488 * calculations occur.
491 p->engine.ps.scale = 11;
493 /* Remember millimetres -> AFM units. */
495 pagex = PNT2AFM(p, ((double)pagex * 2.834));
496 pagey = PNT2AFM(p, ((double)pagey * 2.834));
498 /* Margins are 1/9 the page x and y. */
500 marginx = /* LINTED */
501 (size_t)((double)pagex / 9.0);
502 marginy = /* LINTED */
503 (size_t)((double)pagey / 9.0);
505 /* Line-height is 1.4em. */
507 lineheight = PNT2AFM(p, ((double)p->engine.ps.scale * 1.4));
509 p->engine.ps.width = pagex;
510 p->engine.ps.height = pagey;
511 p->engine.ps.header = pagey - (marginy / 2) - (lineheight / 2);
512 p->engine.ps.top = pagey - marginy;
513 p->engine.ps.footer = (marginy / 2) - (lineheight / 2);
514 p->engine.ps.bottom = marginy;
515 p->engine.ps.left = marginx;
516 p->engine.ps.lineheight = lineheight;
518 p->defrmargin = pagex - (marginx * 2);
524 pspdf_free(void *arg)
528 p = (struct termp *)arg;
530 if (p->engine.ps.psmarg)
531 free(p->engine.ps.psmarg);
532 if (p->engine.ps.pdfobjs)
533 free(p->engine.ps.pdfobjs);
540 ps_printf(struct termp *p, const char *fmt, ...)
548 * If we're running in regular mode, then pipe directly into
549 * vprintf(). If we're processing margins, then push the data
550 * into our growable margin buffer.
553 if ( ! (PS_MARGINS & p->engine.ps.flags)) {
554 len = vprintf(fmt, ap);
556 p->engine.ps.pdfbytes += /* LINTED */
557 len < 0 ? 0 : (size_t)len;
562 * XXX: I assume that the in-margin print won't exceed
563 * PS_BUFSLOP (128 bytes), which is reasonable but still an
564 * assumption that will cause pukeage if it's not the case.
567 ps_growbuf(p, PS_BUFSLOP);
569 pos = (int)p->engine.ps.psmargcur;
570 len = vsnprintf(&p->engine.ps.psmarg[pos], PS_BUFSLOP, fmt, ap);
574 p->engine.ps.psmargcur = strlen(p->engine.ps.psmarg);
579 ps_putchar(struct termp *p, char c)
583 /* See ps_printf(). */
585 if ( ! (PS_MARGINS & p->engine.ps.flags)) {
588 p->engine.ps.pdfbytes++;
594 pos = (int)p->engine.ps.psmargcur++;
595 p->engine.ps.psmarg[pos++] = c;
596 p->engine.ps.psmarg[pos] = '\0';
601 pdf_obj(struct termp *p, size_t obj)
606 if ((obj - 1) >= p->engine.ps.pdfobjsz) {
607 p->engine.ps.pdfobjsz = obj + 128;
608 p->engine.ps.pdfobjs = realloc
609 (p->engine.ps.pdfobjs,
610 p->engine.ps.pdfobjsz * sizeof(size_t));
611 if (NULL == p->engine.ps.pdfobjs) {
613 exit((int)MANDOCLEVEL_SYSERR);
617 p->engine.ps.pdfobjs[(int)obj - 1] = p->engine.ps.pdfbytes;
618 ps_printf(p, "%zu 0 obj\n", obj);
623 ps_closepage(struct termp *p)
629 * Close out a page that we've already flushed to output. In
630 * PostScript, we simply note that the page must be showed. In
631 * PDF, we must now create the Length, Resource, and Page node
632 * for the page contents.
635 assert(p->engine.ps.psmarg && p->engine.ps.psmarg[0]);
636 ps_printf(p, "%s", p->engine.ps.psmarg);
638 if (TERMTYPE_PS != p->type) {
639 ps_printf(p, "ET\n");
641 len = p->engine.ps.pdfbytes - p->engine.ps.pdflastpg;
642 base = p->engine.ps.pages * 4 + p->engine.ps.pdfbody;
644 ps_printf(p, "endstream\nendobj\n");
646 /* Length of content. */
647 pdf_obj(p, base + 1);
648 ps_printf(p, "%zu\nendobj\n", len);
650 /* Resource for content. */
651 pdf_obj(p, base + 2);
652 ps_printf(p, "<<\n/ProcSet [/PDF /Text]\n");
653 ps_printf(p, "/Font <<\n");
654 for (i = 0; i < (int)TERMFONT__MAX; i++)
655 ps_printf(p, "/F%d %d 0 R\n", i, 3 + i);
656 ps_printf(p, ">>\n>>\n");
659 pdf_obj(p, base + 3);
660 ps_printf(p, "<<\n");
661 ps_printf(p, "/Type /Page\n");
662 ps_printf(p, "/Parent 2 0 R\n");
663 ps_printf(p, "/Resources %zu 0 R\n", base + 2);
664 ps_printf(p, "/Contents %zu 0 R\n", base);
665 ps_printf(p, ">>\nendobj\n");
667 ps_printf(p, "showpage\n");
669 p->engine.ps.pages++;
670 p->engine.ps.psrow = p->engine.ps.top;
671 assert( ! (PS_NEWPAGE & p->engine.ps.flags));
672 p->engine.ps.flags |= PS_NEWPAGE;
678 ps_end(struct termp *p)
680 size_t i, xref, base;
683 * At the end of the file, do one last showpage. This is the
684 * same behaviour as groff(1) and works for multiple pages as
688 if ( ! (PS_NEWPAGE & p->engine.ps.flags)) {
689 assert(0 == p->engine.ps.flags);
690 assert('\0' == p->engine.ps.last);
694 if (TERMTYPE_PS == p->type) {
695 ps_printf(p, "%%%%Trailer\n");
696 ps_printf(p, "%%%%Pages: %zu\n", p->engine.ps.pages);
697 ps_printf(p, "%%%%EOF\n");
702 ps_printf(p, "<<\n/Type /Pages\n");
703 ps_printf(p, "/MediaBox [0 0 %zu %zu]\n",
704 (size_t)AFM2PNT(p, p->engine.ps.width),
705 (size_t)AFM2PNT(p, p->engine.ps.height));
707 ps_printf(p, "/Count %zu\n", p->engine.ps.pages);
708 ps_printf(p, "/Kids [");
710 for (i = 0; i < p->engine.ps.pages; i++)
711 ps_printf(p, " %zu 0 R", i * 4 +
712 p->engine.ps.pdfbody + 3);
714 base = (p->engine.ps.pages - 1) * 4 +
715 p->engine.ps.pdfbody + 4;
717 ps_printf(p, "]\n>>\nendobj\n");
719 ps_printf(p, "<<\n");
720 ps_printf(p, "/Type /Catalog\n");
721 ps_printf(p, "/Pages 2 0 R\n");
722 ps_printf(p, ">>\n");
723 xref = p->engine.ps.pdfbytes;
724 ps_printf(p, "xref\n");
725 ps_printf(p, "0 %zu\n", base + 1);
726 ps_printf(p, "0000000000 65535 f \n");
728 for (i = 0; i < base; i++)
729 ps_printf(p, "%.10zu 00000 n \n",
730 p->engine.ps.pdfobjs[(int)i]);
732 ps_printf(p, "trailer\n");
733 ps_printf(p, "<<\n");
734 ps_printf(p, "/Size %zu\n", base + 1);
735 ps_printf(p, "/Root %zu 0 R\n", base);
736 ps_printf(p, "/Info 1 0 R\n");
737 ps_printf(p, ">>\n");
738 ps_printf(p, "startxref\n");
739 ps_printf(p, "%zu\n", xref);
740 ps_printf(p, "%%%%EOF\n");
745 ps_begin(struct termp *p)
751 * Print margins into margin buffer. Nothing gets output to the
752 * screen yet, so we don't need to initialise the primary state.
755 if (p->engine.ps.psmarg) {
756 assert(p->engine.ps.psmargsz);
757 p->engine.ps.psmarg[0] = '\0';
760 /*p->engine.ps.pdfbytes = 0;*/
761 p->engine.ps.psmargcur = 0;
762 p->engine.ps.flags = PS_MARGINS;
763 p->engine.ps.pscol = p->engine.ps.left;
764 p->engine.ps.psrow = p->engine.ps.header;
766 ps_setfont(p, TERMFONT_NONE);
768 (*p->headf)(p, p->argf);
771 p->engine.ps.pscol = p->engine.ps.left;
772 p->engine.ps.psrow = p->engine.ps.footer;
774 (*p->footf)(p, p->argf);
777 p->engine.ps.flags &= ~PS_MARGINS;
779 assert(0 == p->engine.ps.flags);
780 assert(p->engine.ps.psmarg);
781 assert('\0' != p->engine.ps.psmarg[0]);
784 * Print header and initialise page state. Following this,
785 * stuff gets printed to the screen, so make sure we're sane.
790 if (TERMTYPE_PS == p->type) {
791 ps_printf(p, "%%!PS-Adobe-3.0\n");
792 ps_printf(p, "%%%%Creator: mandoc-%s\n", VERSION);
793 ps_printf(p, "%%%%CreationDate: %s", ctime(&t));
794 ps_printf(p, "%%%%DocumentData: Clean7Bit\n");
795 ps_printf(p, "%%%%Orientation: Portrait\n");
796 ps_printf(p, "%%%%Pages: (atend)\n");
797 ps_printf(p, "%%%%PageOrder: Ascend\n");
798 ps_printf(p, "%%%%DocumentMedia: "
799 "Default %zu %zu 0 () ()\n",
800 (size_t)AFM2PNT(p, p->engine.ps.width),
801 (size_t)AFM2PNT(p, p->engine.ps.height));
802 ps_printf(p, "%%%%DocumentNeededResources: font");
804 for (i = 0; i < (int)TERMFONT__MAX; i++)
805 ps_printf(p, " %s", fonts[i].name);
807 ps_printf(p, "\n%%%%EndComments\n");
809 ps_printf(p, "%%PDF-1.1\n");
811 ps_printf(p, "<<\n");
812 ps_printf(p, "/Creator mandoc-%s\n", VERSION);
813 ps_printf(p, ">>\n");
814 ps_printf(p, "endobj\n");
816 for (i = 0; i < (int)TERMFONT__MAX; i++) {
817 pdf_obj(p, (size_t)i + 3);
818 ps_printf(p, "<<\n");
819 ps_printf(p, "/Type /Font\n");
820 ps_printf(p, "/Subtype /Type1\n");
821 ps_printf(p, "/Name /F%zu\n", i);
822 ps_printf(p, "/BaseFont /%s\n", fonts[i].name);
823 ps_printf(p, ">>\n");
827 p->engine.ps.pdfbody = (size_t)TERMFONT__MAX + 3;
828 p->engine.ps.pscol = p->engine.ps.left;
829 p->engine.ps.psrow = p->engine.ps.top;
830 p->engine.ps.flags |= PS_NEWPAGE;
831 ps_setfont(p, TERMFONT_NONE);
836 ps_pletter(struct termp *p, int c)
841 * If we haven't opened a page context, then output that we're
842 * in a new page and make sure the font is correctly set.
845 if (PS_NEWPAGE & p->engine.ps.flags) {
846 if (TERMTYPE_PS == p->type) {
847 ps_printf(p, "%%%%Page: %zu %zu\n",
848 p->engine.ps.pages + 1,
849 p->engine.ps.pages + 1);
850 ps_printf(p, "/%s %zu selectfont\n",
851 fonts[(int)p->engine.ps.lastf].name,
854 pdf_obj(p, p->engine.ps.pdfbody +
855 p->engine.ps.pages * 4);
856 ps_printf(p, "<<\n");
857 ps_printf(p, "/Length %zu 0 R\n",
858 p->engine.ps.pdfbody + 1 +
859 p->engine.ps.pages * 4);
860 ps_printf(p, ">>\nstream\n");
862 p->engine.ps.pdflastpg = p->engine.ps.pdfbytes;
863 p->engine.ps.flags &= ~PS_NEWPAGE;
867 * If we're not in a PostScript "word" context, then open one
868 * now at the current cursor.
871 if ( ! (PS_INLINE & p->engine.ps.flags)) {
872 if (TERMTYPE_PS != p->type) {
873 ps_printf(p, "BT\n/F%d %zu Tf\n",
874 (int)p->engine.ps.lastf,
876 ps_printf(p, "%.3f %.3f Td\n(",
877 AFM2PNT(p, p->engine.ps.pscol),
878 AFM2PNT(p, p->engine.ps.psrow));
880 ps_printf(p, "%.3f %.3f moveto\n(",
881 AFM2PNT(p, p->engine.ps.pscol),
882 AFM2PNT(p, p->engine.ps.psrow));
883 p->engine.ps.flags |= PS_INLINE;
886 assert( ! (PS_NEWPAGE & p->engine.ps.flags));
889 * We need to escape these characters as per the PostScript
890 * specification. We would also escape non-graphable characters
891 * (like tabs), but none of them would get to this point and
892 * it's superfluous to abort() on them.
907 /* Write the character and adjust where we are on the page. */
909 f = (int)p->engine.ps.lastf;
911 if (c <= 32 || (c - 32 >= MAXCHAR)) {
913 p->engine.ps.pscol += (size_t)fonts[f].gly[0].wx;
917 ps_putchar(p, (char)c);
919 p->engine.ps.pscol += (size_t)fonts[f].gly[c].wx;
924 ps_pclose(struct termp *p)
928 * Spit out that we're exiting a word context (this is a
929 * "partial close" because we don't check the last-char buffer
933 if ( ! (PS_INLINE & p->engine.ps.flags))
936 if (TERMTYPE_PS != p->type) {
937 ps_printf(p, ") Tj\nET\n");
939 ps_printf(p, ") show\n");
941 p->engine.ps.flags &= ~PS_INLINE;
946 ps_fclose(struct termp *p)
950 * Strong closure: if we have a last-char, spit it out after
951 * checking that we're in the right font mode. This will of
952 * course open a new scope, if applicable.
954 * Following this, close out any scope that's open.
957 if ('\0' != p->engine.ps.last) {
958 if (p->engine.ps.lastf != TERMFONT_NONE) {
960 ps_setfont(p, TERMFONT_NONE);
962 ps_pletter(p, p->engine.ps.last);
963 p->engine.ps.last = '\0';
966 if ( ! (PS_INLINE & p->engine.ps.flags))
974 ps_letter(struct termp *p, char c)
979 * State machine dictates whether to buffer the last character
980 * or not. Basically, encoded words are detected by checking if
981 * we're an "8" and switching on the buffer. Then we put "8" in
982 * our buffer, and on the next charater, flush both character
983 * and buffer. Thus, "regular" words are detected by having a
984 * regular character and a regular buffer character.
987 if ('\0' == p->engine.ps.last) {
989 p->engine.ps.last = c;
991 } else if (8 == p->engine.ps.last) {
993 p->engine.ps.last = '\0';
995 assert(8 != p->engine.ps.last);
996 if ('_' == p->engine.ps.last) {
997 if (p->engine.ps.lastf != TERMFONT_UNDER) {
999 ps_setfont(p, TERMFONT_UNDER);
1001 } else if (p->engine.ps.lastf != TERMFONT_BOLD) {
1003 ps_setfont(p, TERMFONT_BOLD);
1005 p->engine.ps.last = c;
1008 if (p->engine.ps.lastf != TERMFONT_NONE) {
1010 ps_setfont(p, TERMFONT_NONE);
1012 cc = p->engine.ps.last;
1013 p->engine.ps.last = c;
1022 ps_advance(struct termp *p, size_t len)
1026 * Advance some spaces. This can probably be made smarter,
1027 * i.e., to have multiple space-separated words in the same
1028 * scope, but this is easier: just close out the current scope
1029 * and readjust our column settings.
1033 p->engine.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->engine.ps.flags)
1056 p->engine.ps.pscol = p->engine.ps.left;
1058 /* If we haven't printed anything, return. */
1060 if (PS_NEWPAGE & p->engine.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->engine.ps.psrow >= p->engine.ps.lineheight +
1069 p->engine.ps.bottom) {
1070 p->engine.ps.psrow -= p->engine.ps.lineheight;
1079 ps_setfont(struct termp *p, enum termfont f)
1082 assert(f < TERMFONT__MAX);
1083 p->engine.ps.lastf = f;
1086 * If we're still at the top of the page, let the font-setting
1087 * be delayed until we actually have stuff to print.
1090 if (PS_NEWPAGE & p->engine.ps.flags)
1093 if (TERMTYPE_PS == p->type)
1094 ps_printf(p, "/%s %zu selectfont\n",
1096 p->engine.ps.scale);
1098 ps_printf(p, "/F%d %zu Tf\n",
1100 p->engine.ps.scale);
1106 ps_width(const struct termp *p, char c)
1109 if (c <= 32 || c - 32 >= MAXCHAR)
1110 return((size_t)fonts[(int)TERMFONT_NONE].gly[0].wx);
1113 return((size_t)fonts[(int)TERMFONT_NONE].gly[(int)c].wx);
1118 ps_hspan(const struct termp *p, const struct roffsu *su)
1123 * All of these measurements are derived by converting from the
1124 * native measurement to AFM units.
1129 r = PNT2AFM(p, su->scale * 28.34);
1132 r = PNT2AFM(p, su->scale * 72);
1135 r = PNT2AFM(p, su->scale * 12);
1138 r = PNT2AFM(p, su->scale * 100);
1142 fonts[(int)TERMFONT_NONE].gly[109 - 32].wx;
1145 r = PNT2AFM(p, su->scale * 2.834);
1149 fonts[(int)TERMFONT_NONE].gly[110 - 32].wx;
1152 r = su->scale * p->engine.ps.lineheight;