term_ascii.c

   1 /*      $Id: term_ascii.c,v 1.28 2014/08/10 23:54:41 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 #ifdef USE_WCHAR
  23 #include <locale.h>
  24 #endif
  25 #include <stdint.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <unistd.h>
  29 #ifdef USE_WCHAR
  30 #include <wchar.h>
  31 #endif
  32
  33 #include "mandoc.h"
  34 #include "mandoc_aux.h"
  35 #include "out.h"
  36 #include "term.h"
  37 #include "main.h"
  38
  39 /*
  40  * Sadly, this doesn't seem to be defined on systems even when they
  41  * support it.  For the time being, remove it and let those compiling
  42  * the software decide for themselves what to use.
  43  */
  44 #if 0
  45 #if ! defined(__STDC_ISO_10646__)
  46 # undef USE_WCHAR
  47 #endif
  48 #endif
  49
  50 static  struct termp     *ascii_init(enum termenc, char *);
  51 static  double            ascii_hspan(const struct termp *,
  52                                 const struct roffsu *);
  53 static  size_t            ascii_width(const struct termp *, int);
  54 static  void              ascii_advance(struct termp *, size_t);
  55 static  void              ascii_begin(struct termp *);
  56 static  void              ascii_end(struct termp *);
  57 static  void              ascii_endline(struct termp *);
  58 static  void              ascii_letter(struct termp *, int);
  59 static  void              ascii_setwidth(struct termp *, int, size_t);
  60
  61 #ifdef  USE_WCHAR
  62 static  void              locale_advance(struct termp *, size_t);
  63 static  void              locale_endline(struct termp *);
  64 static  void              locale_letter(struct termp *, int);
  65 static  size_t            locale_width(const struct termp *, int);
  66 #endif
  67
  68
  69 static struct termp *
  70 ascii_init(enum termenc enc, char *outopts)
  71 {
  72         const char      *toks[4];
  73         char            *v;
  74         struct termp    *p;
  75
  76         p = mandoc_calloc(1, sizeof(struct termp));
  77
  78         p->tabwidth = 5;
  79         p->defrmargin = p->lastrmargin = 78;
  80
  81         p->begin = ascii_begin;
  82         p->end = ascii_end;
  83         p->hspan = ascii_hspan;
  84         p->type = TERMTYPE_CHAR;
  85
  86         p->enc = TERMENC_ASCII;
  87         p->advance = ascii_advance;
  88         p->endline = ascii_endline;
  89         p->letter = ascii_letter;
  90         p->setwidth = ascii_setwidth;
  91         p->width = ascii_width;
  92
  93 #ifdef  USE_WCHAR
  94         if (TERMENC_ASCII != enc) {
  95                 v = TERMENC_LOCALE == enc ?
  96                     setlocale(LC_ALL, "") :
  97                     setlocale(LC_CTYPE, "en_US.UTF-8");
  98                 if (NULL != v && MB_CUR_MAX > 1) {
  99                         p->enc = enc;
 100                         p->advance = locale_advance;
 101                         p->endline = locale_endline;
 102                         p->letter = locale_letter;
 103                         p->width = locale_width;
 104                 }
 105         }
 106 #endif
 107
 108         toks[0] = "indent";
 109         toks[1] = "width";
 110         toks[2] = "mdoc";
 111         toks[3] = NULL;
 112
 113         while (outopts && *outopts)
 114                 switch (getsubopt(&outopts, UNCONST(toks), &v)) {
 115                 case 0:
 116                         p->defindent = (size_t)atoi(v);
 117                         break;
 118                 case 1:
 119                         p->defrmargin = (size_t)atoi(v);
 120                         break;
 121                 case 2:
 122                         /*
 123                          * Temporary, undocumented mode
 124                          * to imitate mdoc(7) output style.
 125                          */
 126                         p->mdocstyle = 1;
 127                         p->defindent = 5;
 128                         break;
 129                 default:
 130                         break;
 131                 }
 132
 133         /* Enforce a lower boundary. */
 134         if (p->defrmargin < 58)
 135                 p->defrmargin = 58;
 136
 137         return(p);
 138 }
 139
 140 void *
 141 ascii_alloc(char *outopts)
 142 {
 143
 144         return(ascii_init(TERMENC_ASCII, outopts));
 145 }
 146
 147 void *
 148 utf8_alloc(char *outopts)
 149 {
 150
 151         return(ascii_init(TERMENC_UTF8, outopts));
 152 }
 153
 154 void *
 155 locale_alloc(char *outopts)
 156 {
 157
 158         return(ascii_init(TERMENC_LOCALE, outopts));
 159 }
 160
 161 static void
 162 ascii_setwidth(struct termp *p, int iop, size_t width)
 163 {
 164
 165         p->rmargin = p->defrmargin;
 166         if (0 < iop)
 167                 p->defrmargin += width;
 168         else if (0 > iop)
 169                 p->defrmargin -= width;
 170         else
 171                 p->defrmargin = width ? width : p->lastrmargin;
 172         p->lastrmargin = p->rmargin;
 173         p->rmargin = p->maxrmargin = p->defrmargin;
 174 }
 175
 176 static size_t
 177 ascii_width(const struct termp *p, int c)
 178 {
 179
 180         return(1);
 181 }
 182
 183 void
 184 ascii_free(void *arg)
 185 {
 186
 187         term_free((struct termp *)arg);
 188 }
 189
 190 static void
 191 ascii_letter(struct termp *p, int c)
 192 {
 193
 194         putchar(c);
 195 }
 196
 197 static void
 198 ascii_begin(struct termp *p)
 199 {
 200
 201         (*p->headf)(p, p->argf);
 202 }
 203
 204 static void
 205 ascii_end(struct termp *p)
 206 {
 207
 208         (*p->footf)(p, p->argf);
 209 }
 210
 211 static void
 212 ascii_endline(struct termp *p)
 213 {
 214
 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 double
 228 ascii_hspan(const struct termp *p, const struct roffsu *su)
 229 {
 230         double           r;
 231
 232         /*
 233          * Approximate based on character width.  These are generated
 234          * entirely by eyeballing the screen, but appear to be correct.
 235          */
 236
 237         switch (su->unit) {
 238         case SCALE_CM:
 239                 r = su->scale * 4.0;
 240                 break;
 241         case SCALE_IN:
 242                 r = su->scale * 10.0;
 243                 break;
 244         case SCALE_PC:
 245                 r = (su->scale * 10.0) / 6.0;
 246                 break;
 247         case SCALE_PT:
 248                 r = (su->scale * 10.0) / 72.0;
 249                 break;
 250         case SCALE_MM:
 251                 r = su->scale / 1000.0;
 252                 break;
 253         case SCALE_VS:
 254                 r = su->scale * 2.0 - 1.0;
 255                 break;
 256         default:
 257                 r = su->scale;
 258                 break;
 259         }
 260
 261         return(r);
 262 }
 263
 264 #ifdef USE_WCHAR
 265 static size_t
 266 locale_width(const struct termp *p, int c)
 267 {
 268         int             rc;
 269
 270         if (c == ASCII_NBRSP)
 271                 c = ' ';
 272         rc = wcwidth(c);
 273         if (rc < 0)
 274                 rc = 0;
 275         return(rc);
 276 }
 277
 278 static void
 279 locale_advance(struct termp *p, size_t len)
 280 {
 281         size_t          i;
 282
 283         for (i = 0; i < len; i++)
 284                 putwchar(L' ');
 285 }
 286
 287 static void
 288 locale_endline(struct termp *p)
 289 {
 290
 291         putwchar(L'\n');
 292 }
 293
 294 static void
 295 locale_letter(struct termp *p, int c)
 296 {
 297
 298         putwchar(c);
 299 }
 300 #endif