contrib/mdocml/term_ascii.c

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