]>
git.cameronkatri.com Git - mandoc.git/blob - man_term.c
1 /* $Id: man_term.c,v 1.93 2011/01/03 15:30:25 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 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>
39 /* FIXME: have PD set the default vspace width. */
43 #define MANT_LITERAL (1 << 0)
45 * Default amount to indent the left margin after leading text
46 * has been printed (e.g., `HP' left-indent, `TP' and `IP' body
47 * indent). This needs to be saved because `HP' and so on, if
48 * not having a specified value, must default.
50 * Note that this is the indentation AFTER the left offset, so
51 * the total offset is usually offset + lmargin.
55 * The default offset, i.e., the amount between any text and the
61 #define DECL_ARGS struct termp *p, \
63 const struct man_node *n, \
64 const struct man_meta *m
67 int (*pre
)(DECL_ARGS
);
68 void (*post
)(DECL_ARGS
);
70 #define MAN_NOTEXT (1 << 0) /* Never has text children. */
73 static int a2width(const struct termp
*, const char *);
74 static size_t a2height(const struct termp
*, const char *);
76 static void print_man_nodelist(DECL_ARGS
);
77 static void print_man_node(DECL_ARGS
);
78 static void print_man_head(struct termp
*, const void *);
79 static void print_man_foot(struct termp
*, const void *);
80 static void print_bvspace(struct termp
*,
81 const struct man_node
*);
83 static int pre_alternate(DECL_ARGS
);
84 static int pre_B(DECL_ARGS
);
85 static int pre_HP(DECL_ARGS
);
86 static int pre_I(DECL_ARGS
);
87 static int pre_IP(DECL_ARGS
);
88 static int pre_PP(DECL_ARGS
);
89 static int pre_RS(DECL_ARGS
);
90 static int pre_SH(DECL_ARGS
);
91 static int pre_SS(DECL_ARGS
);
92 static int pre_TP(DECL_ARGS
);
93 static int pre_ign(DECL_ARGS
);
94 static int pre_in(DECL_ARGS
);
95 static int pre_literal(DECL_ARGS
);
96 static int pre_sp(DECL_ARGS
);
97 static int pre_ft(DECL_ARGS
);
99 static void post_IP(DECL_ARGS
);
100 static void post_HP(DECL_ARGS
);
101 static void post_RS(DECL_ARGS
);
102 static void post_SH(DECL_ARGS
);
103 static void post_SS(DECL_ARGS
);
104 static void post_TP(DECL_ARGS
);
106 static const struct termact termacts
[MAN_MAX
] = {
107 { pre_sp
, NULL
, MAN_NOTEXT
}, /* br */
108 { NULL
, NULL
, 0 }, /* TH */
109 { pre_SH
, post_SH
, 0 }, /* SH */
110 { pre_SS
, post_SS
, 0 }, /* SS */
111 { pre_TP
, post_TP
, 0 }, /* TP */
112 { pre_PP
, NULL
, 0 }, /* LP */
113 { pre_PP
, NULL
, 0 }, /* PP */
114 { pre_PP
, NULL
, 0 }, /* P */
115 { pre_IP
, post_IP
, 0 }, /* IP */
116 { pre_HP
, post_HP
, 0 }, /* HP */
117 { NULL
, NULL
, 0 }, /* SM */
118 { pre_B
, NULL
, 0 }, /* SB */
119 { pre_alternate
, NULL
, 0 }, /* BI */
120 { pre_alternate
, NULL
, 0 }, /* IB */
121 { pre_alternate
, NULL
, 0 }, /* BR */
122 { pre_alternate
, NULL
, 0 }, /* RB */
123 { NULL
, NULL
, 0 }, /* R */
124 { pre_B
, NULL
, 0 }, /* B */
125 { pre_I
, NULL
, 0 }, /* I */
126 { pre_alternate
, NULL
, 0 }, /* IR */
127 { pre_alternate
, NULL
, 0 }, /* RI */
128 { NULL
, NULL
, MAN_NOTEXT
}, /* na */
129 { pre_sp
, NULL
, MAN_NOTEXT
}, /* sp */
130 { pre_literal
, NULL
, 0 }, /* nf */
131 { pre_literal
, NULL
, 0 }, /* fi */
132 { NULL
, NULL
, 0 }, /* RE */
133 { pre_RS
, post_RS
, 0 }, /* RS */
134 { pre_ign
, NULL
, 0 }, /* DT */
135 { pre_ign
, NULL
, 0 }, /* UC */
136 { pre_ign
, NULL
, 0 }, /* PD */
137 { pre_ign
, NULL
, 0 }, /* AT */
138 { pre_in
, NULL
, MAN_NOTEXT
}, /* in */
139 { pre_ft
, NULL
, MAN_NOTEXT
}, /* ft */
145 terminal_man(void *arg
, const struct man
*man
)
148 const struct man_node
*n
;
149 const struct man_meta
*m
;
152 p
= (struct termp
*)arg
;
155 p
->maxrmargin
= p
->defrmargin
;
156 p
->tabwidth
= term_len(p
, 5);
158 if (NULL
== p
->symtab
)
160 case (TERMENC_ASCII
):
161 p
->symtab
= chars_init(CHARS_ASCII
);
171 term_begin(p
, print_man_head
, print_man_foot
, m
);
172 p
->flags
|= TERMP_NOSPACE
;
175 mt
.lmargin
= term_len(p
, INDENT
);
176 mt
.offset
= term_len(p
, INDENT
);
179 print_man_nodelist(p
, &mt
, n
->child
, m
);
186 a2height(const struct termp
*p
, const char *cp
)
190 if ( ! a2roffsu(cp
, &su
, SCALE_VS
))
191 SCALE_VS_INIT(&su
, term_strlen(p
, cp
));
193 return(term_vspan(p
, &su
));
198 a2width(const struct termp
*p
, const char *cp
)
202 if ( ! a2roffsu(cp
, &su
, SCALE_BU
))
205 return((int)term_hspan(p
, &su
));
210 print_bvspace(struct termp
*p
, const struct man_node
*n
)
217 if (MAN_SS
== n
->prev
->tok
)
219 if (MAN_SH
== n
->prev
->tok
)
240 term_fontrepl(p
, TERMFONT_UNDER
);
247 pre_literal(DECL_ARGS
)
252 if (MAN_nf
== n
->tok
)
253 mt
->fl
|= MANT_LITERAL
;
255 mt
->fl
&= ~MANT_LITERAL
;
262 pre_alternate(DECL_ARGS
)
264 enum termfont font
[2];
265 const struct man_node
*nn
;
270 font
[0] = TERMFONT_NONE
;
271 font
[1] = TERMFONT_BOLD
;
274 font
[0] = TERMFONT_NONE
;
275 font
[1] = TERMFONT_UNDER
;
278 font
[0] = TERMFONT_BOLD
;
279 font
[1] = TERMFONT_NONE
;
282 font
[0] = TERMFONT_BOLD
;
283 font
[1] = TERMFONT_UNDER
;
286 font
[0] = TERMFONT_UNDER
;
287 font
[1] = TERMFONT_NONE
;
290 font
[0] = TERMFONT_UNDER
;
291 font
[1] = TERMFONT_BOLD
;
297 savelit
= MANT_LITERAL
& mt
->fl
;
298 mt
->fl
&= ~MANT_LITERAL
;
300 for (i
= 0, nn
= n
->child
; nn
; nn
= nn
->next
, i
= 1 - i
) {
301 term_fontrepl(p
, font
[i
]);
302 if (savelit
&& NULL
== nn
->next
)
303 mt
->fl
|= MANT_LITERAL
;
304 print_man_node(p
, mt
, nn
, m
);
306 p
->flags
|= TERMP_NOSPACE
;
317 term_fontrepl(p
, TERMFONT_BOLD
);
327 if (NULL
== n
->child
) {
332 cp
= n
->child
->string
;
339 term_fontrepl(p
, TERMFONT_BOLD
);
344 term_fontrepl(p
, TERMFONT_UNDER
);
354 term_fontrepl(p
, TERMFONT_NONE
);
372 if (NULL
== n
->child
) {
373 p
->offset
= mt
->offset
;
377 cp
= n
->child
->string
;
387 if ((len
= a2width(p
, ++cp
)) < 0)
393 p
->offset
-= p
->offset
> v
? v
: p
->offset
;
414 len
= n
->child
? a2height(p
, n
->child
->string
) : 1;
420 for (i
= 0; i
< len
; i
++)
433 const struct man_node
*nn
;
440 p
->flags
|= TERMP_NOBREAK
;
441 p
->flags
|= TERMP_TWOSPACE
;
450 /* Calculate offset. */
452 if (NULL
!= (nn
= n
->parent
->head
->child
))
453 if ((ival
= a2width(p
, nn
->string
)) >= 0)
457 len
= term_len(p
, 1);
459 p
->offset
= mt
->offset
;
460 p
->rmargin
= mt
->offset
+ len
;
463 mt
->lmargin
= (size_t)ival
;
480 p
->flags
&= ~TERMP_NOBREAK
;
481 p
->flags
&= ~TERMP_TWOSPACE
;
482 p
->offset
= mt
->offset
;
483 p
->rmargin
= p
->maxrmargin
;
498 mt
->lmargin
= term_len(p
, INDENT
);
502 p
->offset
= mt
->offset
;
506 return(MAN_HEAD
!= n
->type
);
514 const struct man_node
*nn
;
520 p
->flags
|= TERMP_NOLPAD
;
521 p
->flags
|= TERMP_NOSPACE
;
524 p
->flags
|= TERMP_NOBREAK
;
536 /* Calculate offset. */
538 if (NULL
!= (nn
= n
->parent
->head
->child
))
539 if (NULL
!= (nn
= nn
->next
)) {
540 for ( ; nn
->next
; nn
= nn
->next
)
542 if ((ival
= a2width(p
, nn
->string
)) >= 0)
548 /* Handle zero-width lengths. */
550 len
= term_len(p
, 1);
552 p
->offset
= mt
->offset
;
553 p
->rmargin
= mt
->offset
+ len
;
557 /* Set the saved left-margin. */
558 mt
->lmargin
= (size_t)ival
;
560 /* Don't print the length value. */
561 for (nn
= n
->child
; nn
->next
; nn
= nn
->next
)
562 print_man_node(p
, mt
, nn
, m
);
565 p
->offset
= mt
->offset
+ len
;
566 p
->rmargin
= p
->maxrmargin
;
584 p
->flags
&= ~TERMP_NOBREAK
;
585 p
->rmargin
= p
->maxrmargin
;
589 p
->flags
&= ~TERMP_NOLPAD
;
601 const struct man_node
*nn
;
607 p
->flags
|= TERMP_NOBREAK
;
608 p
->flags
|= TERMP_TWOSPACE
;
611 p
->flags
|= TERMP_NOLPAD
;
612 p
->flags
|= TERMP_NOSPACE
;
621 len
= (size_t)mt
->lmargin
;
624 /* Calculate offset. */
626 if (NULL
!= (nn
= n
->parent
->head
->child
)) {
627 while (nn
&& MAN_TEXT
!= nn
->type
)
630 if ((ival
= a2width(p
, nn
->string
)) >= 0)
636 /* Handle zero-length properly. */
638 len
= term_len(p
, 1);
640 p
->offset
= mt
->offset
;
641 p
->rmargin
= mt
->offset
+ len
;
643 /* Don't print same-line elements. */
644 for (nn
= n
->child
; nn
; nn
= nn
->next
)
645 if (nn
->line
> n
->line
)
646 print_man_node(p
, mt
, nn
, m
);
649 mt
->lmargin
= (size_t)ival
;
653 p
->offset
= mt
->offset
+ len
;
654 p
->rmargin
= p
->maxrmargin
;
672 p
->flags
&= ~TERMP_NOBREAK
;
673 p
->flags
&= ~TERMP_TWOSPACE
;
674 p
->rmargin
= p
->maxrmargin
;
678 p
->flags
&= ~TERMP_NOLPAD
;
693 mt
->lmargin
= term_len(p
, INDENT
);
694 mt
->offset
= term_len(p
, INDENT
);
695 /* If following a prior empty `SS', no vspace. */
696 if (n
->prev
&& MAN_SS
== n
->prev
->tok
)
697 if (NULL
== n
->prev
->body
->child
)
704 term_fontrepl(p
, TERMFONT_BOLD
);
705 p
->offset
= term_len(p
, HALFINDENT
);
708 p
->offset
= mt
->offset
;
743 mt
->lmargin
= term_len(p
, INDENT
);
744 mt
->offset
= term_len(p
, INDENT
);
745 /* If following a prior empty `SH', no vspace. */
746 if (n
->prev
&& MAN_SH
== n
->prev
->tok
)
747 if (NULL
== n
->prev
->body
->child
)
749 /* If the first macro, no vspae. */
755 term_fontrepl(p
, TERMFONT_BOLD
);
759 p
->offset
= mt
->offset
;
791 const struct man_node
*nn
;
804 if (NULL
== (nn
= n
->parent
->head
->child
)) {
805 mt
->offset
= mt
->lmargin
+ term_len(p
, INDENT
);
806 p
->offset
= mt
->offset
;
810 if ((ival
= a2width(p
, nn
->string
)) < 0)
813 mt
->offset
= term_len(p
, INDENT
) + (size_t)ival
;
814 p
->offset
= mt
->offset
;
827 mt
->offset
= mt
->lmargin
= term_len(p
, INDENT
);
833 p
->offset
= term_len(p
, INDENT
);
840 print_man_node(DECL_ARGS
)
849 if (0 == *n
->string
) {
854 term_word(p
, n
->string
);
856 /* FIXME: this means that macro lines are munged! */
858 if (MANT_LITERAL
& mt
->fl
) {
860 rmax
= p
->maxrmargin
;
861 p
->rmargin
= p
->maxrmargin
= TERM_MAXMARGIN
;
862 p
->flags
|= TERMP_NOSPACE
;
865 p
->maxrmargin
= rmax
;
869 if (TBL_SPAN_FIRST
& n
->span
->flags
)
871 term_tbl(p
, n
->span
);
874 if ( ! (MAN_NOTEXT
& termacts
[n
->tok
].flags
))
875 term_fontrepl(p
, TERMFONT_NONE
);
876 if (termacts
[n
->tok
].pre
)
877 c
= (*termacts
[n
->tok
].pre
)(p
, mt
, n
, m
);
882 print_man_nodelist(p
, mt
, n
->child
, m
);
890 if (termacts
[n
->tok
].post
)
891 (*termacts
[n
->tok
].post
)(p
, mt
, n
, m
);
892 if ( ! (MAN_NOTEXT
& termacts
[n
->tok
].flags
))
893 term_fontrepl(p
, TERMFONT_NONE
);
897 if (MAN_EOS
& n
->flags
)
898 p
->flags
|= TERMP_SENTENCE
;
903 print_man_nodelist(DECL_ARGS
)
906 print_man_node(p
, mt
, n
, m
);
909 print_man_nodelist(p
, mt
, n
->next
, m
);
914 print_man_foot(struct termp
*p
, const void *arg
)
917 const struct man_meta
*meta
;
919 meta
= (const struct man_meta
*)arg
;
921 term_fontrepl(p
, TERMFONT_NONE
);
924 strlcpy(buf
, meta
->rawdate
, DATESIZ
);
926 time2a(meta
->date
, buf
, DATESIZ
);
932 p
->flags
|= TERMP_NOSPACE
| TERMP_NOBREAK
;
933 p
->rmargin
= p
->maxrmargin
- term_strlen(p
, buf
);
936 /* term_strlen() can return zero. */
937 if (p
->rmargin
== p
->maxrmargin
)
941 term_word(p
, meta
->source
);
946 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
947 p
->offset
= p
->rmargin
;
948 p
->rmargin
= p
->maxrmargin
;
949 p
->flags
&= ~TERMP_NOBREAK
;
957 print_man_head(struct termp
*p
, const void *arg
)
959 char buf
[BUFSIZ
], title
[BUFSIZ
];
960 size_t buflen
, titlen
;
961 const struct man_meta
*m
;
963 m
= (const struct man_meta
*)arg
;
966 * Note that old groff would spit out some spaces before the
967 * header. We discontinue this strange behaviour, but at one
968 * point we did so here.
971 p
->rmargin
= p
->maxrmargin
;
974 buf
[0] = title
[0] = '\0';
977 strlcpy(buf
, m
->vol
, BUFSIZ
);
978 buflen
= term_strlen(p
, buf
);
980 snprintf(title
, BUFSIZ
, "%s(%s)", m
->title
, m
->msec
);
981 titlen
= term_strlen(p
, title
);
984 p
->rmargin
= 2 * (titlen
+1) + buflen
< p
->maxrmargin
?
986 term_strlen(p
, buf
) + term_len(p
, 1)) / 2 :
987 p
->maxrmargin
- buflen
;
988 p
->flags
|= TERMP_NOBREAK
| TERMP_NOSPACE
;
993 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
994 p
->offset
= p
->rmargin
;
995 p
->rmargin
= p
->offset
+ buflen
+ titlen
< p
->maxrmargin
?
996 p
->maxrmargin
- titlen
: p
->maxrmargin
;
1001 p
->flags
&= ~TERMP_NOBREAK
;
1002 if (p
->rmargin
+ titlen
<= p
->maxrmargin
) {
1003 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
1004 p
->offset
= p
->rmargin
;
1005 p
->rmargin
= p
->maxrmargin
;
1006 term_word(p
, title
);
1010 p
->rmargin
= p
->maxrmargin
;
1012 p
->flags
&= ~TERMP_NOSPACE
;
1015 * Groff likes to have some leading spaces before content. Well
1016 * that's fine by me.