]>
git.cameronkatri.com Git - mandoc.git/blob - man_term.c
a4ebb1b447250d423731fef58fe91d8fcad80f87
1 /* $Id: man_term.c,v 1.121 2011/09/21 09:57:13 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 #include <sys/types.h>
36 #define INDENT 7 /* fixed-width char full-indent */
37 #define HALFINDENT 3 /* fixed-width char half-indent */
38 #define MAXMARGINS 64 /* maximum number of indented scopes */
40 /* FIXME: have PD set the default vspace width. */
44 #define MANT_LITERAL (1 << 0)
45 size_t lmargin
[MAXMARGINS
]; /* margins (incl. visible page) */
46 int lmargincur
; /* index of current margin */
47 int lmarginsz
; /* actual number of nested margins */
48 size_t offset
; /* default offset to visible page */
51 #define DECL_ARGS struct termp *p, \
53 const struct man_node *n, \
54 const struct man_meta *m
57 int (*pre
)(DECL_ARGS
);
58 void (*post
)(DECL_ARGS
);
60 #define MAN_NOTEXT (1 << 0) /* Never has text children. */
63 static int a2width(const struct termp
*, const char *);
64 static size_t a2height(const struct termp
*, const char *);
66 static void print_man_nodelist(DECL_ARGS
);
67 static void print_man_node(DECL_ARGS
);
68 static void print_man_head(struct termp
*, const void *);
69 static void print_man_foot(struct termp
*, const void *);
70 static void print_bvspace(struct termp
*,
71 const struct man_node
*);
73 static int pre_alternate(DECL_ARGS
);
74 static int pre_B(DECL_ARGS
);
75 static int pre_HP(DECL_ARGS
);
76 static int pre_I(DECL_ARGS
);
77 static int pre_IP(DECL_ARGS
);
78 static int pre_PP(DECL_ARGS
);
79 static int pre_RS(DECL_ARGS
);
80 static int pre_SH(DECL_ARGS
);
81 static int pre_SS(DECL_ARGS
);
82 static int pre_TP(DECL_ARGS
);
83 static int pre_ign(DECL_ARGS
);
84 static int pre_in(DECL_ARGS
);
85 static int pre_literal(DECL_ARGS
);
86 static int pre_sp(DECL_ARGS
);
87 static int pre_ft(DECL_ARGS
);
89 static void post_IP(DECL_ARGS
);
90 static void post_HP(DECL_ARGS
);
91 static void post_RS(DECL_ARGS
);
92 static void post_SH(DECL_ARGS
);
93 static void post_SS(DECL_ARGS
);
94 static void post_TP(DECL_ARGS
);
96 static const struct termact termacts
[MAN_MAX
] = {
97 { pre_sp
, NULL
, MAN_NOTEXT
}, /* br */
98 { NULL
, NULL
, 0 }, /* TH */
99 { pre_SH
, post_SH
, 0 }, /* SH */
100 { pre_SS
, post_SS
, 0 }, /* SS */
101 { pre_TP
, post_TP
, 0 }, /* TP */
102 { pre_PP
, NULL
, 0 }, /* LP */
103 { pre_PP
, NULL
, 0 }, /* PP */
104 { pre_PP
, NULL
, 0 }, /* P */
105 { pre_IP
, post_IP
, 0 }, /* IP */
106 { pre_HP
, post_HP
, 0 }, /* HP */
107 { NULL
, NULL
, 0 }, /* SM */
108 { pre_B
, NULL
, 0 }, /* SB */
109 { pre_alternate
, NULL
, 0 }, /* BI */
110 { pre_alternate
, NULL
, 0 }, /* IB */
111 { pre_alternate
, NULL
, 0 }, /* BR */
112 { pre_alternate
, NULL
, 0 }, /* RB */
113 { NULL
, NULL
, 0 }, /* R */
114 { pre_B
, NULL
, 0 }, /* B */
115 { pre_I
, NULL
, 0 }, /* I */
116 { pre_alternate
, NULL
, 0 }, /* IR */
117 { pre_alternate
, NULL
, 0 }, /* RI */
118 { pre_ign
, NULL
, MAN_NOTEXT
}, /* na */
119 { pre_sp
, NULL
, MAN_NOTEXT
}, /* sp */
120 { pre_literal
, NULL
, 0 }, /* nf */
121 { pre_literal
, NULL
, 0 }, /* fi */
122 { NULL
, NULL
, 0 }, /* RE */
123 { pre_RS
, post_RS
, 0 }, /* RS */
124 { pre_ign
, NULL
, 0 }, /* DT */
125 { pre_ign
, NULL
, 0 }, /* UC */
126 { pre_ign
, NULL
, 0 }, /* PD */
127 { pre_ign
, NULL
, 0 }, /* AT */
128 { pre_in
, NULL
, MAN_NOTEXT
}, /* in */
129 { pre_ft
, NULL
, MAN_NOTEXT
}, /* ft */
135 terminal_man(void *arg
, const struct man
*man
)
138 const struct man_node
*n
;
139 const struct man_meta
*m
;
142 p
= (struct termp
*)arg
;
145 p
->maxrmargin
= p
->defrmargin
;
146 p
->tabwidth
= term_len(p
, 5);
148 if (NULL
== p
->symtab
)
149 p
->symtab
= mchars_alloc();
154 term_begin(p
, print_man_head
, print_man_foot
, m
);
155 p
->flags
|= TERMP_NOSPACE
;
157 memset(&mt
, 0, sizeof(struct mtermp
));
159 mt
.lmargin
[mt
.lmargincur
] = term_len(p
, INDENT
);
160 mt
.offset
= term_len(p
, INDENT
);
163 print_man_nodelist(p
, &mt
, n
->child
, m
);
170 a2height(const struct termp
*p
, const char *cp
)
174 if ( ! a2roffsu(cp
, &su
, SCALE_VS
))
175 SCALE_VS_INIT(&su
, atoi(cp
));
177 return(term_vspan(p
, &su
));
182 a2width(const struct termp
*p
, const char *cp
)
186 if ( ! a2roffsu(cp
, &su
, SCALE_BU
))
189 return((int)term_hspan(p
, &su
));
193 * Printing leading vertical space before a block.
194 * This is used for the paragraph macros.
195 * The rules are pretty simple, since there's very little nesting going
196 * on here. Basically, if we're the first within another block (SS/SH),
197 * then don't emit vertical space. If we are (RS), then do. If not the
201 print_bvspace(struct termp
*p
, const struct man_node
*n
)
206 if (n
->body
&& n
->body
->child
)
207 if (MAN_TBL
== n
->body
->child
->type
)
210 if (MAN_ROOT
== n
->parent
->type
|| MAN_RS
!= n
->parent
->tok
)
231 term_fontrepl(p
, TERMFONT_UNDER
);
238 pre_literal(DECL_ARGS
)
243 if (MAN_nf
== n
->tok
)
244 mt
->fl
|= MANT_LITERAL
;
246 mt
->fl
&= ~MANT_LITERAL
;
249 * Unlike .IP and .TP, .HP does not have a HEAD.
250 * So in case a second call to term_flushln() is needed,
251 * indentation has to be set up explicitly.
253 if (MAN_HP
== n
->parent
->tok
&& p
->rmargin
< p
->maxrmargin
) {
254 p
->offset
= p
->rmargin
;
255 p
->rmargin
= p
->maxrmargin
;
256 p
->flags
&= ~(TERMP_NOBREAK
| TERMP_TWOSPACE
);
257 p
->flags
|= TERMP_NOSPACE
;
265 pre_alternate(DECL_ARGS
)
267 enum termfont font
[2];
268 const struct man_node
*nn
;
273 font
[0] = TERMFONT_NONE
;
274 font
[1] = TERMFONT_BOLD
;
277 font
[0] = TERMFONT_NONE
;
278 font
[1] = TERMFONT_UNDER
;
281 font
[0] = TERMFONT_BOLD
;
282 font
[1] = TERMFONT_NONE
;
285 font
[0] = TERMFONT_BOLD
;
286 font
[1] = TERMFONT_UNDER
;
289 font
[0] = TERMFONT_UNDER
;
290 font
[1] = TERMFONT_NONE
;
293 font
[0] = TERMFONT_UNDER
;
294 font
[1] = TERMFONT_BOLD
;
300 savelit
= MANT_LITERAL
& mt
->fl
;
301 mt
->fl
&= ~MANT_LITERAL
;
303 for (i
= 0, nn
= n
->child
; nn
; nn
= nn
->next
, i
= 1 - i
) {
304 term_fontrepl(p
, font
[i
]);
305 if (savelit
&& NULL
== nn
->next
)
306 mt
->fl
|= MANT_LITERAL
;
307 print_man_node(p
, mt
, nn
, m
);
309 p
->flags
|= TERMP_NOSPACE
;
320 term_fontrepl(p
, TERMFONT_BOLD
);
330 if (NULL
== n
->child
) {
335 cp
= n
->child
->string
;
342 term_fontrepl(p
, TERMFONT_BOLD
);
347 term_fontrepl(p
, TERMFONT_UNDER
);
357 term_fontrepl(p
, TERMFONT_NONE
);
375 if (NULL
== n
->child
) {
376 p
->offset
= mt
->offset
;
380 cp
= n
->child
->string
;
390 if ((len
= a2width(p
, ++cp
)) < 0)
396 p
->offset
-= p
->offset
> v
? v
: p
->offset
;
402 /* Don't let this creep beyond the right margin. */
404 if (p
->offset
> p
->rmargin
)
405 p
->offset
= p
->rmargin
;
417 if ((NULL
== n
->prev
&& n
->parent
)) {
418 if (MAN_SS
== n
->parent
->tok
)
420 if (MAN_SH
== n
->parent
->tok
)
429 len
= n
->child
? a2height(p
, n
->child
->string
) : 1;
435 for (i
= 0; i
< len
; i
++)
448 const struct man_node
*nn
;
455 p
->flags
|= TERMP_NOBREAK
;
456 p
->flags
|= TERMP_TWOSPACE
;
462 len
= mt
->lmargin
[mt
->lmargincur
];
465 /* Calculate offset. */
467 if (NULL
!= (nn
= n
->parent
->head
->child
))
468 if ((ival
= a2width(p
, nn
->string
)) >= 0)
471 one
= term_len(p
, 1);
475 p
->offset
= mt
->offset
;
476 p
->rmargin
= mt
->offset
+ len
;
479 mt
->lmargin
[mt
->lmargincur
] = (size_t)ival
;
496 p
->flags
&= ~TERMP_NOBREAK
;
497 p
->flags
&= ~TERMP_TWOSPACE
;
498 p
->offset
= mt
->offset
;
499 p
->rmargin
= p
->maxrmargin
;
514 mt
->lmargin
[mt
->lmargincur
] = term_len(p
, INDENT
);
518 p
->offset
= mt
->offset
;
522 return(MAN_HEAD
!= n
->type
);
530 const struct man_node
*nn
;
536 p
->flags
|= TERMP_NOSPACE
;
539 p
->flags
|= TERMP_NOBREAK
;
548 len
= mt
->lmargin
[mt
->lmargincur
];
551 /* Calculate the offset from the optional second argument. */
552 if (NULL
!= (nn
= n
->parent
->head
->child
))
553 if (NULL
!= (nn
= nn
->next
))
554 if ((ival
= a2width(p
, nn
->string
)) >= 0)
559 /* Handle zero-width lengths. */
561 len
= term_len(p
, 1);
563 p
->offset
= mt
->offset
;
564 p
->rmargin
= mt
->offset
+ len
;
568 /* Set the saved left-margin. */
569 mt
->lmargin
[mt
->lmargincur
] = (size_t)ival
;
571 savelit
= MANT_LITERAL
& mt
->fl
;
572 mt
->fl
&= ~MANT_LITERAL
;
575 print_man_node(p
, mt
, n
->child
, m
);
578 mt
->fl
|= MANT_LITERAL
;
582 p
->offset
= mt
->offset
+ len
;
583 p
->rmargin
= p
->maxrmargin
;
601 p
->flags
&= ~TERMP_NOBREAK
;
602 p
->rmargin
= p
->maxrmargin
;
617 const struct man_node
*nn
;
623 p
->flags
|= TERMP_NOBREAK
;
626 p
->flags
|= TERMP_NOSPACE
;
635 len
= (size_t)mt
->lmargin
[mt
->lmargincur
];
638 /* Calculate offset. */
640 if (NULL
!= (nn
= n
->parent
->head
->child
))
641 if (nn
->string
&& nn
->parent
->line
== nn
->line
)
642 if ((ival
= a2width(p
, nn
->string
)) >= 0)
647 /* Handle zero-length properly. */
649 len
= term_len(p
, 1);
651 p
->offset
= mt
->offset
;
652 p
->rmargin
= mt
->offset
+ len
;
654 savelit
= MANT_LITERAL
& mt
->fl
;
655 mt
->fl
&= ~MANT_LITERAL
;
657 /* Don't print same-line elements. */
658 for (nn
= n
->child
; nn
; nn
= nn
->next
)
659 if (nn
->line
> n
->line
)
660 print_man_node(p
, mt
, nn
, m
);
663 mt
->fl
|= MANT_LITERAL
;
665 mt
->lmargin
[mt
->lmargincur
] = (size_t)ival
;
669 p
->offset
= mt
->offset
+ len
;
670 p
->rmargin
= p
->maxrmargin
;
688 p
->flags
&= ~TERMP_NOBREAK
;
689 p
->flags
&= ~TERMP_TWOSPACE
;
690 p
->rmargin
= p
->maxrmargin
;
708 mt
->fl
&= ~MANT_LITERAL
;
709 mt
->lmargin
[mt
->lmargincur
] = term_len(p
, INDENT
);
710 mt
->offset
= term_len(p
, INDENT
);
711 /* If following a prior empty `SS', no vspace. */
712 if (n
->prev
&& MAN_SS
== n
->prev
->tok
)
713 if (NULL
== n
->prev
->body
->child
)
720 term_fontrepl(p
, TERMFONT_BOLD
);
721 p
->offset
= term_len(p
, HALFINDENT
);
724 p
->offset
= mt
->offset
;
759 mt
->fl
&= ~MANT_LITERAL
;
760 mt
->lmargin
[mt
->lmargincur
] = term_len(p
, INDENT
);
761 mt
->offset
= term_len(p
, INDENT
);
762 /* If following a prior empty `SH', no vspace. */
763 if (n
->prev
&& MAN_SH
== n
->prev
->tok
)
764 if (NULL
== n
->prev
->body
->child
)
766 /* If the first macro, no vspae. */
772 term_fontrepl(p
, TERMFONT_BOLD
);
776 p
->offset
= mt
->offset
;
820 sz
= term_len(p
, INDENT
);
822 if (NULL
!= (n
= n
->parent
->head
->child
))
823 if ((ival
= a2width(p
, n
->string
)) >= 0)
827 p
->rmargin
= p
->maxrmargin
;
828 p
->offset
= mt
->offset
< p
->rmargin
? mt
->offset
: p
->rmargin
;
830 if (++mt
->lmarginsz
< MAXMARGINS
)
831 mt
->lmargincur
= mt
->lmarginsz
;
833 mt
->lmargin
[mt
->lmargincur
] = mt
->lmargin
[mt
->lmargincur
- 1];
854 sz
= term_len(p
, INDENT
);
856 if (NULL
!= (n
= n
->parent
->head
->child
))
857 if ((ival
= a2width(p
, n
->string
)) >= 0)
860 mt
->offset
= mt
->offset
< sz
? 0 : mt
->offset
- sz
;
861 p
->offset
= mt
->offset
;
863 if (--mt
->lmarginsz
< MAXMARGINS
)
864 mt
->lmargincur
= mt
->lmarginsz
;
868 print_man_node(DECL_ARGS
)
876 * If we have a blank line, output a vertical space.
877 * If we have a space as the first character, break
878 * before printing the line's data.
880 if ('\0' == *n
->string
) {
883 } else if (' ' == *n
->string
&& MAN_LINE
& n
->flags
)
886 term_word(p
, n
->string
);
889 * If we're in a literal context, make sure that words
890 * togehter on the same line stay together. This is a
891 * POST-printing call, so we check the NEXT word. Since
892 * -man doesn't have nested macros, we don't need to be
893 * more specific than this.
895 if (MANT_LITERAL
& mt
->fl
&& ! (TERMP_NOBREAK
& p
->flags
) &&
897 n
->next
->line
> n
->line
)) {
899 rmax
= p
->maxrmargin
;
900 p
->rmargin
= p
->maxrmargin
= TERM_MAXMARGIN
;
901 p
->flags
|= TERMP_NOSPACE
;
904 p
->maxrmargin
= rmax
;
907 if (MAN_EOS
& n
->flags
)
908 p
->flags
|= TERMP_SENTENCE
;
915 * Tables are preceded by a newline. Then process a
916 * table line, which will cause line termination,
918 if (TBL_SPAN_FIRST
& n
->span
->flags
)
920 term_tbl(p
, n
->span
);
926 if ( ! (MAN_NOTEXT
& termacts
[n
->tok
].flags
))
927 term_fontrepl(p
, TERMFONT_NONE
);
930 if (termacts
[n
->tok
].pre
)
931 c
= (*termacts
[n
->tok
].pre
)(p
, mt
, n
, m
);
934 print_man_nodelist(p
, mt
, n
->child
, m
);
936 if (termacts
[n
->tok
].post
)
937 (*termacts
[n
->tok
].post
)(p
, mt
, n
, m
);
938 if ( ! (MAN_NOTEXT
& termacts
[n
->tok
].flags
))
939 term_fontrepl(p
, TERMFONT_NONE
);
941 if (MAN_EOS
& n
->flags
)
942 p
->flags
|= TERMP_SENTENCE
;
947 print_man_nodelist(DECL_ARGS
)
950 print_man_node(p
, mt
, n
, m
);
953 print_man_nodelist(p
, mt
, n
->next
, m
);
958 print_man_foot(struct termp
*p
, const void *arg
)
960 const struct man_meta
*meta
;
962 meta
= (const struct man_meta
*)arg
;
964 term_fontrepl(p
, TERMFONT_NONE
);
970 p
->flags
|= TERMP_NOSPACE
| TERMP_NOBREAK
;
971 p
->rmargin
= p
->maxrmargin
- term_strlen(p
, meta
->date
);
974 /* term_strlen() can return zero. */
975 if (p
->rmargin
== p
->maxrmargin
)
979 term_word(p
, meta
->source
);
984 p
->flags
|= TERMP_NOSPACE
;
985 p
->offset
= p
->rmargin
;
986 p
->rmargin
= p
->maxrmargin
;
987 p
->flags
&= ~TERMP_NOBREAK
;
989 term_word(p
, meta
->date
);
995 print_man_head(struct termp
*p
, const void *arg
)
997 char buf
[BUFSIZ
], title
[BUFSIZ
];
998 size_t buflen
, titlen
;
999 const struct man_meta
*m
;
1001 m
= (const struct man_meta
*)arg
;
1004 * Note that old groff would spit out some spaces before the
1005 * header. We discontinue this strange behaviour, but at one
1006 * point we did so here.
1010 p
->rmargin
= p
->maxrmargin
;
1012 buf
[0] = title
[0] = '\0';
1015 strlcpy(buf
, m
->vol
, BUFSIZ
);
1016 buflen
= term_strlen(p
, buf
);
1018 snprintf(title
, BUFSIZ
, "%s(%s)", m
->title
, m
->msec
);
1019 titlen
= term_strlen(p
, title
);
1021 p
->flags
|= TERMP_NOBREAK
| TERMP_NOSPACE
;
1023 p
->rmargin
= 2 * (titlen
+1) + buflen
< p
->maxrmargin
?
1025 term_strlen(p
, buf
) + term_len(p
, 1)) / 2 :
1026 p
->maxrmargin
- buflen
;
1028 term_word(p
, title
);
1031 p
->flags
|= TERMP_NOSPACE
;
1032 p
->offset
= p
->rmargin
;
1033 p
->rmargin
= p
->offset
+ buflen
+ titlen
< p
->maxrmargin
?
1034 p
->maxrmargin
- titlen
: p
->maxrmargin
;
1039 p
->flags
&= ~TERMP_NOBREAK
;
1040 if (p
->rmargin
+ titlen
<= p
->maxrmargin
) {
1041 p
->flags
|= TERMP_NOSPACE
;
1042 p
->offset
= p
->rmargin
;
1043 p
->rmargin
= p
->maxrmargin
;
1044 term_word(p
, title
);
1048 p
->flags
&= ~TERMP_NOSPACE
;
1050 p
->rmargin
= p
->maxrmargin
;
1053 * Groff likes to have some leading spaces before content. Well
1054 * that's fine by me.