1 /* $Id: term_ps.c,v 1.48 2011/03/17 08:49: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 /* 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 = mandoc_realloc
370 (p->engine.ps.psmarg,
371 p->engine.ps.psmargsz);
374 static double ps_hspan(const struct termp *,
375 const struct roffsu *);
376 static size_t ps_width(const struct termp *, char);
377 static void ps_advance(struct termp *, size_t);
378 static void ps_begin(struct termp *);
379 static void ps_closepage(struct termp *);
380 static void ps_end(struct termp *);
381 static void ps_endline(struct termp *);
382 static void ps_fclose(struct termp *);
383 static void ps_letter(struct termp *, char);
384 static void ps_pclose(struct termp *);
385 static void ps_pletter(struct termp *, int);
386 static void ps_printf(struct termp *, const char *, ...);
387 static void ps_putchar(struct termp *, char);
388 static void ps_setfont(struct termp *, enum termfont);
389 static struct termp *pspdf_alloc(char *);
390 static void pdf_obj(struct termp *, size_t);
394 pdf_alloc(char *outopts)
398 if (NULL != (p = pspdf_alloc(outopts)))
399 p->type = TERMTYPE_PDF;
406 ps_alloc(char *outopts)
410 if (NULL != (p = pspdf_alloc(outopts)))
411 p->type = TERMTYPE_PS;
417 static struct termp *
418 pspdf_alloc(char *outopts)
421 size_t pagex, pagey, marginx, marginy, lineheight;
426 p = term_alloc(TERMENC_ASCII);
428 p->advance = ps_advance;
431 p->endline = ps_endline;
433 p->letter = ps_letter;
441 while (outopts && *outopts)
442 switch (getsubopt(&outopts, UNCONST(toks), &v)) {
450 /* Default to US letter (millimetres). */
456 * The ISO-269 paper sizes can be calculated automatically, but
457 * it would require bringing in -lm for pow() and I'd rather not
458 * do that. So just do it the easy way for now. Since this
459 * only happens once, I'm not terribly concerned.
462 if (pp && strcasecmp(pp, "letter")) {
463 if (0 == strcasecmp(pp, "a3")) {
466 } else if (0 == strcasecmp(pp, "a4")) {
469 } else if (0 == strcasecmp(pp, "a5")) {
472 } else if (0 == strcasecmp(pp, "legal")) {
475 } else if (2 != sscanf(pp, "%zux%zu", &pagex, &pagey))
476 fprintf(stderr, "%s: Unknown paper\n", pp);
477 } else if (NULL == pp)
481 * This MUST be defined before any PNT2AFM or AFM2PNT
482 * calculations occur.
485 p->engine.ps.scale = 11;
487 /* Remember millimetres -> AFM units. */
489 pagex = PNT2AFM(p, ((double)pagex * 2.834));
490 pagey = PNT2AFM(p, ((double)pagey * 2.834));
492 /* Margins are 1/9 the page x and y. */
494 marginx = /* LINTED */
495 (size_t)((double)pagex / 9.0);
496 marginy = /* LINTED */
497 (size_t)((double)pagey / 9.0);
499 /* Line-height is 1.4em. */
501 lineheight = PNT2AFM(p, ((double)p->engine.ps.scale * 1.4));
503 p->engine.ps.width = pagex;
504 p->engine.ps.height = pagey;
505 p->engine.ps.header = pagey - (marginy / 2) - (lineheight / 2);
506 p->engine.ps.top = pagey - marginy;
507 p->engine.ps.footer = (marginy / 2) - (lineheight / 2);
508 p->engine.ps.bottom = marginy;
509 p->engine.ps.left = marginx;
510 p->engine.ps.lineheight = lineheight;
512 p->defrmargin = pagex - (marginx * 2);
518 pspdf_free(void *arg)
522 p = (struct termp *)arg;
524 if (p->engine.ps.psmarg)
525 free(p->engine.ps.psmarg);
526 if (p->engine.ps.pdfobjs)
527 free(p->engine.ps.pdfobjs);
534 ps_printf(struct termp *p, const char *fmt, ...)
542 * If we're running in regular mode, then pipe directly into
543 * vprintf(). If we're processing margins, then push the data
544 * into our growable margin buffer.
547 if ( ! (PS_MARGINS & p->engine.ps.flags)) {
548 len = vprintf(fmt, ap);
550 p->engine.ps.pdfbytes += /* LINTED */
551 len < 0 ? 0 : (size_t)len;
556 * XXX: I assume that the in-margin print won't exceed
557 * PS_BUFSLOP (128 bytes), which is reasonable but still an
558 * assumption that will cause pukeage if it's not the case.
561 ps_growbuf(p, PS_BUFSLOP);
563 pos = (int)p->engine.ps.psmargcur;
564 len = vsnprintf(&p->engine.ps.psmarg[pos], PS_BUFSLOP, fmt, ap);
568 p->engine.ps.psmargcur = strlen(p->engine.ps.psmarg);
573 ps_putchar(struct termp *p, char c)
577 /* See ps_printf(). */
579 if ( ! (PS_MARGINS & p->engine.ps.flags)) {
582 p->engine.ps.pdfbytes++;
588 pos = (int)p->engine.ps.psmargcur++;
589 p->engine.ps.psmarg[pos++] = c;
590 p->engine.ps.psmarg[pos] = '\0';
595 pdf_obj(struct termp *p, size_t obj)
600 if ((obj - 1) >= p->engine.ps.pdfobjsz) {
601 p->engine.ps.pdfobjsz = obj + 128;
602 p->engine.ps.pdfobjs = realloc
603 (p->engine.ps.pdfobjs,
604 p->engine.ps.pdfobjsz * sizeof(size_t));
605 if (NULL == p->engine.ps.pdfobjs) {
607 exit((int)MANDOCLEVEL_SYSERR);
611 p->engine.ps.pdfobjs[(int)obj - 1] = p->engine.ps.pdfbytes;
612 ps_printf(p, "%zu 0 obj\n", obj);
617 ps_closepage(struct termp *p)
623 * Close out a page that we've already flushed to output. In
624 * PostScript, we simply note that the page must be showed. In
625 * PDF, we must now create the Length, Resource, and Page node
626 * for the page contents.
629 assert(p->engine.ps.psmarg && p->engine.ps.psmarg[0]);
630 ps_printf(p, "%s", p->engine.ps.psmarg);
632 if (TERMTYPE_PS != p->type) {
633 ps_printf(p, "ET\n");
635 len = p->engine.ps.pdfbytes - p->engine.ps.pdflastpg;
636 base = p->engine.ps.pages * 4 + p->engine.ps.pdfbody;
638 ps_printf(p, "endstream\nendobj\n");
640 /* Length of content. */
641 pdf_obj(p, base + 1);
642 ps_printf(p, "%zu\nendobj\n", len);
644 /* Resource for content. */
645 pdf_obj(p, base + 2);
646 ps_printf(p, "<<\n/ProcSet [/PDF /Text]\n");
647 ps_printf(p, "/Font <<\n");
648 for (i = 0; i < (int)TERMFONT__MAX; i++)
649 ps_printf(p, "/F%d %d 0 R\n", i, 3 + i);
650 ps_printf(p, ">>\n>>\n");
653 pdf_obj(p, base + 3);
654 ps_printf(p, "<<\n");
655 ps_printf(p, "/Type /Page\n");
656 ps_printf(p, "/Parent 2 0 R\n");
657 ps_printf(p, "/Resources %zu 0 R\n", base + 2);
658 ps_printf(p, "/Contents %zu 0 R\n", base);
659 ps_printf(p, ">>\nendobj\n");
661 ps_printf(p, "showpage\n");
663 p->engine.ps.pages++;
664 p->engine.ps.psrow = p->engine.ps.top;
665 assert( ! (PS_NEWPAGE & p->engine.ps.flags));
666 p->engine.ps.flags |= PS_NEWPAGE;
672 ps_end(struct termp *p)
674 size_t i, xref, base;
677 * At the end of the file, do one last showpage. This is the
678 * same behaviour as groff(1) and works for multiple pages as
682 if ( ! (PS_NEWPAGE & p->engine.ps.flags)) {
683 assert(0 == p->engine.ps.flags);
684 assert('\0' == p->engine.ps.last);
688 if (TERMTYPE_PS == p->type) {
689 ps_printf(p, "%%%%Trailer\n");
690 ps_printf(p, "%%%%Pages: %zu\n", p->engine.ps.pages);
691 ps_printf(p, "%%%%EOF\n");
696 ps_printf(p, "<<\n/Type /Pages\n");
697 ps_printf(p, "/MediaBox [0 0 %zu %zu]\n",
698 (size_t)AFM2PNT(p, p->engine.ps.width),
699 (size_t)AFM2PNT(p, p->engine.ps.height));
701 ps_printf(p, "/Count %zu\n", p->engine.ps.pages);
702 ps_printf(p, "/Kids [");
704 for (i = 0; i < p->engine.ps.pages; i++)
705 ps_printf(p, " %zu 0 R", i * 4 +
706 p->engine.ps.pdfbody + 3);
708 base = (p->engine.ps.pages - 1) * 4 +
709 p->engine.ps.pdfbody + 4;
711 ps_printf(p, "]\n>>\nendobj\n");
713 ps_printf(p, "<<\n");
714 ps_printf(p, "/Type /Catalog\n");
715 ps_printf(p, "/Pages 2 0 R\n");
716 ps_printf(p, ">>\n");
717 xref = p->engine.ps.pdfbytes;
718 ps_printf(p, "xref\n");
719 ps_printf(p, "0 %zu\n", base + 1);
720 ps_printf(p, "0000000000 65535 f \n");
722 for (i = 0; i < base; i++)
723 ps_printf(p, "%.10zu 00000 n \n",
724 p->engine.ps.pdfobjs[(int)i]);
726 ps_printf(p, "trailer\n");
727 ps_printf(p, "<<\n");
728 ps_printf(p, "/Size %zu\n", base + 1);
729 ps_printf(p, "/Root %zu 0 R\n", base);
730 ps_printf(p, "/Info 1 0 R\n");
731 ps_printf(p, ">>\n");
732 ps_printf(p, "startxref\n");
733 ps_printf(p, "%zu\n", xref);
734 ps_printf(p, "%%%%EOF\n");
739 ps_begin(struct termp *p)
745 * Print margins into margin buffer. Nothing gets output to the
746 * screen yet, so we don't need to initialise the primary state.
749 if (p->engine.ps.psmarg) {
750 assert(p->engine.ps.psmargsz);
751 p->engine.ps.psmarg[0] = '\0';
754 /*p->engine.ps.pdfbytes = 0;*/
755 p->engine.ps.psmargcur = 0;
756 p->engine.ps.flags = PS_MARGINS;
757 p->engine.ps.pscol = p->engine.ps.left;
758 p->engine.ps.psrow = p->engine.ps.header;
760 ps_setfont(p, TERMFONT_NONE);
762 (*p->headf)(p, p->argf);
765 p->engine.ps.pscol = p->engine.ps.left;
766 p->engine.ps.psrow = p->engine.ps.footer;
768 (*p->footf)(p, p->argf);
771 p->engine.ps.flags &= ~PS_MARGINS;
773 assert(0 == p->engine.ps.flags);
774 assert(p->engine.ps.psmarg);
775 assert('\0' != p->engine.ps.psmarg[0]);
778 * Print header and initialise page state. Following this,
779 * stuff gets printed to the screen, so make sure we're sane.
784 if (TERMTYPE_PS == p->type) {
785 ps_printf(p, "%%!PS-Adobe-3.0\n");
786 ps_printf(p, "%%%%CreationDate: %s", ctime(&t));
787 ps_printf(p, "%%%%DocumentData: Clean7Bit\n");
788 ps_printf(p, "%%%%Orientation: Portrait\n");
789 ps_printf(p, "%%%%Pages: (atend)\n");
790 ps_printf(p, "%%%%PageOrder: Ascend\n");
791 ps_printf(p, "%%%%DocumentMedia: "
792 "Default %zu %zu 0 () ()\n",
793 (size_t)AFM2PNT(p, p->engine.ps.width),
794 (size_t)AFM2PNT(p, p->engine.ps.height));
795 ps_printf(p, "%%%%DocumentNeededResources: font");
797 for (i = 0; i < (int)TERMFONT__MAX; i++)
798 ps_printf(p, " %s", fonts[i].name);
800 ps_printf(p, "\n%%%%EndComments\n");
802 ps_printf(p, "%%PDF-1.1\n");
804 ps_printf(p, "<<\n");
805 ps_printf(p, ">>\n");
806 ps_printf(p, "endobj\n");
808 for (i = 0; i < (int)TERMFONT__MAX; i++) {
809 pdf_obj(p, (size_t)i + 3);
810 ps_printf(p, "<<\n");
811 ps_printf(p, "/Type /Font\n");
812 ps_printf(p, "/Subtype /Type1\n");
813 ps_printf(p, "/Name /F%zu\n", i);
814 ps_printf(p, "/BaseFont /%s\n", fonts[i].name);
815 ps_printf(p, ">>\n");
819 p->engine.ps.pdfbody = (size_t)TERMFONT__MAX + 3;
820 p->engine.ps.pscol = p->engine.ps.left;
821 p->engine.ps.psrow = p->engine.ps.top;
822 p->engine.ps.flags |= PS_NEWPAGE;
823 ps_setfont(p, TERMFONT_NONE);
828 ps_pletter(struct termp *p, int c)
833 * If we haven't opened a page context, then output that we're
834 * in a new page and make sure the font is correctly set.
837 if (PS_NEWPAGE & p->engine.ps.flags) {
838 if (TERMTYPE_PS == p->type) {
839 ps_printf(p, "%%%%Page: %zu %zu\n",
840 p->engine.ps.pages + 1,
841 p->engine.ps.pages + 1);
842 ps_printf(p, "/%s %zu selectfont\n",
843 fonts[(int)p->engine.ps.lastf].name,
846 pdf_obj(p, p->engine.ps.pdfbody +
847 p->engine.ps.pages * 4);
848 ps_printf(p, "<<\n");
849 ps_printf(p, "/Length %zu 0 R\n",
850 p->engine.ps.pdfbody + 1 +
851 p->engine.ps.pages * 4);
852 ps_printf(p, ">>\nstream\n");
854 p->engine.ps.pdflastpg = p->engine.ps.pdfbytes;
855 p->engine.ps.flags &= ~PS_NEWPAGE;
859 * If we're not in a PostScript "word" context, then open one
860 * now at the current cursor.
863 if ( ! (PS_INLINE & p->engine.ps.flags)) {
864 if (TERMTYPE_PS != p->type) {
865 ps_printf(p, "BT\n/F%d %zu Tf\n",
866 (int)p->engine.ps.lastf,
868 ps_printf(p, "%.3f %.3f Td\n(",
869 AFM2PNT(p, p->engine.ps.pscol),
870 AFM2PNT(p, p->engine.ps.psrow));
872 ps_printf(p, "%.3f %.3f moveto\n(",
873 AFM2PNT(p, p->engine.ps.pscol),
874 AFM2PNT(p, p->engine.ps.psrow));
875 p->engine.ps.flags |= PS_INLINE;
878 assert( ! (PS_NEWPAGE & p->engine.ps.flags));
881 * We need to escape these characters as per the PostScript
882 * specification. We would also escape non-graphable characters
883 * (like tabs), but none of them would get to this point and
884 * it's superfluous to abort() on them.
899 /* Write the character and adjust where we are on the page. */
901 f = (int)p->engine.ps.lastf;
903 if (c <= 32 || (c - 32 >= MAXCHAR)) {
905 p->engine.ps.pscol += (size_t)fonts[f].gly[0].wx;
909 ps_putchar(p, (char)c);
911 p->engine.ps.pscol += (size_t)fonts[f].gly[c].wx;
916 ps_pclose(struct termp *p)
920 * Spit out that we're exiting a word context (this is a
921 * "partial close" because we don't check the last-char buffer
925 if ( ! (PS_INLINE & p->engine.ps.flags))
928 if (TERMTYPE_PS != p->type) {
929 ps_printf(p, ") Tj\nET\n");
931 ps_printf(p, ") show\n");
933 p->engine.ps.flags &= ~PS_INLINE;
938 ps_fclose(struct termp *p)
942 * Strong closure: if we have a last-char, spit it out after
943 * checking that we're in the right font mode. This will of
944 * course open a new scope, if applicable.
946 * Following this, close out any scope that's open.
949 if ('\0' != p->engine.ps.last) {
950 if (p->engine.ps.lastf != TERMFONT_NONE) {
952 ps_setfont(p, TERMFONT_NONE);
954 ps_pletter(p, p->engine.ps.last);
955 p->engine.ps.last = '\0';
958 if ( ! (PS_INLINE & p->engine.ps.flags))
966 ps_letter(struct termp *p, char c)
971 * State machine dictates whether to buffer the last character
972 * or not. Basically, encoded words are detected by checking if
973 * we're an "8" and switching on the buffer. Then we put "8" in
974 * our buffer, and on the next charater, flush both character
975 * and buffer. Thus, "regular" words are detected by having a
976 * regular character and a regular buffer character.
979 if ('\0' == p->engine.ps.last) {
981 p->engine.ps.last = c;
983 } else if (8 == p->engine.ps.last) {
985 p->engine.ps.last = '\0';
987 assert(8 != p->engine.ps.last);
988 if ('_' == p->engine.ps.last) {
989 if (p->engine.ps.lastf != TERMFONT_UNDER) {
991 ps_setfont(p, TERMFONT_UNDER);
993 } else if (p->engine.ps.lastf != TERMFONT_BOLD) {
995 ps_setfont(p, TERMFONT_BOLD);
997 p->engine.ps.last = c;
1000 if (p->engine.ps.lastf != TERMFONT_NONE) {
1002 ps_setfont(p, TERMFONT_NONE);
1004 cc = p->engine.ps.last;
1005 p->engine.ps.last = c;
1014 ps_advance(struct termp *p, size_t len)
1018 * Advance some spaces. This can probably be made smarter,
1019 * i.e., to have multiple space-separated words in the same
1020 * scope, but this is easier: just close out the current scope
1021 * and readjust our column settings.
1025 p->engine.ps.pscol += len;
1030 ps_endline(struct termp *p)
1033 /* Close out any scopes we have open: we're at eoln. */
1038 * If we're in the margin, don't try to recalculate our current
1039 * row. XXX: if the column tries to be fancy with multiple
1040 * lines, we'll do nasty stuff.
1043 if (PS_MARGINS & p->engine.ps.flags)
1048 p->engine.ps.pscol = p->engine.ps.left;
1050 /* If we haven't printed anything, return. */
1052 if (PS_NEWPAGE & p->engine.ps.flags)
1056 * Put us down a line. If we're at the page bottom, spit out a
1057 * showpage and restart our row.
1060 if (p->engine.ps.psrow >= p->engine.ps.lineheight +
1061 p->engine.ps.bottom) {
1062 p->engine.ps.psrow -= p->engine.ps.lineheight;
1071 ps_setfont(struct termp *p, enum termfont f)
1074 assert(f < TERMFONT__MAX);
1075 p->engine.ps.lastf = f;
1078 * If we're still at the top of the page, let the font-setting
1079 * be delayed until we actually have stuff to print.
1082 if (PS_NEWPAGE & p->engine.ps.flags)
1085 if (TERMTYPE_PS == p->type)
1086 ps_printf(p, "/%s %zu selectfont\n",
1088 p->engine.ps.scale);
1090 ps_printf(p, "/F%d %zu Tf\n",
1092 p->engine.ps.scale);
1098 ps_width(const struct termp *p, char c)
1101 if (c <= 32 || c - 32 >= MAXCHAR)
1102 return((size_t)fonts[(int)TERMFONT_NONE].gly[0].wx);
1105 return((size_t)fonts[(int)TERMFONT_NONE].gly[(int)c].wx);
1110 ps_hspan(const struct termp *p, const struct roffsu *su)
1115 * All of these measurements are derived by converting from the
1116 * native measurement to AFM units.
1121 r = PNT2AFM(p, su->scale * 28.34);
1124 r = PNT2AFM(p, su->scale * 72);
1127 r = PNT2AFM(p, su->scale * 12);
1130 r = PNT2AFM(p, su->scale * 100);
1134 fonts[(int)TERMFONT_NONE].gly[109 - 32].wx;
1137 r = PNT2AFM(p, su->scale * 2.834);
1141 fonts[(int)TERMFONT_NONE].gly[110 - 32].wx;
1144 r = su->scale * p->engine.ps.lineheight;