improve documentation of .Fa, .Va, and .Vt;

[mandoc.git] / term_ascii.c

diff --git a/term_ascii.c b/term_ascii.c
index 3b4ca241196dc1582f038cd8f2cc662775e89a28..887710a208c213133f5e40a24db9c28f31a496e7 100644 (file)
--- a/term_ascii.c
+++ b/term_ascii.c
@@ -1,6 +1,7 @@
-/*     $Id: term_ascii.c,v 1.16 2011/05/19 15:48:58 kristaps Exp $ */
+/*     $Id: term_ascii.c,v 1.33 2014/09/03 05:22:45 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -14,40 +15,27 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */

-#ifdef HAVE_CONFIG_H

 #include "config.h"
 #include "config.h"

-#endif

 
 #include <sys/types.h>
 
 
 #include <sys/types.h>
 

-#include <assert.h>
-#ifdef USE_WCHAR
-# include <locale.h>
+#if HAVE_WCHAR
+#include <locale.h>

 #endif
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
 #endif
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>

-#ifdef USE_WCHAR
-# include <wchar.h>
+#if HAVE_WCHAR
+#include <wchar.h>

 #endif
 
 #include "mandoc.h"
 #endif
 
 #include "mandoc.h"

+#include "mandoc_aux.h"

 #include "out.h"
 #include "term.h"
 #include "main.h"
 
 #include "out.h"
 #include "term.h"
 #include "main.h"
 

-/* 
- * Sadly, this doesn't seem to be defined on systems even when they
- * support it.  For the time being, remove it and let those compiling
- * the software decide for themselves what to use.
- */
-#if 0
-#if ! defined(__STDC_ISO_10646__)
-# undef USE_WCHAR
-#endif
-#endif
-

 static struct termp     *ascii_init(enum termenc, char *);
 static double            ascii_hspan(const struct termp *,
                                const struct roffsu *);
 static struct termp     *ascii_init(enum termenc, char *);
 static double            ascii_hspan(const struct termp *,
                                const struct roffsu *);


@@ -57,26 +45,27 @@ static      void              ascii_begin(struct termp *);
 static void              ascii_end(struct termp *);
 static void              ascii_endline(struct termp *);
 static void              ascii_letter(struct termp *, int);
 static void              ascii_end(struct termp *);
 static void              ascii_endline(struct termp *);
 static void              ascii_letter(struct termp *, int);

+static void              ascii_setwidth(struct termp *, int, size_t);

 
 

-#ifdef USE_WCHAR
+#if HAVE_WCHAR

 static void              locale_advance(struct termp *, size_t);
 static void              locale_endline(struct termp *);
 static void              locale_letter(struct termp *, int);
 static size_t            locale_width(const struct termp *, int);
 #endif
 
 static void              locale_advance(struct termp *, size_t);
 static void              locale_endline(struct termp *);
 static void              locale_letter(struct termp *, int);
 static size_t            locale_width(const struct termp *, int);
 #endif
 

+

 static struct termp *
 ascii_init(enum termenc enc, char *outopts)
 {
 static struct termp *
 ascii_init(enum termenc enc, char *outopts)
 {

-       const char      *toks[2];
+       const char      *toks[5];

        char            *v;
        struct termp    *p;
 
        p = mandoc_calloc(1, sizeof(struct termp));
        char            *v;
        struct termp    *p;
 
        p = mandoc_calloc(1, sizeof(struct termp));

-       p->enc = enc;

 
        p->tabwidth = 5;
 
        p->tabwidth = 5;

-       p->defrmargin = 78;
+       p->defrmargin = p->lastrmargin = 78;

 
        p->begin = ascii_begin;
        p->end = ascii_end;
 
        p->begin = ascii_begin;
        p->end = ascii_end;


@@ -87,27 +76,49 @@ ascii_init(enum termenc enc, char *outopts)
        p->advance = ascii_advance;
        p->endline = ascii_endline;
        p->letter = ascii_letter;
        p->advance = ascii_advance;
        p->endline = ascii_endline;
        p->letter = ascii_letter;

+       p->setwidth = ascii_setwidth;

        p->width = ascii_width;
 
        p->width = ascii_width;
 

-#if defined (USE_WCHAR)
-       if (TERMENC_LOCALE == enc)
-               if (setlocale(LC_ALL, "") && MB_CUR_MAX > 1) {
+#if HAVE_WCHAR
+       if (TERMENC_ASCII != enc) {
+               v = TERMENC_LOCALE == enc ?
+                   setlocale(LC_ALL, "") :
+                   setlocale(LC_CTYPE, "en_US.UTF-8");
+               if (NULL != v && MB_CUR_MAX > 1) {

                        p->enc = enc;
                        p->advance = locale_advance;
                        p->endline = locale_endline;
                        p->letter = locale_letter;
                        p->width = locale_width;
                }
                        p->enc = enc;
                        p->advance = locale_advance;
                        p->endline = locale_endline;
                        p->letter = locale_letter;
                        p->width = locale_width;
                }

+       }

 #endif
 
 #endif
 

-       toks[0] = "width";
-       toks[1] = NULL;
+       toks[0] = "indent";
+       toks[1] = "width";
+       toks[2] = "mdoc";
+       toks[3] = "synopsis";
+       toks[4] = NULL;

 
        while (outopts && *outopts)
                switch (getsubopt(&outopts, UNCONST(toks), &v)) {
 
        while (outopts && *outopts)
                switch (getsubopt(&outopts, UNCONST(toks), &v)) {

-               case (0):
+               case 0:
+                       p->defindent = (size_t)atoi(v);
+                       break;
+               case 1:

                        p->defrmargin = (size_t)atoi(v);
                        break;
                        p->defrmargin = (size_t)atoi(v);
                        break;

+               case 2:
+                       /*
+                        * Temporary, undocumented mode
+                        * to imitate mdoc(7) output style.
+                        */
+                       p->mdocstyle = 1;
+                       p->defindent = 5;
+                       break;
+               case 3:
+                       p->synopsisonly = 1;
+                       break;

                default:
                        break;
                }
                default:
                        break;
                }


@@ -126,6 +137,13 @@ ascii_alloc(char *outopts)
        return(ascii_init(TERMENC_ASCII, outopts));
 }
 
        return(ascii_init(TERMENC_ASCII, outopts));
 }
 

+void *
+utf8_alloc(char *outopts)
+{
+
+       return(ascii_init(TERMENC_UTF8, outopts));
+}
+

 void *
 locale_alloc(char *outopts)
 {
 void *
 locale_alloc(char *outopts)
 {


@@ -133,7 +151,21 @@ locale_alloc(char *outopts)
        return(ascii_init(TERMENC_LOCALE, outopts));
 }
 
        return(ascii_init(TERMENC_LOCALE, outopts));
 }
 

-/* ARGSUSED */
+static void
+ascii_setwidth(struct termp *p, int iop, size_t width)
+{
+
+       p->rmargin = p->defrmargin;
+       if (0 < iop)
+               p->defrmargin += width;
+       else if (0 > iop)
+               p->defrmargin -= width;
+       else
+               p->defrmargin = width ? width : p->lastrmargin;
+       p->lastrmargin = p->rmargin;
+       p->rmargin = p->maxrmargin = p->defrmargin;
+}
+

 static size_t
 ascii_width(const struct termp *p, int c)
 {
 static size_t
 ascii_width(const struct termp *p, int c)
 {


@@ -148,11 +180,10 @@ ascii_free(void *arg)
        term_free((struct termp *)arg);
 }
 
        term_free((struct termp *)arg);
 }
 

-/* ARGSUSED */

 static void
 ascii_letter(struct termp *p, int c)
 {
 static void
 ascii_letter(struct termp *p, int c)
 {

-       
+

        putchar(c);
 }
 
        putchar(c);
 }
 


@@ -170,7 +201,6 @@ ascii_end(struct termp *p)
        (*p->footf)(p, p->argf);
 }
 
        (*p->footf)(p, p->argf);
 }
 

-/* ARGSUSED */

 static void
 ascii_endline(struct termp *p)
 {
 static void
 ascii_endline(struct termp *p)
 {


@@ -178,75 +208,86 @@ ascii_endline(struct termp *p)
        putchar('\n');
 }
 
        putchar('\n');
 }
 

-/* ARGSUSED */

 static void
 ascii_advance(struct termp *p, size_t len)
 {
 static void
 ascii_advance(struct termp *p, size_t len)
 {

-       size_t          i;
+       size_t          i;

 
        for (i = 0; i < len; i++)
                putchar(' ');
 }
 
 
        for (i = 0; i < len; i++)
                putchar(' ');
 }
 

-/* ARGSUSED */

 static double
 ascii_hspan(const struct termp *p, const struct roffsu *su)
 {
        double           r;
 
        /*
 static double
 ascii_hspan(const struct termp *p, const struct roffsu *su)
 {
        double           r;
 
        /*

-        * Approximate based on character width.  These are generated
-        * entirely by eyeballing the screen, but appear to be correct.
+        * Approximate based on character width.
+        * None of these will be actually correct given that an inch on
+        * the screen depends on character size, terminal, etc., etc.

         */
         */

-

        switch (su->unit) {
        switch (su->unit) {

-       case (SCALE_CM):
-               r = 4 * su->scale;
+       case SCALE_BU:
+               r = su->scale * 10.0 / 240.0;

                break;
                break;

-       case (SCALE_IN):
-               r = 10 * su->scale;
+       case SCALE_CM:
+               r = su->scale * 10.0 / 2.54;

                break;
                break;

-       case (SCALE_PC):
-               r = (10 * su->scale) / 6;
+       case SCALE_FS:
+               r = su->scale * 2730.666;

                break;
                break;

-       case (SCALE_PT):
-               r = (10 * su->scale) / 72;
+       case SCALE_IN:
+               r = su->scale * 10.0;

                break;
                break;

-       case (SCALE_MM):
-               r = su->scale / 1000;
+       case SCALE_MM:
+               r = su->scale / 100.0;

                break;
                break;

-       case (SCALE_VS):
-               r = su->scale * 2 - 1;
+       case SCALE_PC:
+               r = su->scale * 10.0 / 6.0;

                break;
                break;

-       default:
+       case SCALE_PT:
+               r = su->scale * 10.0 / 72.0;
+               break;
+       case SCALE_VS:
+               r = su->scale * 2.0 - 1.0;
+               break;
+       case SCALE_EN:
+               /* FALLTHROUGH */
+       case SCALE_EM:

                r = su->scale;
                break;
                r = su->scale;
                break;

+       default:
+               abort();
+               /* NOTREACHED */

        }
 
        return(r);
 }
 
        }
 
        return(r);
 }
 

-#ifdef USE_WCHAR
-/* ARGSUSED */
+#if HAVE_WCHAR

 static size_t
 locale_width(const struct termp *p, int c)
 {
        int             rc;
 
 static size_t
 locale_width(const struct termp *p, int c)
 {
        int             rc;
 

-       return((rc = wcwidth(c)) < 0 ? 0 : rc);
+       if (c == ASCII_NBRSP)
+               c = ' ';
+       rc = wcwidth(c);
+       if (rc < 0)
+               rc = 0;
+       return(rc);

 }
 
 }
 

-/* ARGSUSED */

 static void
 locale_advance(struct termp *p, size_t len)
 {
 static void
 locale_advance(struct termp *p, size_t len)
 {

-       size_t          i;
+       size_t          i;

 
        for (i = 0; i < len; i++)
                putwchar(L' ');
 }
 
 
        for (i = 0; i < len; i++)
                putwchar(L' ');
 }
 

-/* ARGSUSED */

 static void
 locale_endline(struct termp *p)
 {
 static void
 locale_endline(struct termp *p)
 {


@@ -254,11 +295,10 @@ locale_endline(struct termp *p)
        putwchar(L'\n');
 }
 
        putwchar(L'\n');
 }
 

-/* ARGSUSED */

 static void
 locale_letter(struct termp *p, int c)
 {
 static void
 locale_letter(struct termp *p, int c)
 {

-       
+

        putwchar(c);
 }
 #endif
        putwchar(c);
 }
 #endif