Annotation of mandoc/term.c, Revision 1.124
1.124 ! kristaps 1: /* $Id: term.c,v 1.123 2009/11/06 10:31:32 kristaps Exp $ */
1.1 kristaps 2: /*
1.75 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.74 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.74 kristaps 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.
1.1 kristaps 16: */
17: #include <assert.h>
1.122 kristaps 18: #include <ctype.h>
1.22 kristaps 19: #include <stdio.h>
1.1 kristaps 20: #include <stdlib.h>
21: #include <string.h>
1.113 kristaps 22: #include <time.h>
1.1 kristaps 23:
1.101 kristaps 24: #include "chars.h"
1.107 kristaps 25: #include "out.h"
1.71 kristaps 26: #include "term.h"
27: #include "man.h"
28: #include "mdoc.h"
1.105 kristaps 29: #include "main.h"
1.1 kristaps 30:
1.103 kristaps 31: /* FIXME: accomodate non-breaking, non-collapsing white-space. */
32: /* FIXME: accomodate non-breaking, collapsing white-space. */
33:
1.71 kristaps 34: static struct termp *term_alloc(enum termenc);
35: static void term_free(struct termp *);
1.95 kristaps 36:
37: static void do_special(struct termp *,
1.71 kristaps 38: const char *, size_t);
1.95 kristaps 39: static void do_reserved(struct termp *,
1.94 kristaps 40: const char *, size_t);
1.95 kristaps 41: static void buffer(struct termp *, char);
42: static void encode(struct termp *, char);
1.1 kristaps 43:
44:
1.71 kristaps 45: void *
46: ascii_alloc(void)
1.10 kristaps 47: {
1.1 kristaps 48:
1.71 kristaps 49: return(term_alloc(TERMENC_ASCII));
1.1 kristaps 50: }
51:
52:
1.99 kristaps 53: void
1.71 kristaps 54: terminal_free(void *arg)
1.11 kristaps 55: {
56:
1.71 kristaps 57: term_free((struct termp *)arg);
1.11 kristaps 58: }
59:
60:
1.71 kristaps 61: static void
62: term_free(struct termp *p)
1.14 kristaps 63: {
64:
1.71 kristaps 65: if (p->buf)
66: free(p->buf);
1.102 kristaps 67: if (p->symtab)
1.101 kristaps 68: chars_free(p->symtab);
1.14 kristaps 69:
1.71 kristaps 70: free(p);
1.14 kristaps 71: }
72:
73:
1.71 kristaps 74: static struct termp *
75: term_alloc(enum termenc enc)
1.14 kristaps 76: {
1.71 kristaps 77: struct termp *p;
1.14 kristaps 78:
1.117 kristaps 79: p = calloc(1, sizeof(struct termp));
80: if (NULL == p) {
1.120 kristaps 81: perror(NULL);
1.117 kristaps 82: exit(EXIT_FAILURE);
83: }
1.80 kristaps 84: p->maxrmargin = 78;
1.71 kristaps 85: p->enc = enc;
86: return(p);
1.14 kristaps 87: }
88:
89:
1.71 kristaps 90: /*
91: * Flush a line of text. A "line" is loosely defined as being something
92: * that should be followed by a newline, regardless of whether it's
93: * broken apart by newlines getting there. A line can also be a
94: * fragment of a columnar list.
95: *
96: * Specifically, a line is whatever's in p->buf of length p->col, which
97: * is zeroed after this function returns.
98: *
1.84 kristaps 99: * The usage of termp:flags is as follows:
1.71 kristaps 100: *
101: * - TERMP_NOLPAD: when beginning to write the line, don't left-pad the
102: * offset value. This is useful when doing columnar lists where the
103: * prior column has right-padded.
104: *
105: * - TERMP_NOBREAK: this is the most important and is used when making
106: * columns. In short: don't print a newline and instead pad to the
107: * right margin. Used in conjunction with TERMP_NOLPAD.
108: *
1.91 kristaps 109: * - TERMP_TWOSPACE: when padding, make sure there are at least two
110: * space characters of padding. Otherwise, rather break the line.
111: *
1.84 kristaps 112: * - TERMP_DANGLE: don't newline when TERMP_NOBREAK is specified and
113: * the line is overrun, and don't pad-right if it's underrun.
114: *
115: * - TERMP_HANG: like TERMP_DANGLE, but doesn't newline when
116: * overruning, instead save the position and continue at that point
117: * when the next invocation.
1.71 kristaps 118: *
119: * In-line line breaking:
120: *
121: * If TERMP_NOBREAK is specified and the line overruns the right
122: * margin, it will break and pad-right to the right margin after
123: * writing. If maxrmargin is violated, it will break and continue
1.114 kristaps 124: * writing from the right-margin, which will lead to the above scenario
125: * upon exit. Otherwise, the line will break at the right margin.
1.71 kristaps 126: */
127: void
128: term_flushln(struct termp *p)
1.53 kristaps 129: {
1.114 kristaps 130: int i; /* current input position in p->buf */
131: size_t vis; /* current visual position on output */
132: size_t vbl; /* number of blanks to prepend to output */
133: size_t vsz; /* visual characters to write to output */
134: size_t bp; /* visual right border position */
135: int j; /* temporary loop index */
136: size_t maxvis, mmax;
1.91 kristaps 137: static int overstep = 0;
1.53 kristaps 138:
1.71 kristaps 139: /*
140: * First, establish the maximum columns of "visible" content.
141: * This is usually the difference between the right-margin and
142: * an indentation, but can be, for tagged lists or columns, a
1.115 kristaps 143: * small set of values.
1.71 kristaps 144: */
1.53 kristaps 145:
1.71 kristaps 146: assert(p->offset < p->rmargin);
1.92 kristaps 147:
1.114 kristaps 148: maxvis = (int)(p->rmargin - p->offset) - overstep < 0 ?
1.119 kristaps 149: /* LINTED */
150: 0 : p->rmargin - p->offset - overstep;
1.114 kristaps 151: mmax = (int)(p->maxrmargin - p->offset) - overstep < 0 ?
1.119 kristaps 152: /* LINTED */
153: 0 : p->maxrmargin - p->offset - overstep;
1.92 kristaps 154:
1.71 kristaps 155: bp = TERMP_NOBREAK & p->flags ? mmax : maxvis;
1.115 kristaps 156:
157: /*
158: * FIXME: if bp is zero, we still output the first word before
159: * breaking the line.
160: */
161:
1.71 kristaps 162: vis = 0;
1.84 kristaps 163:
1.71 kristaps 164: /*
165: * If in the standard case (left-justified), then begin with our
166: * indentation, otherwise (columns, etc.) just start spitting
167: * out text.
168: */
1.53 kristaps 169:
1.71 kristaps 170: if ( ! (p->flags & TERMP_NOLPAD))
171: /* LINTED */
172: for (j = 0; j < (int)p->offset; j++)
173: putchar(' ');
174:
175: for (i = 0; i < (int)p->col; i++) {
176: /*
177: * Count up visible word characters. Control sequences
178: * (starting with the CSI) aren't counted. A space
179: * generates a non-printing word, which is valid (the
180: * space is printed according to regular spacing rules).
181: */
182:
183: /* LINTED */
184: for (j = i, vsz = 0; j < (int)p->col; j++) {
1.93 kristaps 185: if (j && ' ' == p->buf[j])
1.71 kristaps 186: break;
187: else if (8 == p->buf[j])
1.89 kristaps 188: vsz--;
1.71 kristaps 189: else
190: vsz++;
191: }
1.53 kristaps 192:
1.71 kristaps 193: /*
1.81 kristaps 194: * Choose the number of blanks to prepend: no blank at the
195: * beginning of a line, one between words -- but do not
196: * actually write them yet.
1.71 kristaps 197: */
1.81 kristaps 198: vbl = (size_t)(0 == vis ? 0 : 1);
1.71 kristaps 199:
1.81 kristaps 200: /*
201: * Find out whether we would exceed the right margin.
202: * If so, break to the next line. (TODO: hyphenate)
203: * Otherwise, write the chosen number of blanks now.
204: */
205: if (vis && vis + vbl + vsz > bp) {
206: putchar('\n');
207: if (TERMP_NOBREAK & p->flags) {
208: for (j = 0; j < (int)p->rmargin; j++)
209: putchar(' ');
210: vis = p->rmargin - p->offset;
211: } else {
1.71 kristaps 212: for (j = 0; j < (int)p->offset; j++)
213: putchar(' ');
214: vis = 0;
1.81 kristaps 215: }
1.104 kristaps 216: /* Remove the overstep width. */
1.112 kristaps 217: bp += (int)/* LINTED */
218: overstep;
1.110 kristaps 219: overstep = 0;
1.81 kristaps 220: } else {
221: for (j = 0; j < (int)vbl; j++)
1.71 kristaps 222: putchar(' ');
1.81 kristaps 223: vis += vbl;
1.71 kristaps 224: }
1.53 kristaps 225:
1.78 kristaps 226: /*
1.81 kristaps 227: * Finally, write out the word.
1.71 kristaps 228: */
229: for ( ; i < (int)p->col; i++) {
230: if (' ' == p->buf[i])
231: break;
1.121 kristaps 232:
233: /* The unit sep. is a non-breaking space. */
234: if (31 == p->buf[i])
235: putchar(' ');
236: else
237: putchar(p->buf[i]);
1.71 kristaps 238: }
239: vis += vsz;
240: }
1.111 kristaps 241:
1.91 kristaps 242: p->col = 0;
1.111 kristaps 243: overstep = 0;
1.15 kristaps 244:
1.91 kristaps 245: if ( ! (TERMP_NOBREAK & p->flags)) {
246: putchar('\n');
1.15 kristaps 247: return;
1.71 kristaps 248: }
1.15 kristaps 249:
1.91 kristaps 250: if (TERMP_HANG & p->flags) {
251: /* We need one blank after the tag. */
1.92 kristaps 252: overstep = /* LINTED */
253: vis - maxvis + 1;
1.91 kristaps 254:
255: /*
256: * Behave exactly the same way as groff:
1.92 kristaps 257: * If we have overstepped the margin, temporarily move
258: * it to the right and flag the rest of the line to be
259: * shorter.
1.91 kristaps 260: * If we landed right at the margin, be happy.
1.92 kristaps 261: * If we are one step before the margin, temporarily
262: * move it one step LEFT and flag the rest of the line
263: * to be longer.
1.91 kristaps 264: */
1.92 kristaps 265: if (overstep >= -1) {
266: assert((int)maxvis + overstep >= 0);
267: /* LINTED */
1.91 kristaps 268: maxvis += overstep;
1.92 kristaps 269: } else
1.91 kristaps 270: overstep = 0;
271:
272: } else if (TERMP_DANGLE & p->flags)
273: return;
1.15 kristaps 274:
1.92 kristaps 275: /* Right-pad. */
276: if (maxvis > vis + /* LINTED */
277: ((TERMP_TWOSPACE & p->flags) ? 1 : 0))
1.91 kristaps 278: for ( ; vis < maxvis; vis++)
279: putchar(' ');
1.92 kristaps 280: else { /* ...or newline break. */
1.71 kristaps 281: putchar('\n');
1.91 kristaps 282: for (i = 0; i < (int)p->rmargin; i++)
283: putchar(' ');
284: }
1.15 kristaps 285: }
286:
287:
1.71 kristaps 288: /*
289: * A newline only breaks an existing line; it won't assert vertical
290: * space. All data in the output buffer is flushed prior to the newline
291: * assertion.
292: */
293: void
294: term_newln(struct termp *p)
1.15 kristaps 295: {
296:
1.71 kristaps 297: p->flags |= TERMP_NOSPACE;
298: if (0 == p->col) {
299: p->flags &= ~TERMP_NOLPAD;
1.15 kristaps 300: return;
1.16 kristaps 301: }
1.71 kristaps 302: term_flushln(p);
303: p->flags &= ~TERMP_NOLPAD;
1.16 kristaps 304: }
305:
306:
1.71 kristaps 307: /*
308: * Asserts a vertical space (a full, empty line-break between lines).
309: * Note that if used twice, this will cause two blank spaces and so on.
310: * All data in the output buffer is flushed prior to the newline
311: * assertion.
312: */
313: void
314: term_vspace(struct termp *p)
1.16 kristaps 315: {
316:
1.62 kristaps 317: term_newln(p);
1.71 kristaps 318: putchar('\n');
1.16 kristaps 319: }
320:
321:
1.71 kristaps 322: static void
1.95 kristaps 323: do_special(struct termp *p, const char *word, size_t len)
1.17 kristaps 324: {
1.71 kristaps 325: const char *rhs;
326: size_t sz;
1.79 kristaps 327: int i;
1.17 kristaps 328:
1.101 kristaps 329: rhs = chars_a2ascii(p->symtab, word, len, &sz);
1.86 kristaps 330:
1.96 kristaps 331: if (NULL == rhs) {
1.97 kristaps 332: #if 0
1.96 kristaps 333: fputs("Unknown special character: ", stderr);
334: for (i = 0; i < (int)len; i++)
335: fputc(word[i], stderr);
336: fputc('\n', stderr);
337: #endif
1.94 kristaps 338: return;
1.96 kristaps 339: }
1.94 kristaps 340: for (i = 0; i < (int)sz; i++)
1.95 kristaps 341: encode(p, rhs[i]);
1.94 kristaps 342: }
343:
344:
345: static void
1.95 kristaps 346: do_reserved(struct termp *p, const char *word, size_t len)
1.94 kristaps 347: {
348: const char *rhs;
349: size_t sz;
350: int i;
351:
1.101 kristaps 352: rhs = chars_a2res(p->symtab, word, len, &sz);
1.94 kristaps 353:
1.96 kristaps 354: if (NULL == rhs) {
355: #if 0
356: fputs("Unknown reserved word: ", stderr);
357: for (i = 0; i < (int)len; i++)
358: fputc(word[i], stderr);
359: fputc('\n', stderr);
360: #endif
1.94 kristaps 361: return;
1.96 kristaps 362: }
1.94 kristaps 363: for (i = 0; i < (int)sz; i++)
1.95 kristaps 364: encode(p, rhs[i]);
1.17 kristaps 365: }
366:
367:
1.71 kristaps 368: /*
369: * Handle pwords, partial words, which may be either a single word or a
370: * phrase that cannot be broken down (such as a literal string). This
371: * handles word styling.
372: */
1.86 kristaps 373: void
374: term_word(struct termp *p, const char *word)
1.65 kristaps 375: {
1.124 ! kristaps 376: const char *sv, *seq;
! 377: int sz, meta;
! 378: size_t ssz;
! 379: enum roffdeco deco;
1.71 kristaps 380:
1.100 kristaps 381: sv = word;
382:
1.123 kristaps 383: if (word[0] && '\0' == word[1])
1.100 kristaps 384: switch (word[0]) {
385: case('.'):
386: /* FALLTHROUGH */
387: case(','):
388: /* FALLTHROUGH */
389: case(';'):
390: /* FALLTHROUGH */
391: case(':'):
392: /* FALLTHROUGH */
393: case('?'):
394: /* FALLTHROUGH */
395: case('!'):
396: /* FALLTHROUGH */
397: case(')'):
398: /* FALLTHROUGH */
399: case(']'):
400: /* FALLTHROUGH */
401: case('}'):
402: if ( ! (TERMP_IGNDELIM & p->flags))
403: p->flags |= TERMP_NOSPACE;
404: break;
405: default:
406: break;
407: }
1.65 kristaps 408:
1.71 kristaps 409: if ( ! (TERMP_NOSPACE & p->flags))
1.95 kristaps 410: buffer(p, ' ');
1.65 kristaps 411:
1.71 kristaps 412: if ( ! (p->flags & TERMP_NONOSPACE))
413: p->flags &= ~TERMP_NOSPACE;
1.65 kristaps 414:
1.124 ! kristaps 415: /*
! 416: * FIXME: it's faster to put the metafont conditional here,
! 417: * because most of the time we're not a metafont and can use
! 418: * strcspn and fwrite.
! 419: */
! 420:
! 421: while (*word) {
! 422: if ('\\' != *word) {
1.95 kristaps 423: encode(p, *word);
1.124 ! kristaps 424: word++;
! 425: continue;
! 426: }
! 427:
! 428: seq = ++word;
! 429: sz = a2roffdeco(&deco, &seq, &ssz);
! 430:
! 431: switch (deco) {
! 432: case (DECO_RESERVED):
! 433: do_reserved(p, seq, ssz);
! 434: break;
! 435: case (DECO_SPECIAL):
! 436: do_special(p, seq, ssz);
! 437: break;
! 438: case (DECO_BOLD):
! 439: p->metamask = p->metafont;
! 440: p->metafont |= METAF_BOLD;
! 441: break;
! 442: case (DECO_ITALIC):
! 443: p->metamask = p->metafont;
! 444: p->metafont |= METAF_UNDER;
! 445: break;
! 446: case (DECO_ROMAN):
! 447: p->metamask = p->metafont;
! 448: p->metafont &= ~METAF_UNDER;
! 449: p->metafont &= ~METAF_BOLD;
! 450: break;
! 451: case (DECO_PREVIOUS):
! 452: meta = p->metamask;
! 453: p->metamask = p->metafont;
! 454: p->metafont = meta;
! 455: break;
! 456: default:
! 457: break;
! 458: }
! 459: word += sz;
! 460: }
1.65 kristaps 461:
1.100 kristaps 462: if (sv[0] && 0 == sv[1])
463: switch (sv[0]) {
464: case('('):
465: /* FALLTHROUGH */
466: case('['):
467: /* FALLTHROUGH */
468: case('{'):
469: p->flags |= TERMP_NOSPACE;
470: break;
471: default:
472: break;
473: }
1.65 kristaps 474: }
475:
476:
1.71 kristaps 477: /*
478: * Insert a single character into the line-buffer. If the buffer's
479: * space is exceeded, then allocate more space by doubling the buffer
480: * size.
481: */
482: static void
1.95 kristaps 483: buffer(struct termp *p, char c)
1.51 kristaps 484: {
1.71 kristaps 485: size_t s;
1.51 kristaps 486:
1.71 kristaps 487: if (p->col + 1 >= p->maxcols) {
488: if (0 == p->maxcols)
489: p->maxcols = 256;
490: s = p->maxcols * 2;
491: p->buf = realloc(p->buf, s);
1.118 kristaps 492: if (NULL == p->buf) {
1.120 kristaps 493: perror(NULL);
1.118 kristaps 494: exit(EXIT_FAILURE);
495: }
1.71 kristaps 496: p->maxcols = s;
497: }
498: p->buf[(int)(p->col)++] = c;
1.51 kristaps 499: }
500:
1.79 kristaps 501:
502: static void
1.95 kristaps 503: encode(struct termp *p, char c)
1.79 kristaps 504: {
1.89 kristaps 505:
1.122 kristaps 506: if (isgraph((u_char)c)) {
507: if (p->under || METAF_UNDER & p->metafont) {
1.109 kristaps 508: buffer(p, '_');
509: buffer(p, 8);
510: }
1.122 kristaps 511: if (p->bold || METAF_BOLD & p->metafont) {
1.95 kristaps 512: buffer(p, c);
513: buffer(p, 8);
1.79 kristaps 514: }
515: }
1.95 kristaps 516: buffer(p, c);
1.79 kristaps 517: }
1.106 kristaps 518:
519:
1.107 kristaps 520: size_t
521: term_vspan(const struct roffsu *su)
1.106 kristaps 522: {
523: double r;
524:
1.107 kristaps 525: switch (su->unit) {
1.106 kristaps 526: case (SCALE_CM):
1.107 kristaps 527: r = su->scale * 2;
1.106 kristaps 528: break;
529: case (SCALE_IN):
1.107 kristaps 530: r = su->scale * 6;
1.106 kristaps 531: break;
532: case (SCALE_PC):
1.107 kristaps 533: r = su->scale;
1.106 kristaps 534: break;
535: case (SCALE_PT):
1.107 kristaps 536: r = su->scale / 8;
1.106 kristaps 537: break;
538: case (SCALE_MM):
1.107 kristaps 539: r = su->scale / 1000;
1.106 kristaps 540: break;
541: case (SCALE_VS):
1.107 kristaps 542: r = su->scale;
1.106 kristaps 543: break;
544: default:
1.107 kristaps 545: r = su->scale - 1;
1.106 kristaps 546: break;
547: }
548:
549: if (r < 0.0)
550: r = 0.0;
1.107 kristaps 551: return(/* LINTED */(size_t)
1.106 kristaps 552: r);
553: }
554:
555:
1.107 kristaps 556: size_t
557: term_hspan(const struct roffsu *su)
1.106 kristaps 558: {
559: double r;
560:
1.108 kristaps 561: /* XXX: CM, IN, and PT are approximations. */
562:
1.107 kristaps 563: switch (su->unit) {
1.106 kristaps 564: case (SCALE_CM):
1.108 kristaps 565: r = 4 * su->scale;
1.106 kristaps 566: break;
567: case (SCALE_IN):
1.108 kristaps 568: /* XXX: this is an approximation. */
569: r = 10 * su->scale;
1.106 kristaps 570: break;
571: case (SCALE_PC):
1.108 kristaps 572: r = (10 * su->scale) / 6;
1.106 kristaps 573: break;
574: case (SCALE_PT):
1.108 kristaps 575: r = (10 * su->scale) / 72;
1.106 kristaps 576: break;
577: case (SCALE_MM):
1.107 kristaps 578: r = su->scale / 1000; /* FIXME: double-check. */
1.106 kristaps 579: break;
580: case (SCALE_VS):
1.107 kristaps 581: r = su->scale * 2 - 1; /* FIXME: double-check. */
1.106 kristaps 582: break;
583: default:
1.107 kristaps 584: r = su->scale;
1.106 kristaps 585: break;
586: }
587:
588: if (r < 0.0)
589: r = 0.0;
1.107 kristaps 590: return((size_t)/* LINTED */
1.106 kristaps 591: r);
592: }
593:
594:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to term.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc