term_ascii.c

   1 /*      $Id: term_ascii.c,v 1.50 2015/10/12 00:08:16 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4  * Copyright (c) 2014, 2015 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 AUTHORS DISCLAIM ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 #if HAVE_WCHAR
  24 #include <locale.h>
  25 #endif
  26 #include <stdint.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <unistd.h>
  30 #if HAVE_WCHAR
  31 #include <wchar.h>
  32 #endif
  33
  34 #include "mandoc.h"
  35 #include "mandoc_aux.h"
  36 #include "out.h"
  37 #include "term.h"
  38 #include "manconf.h"
  39 #include "main.h"
  40
  41 static  struct termp     *ascii_init(enum termenc, const struct mchars *,
  42                                 const struct manoutput *);
  43 static  int               ascii_hspan(const struct termp *,
  44                                 const struct roffsu *);
  45 static  size_t            ascii_width(const struct termp *, int);
  46 static  void              ascii_advance(struct termp *, size_t);
  47 static  void              ascii_begin(struct termp *);
  48 static  void              ascii_end(struct termp *);
  49 static  void              ascii_endline(struct termp *);
  50 static  void              ascii_letter(struct termp *, int);
  51 static  void              ascii_setwidth(struct termp *, int, int);
  52
  53 #if HAVE_WCHAR
  54 static  void              locale_advance(struct termp *, size_t);
  55 static  void              locale_endline(struct termp *);
  56 static  void              locale_letter(struct termp *, int);
  57 static  size_t            locale_width(const struct termp *, int);
  58 #endif
  59
  60
  61 static struct termp *
  62 ascii_init(enum termenc enc, const struct mchars *mchars,
  63         const struct manoutput *outopts)
  64 {
  65 #if HAVE_WCHAR
  66         char            *v;
  67 #endif
  68         struct termp    *p;
  69
  70         p = mandoc_calloc(1, sizeof(struct termp));
  71
  72         p->symtab = mchars;
  73         p->line = 1;
  74         p->tabwidth = 5;
  75         p->defrmargin = p->lastrmargin = 78;
  76         p->fontq = mandoc_reallocarray(NULL,
  77              (p->fontsz = 8), sizeof(enum termfont));
  78         p->fontq[0] = p->fontl = TERMFONT_NONE;
  79
  80         p->begin = ascii_begin;
  81         p->end = ascii_end;
  82         p->hspan = ascii_hspan;
  83         p->type = TERMTYPE_CHAR;
  84
  85         p->enc = TERMENC_ASCII;
  86         p->advance = ascii_advance;
  87         p->endline = ascii_endline;
  88         p->letter = ascii_letter;
  89         p->setwidth = ascii_setwidth;
  90         p->width = ascii_width;
  91
  92 #if HAVE_WCHAR
  93         if (TERMENC_ASCII != enc) {
  94                 v = TERMENC_LOCALE == enc ?
  95                     setlocale(LC_ALL, "") :
  96                     setlocale(LC_CTYPE, "en_US.UTF-8");
  97                 if (NULL != v && MB_CUR_MAX > 1) {
  98                         p->enc = enc;
  99                         p->advance = locale_advance;
 100                         p->endline = locale_endline;
 101                         p->letter = locale_letter;
 102                         p->width = locale_width;
 103                 }
 104         }
 105 #endif
 106
 107         if (outopts->mdoc) {
 108                 p->mdocstyle = 1;
 109                 p->defindent = 5;
 110         }
 111         if (outopts->indent)
 112                 p->defindent = outopts->indent;
 113         if (outopts->width)
 114                 p->defrmargin = outopts->width;
 115         if (outopts->synopsisonly)
 116                 p->synopsisonly = 1;
 117
 118         return p;
 119 }
 120
 121 void *
 122 ascii_alloc(const struct mchars *mchars, const struct manoutput *outopts)
 123 {
 124
 125         return ascii_init(TERMENC_ASCII, mchars, outopts);
 126 }
 127
 128 void *
 129 utf8_alloc(const struct mchars *mchars, const struct manoutput *outopts)
 130 {
 131
 132         return ascii_init(TERMENC_UTF8, mchars, outopts);
 133 }
 134
 135 void *
 136 locale_alloc(const struct mchars *mchars, const struct manoutput *outopts)
 137 {
 138
 139         return ascii_init(TERMENC_LOCALE, mchars, outopts);
 140 }
 141
 142 static void
 143 ascii_setwidth(struct termp *p, int iop, int width)
 144 {
 145
 146         width /= 24;
 147         p->rmargin = p->defrmargin;
 148         if (iop > 0)
 149                 p->defrmargin += width;
 150         else if (iop == 0)
 151                 p->defrmargin = width ? (size_t)width : p->lastrmargin;
 152         else if (p->defrmargin > (size_t)width)
 153                 p->defrmargin -= width;
 154         else
 155                 p->defrmargin = 0;
 156         p->lastrmargin = p->rmargin;
 157         p->rmargin = p->maxrmargin = p->defrmargin;
 158 }
 159
 160 void
 161 ascii_sepline(void *arg)
 162 {
 163         struct termp    *p;
 164         size_t           i;
 165
 166         p = (struct termp *)arg;
 167         p->line += 3;
 168         putchar('\n');
 169         for (i = 0; i < p->defrmargin; i++)
 170                 putchar('-');
 171         putchar('\n');
 172         putchar('\n');
 173 }
 174
 175 static size_t
 176 ascii_width(const struct termp *p, int c)
 177 {
 178
 179         return 1;
 180 }
 181
 182 void
 183 ascii_free(void *arg)
 184 {
 185
 186         term_free((struct termp *)arg);
 187 }
 188
 189 static void
 190 ascii_letter(struct termp *p, int c)
 191 {
 192
 193         putchar(c);
 194 }
 195
 196 static void
 197 ascii_begin(struct termp *p)
 198 {
 199
 200         (*p->headf)(p, p->argf);
 201 }
 202
 203 static void
 204 ascii_end(struct termp *p)
 205 {
 206
 207         (*p->footf)(p, p->argf);
 208 }
 209
 210 static void
 211 ascii_endline(struct termp *p)
 212 {
 213
 214         p->line++;
 215         putchar('\n');
 216 }
 217
 218 static void
 219 ascii_advance(struct termp *p, size_t len)
 220 {
 221         size_t          i;
 222
 223         for (i = 0; i < len; i++)
 224                 putchar(' ');
 225 }
 226
 227 static int
 228 ascii_hspan(const struct termp *p, const struct roffsu *su)
 229 {
 230         double           r;
 231
 232         switch (su->unit) {
 233         case SCALE_BU:
 234                 r = su->scale;
 235                 break;
 236         case SCALE_CM:
 237                 r = su->scale * 240.0 / 2.54;
 238                 break;
 239         case SCALE_FS:
 240                 r = su->scale * 65536.0;
 241                 break;
 242         case SCALE_IN:
 243                 r = su->scale * 240.0;
 244                 break;
 245         case SCALE_MM:
 246                 r = su->scale * 0.24;
 247                 break;
 248         case SCALE_VS:
 249         case SCALE_PC:
 250                 r = su->scale * 40.0;
 251                 break;
 252         case SCALE_PT:
 253                 r = su->scale * 10.0 / 3.0;
 254                 break;
 255         case SCALE_EN:
 256         case SCALE_EM:
 257                 r = su->scale * 24.0;
 258                 break;
 259         default:
 260                 abort();
 261         }
 262         return r > 0.0 ? r + 0.01 : r - 0.01;
 263 }
 264
 265 const char *
 266 ascii_uc2str(int uc)
 267 {
 268         static const char nbrsp[2] = { ASCII_NBRSP, '\0' };
 269         static const char *tab[] = {
 270         "<NUL>","<SOH>","<STX>","<ETX>","<EOT>","<ENQ>","<ACK>","<BEL>",
 271         "<BS>", "\t",   "<LF>", "<VT>", "<FF>", "<CR>", "<SO>", "<SI>",
 272         "<DLE>","<DC1>","<DC2>","<DC3>","<DC4>","<NAK>","<SYN>","<ETB>",
 273         "<CAN>","<EM>", "<SUB>","<ESC>","<FS>", "<GS>", "<RS>", "<US>",
 274         " ",    "!",    "\"",   "#",    "$",    "%",    "&",    "'",
 275         "(",    ")",    "*",    "+",    ",",    "-",    ".",    "/",
 276         "0",    "1",    "2",    "3",    "4",    "5",    "6",    "7",
 277         "8",    "9",    ":",    ";",    "<",    "=",    ">",    "?",
 278         "@",    "A",    "B",    "C",    "D",    "E",    "F",    "G",
 279         "H",    "I",    "J",    "K",    "L",    "M",    "N",    "O",
 280         "P",    "Q",    "R",    "S",    "T",    "U",    "V",    "W",
 281         "X",    "Y",    "Z",    "[",    "\\",   "]",    "^",    "_",
 282         "`",    "a",    "b",    "c",    "d",    "e",    "f",    "g",
 283         "h",    "i",    "j",    "k",    "l",    "m",    "n",    "o",
 284         "p",    "q",    "r",    "s",    "t",    "u",    "v",    "w",
 285         "x",    "y",    "z",    "{",    "|",    "}",    "~",    "<DEL>",
 286         "<80>", "<81>", "<82>", "<83>", "<84>", "<85>", "<86>", "<87>",
 287         "<88>", "<89>", "<8A>", "<8B>", "<8C>", "<8D>", "<8E>", "<8F>",
 288         "<90>", "<91>", "<92>", "<93>", "<94>", "<95>", "<96>", "<97>",
 289         "<99>", "<99>", "<9A>", "<9B>", "<9C>", "<9D>", "<9E>", "<9F>",
 290         nbrsp,  "!",    "/\bc", "GBP",  "o\bx", "=\bY", "|",    "<sec>",
 291         "\"",   "(C)",  "_\ba", "<<",   "~",    "",     "(R)",  "-",
 292         "<deg>","+-",   "2",    "3",    "'",    ",\bu", "<par>",".",
 293         ",",    "1",    "_\bo", ">>",   "1/4",  "1/2",  "3/4",  "?",
 294         "`\bA", "'\bA", "^\bA", "~\bA", "\"\bA","o\bA", "AE",   ",\bC",
 295         "`\bE", "'\bE", "^\bE", "\"\bE","`\bI", "'\bI", "^\bI", "\"\bI",
 296         "-\bD", "~\bN", "`\bO", "'\bO", "^\bO", "~\bO", "\"\bO","x",
 297         "/\bO", "`\bU", "'\bU", "^\bU", "\"\bU","'\bY", "Th",   "ss",
 298         "`\ba", "'\ba", "^\ba", "~\ba", "\"\ba","o\ba", "ae",   ",\bc",
 299         "`\be", "'\be", "^\be", "\"\be","`\bi", "'\bi", "^\bi", "\"\bi",
 300         "d",    "~\bn", "`\bo", "'\bo", "^\bo", "~\bo", "\"\bo","-:-",
 301         "/\bo", "`\bu", "'\bu", "^\bu", "\"\bu","'\by", "th",   "\"\by",
 302         "A",    "a",    "A",    "a",    "A",    "a",    "'\bC", "'\bc",
 303         "^\bC", "^\bc", "C",    "c",    "C",    "c",    "D",    "d",
 304         "/\bD", "/\bd", "E",    "e",    "E",    "e",    "E",    "e",
 305         "E",    "e",    "E",    "e",    "^\bG", "^\bg", "G",    "g",
 306         "G",    "g",    ",\bG", ",\bg", "^\bH", "^\bh", "/\bH", "/\bh",
 307         "~\bI", "~\bi", "I",    "i",    "I",    "i",    "I",    "i",
 308         "I",    "i",    "IJ",   "ij",   "^\bJ", "^\bj", ",\bK", ",\bk",
 309         "q",    "'\bL", "'\bl", ",\bL", ",\bl", "L",    "l",    "L",
 310         "l",    "/\bL", "/\bl", "'\bN", "'\bn", ",\bN", ",\bn", "N",
 311         "n",    "'n",   "Ng",   "ng",   "O",    "o",    "O",    "o",
 312         "O",    "o",    "OE",   "oe",   "'\bR", "'\br", ",\bR", ",\br",
 313         "R",    "r",    "'\bS", "'\bs", "^\bS", "^\bs", ",\bS", ",\bs",
 314         "S",    "s",    ",\bT", ",\bt", "T",    "t",    "/\bT", "/\bt",
 315         "~\bU", "~\bu", "U",    "u",    "U",    "u",    "U",    "u",
 316         "U",    "u",    "U",    "u",    "^\bW", "^\bw", "^\bY", "^\by",
 317         "\"\bY","'\bZ", "'\bz", "Z",    "z",    "Z",    "z",    "s",
 318         "b",    "B",    "B",    "b",    "6",    "6",    "O",    "C",
 319         "c",    "D",    "D",    "D",    "d",    "d",    "3",    "@",
 320         "E",    "F",    ",\bf", "G",    "G",    "hv",   "I",    "/\bI",
 321         "K",    "k",    "/\bl", "l",    "W",    "N",    "n",    "~\bO",
 322         "O",    "o",    "OI",   "oi",   "P",    "p",    "YR",   "2",
 323         "2",    "SH",   "sh",   "t",    "T",    "t",    "T",    "U",
 324         "u",    "Y",    "V",    "Y",    "y",    "/\bZ", "/\bz", "ZH",
 325         "ZH",   "zh",   "zh",   "/\b2", "5",    "5",    "ts",   "w",
 326         "|",    "||",   "|=",   "!",    "DZ",   "Dz",   "dz",   "LJ",
 327         "Lj",   "lj",   "NJ",   "Nj",   "nj",   "A",    "a",    "I",
 328         "i",    "O",    "o",    "U",    "u",    "U",    "u",    "U",
 329         "u",    "U",    "u",    "U",    "u",    "@",    "A",    "a",
 330         "A",    "a",    "AE",   "ae",   "/\bG", "/\bg", "G",    "g",
 331         "K",    "k",    "O",    "o",    "O",    "o",    "ZH",   "zh",
 332         "j",    "DZ",   "Dz",   "dz",   "'\bG", "'\bg", "HV",   "W",
 333         "`\bN", "`\bn", "A",    "a",    "'\bAE","'\bae","O",    "o"};
 334
 335         assert(uc >= 0);
 336         if ((size_t)uc < sizeof(tab)/sizeof(tab[0]))
 337                 return tab[uc];
 338         return mchars_uc2str(uc);
 339 }
 340
 341 #if HAVE_WCHAR
 342 static size_t
 343 locale_width(const struct termp *p, int c)
 344 {
 345         int             rc;
 346
 347         if (c == ASCII_NBRSP)
 348                 c = ' ';
 349         rc = wcwidth(c);
 350         if (rc < 0)
 351                 rc = 0;
 352         return rc;
 353 }
 354
 355 static void
 356 locale_advance(struct termp *p, size_t len)
 357 {
 358         size_t          i;
 359
 360         for (i = 0; i < len; i++)
 361                 putwchar(L' ');
 362 }
 363
 364 static void
 365 locale_endline(struct termp *p)
 366 {
 367
 368         p->line++;
 369         putwchar(L'\n');
 370 }
 371
 372 static void
 373 locale_letter(struct termp *p, int c)
 374 {
 375
 376         putwchar(c);
 377 }
 378 #endif