1 /* $Id: term.c,v 1.183 2011/04/04 21:14:12 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010 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 static void spec(struct termp *, enum roffdeco,
37 const char *, size_t);
38 static void res(struct termp *, const char *, size_t);
39 static void bufferc(struct termp *, char);
40 static void adjbuf(struct termp *p, size_t);
41 static void encode(struct termp *, const char *, size_t);
45 term_free(struct termp *p)
51 chars_free(p->symtab);
58 term_begin(struct termp *p, term_margin head,
59 term_margin foot, const void *arg)
70 term_end(struct termp *p)
78 term_alloc(enum termenc enc)
82 p = mandoc_calloc(1, sizeof(struct termp));
89 * Flush a line of text. A "line" is loosely defined as being something
90 * that should be followed by a newline, regardless of whether it's
91 * broken apart by newlines getting there. A line can also be a
92 * fragment of a columnar list (`Bl -tag' or `Bl -column'), which does
93 * not have a trailing newline.
95 * The following flags may be specified:
97 * - TERMP_NOLPAD: when beginning to write the line, don't left-pad the
98 * offset value. This is useful when doing columnar lists where the
99 * prior column has right-padded.
101 * - TERMP_NOBREAK: this is the most important and is used when making
102 * columns. In short: don't print a newline and instead pad to the
103 * right margin. Used in conjunction with TERMP_NOLPAD.
105 * - TERMP_TWOSPACE: when padding, make sure there are at least two
106 * space characters of padding. Otherwise, rather break the line.
108 * - TERMP_DANGLE: don't newline when TERMP_NOBREAK is specified and
109 * the line is overrun, and don't pad-right if it's underrun.
111 * - TERMP_HANG: like TERMP_DANGLE, but doesn't newline when
112 * overruning, instead save the position and continue at that point
113 * when the next invocation.
115 * In-line line breaking:
117 * If TERMP_NOBREAK is specified and the line overruns the right
118 * margin, it will break and pad-right to the right margin after
119 * writing. If maxrmargin is violated, it will break and continue
120 * writing from the right-margin, which will lead to the above scenario
121 * upon exit. Otherwise, the line will break at the right margin.
124 term_flushln(struct termp *p)
126 int i; /* current input position in p->buf */
127 size_t vis; /* current visual position on output */
128 size_t vbl; /* number of blanks to prepend to output */
129 size_t vend; /* end of word visual position on output */
130 size_t bp; /* visual right border position */
131 size_t dv; /* temporary for visual pos calculations */
132 int j; /* temporary loop index for p->buf */
133 int jhy; /* last hyph before overflow w/r/t j */
134 size_t maxvis; /* output position of visible boundary */
135 size_t mmax; /* used in calculating bp */
138 * First, establish the maximum columns of "visible" content.
139 * This is usually the difference between the right-margin and
140 * an indentation, but can be, for tagged lists or columns, a
141 * small set of values.
143 assert (p->rmargin >= p->offset);
144 dv = p->rmargin - p->offset;
145 maxvis = (int)dv > p->overstep ? dv - (size_t)p->overstep : 0;
146 dv = p->maxrmargin - p->offset;
147 mmax = (int)dv > p->overstep ? dv - (size_t)p->overstep : 0;
149 bp = TERMP_NOBREAK & p->flags ? mmax : maxvis;
152 * Indent the first line of a paragraph.
154 vbl = p->flags & TERMP_NOLPAD ? (size_t)0 : p->offset;
159 while (i < (int)p->col) {
161 * Handle literal tab characters: collapse all
162 * subsequent tabs into a single huge set of spaces.
164 while (i < (int)p->col && '\t' == p->buf[i]) {
165 vend = (vis / p->tabwidth + 1) * p->tabwidth;
172 * Count up visible word characters. Control sequences
173 * (starting with the CSI) aren't counted. A space
174 * generates a non-printing word, which is valid (the
175 * space is printed according to regular spacing rules).
178 for (j = i, jhy = 0; j < (int)p->col; j++) {
179 if ((j && ' ' == p->buf[j]) || '\t' == p->buf[j])
182 /* Back over the the last printed character. */
183 if (8 == p->buf[j]) {
185 vend -= (*p->width)(p, p->buf[j - 1]);
190 /* Break at the hyphen point if we overrun. */
191 if (vend > vis && vend < bp &&
192 ASCII_HYPH == p->buf[j])
195 vend += (*p->width)(p, p->buf[j]);
199 * Find out whether we would exceed the right margin.
200 * If so, break to the next line.
202 if (vend > bp && 0 == jhy && vis > 0) {
205 if (TERMP_NOBREAK & p->flags) {
206 p->viscol = p->rmargin;
207 (*p->advance)(p, p->rmargin);
208 vend += p->rmargin - p->offset;
214 /* Remove the p->overstep width. */
216 bp += (size_t)p->overstep;
220 /* Write out the [remaining] word. */
221 for ( ; i < (int)p->col; i++) {
222 if (vend > bp && jhy > 0 && i > jhy)
224 if ('\t' == p->buf[i])
226 if (' ' == p->buf[i]) {
228 while (' ' == p->buf[i])
230 dv = (size_t)(i - j) * (*p->width)(p, ' ');
235 if (ASCII_NBRSP == p->buf[i]) {
236 vbl += (*p->width)(p, ' ');
241 * Now we definitely know there will be
242 * printable characters to output,
243 * so write preceding white space now.
246 (*p->advance)(p, vbl);
251 if (ASCII_HYPH == p->buf[i]) {
252 (*p->letter)(p, '-');
253 p->viscol += (*p->width)(p, '-');
255 (*p->letter)(p, p->buf[i]);
256 p->viscol += (*p->width)(p, p->buf[i]);
263 * If there was trailing white space, it was not printed;
264 * so reset the cursor position accordingly.
271 if ( ! (TERMP_NOBREAK & p->flags)) {
277 if (TERMP_HANG & p->flags) {
278 /* We need one blank after the tag. */
279 p->overstep = (int)(vis - maxvis + (*p->width)(p, ' '));
282 * Behave exactly the same way as groff:
283 * If we have overstepped the margin, temporarily move
284 * it to the right and flag the rest of the line to be
286 * If we landed right at the margin, be happy.
287 * If we are one step before the margin, temporarily
288 * move it one step LEFT and flag the rest of the line
291 if (p->overstep >= -1) {
292 assert((int)maxvis + p->overstep >= 0);
293 maxvis += (size_t)p->overstep;
297 } else if (TERMP_DANGLE & p->flags)
302 ((TERMP_TWOSPACE & p->flags) ? (*p->width)(p, ' ') : 0)) {
303 p->viscol += maxvis - vis;
304 (*p->advance)(p, maxvis - vis);
305 vis += (maxvis - vis);
306 } else { /* ...or newline break. */
308 p->viscol = p->rmargin;
309 (*p->advance)(p, p->rmargin);
315 * A newline only breaks an existing line; it won't assert vertical
316 * space. All data in the output buffer is flushed prior to the newline
320 term_newln(struct termp *p)
323 p->flags |= TERMP_NOSPACE;
324 if (0 == p->col && 0 == p->viscol) {
325 p->flags &= ~TERMP_NOLPAD;
329 p->flags &= ~TERMP_NOLPAD;
334 * Asserts a vertical space (a full, empty line-break between lines).
335 * Note that if used twice, this will cause two blank spaces and so on.
336 * All data in the output buffer is flushed prior to the newline
340 term_vspace(struct termp *p)
350 numbered(struct termp *p, const char *word, size_t len)
354 rhs = chars_num2char(word, len);
361 spec(struct termp *p, enum roffdeco d, const char *word, size_t len)
366 rhs = chars_spec2str(p->symtab, word, len, &sz);
369 else if (DECO_SSPECIAL == d)
370 encode(p, word, len);
375 res(struct termp *p, const char *word, size_t len)
380 rhs = chars_res2str(p->symtab, word, len, &sz);
387 term_fontlast(struct termp *p)
392 p->fontl = p->fontq[p->fonti];
393 p->fontq[p->fonti] = f;
398 term_fontrepl(struct termp *p, enum termfont f)
401 p->fontl = p->fontq[p->fonti];
402 p->fontq[p->fonti] = f;
407 term_fontpush(struct termp *p, enum termfont f)
410 assert(p->fonti + 1 < 10);
411 p->fontl = p->fontq[p->fonti];
412 p->fontq[++p->fonti] = f;
417 term_fontq(struct termp *p)
420 return(&p->fontq[p->fonti]);
425 term_fonttop(struct termp *p)
428 return(p->fontq[p->fonti]);
433 term_fontpopq(struct termp *p, const void *key)
436 while (p->fonti >= 0 && key != &p->fontq[p->fonti])
438 assert(p->fonti >= 0);
443 term_fontpop(struct termp *p)
452 * Handle pwords, partial words, which may be either a single word or a
453 * phrase that cannot be broken down (such as a literal string). This
454 * handles word styling.
457 term_word(struct termp *p, const char *word)
463 if ( ! (TERMP_NOSPACE & p->flags)) {
464 if ( ! (TERMP_KEEP & p->flags)) {
465 if (TERMP_PREKEEP & p->flags)
466 p->flags |= TERMP_KEEP;
468 if (TERMP_SENTENCE & p->flags)
471 bufferc(p, ASCII_NBRSP);
474 if ( ! (p->flags & TERMP_NONOSPACE))
475 p->flags &= ~TERMP_NOSPACE;
477 p->flags |= TERMP_NOSPACE;
479 p->flags &= ~(TERMP_SENTENCE | TERMP_IGNDELIM);
482 if ((ssz = strcspn(word, "\\")) > 0)
483 encode(p, word, ssz);
490 word += a2roffdeco(&deco, &seq, &ssz);
493 case (DECO_NUMBERED):
494 numbered(p, seq, ssz);
496 case (DECO_RESERVED):
501 case (DECO_SSPECIAL):
502 spec(p, deco, seq, ssz);
505 term_fontrepl(p, TERMFONT_BOLD);
508 term_fontrepl(p, TERMFONT_UNDER);
511 term_fontrepl(p, TERMFONT_NONE);
513 case (DECO_PREVIOUS):
520 if (DECO_NOSPACE == deco && '\0' == *word)
521 p->flags |= TERMP_NOSPACE;
527 adjbuf(struct termp *p, size_t sz)
532 while (sz >= p->maxcols)
535 p->buf = mandoc_realloc(p->buf, p->maxcols);
540 bufferc(struct termp *p, char c)
543 if (p->col + 1 >= p->maxcols)
544 adjbuf(p, p->col + 1);
546 p->buf[(int)p->col++] = c;
551 encode(struct termp *p, const char *word, size_t sz)
557 * Encode and buffer a string of characters. If the current
558 * font mode is unset, buffer directly, else encode then buffer
559 * character by character.
562 if (TERMFONT_NONE == (f = term_fonttop(p))) {
563 if (p->col + sz >= p->maxcols)
564 adjbuf(p, p->col + sz);
565 memcpy(&p->buf[(int)p->col], word, sz);
570 /* Pre-buffer, assuming worst-case. */
572 if (p->col + 1 + (sz * 3) >= p->maxcols)
573 adjbuf(p, p->col + 1 + (sz * 3));
575 for (i = 0; i < (int)sz; i++) {
576 if ( ! isgraph((u_char)word[i])) {
577 p->buf[(int)p->col++] = word[i];
581 if (TERMFONT_UNDER == f)
582 p->buf[(int)p->col++] = '_';
584 p->buf[(int)p->col++] = word[i];
586 p->buf[(int)p->col++] = 8;
587 p->buf[(int)p->col++] = word[i];
593 term_len(const struct termp *p, size_t sz)
596 return((*p->width)(p, ' ') * sz);
601 term_strlen(const struct termp *p, const char *cp)
603 size_t sz, ssz, rsz, i;
605 const char *seq, *rhs;
607 for (sz = 0; '\0' != *cp; )
609 * Account for escaped sequences within string length
610 * calculations. This follows the logic in term_word()
611 * as we must calculate the width of produced strings.
615 cp += a2roffdeco(&d, &seq, &ssz);
618 case (DECO_RESERVED):
620 (p->symtab, seq, ssz, &rsz);
624 case (DECO_SSPECIAL):
626 (p->symtab, seq, ssz, &rsz);
628 /* Allow for one-char escapes. */
629 if (DECO_SSPECIAL != d || rhs)
641 for (i = 0; i < rsz; i++)
642 sz += (*p->width)(p, *rhs++);
643 } else if (ASCII_NBRSP == *cp) {
644 sz += (*p->width)(p, ' ');
646 } else if (ASCII_HYPH == *cp) {
647 sz += (*p->width)(p, '-');
650 sz += (*p->width)(p, *cp++);
658 term_vspan(const struct termp *p, const struct roffsu *su)
676 r = su->scale / 1000;
688 return(/* LINTED */(size_t)
694 term_hspan(const struct termp *p, const struct roffsu *su)
698 v = ((*p->hspan)(p, su));
701 return((size_t) /* LINTED */