]>
git.cameronkatri.com Git - mandoc.git/blob - term_ps.c
1 /* $Id: term_ps.c,v 1.28 2010/07/04 19:24:00 kristaps Exp $ */
3 * Copyright (c) 2008, 2009 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/param.h>
36 #define MINMARGIN_MM 20 /* Minimum 2cm margins. */
37 #define MINMARGIN_PNT 56.68
38 #define DEFPAGEX_MM 216 /* Default page size is US-letter. */
39 #define DEFPAGEY_MM 279
41 /* Convert PostScript point "x" to an AFM unit. */
42 #define PNT2AFM(p, x) /* LINTED */ \
43 (size_t)((double)(x) * (1000.0 / (double)(p)->engine.ps.scale))
45 /* Convert an AFM unit "x" to a PostScript points */
46 #define AFM2PNT(p, x) /* LINTED */ \
47 (size_t)((double)(x) / (1000.0 / (double)(p)->engine.ps.scale))
50 size_t wx
; /* WX in AFM */
54 const char *name
; /* FontName in AFM */
55 #define MAXCHAR 95 /* total characters we can handle */
56 struct glyph gly
[MAXCHAR
]; /* glyph metrics */
60 * We define, for the time being, three fonts: bold, oblique/italic, and
61 * normal (roman). The following table hard-codes the font metrics for
62 * ASCII, i.e., 32--127.
65 static const struct font fonts
[TERMFONT__MAX
] = {
359 /* These work the buffer used by the header and footer. */
360 #define PS_BUFSLOP 128
361 #define PS_GROWBUF(p, sz) \
362 do if ((p)->engine.ps.psmargcur + (sz) > \
363 (p)->engine.ps.psmargsz) { \
364 (p)->engine.ps.psmargsz += /* CONSTCOND */ \
365 MAX(PS_BUFSLOP, (sz)); \
366 (p)->engine.ps.psmarg = realloc \
367 ((p)->engine.ps.psmarg, \
368 (p)->engine.ps.psmargsz); \
369 if (NULL == (p)->engine.ps.psmarg) { \
371 exit(EXIT_FAILURE); \
373 } while (/* CONSTCOND */ 0)
376 static double ps_hspan(const struct termp
*,
377 const struct roffsu
*);
378 static size_t ps_width(const struct termp
*, char);
379 static void ps_advance(struct termp
*, size_t);
380 static void ps_begin(struct termp
*);
381 static void ps_end(struct termp
*);
382 static void ps_endline(struct termp
*);
383 static void ps_fclose(struct termp
*);
384 static void ps_letter(struct termp
*, char);
385 static void ps_pclose(struct termp
*);
386 static void ps_pletter(struct termp
*, int);
387 static void ps_printf(struct termp
*, const char *, ...);
388 static void ps_putchar(struct termp
*, char);
389 static void ps_setfont(struct termp
*, enum termfont
);
393 ps_alloc(char *outopts
)
396 size_t pagex
, pagey
, marginx
, marginy
, lineheight
;
401 if (NULL
== (p
= term_alloc(TERMENC_ASCII
)))
404 p
->advance
= ps_advance
;
407 p
->endline
= ps_endline
;
409 p
->letter
= ps_letter
;
410 p
->type
= TERMTYPE_PS
;
418 while (outopts
&& *outopts
)
419 switch (getsubopt(&outopts
, UNCONST(toks
), &v
)) {
427 /* Default to US letter (millimetres). */
433 * The ISO-269 paper sizes can be calculated automatically, but
434 * it would require bringing in -lm for pow() and I'd rather not
435 * do that. So just do it the easy way for now. Since this
436 * only happens once, I'm not terribly concerned.
439 if (pp
&& strcasecmp(pp
, "letter")) {
440 if (0 == strcasecmp(pp
, "a3")) {
443 } else if (0 == strcasecmp(pp
, "a4")) {
446 } else if (0 == strcasecmp(pp
, "a5")) {
449 } else if (0 == strcasecmp(pp
, "legal")) {
452 } else if (2 != sscanf(pp
, "%zux%zu", &pagex
, &pagey
))
453 fprintf(stderr
, "%s: Unknown paper\n", pp
);
454 } else if (NULL
== pp
)
457 /* Enforce minimum page size >= (2 times) min-margin. */
459 if ((2 * MINMARGIN_MM
) >= pagex
) {
460 fprintf(stderr
, "%s: Insufficient page width\n", pp
);
462 } else if ((2 * MINMARGIN_MM
>= pagey
)) {
463 fprintf(stderr
, "%s: Insufficient page length\n", pp
);
468 * This MUST be defined before any PNT2AFM or AFM2PNT
469 * calculations occur.
472 p
->engine
.ps
.scale
= 11;
474 /* Remember millimetres -> AFM units. */
476 pagex
= PNT2AFM(p
, ((double)pagex
* 2.834));
477 pagey
= PNT2AFM(p
, ((double)pagey
* 2.834));
479 /* Margins are 1/9 the page x and y. */
481 marginx
= (size_t)((double)pagex
/ 9.0);
482 marginy
= (size_t)((double)pagey
/ 9.0);
484 lineheight
= PNT2AFM(p
, 16);
486 p
->engine
.ps
.width
= pagex
;
487 p
->engine
.ps
.height
= pagey
;
488 p
->engine
.ps
.header
= pagey
- (marginy
/ 2) - (lineheight
/ 2);
489 p
->engine
.ps
.top
= pagey
- marginy
;
490 p
->engine
.ps
.footer
= (marginy
/ 2) - (lineheight
/ 2);
491 p
->engine
.ps
.bottom
= marginy
;
492 p
->engine
.ps
.left
= marginx
;
493 p
->engine
.ps
.lineheight
= lineheight
;
495 p
->defrmargin
= pagex
- (marginx
* 2);
505 p
= (struct termp
*)arg
;
507 if (p
->engine
.ps
.psmarg
)
508 free(p
->engine
.ps
.psmarg
);
515 ps_printf(struct termp
*p
, const char *fmt
, ...)
523 * If we're running in regular mode, then pipe directly into
524 * vprintf(). If we're processing margins, then push the data
525 * into our growable margin buffer.
528 if ( ! (PS_MARGINS
& p
->engine
.ps
.psstate
)) {
535 * XXX: I assume that the in-margin print won't exceed
536 * PS_BUFSLOP (128 bytes), which is reasonable but still an
537 * assumption that will cause pukeage if it's not the case.
540 PS_GROWBUF(p
, PS_BUFSLOP
);
542 pos
= (int)p
->engine
.ps
.psmargcur
;
543 vsnprintf(&p
->engine
.ps
.psmarg
[pos
], PS_BUFSLOP
, fmt
, ap
);
544 p
->engine
.ps
.psmargcur
= strlen(p
->engine
.ps
.psmarg
);
551 ps_putchar(struct termp
*p
, char c
)
555 /* See ps_printf(). */
557 if ( ! (PS_MARGINS
& p
->engine
.ps
.psstate
)) {
564 pos
= (int)p
->engine
.ps
.psmargcur
++;
565 p
->engine
.ps
.psmarg
[pos
++] = c
;
566 p
->engine
.ps
.psmarg
[pos
] = '\0';
572 ps_end(struct termp
*p
)
576 * At the end of the file, do one last showpage. This is the
577 * same behaviour as groff(1) and works for multiple pages as
581 assert(0 == p
->engine
.ps
.psstate
);
582 assert('\0' == p
->engine
.ps
.last
);
583 assert(p
->engine
.ps
.psmarg
&& p
->engine
.ps
.psmarg
[0]);
584 printf("%s", p
->engine
.ps
.psmarg
);
585 p
->engine
.ps
.pages
++;
586 printf("showpage\n");
588 printf("%%%%Trailer\n");
589 printf("%%%%Pages: %zu\n", p
->engine
.ps
.pages
);
595 ps_begin(struct termp
*p
)
601 * Print margins into margin buffer. Nothing gets output to the
602 * screen yet, so we don't need to initialise the primary state.
605 if (p
->engine
.ps
.psmarg
) {
606 assert(p
->engine
.ps
.psmargsz
);
607 p
->engine
.ps
.psmarg
[0] = '\0';
610 p
->engine
.ps
.psmargcur
= 0;
611 p
->engine
.ps
.psstate
= PS_MARGINS
;
612 p
->engine
.ps
.pscol
= p
->engine
.ps
.left
;
613 p
->engine
.ps
.psrow
= p
->engine
.ps
.header
;
615 ps_setfont(p
, TERMFONT_NONE
);
617 (*p
->headf
)(p
, p
->argf
);
620 p
->engine
.ps
.pscol
= p
->engine
.ps
.left
;
621 p
->engine
.ps
.psrow
= p
->engine
.ps
.footer
;
623 (*p
->footf
)(p
, p
->argf
);
626 p
->engine
.ps
.psstate
&= ~PS_MARGINS
;
628 assert(0 == p
->engine
.ps
.psstate
);
629 assert(p
->engine
.ps
.psmarg
);
630 assert('\0' != p
->engine
.ps
.psmarg
[0]);
633 * Print header and initialise page state. Following this,
634 * stuff gets printed to the screen, so make sure we're sane.
639 printf("%%!PS-Adobe-3.0\n");
640 printf("%%%%Creator: mandoc-%s\n", VERSION
);
641 printf("%%%%CreationDate: %s", ctime(&t
));
642 printf("%%%%DocumentData: Clean7Bit\n");
643 printf("%%%%Orientation: Portrait\n");
644 printf("%%%%Pages: (atend)\n");
645 printf("%%%%PageOrder: Ascend\n");
646 printf("%%%%DocumentMedia: Default %zu %zu 0 () ()\n",
647 AFM2PNT(p
, p
->engine
.ps
.width
),
648 AFM2PNT(p
, p
->engine
.ps
.height
));
649 printf("%%%%DocumentNeededResources: font");
650 for (i
= 0; i
< (int)TERMFONT__MAX
; i
++)
651 printf(" %s", fonts
[i
].name
);
652 printf("\n%%%%EndComments\n");
654 printf("%%%%Page: %zu %zu\n",
655 p
->engine
.ps
.pages
+ 1,
656 p
->engine
.ps
.pages
+ 1);
658 ps_setfont(p
, TERMFONT_NONE
);
659 p
->engine
.ps
.pscol
= p
->engine
.ps
.left
;
660 p
->engine
.ps
.psrow
= p
->engine
.ps
.top
;
665 ps_pletter(struct termp
*p
, int c
)
670 * If we're not in a PostScript "word" context, then open one
671 * now at the current cursor.
674 if ( ! (PS_INLINE
& p
->engine
.ps
.psstate
)) {
675 ps_printf(p
, "%zu %zu moveto\n(",
676 AFM2PNT(p
, p
->engine
.ps
.pscol
),
677 AFM2PNT(p
, p
->engine
.ps
.psrow
));
678 p
->engine
.ps
.psstate
|= PS_INLINE
;
682 * We need to escape these characters as per the PostScript
683 * specification. We would also escape non-graphable characters
684 * (like tabs), but none of them would get to this point and
685 * it's superfluous to abort() on them.
700 /* Write the character and adjust where we are on the page. */
702 f
= (int)p
->engine
.ps
.lastf
;
704 if (c
<= 32 || (c
- 32 > MAXCHAR
)) {
706 p
->engine
.ps
.pscol
+= fonts
[f
].gly
[0].wx
;
710 ps_putchar(p
, (char)c
);
712 p
->engine
.ps
.pscol
+= fonts
[f
].gly
[c
].wx
;
717 ps_pclose(struct termp
*p
)
721 * Spit out that we're exiting a word context (this is a
722 * "partial close" because we don't check the last-char buffer
726 if ( ! (PS_INLINE
& p
->engine
.ps
.psstate
))
729 ps_printf(p
, ") show\n");
730 p
->engine
.ps
.psstate
&= ~PS_INLINE
;
735 ps_fclose(struct termp
*p
)
739 * Strong closure: if we have a last-char, spit it out after
740 * checking that we're in the right font mode. This will of
741 * course open a new scope, if applicable.
743 * Following this, close out any scope that's open.
746 if ('\0' != p
->engine
.ps
.last
) {
747 if (p
->engine
.ps
.lastf
!= TERMFONT_NONE
) {
749 ps_setfont(p
, TERMFONT_NONE
);
751 ps_pletter(p
, p
->engine
.ps
.last
);
752 p
->engine
.ps
.last
= '\0';
755 if ( ! (PS_INLINE
& p
->engine
.ps
.psstate
))
763 ps_letter(struct termp
*p
, char c
)
768 * State machine dictates whether to buffer the last character
769 * or not. Basically, encoded words are detected by checking if
770 * we're an "8" and switching on the buffer. Then we put "8" in
771 * our buffer, and on the next charater, flush both character
772 * and buffer. Thus, "regular" words are detected by having a
773 * regular character and a regular buffer character.
776 if ('\0' == p
->engine
.ps
.last
) {
778 p
->engine
.ps
.last
= c
;
780 } else if (8 == p
->engine
.ps
.last
) {
782 p
->engine
.ps
.last
= '\0';
784 assert(8 != p
->engine
.ps
.last
);
785 if ('_' == p
->engine
.ps
.last
) {
786 if (p
->engine
.ps
.lastf
!= TERMFONT_UNDER
) {
788 ps_setfont(p
, TERMFONT_UNDER
);
790 } else if (p
->engine
.ps
.lastf
!= TERMFONT_BOLD
) {
792 ps_setfont(p
, TERMFONT_BOLD
);
794 p
->engine
.ps
.last
= c
;
797 if (p
->engine
.ps
.lastf
!= TERMFONT_NONE
) {
799 ps_setfont(p
, TERMFONT_NONE
);
801 cc
= p
->engine
.ps
.last
;
802 p
->engine
.ps
.last
= c
;
811 ps_advance(struct termp
*p
, size_t len
)
815 * Advance some spaces. This can probably be made smarter,
816 * i.e., to have multiple space-separated words in the same
817 * scope, but this is easier: just close out the current scope
818 * and readjust our column settings.
822 p
->engine
.ps
.pscol
+= len
;
827 ps_endline(struct termp
*p
)
830 /* Close out any scopes we have open: we're at eoln. */
835 * If we're in the margin, don't try to recalculate our current
836 * row. XXX: if the column tries to be fancy with multiple
837 * lines, we'll do nasty stuff.
840 if (PS_MARGINS
& p
->engine
.ps
.psstate
)
844 * Put us down a line. If we're at the page bottom, spit out a
845 * showpage and restart our row.
848 p
->engine
.ps
.pscol
= p
->engine
.ps
.left
;
849 if (p
->engine
.ps
.psrow
>= p
->engine
.ps
.lineheight
+
850 p
->engine
.ps
.bottom
) {
851 p
->engine
.ps
.psrow
-= p
->engine
.ps
.lineheight
;
855 assert(p
->engine
.ps
.psmarg
&& p
->engine
.ps
.psmarg
[0]);
856 printf("%s", p
->engine
.ps
.psmarg
);
857 printf("showpage\n");
858 p
->engine
.ps
.pages
++;
859 printf("%%%%Page: %zu %zu\n",
860 p
->engine
.ps
.pages
+ 1,
861 p
->engine
.ps
.pages
+ 1);
862 p
->engine
.ps
.psrow
= p
->engine
.ps
.top
;
867 ps_setfont(struct termp
*p
, enum termfont f
)
870 assert(f
< TERMFONT__MAX
);
871 ps_printf(p
, "/%s %zu selectfont\n",
872 fonts
[(int)f
].name
, p
->engine
.ps
.scale
);
873 p
->engine
.ps
.lastf
= f
;
879 ps_width(const struct termp
*p
, char c
)
882 if (c
<= 32 || c
- 32 >= MAXCHAR
)
883 return(fonts
[(int)TERMFONT_NONE
].gly
[0].wx
);
886 return(fonts
[(int)TERMFONT_NONE
].gly
[(int)c
].wx
);
891 ps_hspan(const struct termp
*p
, const struct roffsu
*su
)
896 * All of these measurements are derived by converting from the
897 * native measurement to AFM units.
902 r
= PNT2AFM(p
, su
->scale
* 28.34);
905 r
= PNT2AFM(p
, su
->scale
* 72);
908 r
= PNT2AFM(p
, su
->scale
* 12);
911 r
= PNT2AFM(p
, su
->scale
* 100);
915 fonts
[(int)TERMFONT_NONE
].gly
[109 - 32].wx
;
918 r
= PNT2AFM(p
, su
->scale
* 2.834);
922 fonts
[(int)TERMFONT_NONE
].gly
[110 - 32].wx
;
925 r
= su
->scale
* p
->engine
.ps
.lineheight
;