contrib/mdocml/tbl_term.c

   1 /*      $Id: tbl_term.c,v 1.46 2017/06/08 18:11:22 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2009, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4  * Copyright (c) 2011,2012,2014,2015,2017 Ingo Schwarze <schwarze@openbsd.org>
   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 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.
  17  */
  18 #include "config.h"
  19
  20 #include <sys/types.h>
  21
  22 #include <assert.h>
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "mandoc.h"
  28 #include "out.h"
  29 #include "term.h"
  30
  31 static  size_t  term_tbl_len(size_t, void *);
  32 static  size_t  term_tbl_strlen(const char *, void *);
  33 static  size_t  term_tbl_sulen(const struct roffsu *, void *);
  34 static  void    tbl_char(struct termp *, char, size_t);
  35 static  void    tbl_data(struct termp *, const struct tbl_opts *,
  36                         const struct tbl_dat *,
  37                         const struct roffcol *);
  38 static  void    tbl_literal(struct termp *, const struct tbl_dat *,
  39                         const struct roffcol *);
  40 static  void    tbl_number(struct termp *, const struct tbl_opts *,
  41                         const struct tbl_dat *,
  42                         const struct roffcol *);
  43 static  void    tbl_hrule(struct termp *, const struct tbl_span *, int);
  44 static  void    tbl_word(struct termp *, const struct tbl_dat *);
  45
  46
  47 static size_t
  48 term_tbl_sulen(const struct roffsu *su, void *arg)
  49 {
  50         return term_hspan((const struct termp *)arg, su) / 24;
  51 }
  52
  53 static size_t
  54 term_tbl_strlen(const char *p, void *arg)
  55 {
  56         return term_strlen((const struct termp *)arg, p);
  57 }
  58
  59 static size_t
  60 term_tbl_len(size_t sz, void *arg)
  61 {
  62         return term_len((const struct termp *)arg, sz);
  63 }
  64
  65 void
  66 term_tbl(struct termp *tp, const struct tbl_span *sp)
  67 {
  68         const struct tbl_cell   *cp;
  69         const struct tbl_dat    *dp;
  70         static size_t            offset;
  71         size_t                   tsz;
  72         int                      ic, horiz, spans, vert;
  73
  74         /* Inhibit printing of spaces: we do padding ourselves. */
  75
  76         tp->flags |= TERMP_NOSPACE | TERMP_NONOSPACE | TERMP_BRNEVER;
  77
  78         /*
  79          * The first time we're invoked for a given table block,
  80          * calculate the table widths and decimal positions.
  81          */
  82
  83         if (tp->tbl.cols == NULL) {
  84                 tp->tbl.len = term_tbl_len;
  85                 tp->tbl.slen = term_tbl_strlen;
  86                 tp->tbl.sulen = term_tbl_sulen;
  87                 tp->tbl.arg = tp;
  88
  89                 tblcalc(&tp->tbl, sp, tp->tcol->rmargin - tp->tcol->offset);
  90
  91                 /* Center the table as a whole. */
  92
  93                 offset = tp->tcol->offset;
  94                 if (sp->opts->opts & TBL_OPT_CENTRE) {
  95                         tsz = sp->opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX)
  96                             ? 2 : !!sp->opts->lvert + !!sp->opts->rvert;
  97                         for (ic = 0; ic < sp->opts->cols; ic++)
  98                                 tsz += tp->tbl.cols[ic].width + 3;
  99                         tsz -= 3;
 100                         if (offset + tsz > tp->tcol->rmargin)
 101                                 tsz -= 1;
 102                         tp->tcol->offset = offset + tp->tcol->rmargin > tsz ?
 103                             (offset + tp->tcol->rmargin - tsz) / 2 : 0;
 104                 }
 105
 106                 /* Horizontal frame at the start of boxed tables. */
 107
 108                 if (sp->opts->opts & TBL_OPT_DBOX)
 109                         tbl_hrule(tp, sp, 2);
 110                 if (sp->opts->opts & (TBL_OPT_DBOX | TBL_OPT_BOX))
 111                         tbl_hrule(tp, sp, 1);
 112         }
 113
 114         /* Vertical frame at the start of each row. */
 115
 116         horiz = sp->pos == TBL_SPAN_HORIZ || sp->pos == TBL_SPAN_DHORIZ;
 117
 118         if (sp->layout->vert ||
 119             (sp->prev != NULL && sp->prev->layout->vert) ||
 120             sp->opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX))
 121                 term_word(tp, horiz ? "+" : "|");
 122         else if (sp->opts->lvert)
 123                 tbl_char(tp, horiz ? '-' : ASCII_NBRSP, 1);
 124
 125         /*
 126          * Now print the actual data itself depending on the span type.
 127          * Match data cells to column numbers.
 128          */
 129
 130         if (sp->pos == TBL_SPAN_DATA) {
 131                 cp = sp->layout->first;
 132                 dp = sp->first;
 133                 spans = 0;
 134                 for (ic = 0; ic < sp->opts->cols; ic++) {
 135
 136                         /*
 137                          * Remeber whether we need a vertical bar
 138                          * after this cell.
 139                          */
 140
 141                         vert = cp == NULL ? 0 : cp->vert;
 142
 143                         /*
 144                          * Print the data and advance to the next cell.
 145                          */
 146
 147                         if (spans == 0) {
 148                                 tbl_data(tp, sp->opts, dp, tp->tbl.cols + ic);
 149                                 if (dp != NULL) {
 150                                         spans = dp->spans;
 151                                         dp = dp->next;
 152                                 }
 153                         } else
 154                                 spans--;
 155                         if (cp != NULL)
 156                                 cp = cp->next;
 157
 158                         /*
 159                          * Separate columns, except in the middle
 160                          * of spans and after the last cell.
 161                          */
 162
 163                         if (ic + 1 == sp->opts->cols || spans)
 164                                 continue;
 165
 166                         tbl_char(tp, ASCII_NBRSP, 1);
 167                         if (vert > 0)
 168                                 tbl_char(tp, '|', vert);
 169                         if (vert < 2)
 170                                 tbl_char(tp, ASCII_NBRSP, 2 - vert);
 171                 }
 172         } else if (horiz)
 173                 tbl_hrule(tp, sp, 0);
 174
 175         /* Vertical frame at the end of each row. */
 176
 177         if (sp->layout->last->vert ||
 178             (sp->prev != NULL && sp->prev->layout->last->vert) ||
 179             (sp->opts->opts & (TBL_OPT_BOX | TBL_OPT_DBOX)))
 180                 term_word(tp, horiz ? "+" : " |");
 181         else if (sp->opts->rvert)
 182                 tbl_char(tp, horiz ? '-' : ASCII_NBRSP, 1);
 183         term_flushln(tp);
 184
 185         /*
 186          * If we're the last row, clean up after ourselves: clear the
 187          * existing table configuration and set it to NULL.
 188          */
 189
 190         if (sp->next == NULL) {
 191                 if (sp->opts->opts & (TBL_OPT_DBOX | TBL_OPT_BOX)) {
 192                         tbl_hrule(tp, sp, 1);
 193                         tp->skipvsp = 1;
 194                 }
 195                 if (sp->opts->opts & TBL_OPT_DBOX) {
 196                         tbl_hrule(tp, sp, 2);
 197                         tp->skipvsp = 2;
 198                 }
 199                 assert(tp->tbl.cols);
 200                 free(tp->tbl.cols);
 201                 tp->tbl.cols = NULL;
 202                 tp->tcol->offset = offset;
 203         }
 204         tp->flags &= ~(TERMP_NONOSPACE | TERMP_BRNEVER);
 205 }
 206
 207 /*
 208  * Kinds of horizontal rulers:
 209  * 0: inside the table (single or double line with crossings)
 210  * 1: inner frame (single line with crossings and ends)
 211  * 2: outer frame (single line without crossings with ends)
 212  */
 213 static void
 214 tbl_hrule(struct termp *tp, const struct tbl_span *sp, int kind)
 215 {
 216         const struct tbl_cell *c1, *c2;
 217         int      vert;
 218         char     line, cross;
 219
 220         line = (kind == 0 && TBL_SPAN_DHORIZ == sp->pos) ? '=' : '-';
 221         cross = (kind < 2) ? '+' : '-';
 222
 223         if (kind)
 224                 term_word(tp, "+");
 225         c1 = sp->layout->first;
 226         c2 = sp->prev == NULL ? NULL : sp->prev->layout->first;
 227         if (c2 == c1)
 228                 c2 = NULL;
 229         for (;;) {
 230                 tbl_char(tp, line, tp->tbl.cols[c1->col].width + 1);
 231                 vert = c1->vert;
 232                 if ((c1 = c1->next) == NULL)
 233                          break;
 234                 if (c2 != NULL) {
 235                         if (vert < c2->vert)
 236                                 vert = c2->vert;
 237                         c2 = c2->next;
 238                 }
 239                 if (vert)
 240                         tbl_char(tp, cross, vert);
 241                 if (vert < 2)
 242                         tbl_char(tp, line, 2 - vert);
 243         }
 244         if (kind) {
 245                 term_word(tp, "+");
 246                 term_flushln(tp);
 247         }
 248 }
 249
 250 static void
 251 tbl_data(struct termp *tp, const struct tbl_opts *opts,
 252         const struct tbl_dat *dp,
 253         const struct roffcol *col)
 254 {
 255
 256         if (dp == NULL) {
 257                 tbl_char(tp, ASCII_NBRSP, col->width);
 258                 return;
 259         }
 260
 261         switch (dp->pos) {
 262         case TBL_DATA_NONE:
 263                 tbl_char(tp, ASCII_NBRSP, col->width);
 264                 return;
 265         case TBL_DATA_HORIZ:
 266         case TBL_DATA_NHORIZ:
 267                 tbl_char(tp, '-', col->width);
 268                 return;
 269         case TBL_DATA_NDHORIZ:
 270         case TBL_DATA_DHORIZ:
 271                 tbl_char(tp, '=', col->width);
 272                 return;
 273         default:
 274                 break;
 275         }
 276
 277         switch (dp->layout->pos) {
 278         case TBL_CELL_HORIZ:
 279                 tbl_char(tp, '-', col->width);
 280                 break;
 281         case TBL_CELL_DHORIZ:
 282                 tbl_char(tp, '=', col->width);
 283                 break;
 284         case TBL_CELL_LONG:
 285         case TBL_CELL_CENTRE:
 286         case TBL_CELL_LEFT:
 287         case TBL_CELL_RIGHT:
 288                 tbl_literal(tp, dp, col);
 289                 break;
 290         case TBL_CELL_NUMBER:
 291                 tbl_number(tp, opts, dp, col);
 292                 break;
 293         case TBL_CELL_DOWN:
 294                 tbl_char(tp, ASCII_NBRSP, col->width);
 295                 break;
 296         default:
 297                 abort();
 298         }
 299 }
 300
 301 static void
 302 tbl_char(struct termp *tp, char c, size_t len)
 303 {
 304         size_t          i, sz;
 305         char            cp[2];
 306
 307         cp[0] = c;
 308         cp[1] = '\0';
 309
 310         sz = term_strlen(tp, cp);
 311
 312         for (i = 0; i < len; i += sz)
 313                 term_word(tp, cp);
 314 }
 315
 316 static void
 317 tbl_literal(struct termp *tp, const struct tbl_dat *dp,
 318                 const struct roffcol *col)
 319 {
 320         size_t           len, padl, padr, width;
 321         int              ic, spans;
 322
 323         assert(dp->string);
 324         len = term_strlen(tp, dp->string);
 325         width = col->width;
 326         ic = dp->layout->col;
 327         spans = dp->spans;
 328         while (spans--)
 329                 width += tp->tbl.cols[++ic].width + 3;
 330
 331         padr = width > len ? width - len : 0;
 332         padl = 0;
 333
 334         switch (dp->layout->pos) {
 335         case TBL_CELL_LONG:
 336                 padl = term_len(tp, 1);
 337                 padr = padr > padl ? padr - padl : 0;
 338                 break;
 339         case TBL_CELL_CENTRE:
 340                 if (2 > padr)
 341                         break;
 342                 padl = padr / 2;
 343                 padr -= padl;
 344                 break;
 345         case TBL_CELL_RIGHT:
 346                 padl = padr;
 347                 padr = 0;
 348                 break;
 349         default:
 350                 break;
 351         }
 352
 353         tbl_char(tp, ASCII_NBRSP, padl);
 354         tbl_word(tp, dp);
 355         tbl_char(tp, ASCII_NBRSP, padr);
 356 }
 357
 358 static void
 359 tbl_number(struct termp *tp, const struct tbl_opts *opts,
 360                 const struct tbl_dat *dp,
 361                 const struct roffcol *col)
 362 {
 363         char            *cp;
 364         char             buf[2];
 365         size_t           sz, psz, ssz, d, padl;
 366         int              i;
 367
 368         /*
 369          * See calc_data_number().  Left-pad by taking the offset of our
 370          * and the maximum decimal; right-pad by the remaining amount.
 371          */
 372
 373         assert(dp->string);
 374
 375         sz = term_strlen(tp, dp->string);
 376
 377         buf[0] = opts->decimal;
 378         buf[1] = '\0';
 379
 380         psz = term_strlen(tp, buf);
 381
 382         if ((cp = strrchr(dp->string, opts->decimal)) != NULL) {
 383                 for (ssz = 0, i = 0; cp != &dp->string[i]; i++) {
 384                         buf[0] = dp->string[i];
 385                         ssz += term_strlen(tp, buf);
 386                 }
 387                 d = ssz + psz;
 388         } else
 389                 d = sz + psz;
 390
 391         if (col->decimal > d && col->width > sz) {
 392                 padl = col->decimal - d;
 393                 if (padl + sz > col->width)
 394                         padl = col->width - sz;
 395                 tbl_char(tp, ASCII_NBRSP, padl);
 396         } else
 397                 padl = 0;
 398         tbl_word(tp, dp);
 399         if (col->width > sz + padl)
 400                 tbl_char(tp, ASCII_NBRSP, col->width - sz - padl);
 401 }
 402
 403 static void
 404 tbl_word(struct termp *tp, const struct tbl_dat *dp)
 405 {
 406         int              prev_font;
 407
 408         prev_font = tp->fonti;
 409         if (dp->layout->flags & TBL_CELL_BOLD)
 410                 term_fontpush(tp, TERMFONT_BOLD);
 411         else if (dp->layout->flags & TBL_CELL_ITALIC)
 412                 term_fontpush(tp, TERMFONT_UNDER);
 413
 414         term_word(tp, dp->string);
 415
 416         term_fontpopq(tp, prev_font);
 417 }