xref: /openbsd-src/usr.bin/tmux/format-draw.c (revision 824adb5411e4389b29bae28eba5c2c2bbd147f34)
1 /* $OpenBSD: format-draw.c,v 1.24 2021/08/22 15:33:14 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2019 Nicholas Marriott <nicholas.marriott@gmail.com>
5  *
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.
9  *
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 MIND, USE, DATA OR PROFITS, WHETHER
15  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #include <sys/types.h>
20 
21 #include <stdlib.h>
22 #include <string.h>
23 
24 #include "tmux.h"
25 
26 /* Format range. */
27 struct format_range {
28 	u_int				 index;
29 	struct screen			*s;
30 
31 	u_int				 start;
32 	u_int				 end;
33 
34 	enum style_range_type		 type;
35 	u_int				 argument;
36 
37 	TAILQ_ENTRY(format_range)	 entry;
38 };
39 TAILQ_HEAD(format_ranges, format_range);
40 
41 /* Does this range match this style? */
42 static int
43 format_is_type(struct format_range *fr, struct style *sy)
44 {
45 	if (fr->type != sy->range_type)
46 		return (0);
47 	if (fr->type == STYLE_RANGE_WINDOW &&
48 	    fr->argument != sy->range_argument)
49 		return (0);
50 	return (1);
51 }
52 
53 /* Free a range. */
54 static void
55 format_free_range(struct format_ranges *frs, struct format_range *fr)
56 {
57 	TAILQ_REMOVE(frs, fr, entry);
58 	free(fr);
59 }
60 
61 /* Fix range positions. */
62 static void
63 format_update_ranges(struct format_ranges *frs, struct screen *s, u_int offset,
64     u_int start, u_int width)
65 {
66 	struct format_range	*fr, *fr1;
67 
68 	if (frs == NULL)
69 		return;
70 
71 	TAILQ_FOREACH_SAFE(fr, frs, entry, fr1) {
72 		if (fr->s != s)
73 			continue;
74 
75 		if (fr->end <= start || fr->start >= start + width) {
76 			format_free_range(frs, fr);
77 			continue;
78 		}
79 
80 		if (fr->start < start)
81 			fr->start = start;
82 		if (fr->end > start + width)
83 			fr->end = start + width;
84 		if (fr->start == fr->end) {
85 			format_free_range(frs, fr);
86 			continue;
87 		}
88 
89 		fr->start -= start;
90 		fr->end -= start;
91 
92 		fr->start += offset;
93 		fr->end += offset;
94 	}
95 }
96 
97 /* Draw a part of the format. */
98 static void
99 format_draw_put(struct screen_write_ctx *octx, u_int ocx, u_int ocy,
100     struct screen *s, struct format_ranges *frs, u_int offset, u_int start,
101     u_int width)
102 {
103 	/*
104 	 * The offset is how far from the cursor on the target screen; start
105 	 * and width how much to copy from the source screen.
106 	 */
107 	screen_write_cursormove(octx, ocx + offset, ocy, 0);
108 	screen_write_fast_copy(octx, s, start, 0, width, 1);
109 	format_update_ranges(frs, s, offset, start, width);
110 }
111 
112 /* Draw list part of format. */
113 static void
114 format_draw_put_list(struct screen_write_ctx *octx,
115     u_int ocx, u_int ocy, u_int offset, u_int width, struct screen *list,
116     struct screen *list_left, struct screen *list_right, int focus_start,
117     int focus_end, struct format_ranges *frs)
118 {
119 	u_int	start, focus_centre;
120 
121 	/* If there is enough space for the list, draw it entirely. */
122 	if (width >= list->cx) {
123 		format_draw_put(octx, ocx, ocy, list, frs, offset, 0, width);
124 		return;
125 	}
126 
127 	/* The list needs to be trimmed. Try to keep the focus visible. */
128 	focus_centre = focus_start + (focus_end - focus_start) / 2;
129 	if (focus_centre < width / 2)
130 		start = 0;
131 	else
132 		start = focus_centre - width / 2;
133 	if (start + width > list->cx)
134 		start = list->cx - width;
135 
136 	/* Draw <> markers at either side if needed. */
137 	if (start != 0 && width > list_left->cx) {
138 		screen_write_cursormove(octx, ocx + offset, ocy, 0);
139 		screen_write_fast_copy(octx, list_left, 0, 0, list_left->cx, 1);
140 		offset += list_left->cx;
141 		start += list_left->cx;
142 		width -= list_left->cx;
143 	}
144 	if (start + width < list->cx && width > list_right->cx) {
145 		screen_write_cursormove(octx, ocx + offset + width -
146 		    list_right->cx, ocy, 0);
147 		screen_write_fast_copy(octx, list_right, 0, 0, list_right->cx,
148 		    1);
149 		width -= list_right->cx;
150 	}
151 
152 	/* Draw the list screen itself. */
153 	format_draw_put(octx, ocx, ocy, list, frs, offset, start, width);
154 }
155 
156 /* Draw format with no list. */
157 static void
158 format_draw_none(struct screen_write_ctx *octx, u_int available, u_int ocx,
159     u_int ocy, struct screen *left, struct screen *centre, struct screen *right,
160     struct screen *abs_centre, struct format_ranges *frs)
161 {
162 	u_int	width_left, width_centre, width_right, width_abs_centre;
163 
164 	width_left = left->cx;
165 	width_centre = centre->cx;
166 	width_right = right->cx;
167 	width_abs_centre = abs_centre->cx;
168 
169 	/*
170 	 * Try to keep as much of the left and right as possible at the expense
171 	 * of the centre.
172 	 */
173 	while (width_left + width_centre + width_right > available) {
174 		if (width_centre > 0)
175 			width_centre--;
176 		else if (width_right > 0)
177 			width_right--;
178 		else
179 			width_left--;
180 	}
181 
182 	/* Write left. */
183 	format_draw_put(octx, ocx, ocy, left, frs, 0, 0, width_left);
184 
185 	/* Write right at available - width_right. */
186 	format_draw_put(octx, ocx, ocy, right, frs,
187 	    available - width_right,
188 	    right->cx - width_right,
189 	    width_right);
190 
191 	/*
192 	 * Write centre halfway between
193 	 *     width_left
194 	 * and
195 	 *     available - width_right.
196 	 */
197 	format_draw_put(octx, ocx, ocy, centre, frs,
198 	    width_left
199 	    + ((available - width_right) - width_left) / 2
200 	    - width_centre / 2,
201 	    centre->cx / 2 - width_centre / 2,
202 	    width_centre);
203 
204 	/*
205 	 * Write abs_centre in the perfect centre of all horizontal space.
206 	 */
207 	if (width_abs_centre > available)
208 		width_abs_centre = available;
209 	format_draw_put(octx, ocx, ocy, abs_centre, frs,
210 	    (available - width_abs_centre) / 2,
211 	    0,
212 	    width_abs_centre);
213 }
214 
215 /* Draw format with list on the left. */
216 static void
217 format_draw_left(struct screen_write_ctx *octx, u_int available, u_int ocx,
218     u_int ocy, struct screen *left, struct screen *centre, struct screen *right,
219     struct screen *abs_centre, struct screen *list, struct screen *list_left,
220     struct screen *list_right, struct screen *after, int focus_start,
221     int focus_end, struct format_ranges *frs)
222 {
223 	u_int			width_left, width_centre, width_right;
224 	u_int			width_list, width_after, width_abs_centre;
225 	struct screen_write_ctx	ctx;
226 
227 	width_left = left->cx;
228 	width_centre = centre->cx;
229 	width_right = right->cx;
230 	width_abs_centre = abs_centre->cx;
231 	width_list = list->cx;
232 	width_after = after->cx;
233 
234 	/*
235 	 * Trim first the centre, then the list, then the right, then after the
236 	 * list, then the left.
237 	 */
238 	while (width_left +
239 	    width_centre +
240 	    width_right +
241 	    width_list +
242 	    width_after > available) {
243 		if (width_centre > 0)
244 			width_centre--;
245 		else if (width_list > 0)
246 			width_list--;
247 		else if (width_right > 0)
248 			width_right--;
249 		else if (width_after > 0)
250 			width_after--;
251 		else
252 			width_left--;
253 	}
254 
255 	/* If there is no list left, pass off to the no list function. */
256 	if (width_list == 0) {
257 		screen_write_start(&ctx, left);
258 		screen_write_fast_copy(&ctx, after, 0, 0, width_after, 1);
259 		screen_write_stop(&ctx);
260 
261 		format_draw_none(octx, available, ocx, ocy, left, centre,
262 		    right, abs_centre, frs);
263 		return;
264 	}
265 
266 	/* Write left at 0. */
267 	format_draw_put(octx, ocx, ocy, left, frs, 0, 0, width_left);
268 
269 	/* Write right at available - width_right. */
270 	format_draw_put(octx, ocx, ocy, right, frs,
271 	    available - width_right,
272 	    right->cx - width_right,
273 	    width_right);
274 
275 	/* Write after at width_left + width_list. */
276 	format_draw_put(octx, ocx, ocy, after, frs,
277 	    width_left + width_list,
278 	    0,
279 	    width_after);
280 
281 	/*
282 	 * Write centre halfway between
283 	 *     width_left + width_list + width_after
284 	 * and
285 	 *     available - width_right.
286 	 */
287 	format_draw_put(octx, ocx, ocy, centre, frs,
288 	    (width_left + width_list + width_after)
289 	    + ((available - width_right)
290 		- (width_left + width_list + width_after)) / 2
291 	    - width_centre / 2,
292 	    centre->cx / 2 - width_centre / 2,
293 	    width_centre);
294 
295 	/*
296 	 * The list now goes from
297 	 *     width_left
298 	 * to
299 	 *     width_left + width_list.
300 	 * If there is no focus given, keep the left in focus.
301 	 */
302 	if (focus_start == -1 || focus_end == -1)
303 		focus_start = focus_end = 0;
304 	format_draw_put_list(octx, ocx, ocy, width_left, width_list, list,
305 	    list_left, list_right, focus_start, focus_end, frs);
306 
307 	/*
308 	 * Write abs_centre in the perfect centre of all horizontal space.
309 	 */
310 	if (width_abs_centre > available)
311 		width_abs_centre = available;
312 	format_draw_put(octx, ocx, ocy, abs_centre, frs,
313 	    (available - width_abs_centre) / 2,
314 	    0,
315 	    width_abs_centre);
316 }
317 
318 /* Draw format with list in the centre. */
319 static void
320 format_draw_centre(struct screen_write_ctx *octx, u_int available, u_int ocx,
321     u_int ocy, struct screen *left, struct screen *centre, struct screen *right,
322     struct screen *abs_centre, struct screen *list, struct screen *list_left,
323     struct screen *list_right, struct screen *after, int focus_start,
324     int focus_end, struct format_ranges *frs)
325 {
326 	u_int			width_left, width_centre, width_right, middle;
327 	u_int			width_list, width_after, width_abs_centre;
328 	struct screen_write_ctx	ctx;
329 
330 	width_left = left->cx;
331 	width_centre = centre->cx;
332 	width_right = right->cx;
333 	width_abs_centre = abs_centre->cx;
334 	width_list = list->cx;
335 	width_after = after->cx;
336 
337 	/*
338 	 * Trim first the list, then after the list, then the centre, then the
339 	 * right, then the left.
340 	 */
341 	while (width_left +
342 	    width_centre +
343 	    width_right +
344 	    width_list +
345 	    width_after > available) {
346 		if (width_list > 0)
347 			width_list--;
348 		else if (width_after > 0)
349 			width_after--;
350 		else if (width_centre > 0)
351 			width_centre--;
352 		else if (width_right > 0)
353 			width_right--;
354 		else
355 			width_left--;
356 	}
357 
358 	/* If there is no list left, pass off to the no list function. */
359 	if (width_list == 0) {
360 		screen_write_start(&ctx, centre);
361 		screen_write_fast_copy(&ctx, after, 0, 0, width_after, 1);
362 		screen_write_stop(&ctx);
363 
364 		format_draw_none(octx, available, ocx, ocy, left, centre,
365 		    right, abs_centre, frs);
366 		return;
367 	}
368 
369 	/* Write left at 0. */
370 	format_draw_put(octx, ocx, ocy, left, frs, 0, 0, width_left);
371 
372 	/* Write right at available - width_right. */
373 	format_draw_put(octx, ocx, ocy, right, frs,
374 	    available - width_right,
375 	    right->cx - width_right,
376 	    width_right);
377 
378 	/*
379 	 * All three centre sections are offset from the middle of the
380 	 * available space.
381 	 */
382 	middle = (width_left + ((available - width_right) - width_left) / 2);
383 
384 	/*
385 	 * Write centre at
386 	 *     middle - width_list / 2 - width_centre.
387 	 */
388 	format_draw_put(octx, ocx, ocy, centre, frs,
389 	    middle - width_list / 2 - width_centre,
390 	    0,
391 	    width_centre);
392 
393 	/*
394 	 * Write after at
395 	 *     middle - width_list / 2 + width_list
396 	 */
397 	format_draw_put(octx, ocx, ocy, after, frs,
398 	    middle - width_list / 2 + width_list,
399 	    0,
400 	    width_after);
401 
402 	/*
403 	 * The list now goes from
404 	 *     middle - width_list / 2
405 	 * to
406 	 *     middle + width_list / 2
407 	 * If there is no focus given, keep the centre in focus.
408 	 */
409 	if (focus_start == -1 || focus_end == -1)
410 		focus_start = focus_end = list->cx / 2;
411 	format_draw_put_list(octx, ocx, ocy, middle - width_list / 2,
412 	    width_list, list, list_left, list_right, focus_start, focus_end,
413 	    frs);
414 
415 	/*
416 	 * Write abs_centre in the perfect centre of all horizontal space.
417 	 */
418 	if (width_abs_centre > available)
419 		width_abs_centre = available;
420 	format_draw_put(octx, ocx, ocy, abs_centre, frs,
421 	    (available - width_abs_centre) / 2,
422 	    0,
423 	    width_abs_centre);
424 }
425 
426 /* Draw format with list on the right. */
427 static void
428 format_draw_right(struct screen_write_ctx *octx, u_int available, u_int ocx,
429     u_int ocy, struct screen *left, struct screen *centre, struct screen *right,
430     struct screen *abs_centre,     struct screen *list,
431     struct screen *list_left, struct screen *list_right, struct screen *after,
432     int focus_start, int focus_end, struct format_ranges *frs)
433 {
434 	u_int			width_left, width_centre, width_right;
435 	u_int			width_list, width_after, width_abs_centre;
436 	struct screen_write_ctx	ctx;
437 
438 	width_left = left->cx;
439 	width_centre = centre->cx;
440 	width_right = right->cx;
441 	width_abs_centre = abs_centre->cx;
442 	width_list = list->cx;
443 	width_after = after->cx;
444 
445 	/*
446 	 * Trim first the centre, then the list, then the right, then
447 	 * after the list, then the left.
448 	 */
449 	while (width_left +
450 	    width_centre +
451 	    width_right +
452 	    width_list +
453 	    width_after > available) {
454 		if (width_centre > 0)
455 			width_centre--;
456 		else if (width_list > 0)
457 			width_list--;
458 		else if (width_right > 0)
459 			width_right--;
460 		else if (width_after > 0)
461 			width_after--;
462 		else
463 			width_left--;
464 	}
465 
466 	/* If there is no list left, pass off to the no list function. */
467 	if (width_list == 0) {
468 		screen_write_start(&ctx, right);
469 		screen_write_fast_copy(&ctx, after, 0, 0, width_after, 1);
470 		screen_write_stop(&ctx);
471 
472 		format_draw_none(octx, available, ocx, ocy, left, centre,
473 		    right, abs_centre, frs);
474 		return;
475 	}
476 
477 	/* Write left at 0. */
478 	format_draw_put(octx, ocx, ocy, left, frs, 0, 0, width_left);
479 
480 	/* Write after at available - width_after. */
481 	format_draw_put(octx, ocx, ocy, after, frs,
482 	    available - width_after,
483 	    after->cx - width_after,
484 	    width_after);
485 
486 	/*
487 	 * Write right at
488 	 *     available - width_right - width_list - width_after.
489 	 */
490 	format_draw_put(octx, ocx, ocy, right, frs,
491 	    available - width_right - width_list - width_after,
492 	    0,
493 	    width_right);
494 
495 	/*
496 	 * Write centre halfway between
497 	 *     width_left
498 	 * and
499 	 *     available - width_right - width_list - width_after.
500 	 */
501 	format_draw_put(octx, ocx, ocy, centre, frs,
502 	    width_left
503 	    + ((available - width_right - width_list - width_after)
504 		- width_left) / 2
505 	    - width_centre / 2,
506 	    centre->cx / 2 - width_centre / 2,
507 	    width_centre);
508 
509 	/*
510 	 * The list now goes from
511 	 *     available - width_list - width_after
512 	 * to
513 	 *     available - width_after
514 	 * If there is no focus given, keep the right in focus.
515 	 */
516 	if (focus_start == -1 || focus_end == -1)
517 		focus_start = focus_end = 0;
518 	format_draw_put_list(octx, ocx, ocy, available - width_list -
519 	    width_after, width_list, list, list_left, list_right, focus_start,
520 	    focus_end, frs);
521 
522 	/*
523 	 * Write abs_centre in the perfect centre of all horizontal space.
524 	 */
525 	if (width_abs_centre > available)
526 		width_abs_centre = available;
527 	format_draw_put(octx, ocx, ocy, abs_centre, frs,
528 	    (available - width_abs_centre) / 2,
529 	    0,
530 	    width_abs_centre);
531 }
532 
533 static void
534 format_draw_absolute_centre(struct screen_write_ctx *octx, u_int available,
535     u_int ocx, u_int ocy, struct screen *left, struct screen *centre,
536     struct screen *right, struct screen *abs_centre, struct screen *list,
537     struct screen *list_left, struct screen *list_right, struct screen *after,
538     int focus_start, int focus_end, struct format_ranges *frs)
539 {
540 	u_int	width_left, width_centre, width_right, width_abs_centre;
541 	u_int	width_list, width_after, middle, abs_centre_offset;
542 
543 	width_left = left->cx;
544 	width_centre = centre->cx;
545 	width_right = right->cx;
546 	width_abs_centre = abs_centre->cx;
547 	width_list = list->cx;
548 	width_after = after->cx;
549 
550 	/*
551 	 * Trim first centre, then the right, then the left.
552 	 */
553 	while (width_left +
554 	    width_centre +
555 	    width_right > available) {
556 		if (width_centre > 0)
557 			width_centre--;
558 		else if (width_right > 0)
559 			width_right--;
560 		else
561 			width_left--;
562 	}
563 
564 	/*
565 	 * We trim list after and abs_centre independently, as we are drawing
566 	 * them over the rest. Trim first the list, then after the list, then
567 	 * abs_centre.
568 	 */
569 	while (width_list + width_after + width_abs_centre > available) {
570 		if (width_list > 0)
571 			width_list--;
572 		else if (width_after > 0)
573 			width_after--;
574 		else
575 			width_abs_centre--;
576 	}
577 
578 	/* Write left at 0. */
579 	format_draw_put(octx, ocx, ocy, left, frs, 0, 0, width_left);
580 
581 	/* Write right at available - width_right. */
582 	format_draw_put(octx, ocx, ocy, right, frs,
583 	    available - width_right,
584 	    right->cx - width_right,
585 	    width_right);
586 
587 	/*
588 	 * Keep writing centre at the relative centre. Only the list is written
589 	 * in the absolute centre of the horizontal space.
590 	 */
591 	middle = (width_left + ((available - width_right) - width_left) / 2);
592 
593 	/*
594 	 * Write centre at
595 	 *     middle - width_centre.
596 	 */
597 	format_draw_put(octx, ocx, ocy, centre, frs,
598 		middle - width_centre,
599 		0,
600 		width_centre);
601 
602 	/*
603 	 * If there is no focus given, keep the centre in focus.
604 	 */
605 	if (focus_start == -1 || focus_end == -1)
606 		focus_start = focus_end = list->cx / 2;
607 
608 	/*
609 	 * We centre abs_centre and the list together, so their shared centre is
610 	 * in the perfect centre of horizontal space.
611 	 */
612 	abs_centre_offset = (available - width_list - width_abs_centre) / 2;
613 
614 	/*
615 	 * Write abs_centre before the list.
616 	 */
617 	format_draw_put(octx, ocx, ocy, abs_centre, frs, abs_centre_offset,
618 	    0, width_abs_centre);
619 	abs_centre_offset += width_abs_centre;
620 
621 	/*
622 	 * Draw the list in the absolute centre
623 	 */
624 	format_draw_put_list(octx, ocx, ocy, abs_centre_offset, width_list,
625 	    list, list_left, list_right, focus_start, focus_end, frs);
626 	abs_centre_offset += width_list;
627 
628 	/*
629 	 * Write after at the end of the centre
630 	 */
631 	format_draw_put(octx, ocx, ocy, after, frs, abs_centre_offset, 0,
632 	    width_after);
633 }
634 
635 /* Get width and count of any leading #s. */
636 static const char *
637 format_leading_hashes(const char *cp, u_int *n, u_int *width)
638 {
639 	for (*n = 0; cp[*n] == '#'; (*n)++)
640 		/* nothing */;
641 	if (*n == 0) {
642 		*width = 0;
643 		return (cp);
644 	}
645 	if (cp[*n] != '[') {
646 		if ((*n % 2) == 0)
647 			*width = (*n / 2);
648 		else
649 			*width = (*n / 2) + 1;
650 		return (cp + *n);
651 	}
652 	*width = (*n / 2);
653 	if ((*n % 2) == 0) {
654 		/*
655 		 * An even number of #s means that all #s are escaped, so not a
656 		 * style. The caller should not skip this. Return pointing to
657 		 * the [.
658 		 */
659 		return (cp + *n);
660 	}
661 	/* This is a style, so return pointing to the #. */
662 	return (cp + *n - 1);
663 }
664 
665 /* Draw multiple characters. */
666 static void
667 format_draw_many(struct screen_write_ctx *ctx, struct style *sy, char ch,
668     u_int n)
669 {
670 	u_int	i;
671 
672 	utf8_set(&sy->gc.data, ch);
673 	for (i = 0; i < n; i++)
674 		screen_write_cell(ctx, &sy->gc);
675 }
676 
677 /* Draw a format to a screen. */
678 void
679 format_draw(struct screen_write_ctx *octx, const struct grid_cell *base,
680     u_int available, const char *expanded, struct style_ranges *srs)
681 {
682 	enum { LEFT,
683 	       CENTRE,
684 	       RIGHT,
685 	       ABSOLUTE_CENTRE,
686 	       LIST,
687 	       LIST_LEFT,
688 	       LIST_RIGHT,
689 	       AFTER,
690 	       TOTAL } current = LEFT, last = LEFT;
691 	const char	        *names[] = { "LEFT",
692 					     "CENTRE",
693 					     "RIGHT",
694 					     "ABSOLUTE_CENTRE",
695 					     "LIST",
696 					     "LIST_LEFT",
697 					     "LIST_RIGHT",
698 					     "AFTER" };
699 	size_t			 size = strlen(expanded);
700 	struct screen		*os = octx->s, s[TOTAL];
701 	struct screen_write_ctx	 ctx[TOTAL];
702 	u_int			 ocx = os->cx, ocy = os->cy, n, i, width[TOTAL];
703 	u_int			 map[] = { LEFT,
704 					   LEFT,
705 					   CENTRE,
706 					   RIGHT,
707 					   ABSOLUTE_CENTRE };
708 	int			 focus_start = -1, focus_end = -1;
709 	int			 list_state = -1, fill = -1, even;
710 	enum style_align	 list_align = STYLE_ALIGN_DEFAULT;
711 	struct grid_cell	 gc, current_default;
712 	struct style		 sy, saved_sy;
713 	struct utf8_data	*ud = &sy.gc.data;
714 	const char		*cp, *end;
715 	enum utf8_state		 more;
716 	char			*tmp;
717 	struct format_range	*fr = NULL, *fr1;
718 	struct format_ranges	 frs;
719 	struct style_range	*sr;
720 
721 	memcpy(&current_default, base, sizeof current_default);
722 	style_set(&sy, &current_default);
723 	TAILQ_INIT(&frs);
724 	log_debug("%s: %s", __func__, expanded);
725 
726 	/*
727 	 * We build three screens for left, right, centre alignment, one for
728 	 * the list, one for anything after the list and two for the list left
729 	 * and right markers.
730 	 */
731 	for (i = 0; i < TOTAL; i++) {
732 		screen_init(&s[i], size, 1, 0);
733 		screen_write_start(&ctx[i], &s[i]);
734 		screen_write_clearendofline(&ctx[i], current_default.bg);
735 		width[i] = 0;
736 	}
737 
738 	/*
739 	 * Walk the string and add to the corresponding screens,
740 	 * parsing styles as we go.
741 	 */
742 	cp = expanded;
743 	while (*cp != '\0') {
744 		/* Handle sequences of #. */
745 		if (cp[0] == '#' && cp[1] != '[' && cp[1] != '\0') {
746 			for (n = 1; cp[n] == '#'; n++)
747 				 /* nothing */;
748 			even = ((n % 2) == 0);
749 			if (cp[n] != '[') {
750 				cp += n;
751 				if (even)
752 					n = (n / 2);
753 				else
754 					n = (n / 2) + 1;
755 				width[current] += n;
756 				format_draw_many(&ctx[current], &sy, '#', n);
757 				continue;
758 			}
759 			if (even)
760 				cp += (n + 1);
761 			else
762 				cp += (n - 1);
763 			if (sy.ignore)
764 				continue;
765 			format_draw_many(&ctx[current], &sy, '#', n / 2);
766 			width[current] += (n / 2);
767 			if (even) {
768 				utf8_set(ud, '[');
769 				screen_write_cell(&ctx[current], &sy.gc);
770 				width[current]++;
771 			}
772 			continue;
773 		}
774 
775 		/* Is this not a style? */
776 		if (cp[0] != '#' || cp[1] != '[' || sy.ignore) {
777 			/* See if this is a UTF-8 character. */
778 			if ((more = utf8_open(ud, *cp)) == UTF8_MORE) {
779 				while (*++cp != '\0' && more == UTF8_MORE)
780 					more = utf8_append(ud, *cp);
781 				if (more != UTF8_DONE)
782 					cp -= ud->have;
783 			}
784 
785 			/* Not a UTF-8 character - ASCII or not valid. */
786 			if (more != UTF8_DONE) {
787 				if (*cp < 0x20 || *cp > 0x7e) {
788 					/* Ignore nonprintable characters. */
789 					cp++;
790 					continue;
791 				}
792 				utf8_set(ud, *cp);
793 				cp++;
794 			}
795 
796 			/* Draw the cell to the current screen. */
797 			screen_write_cell(&ctx[current], &sy.gc);
798 			width[current] += ud->width;
799 			continue;
800 		}
801 
802 		/* This is a style. Work out where the end is and parse it. */
803 		end = format_skip(cp + 2, "]");
804 		if (end == NULL) {
805 			log_debug("%s: no terminating ] at '%s'", __func__,
806 			    cp + 2);
807 			TAILQ_FOREACH_SAFE(fr, &frs, entry, fr1)
808 			    format_free_range(&frs, fr);
809 			goto out;
810 		}
811 		tmp = xstrndup(cp + 2, end - (cp + 2));
812 		style_copy(&saved_sy, &sy);
813 		if (style_parse(&sy, &current_default, tmp) != 0) {
814 			log_debug("%s: invalid style '%s'", __func__, tmp);
815 			free(tmp);
816 			cp = end + 1;
817 			continue;
818 		}
819 		log_debug("%s: style '%s' -> '%s'", __func__, tmp,
820 		    style_tostring(&sy));
821 		free(tmp);
822 
823 		/* If this style has a fill colour, store it for later. */
824 		if (sy.fill != 8)
825 			fill = sy.fill;
826 
827 		/* If this style pushed or popped the default, update it. */
828 		if (sy.default_type == STYLE_DEFAULT_PUSH) {
829 			memcpy(&current_default, &saved_sy.gc,
830 			    sizeof current_default);
831 			sy.default_type = STYLE_DEFAULT_BASE;
832 		} else if (sy.default_type == STYLE_DEFAULT_POP) {
833 			memcpy(&current_default, base, sizeof current_default);
834 			sy.default_type = STYLE_DEFAULT_BASE;
835 		}
836 
837 		/* Check the list state. */
838 		switch (sy.list) {
839 		case STYLE_LIST_ON:
840 			/*
841 			 * Entering the list, exiting a marker, or exiting the
842 			 * focus.
843 			 */
844 			if (list_state != 0) {
845 				if (fr != NULL) { /* abort any region */
846 					free(fr);
847 					fr = NULL;
848 				}
849 				list_state = 0;
850 				list_align = sy.align;
851 			}
852 
853 			/* End the focus if started. */
854 			if (focus_start != -1 && focus_end == -1)
855 				focus_end = s[LIST].cx;
856 
857 			current = LIST;
858 			break;
859 		case STYLE_LIST_FOCUS:
860 			/* Entering the focus. */
861 			if (list_state != 0) /* not inside the list */
862 				break;
863 			if (focus_start == -1) /* focus already started */
864 				focus_start = s[LIST].cx;
865 			break;
866 		case STYLE_LIST_OFF:
867 			/* Exiting or outside the list. */
868 			if (list_state == 0) {
869 				if (fr != NULL) { /* abort any region */
870 					free(fr);
871 					fr = NULL;
872 				}
873 				if (focus_start != -1 && focus_end == -1)
874 					focus_end = s[LIST].cx;
875 
876 				map[list_align] = AFTER;
877 				if (list_align == STYLE_ALIGN_LEFT)
878 					map[STYLE_ALIGN_DEFAULT] = AFTER;
879 				list_state = 1;
880 			}
881 			current = map[sy.align];
882 			break;
883 		case STYLE_LIST_LEFT_MARKER:
884 			/* Entering left marker. */
885 			if (list_state != 0) /* not inside the list */
886 				break;
887 			if (s[LIST_LEFT].cx != 0) /* already have marker */
888 				break;
889 			if (fr != NULL) { /* abort any region */
890 				free(fr);
891 				fr = NULL;
892 			}
893 			if (focus_start != -1 && focus_end == -1)
894 				focus_start = focus_end = -1;
895 			current = LIST_LEFT;
896 			break;
897 		case STYLE_LIST_RIGHT_MARKER:
898 			/* Entering right marker. */
899 			if (list_state != 0) /* not inside the list */
900 				break;
901 			if (s[LIST_RIGHT].cx != 0) /* already have marker */
902 				break;
903 			if (fr != NULL) { /* abort any region */
904 				free(fr);
905 				fr = NULL;
906 			}
907 			if (focus_start != -1 && focus_end == -1)
908 				focus_start = focus_end = -1;
909 			current = LIST_RIGHT;
910 			break;
911 		}
912 		if (current != last) {
913 			log_debug("%s: change %s -> %s", __func__,
914 			    names[last], names[current]);
915 			last = current;
916 		}
917 
918 		/*
919 		 * Check if the range style has changed and if so end the
920 		 * current range and start a new one if needed.
921 		 */
922 		if (srs != NULL) {
923 			if (fr != NULL && !format_is_type(fr, &sy)) {
924 				if (s[current].cx != fr->start) {
925 					fr->end = s[current].cx + 1;
926 					TAILQ_INSERT_TAIL(&frs, fr, entry);
927 				} else
928 					free(fr);
929 				fr = NULL;
930 			}
931 			if (fr == NULL && sy.range_type != STYLE_RANGE_NONE) {
932 				fr = xcalloc(1, sizeof *fr);
933 				fr->index = current;
934 
935 				fr->s = &s[current];
936 				fr->start = s[current].cx;
937 
938 				fr->type = sy.range_type;
939 				fr->argument = sy.range_argument;
940 			}
941 		}
942 
943 		cp = end + 1;
944 	}
945 	free(fr);
946 
947 	for (i = 0; i < TOTAL; i++) {
948 		screen_write_stop(&ctx[i]);
949 		log_debug("%s: width %s is %u", __func__, names[i], width[i]);
950 	}
951 	if (focus_start != -1 && focus_end != -1)
952 		log_debug("%s: focus %d-%d", __func__, focus_start, focus_end);
953 	TAILQ_FOREACH(fr, &frs, entry) {
954 		log_debug("%s: range %d|%u is %s %u-%u", __func__, fr->type,
955 		    fr->argument, names[fr->index], fr->start, fr->end);
956 	}
957 
958 	/* Clear the available area. */
959 	if (fill != -1) {
960 		memcpy(&gc, &grid_default_cell, sizeof gc);
961 		gc.bg = fill;
962 		for (i = 0; i < available; i++)
963 			screen_write_putc(octx, &gc, ' ');
964 	}
965 
966 	/*
967 	 * Draw the screens. How they are arranged depends on where the list
968 	 * appears.
969 	 */
970 	switch (list_align) {
971 	case STYLE_ALIGN_DEFAULT:
972 		/* No list. */
973 		format_draw_none(octx, available, ocx, ocy, &s[LEFT],
974 		    &s[CENTRE], &s[RIGHT], &s[ABSOLUTE_CENTRE], &frs);
975 		break;
976 	case STYLE_ALIGN_LEFT:
977 		/* List is part of the left. */
978 		format_draw_left(octx, available, ocx, ocy, &s[LEFT],
979 		    &s[CENTRE], &s[RIGHT], &s[ABSOLUTE_CENTRE], &s[LIST],
980 		    &s[LIST_LEFT], &s[LIST_RIGHT], &s[AFTER],
981 		    focus_start, focus_end, &frs);
982 		break;
983 	case STYLE_ALIGN_CENTRE:
984 		/* List is part of the centre. */
985 		format_draw_centre(octx, available, ocx, ocy, &s[LEFT],
986 		    &s[CENTRE], &s[RIGHT], &s[ABSOLUTE_CENTRE], &s[LIST],
987 		    &s[LIST_LEFT], &s[LIST_RIGHT], &s[AFTER],
988 		    focus_start, focus_end, &frs);
989 		break;
990 	case STYLE_ALIGN_RIGHT:
991 		/* List is part of the right. */
992 		format_draw_right(octx, available, ocx, ocy, &s[LEFT],
993 		    &s[CENTRE], &s[RIGHT], &s[ABSOLUTE_CENTRE], &s[LIST],
994 		    &s[LIST_LEFT], &s[LIST_RIGHT], &s[AFTER],
995 		    focus_start, focus_end, &frs);
996 		break;
997 	case STYLE_ALIGN_ABSOLUTE_CENTRE:
998 		/* List is in the centre of the entire horizontal space. */
999 		format_draw_absolute_centre(octx, available, ocx, ocy, &s[LEFT],
1000 		    &s[CENTRE], &s[RIGHT], &s[ABSOLUTE_CENTRE], &s[LIST],
1001 		    &s[LIST_LEFT], &s[LIST_RIGHT], &s[AFTER],
1002 		    focus_start, focus_end, &frs);
1003 		break;
1004 	}
1005 
1006 	/* Create ranges to return. */
1007 	TAILQ_FOREACH_SAFE(fr, &frs, entry, fr1) {
1008 		sr = xcalloc(1, sizeof *sr);
1009 		sr->type = fr->type;
1010 		sr->argument = fr->argument;
1011 		sr->start = fr->start;
1012 		sr->end = fr->end;
1013 		TAILQ_INSERT_TAIL(srs, sr, entry);
1014 
1015 		log_debug("%s: range %d|%u at %u-%u", __func__, sr->type,
1016 		    sr->argument, sr->start, sr->end);
1017 
1018 		format_free_range(&frs, fr);
1019 	}
1020 
1021 out:
1022 	/* Free the screens. */
1023 	for (i = 0; i < TOTAL; i++)
1024 		screen_free(&s[i]);
1025 
1026 	/* Restore the original cursor position. */
1027 	screen_write_cursormove(octx, ocx, ocy, 0);
1028 }
1029 
1030 /* Get width, taking #[] into account. */
1031 u_int
1032 format_width(const char *expanded)
1033 {
1034 	const char		*cp, *end;
1035 	u_int			 n, leading_width, width = 0;
1036 	struct utf8_data	 ud;
1037 	enum utf8_state		 more;
1038 
1039 	cp = expanded;
1040 	while (*cp != '\0') {
1041 		if (*cp == '#') {
1042 			end = format_leading_hashes(cp, &n, &leading_width);
1043 			width += leading_width;
1044 			cp = end;
1045 			if (*cp == '#') {
1046 				end = format_skip(cp + 2, "]");
1047 				if (end == NULL)
1048 					return (0);
1049 				cp = end + 1;
1050 			}
1051 		} else if ((more = utf8_open(&ud, *cp)) == UTF8_MORE) {
1052 			while (*++cp != '\0' && more == UTF8_MORE)
1053 				more = utf8_append(&ud, *cp);
1054 			if (more == UTF8_DONE)
1055 				width += ud.width;
1056 			else
1057 				cp -= ud.have;
1058 		} else if (*cp > 0x1f && *cp < 0x7f) {
1059 			width++;
1060 			cp++;
1061 		} else
1062 			cp++;
1063 	}
1064 	return (width);
1065 }
1066 
1067 /*
1068  * Trim on the left, taking #[] into account.  Note, we copy the whole set of
1069  * unescaped #s, but only add their escaped size to width. This is because the
1070  * format_draw function will actually do the escaping when it runs
1071  */
1072 char *
1073 format_trim_left(const char *expanded, u_int limit)
1074 {
1075 	char			*copy, *out;
1076 	const char		*cp = expanded, *end;
1077 	u_int			 n, width = 0, leading_width;
1078 	struct utf8_data	 ud;
1079 	enum utf8_state		 more;
1080 
1081 	out = copy = xcalloc(1, strlen(expanded) + 1);
1082 	while (*cp != '\0') {
1083 		if (width >= limit)
1084 			break;
1085 		if (*cp == '#') {
1086 			end = format_leading_hashes(cp, &n, &leading_width);
1087 			if (leading_width > limit - width)
1088 				leading_width = limit - width;
1089 			if (leading_width != 0) {
1090 				if (n == 1)
1091 					*out++ = '#';
1092 				else {
1093 					memset(out, '#', 2 * leading_width);
1094 					out += 2 * leading_width;
1095 				}
1096 				width += leading_width;
1097 			}
1098 			cp = end;
1099 			if (*cp == '#') {
1100 				end = format_skip(cp + 2, "]");
1101 				if (end == NULL)
1102 					break;
1103 				memcpy(out, cp, end + 1 - cp);
1104 				out += (end + 1 - cp);
1105 				cp = end + 1;
1106 			}
1107 		} else if ((more = utf8_open(&ud, *cp)) == UTF8_MORE) {
1108 			while (*++cp != '\0' && more == UTF8_MORE)
1109 				more = utf8_append(&ud, *cp);
1110 			if (more == UTF8_DONE) {
1111 				if (width + ud.width <= limit) {
1112 					memcpy(out, ud.data, ud.size);
1113 					out += ud.size;
1114 				}
1115 				width += ud.width;
1116 			} else {
1117 				cp -= ud.have;
1118 				cp++;
1119 			}
1120 		} else if (*cp > 0x1f && *cp < 0x7f) {
1121 			if (width + 1 <= limit)
1122 				*out++ = *cp;
1123 			width++;
1124 			cp++;
1125 		} else
1126 			cp++;
1127 	}
1128 	*out = '\0';
1129 	return (copy);
1130 }
1131 
1132 /* Trim on the right, taking #[] into account. */
1133 char *
1134 format_trim_right(const char *expanded, u_int limit)
1135 {
1136 	char			*copy, *out;
1137 	const char		*cp = expanded, *end;
1138 	u_int			 width = 0, total_width, skip, n;
1139 	u_int			 leading_width, copy_width;
1140 	struct utf8_data	 ud;
1141 	enum utf8_state		 more;
1142 
1143 	total_width = format_width(expanded);
1144 	if (total_width <= limit)
1145 		return (xstrdup(expanded));
1146 	skip = total_width - limit;
1147 
1148 	out = copy = xcalloc(1, strlen(expanded) + 1);
1149 	while (*cp != '\0') {
1150 		if (*cp == '#') {
1151 			end = format_leading_hashes(cp, &n, &leading_width);
1152 			if (width <= skip) {
1153 				if (skip - width >= leading_width)
1154 					copy_width = 0;
1155 				else
1156 					copy_width -= (skip - width);
1157 			} else
1158 				copy_width = leading_width;
1159 			if (copy_width != 0) {
1160 				if (n == 1)
1161 					*out++ = '#';
1162 				else {
1163 					memset(out, '#', 2 * copy_width);
1164 					out += 2 * copy_width;
1165 				}
1166 			}
1167 			width += leading_width;
1168 			cp = end;
1169 			if (*cp == '#') {
1170 				end = format_skip(cp + 2, "]");
1171 				if (end == NULL)
1172 					break;
1173 				memcpy(out, cp, end + 1 - cp);
1174 				out += (end + 1 - cp);
1175 				cp = end + 1;
1176 			}
1177 		} else if ((more = utf8_open(&ud, *cp)) == UTF8_MORE) {
1178 			while (*++cp != '\0' && more == UTF8_MORE)
1179 				more = utf8_append(&ud, *cp);
1180 			if (more == UTF8_DONE) {
1181 				if (width >= skip) {
1182 					memcpy(out, ud.data, ud.size);
1183 					out += ud.size;
1184 				}
1185 				width += ud.width;
1186 			} else {
1187 				cp -= ud.have;
1188 				cp++;
1189 			}
1190 		} else if (*cp > 0x1f && *cp < 0x7f) {
1191 			if (width >= skip)
1192 				*out++ = *cp;
1193 			width++;
1194 			cp++;
1195 		} else
1196 			cp++;
1197 	}
1198 	*out = '\0';
1199 	return (copy);
1200 }
1201