during prioritization for man(1), correctly extract the section name

[mandoc.git] / out.h

diff --git a/out.h b/out.h
index 9ace711747daca603638c7460b17713a280c5e72..e621cbb7b92ea946d856661c5b7681ce4d663534 100644 (file)
--- a/out.h
+++ b/out.h
@@ -1,6 +1,7 @@
-/*     $Id: out.h,v 1.9 2009/11/12 08:21:05 kristaps Exp $ */
+/* $Id: out.h,v 1.34 2020/04/03 11:35:01 schwarze Exp $ */
 /*
- * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2014, 2017, 2018 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
@@ -13,68 +14,57 @@
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ * Utilities for use by multiple mandoc(1) formatters.
  */
-#ifndef OUT_H
-#define OUT_H
-
-#define        DATESIZ         24
-
-__BEGIN_DECLS
 
 enum   roffscale {
-       SCALE_CM,
-       SCALE_IN,
-       SCALE_PC,
-       SCALE_PT,
-       SCALE_EM,
-       SCALE_MM,
-       SCALE_EN,
-       SCALE_BU,
-       SCALE_VS,
-       SCALE_FS,
+       SCALE_CM, /* centimeters (c) */
+       SCALE_IN, /* inches (i) */
+       SCALE_PC, /* pica (P) */
+       SCALE_PT, /* points (p) */
+       SCALE_EM, /* ems (m) */
+       SCALE_MM, /* mini-ems (M) */
+       SCALE_EN, /* ens (n) */
+       SCALE_BU, /* default horizontal (u) */
+       SCALE_VS, /* default vertical (v) */
+       SCALE_FS, /* syn. for u (f) */
        SCALE_MAX
 };
 
-enum   roffdeco {
-       DECO_NONE,
-       DECO_SPECIAL,
-       DECO_RESERVED,
-       DECO_BOLD,
-       DECO_ITALIC,
-       DECO_ROMAN,
-       DECO_PREVIOUS,
-       DECO_SIZE,
-       DECO_NOSPACE,
-       DECO_MAX
+struct roffcol {
+       size_t           width; /* width of cell */
+       size_t           nwidth; /* max. width of number in cell */
+       size_t           decimal; /* decimal position in cell */
+       size_t           spacing; /* spacing after the column */
+       int              flags; /* layout flags, see tbl_cell */
 };
 
 struct roffsu {
        enum roffscale    unit;
        double            scale;
-       int               pt;
 };
 
-#define        SCALE_INVERT(p) \
-       do { (p)->scale = -(p)->scale; } \
-       while (/* CONSTCOND */ 0)
+typedef        size_t  (*tbl_sulen)(const struct roffsu *, void *);
+typedef        size_t  (*tbl_strlen)(const char *, void *);
+typedef        size_t  (*tbl_len)(size_t, void *);
 
-#define        SCALE_VS_INIT(p, v) \
-       do { (p)->unit = SCALE_VS; \
-            (p)->scale = (v); \
-            (p)->pt = 0; } \
-       while (/* CONSTCOND */ 0)
+struct rofftbl {
+       tbl_sulen        sulen; /* calculate scaling unit length */
+       tbl_strlen       slen; /* calculate string length */
+       tbl_len          len; /* produce width of empty space */
+       struct roffcol  *cols; /* master column specifiers */
+       void            *arg; /* passed to sulen, slen, and len */
+};
 
 #define        SCALE_HS_INIT(p, v) \
-       do { (p)->unit = SCALE_BU; \
-            (p)->scale = (v); \
-            (p)->pt = 0; } \
+       do { (p)->unit = SCALE_EN; \
+            (p)->scale = (v); } \
        while (/* CONSTCOND */ 0)
 
-int              a2roffsu(const char *, 
-                       struct roffsu *, enum roffscale);
-int              a2roffdeco(enum roffdeco *, const char **, size_t *);
-void             time2a(time_t, char *, size_t);
 
-__END_DECLS
+struct tbl_span;
 
-#endif /*!HTML_H*/
+const char      *a2roffsu(const char *, struct roffsu *, enum roffscale);
+void             tblcalc(struct rofftbl *,
+                       const struct tbl_span *, size_t, size_t);