In mdoc(7) and man(7), if a width is given as a bare number without

[mandoc.git] / man.h

diff --git a/man.h b/man.h
index 1e7a3a2d4fb3703849300298eb4203f96613ad43..aa80b6732eaea4690d1f448b22fe9125d8c4b410 100644 (file)
--- a/man.h
+++ b/man.h
@@ -1,6 +1,7 @@
-/*     $Id: man.h,v 1.47 2010/12/06 15:31:19 kristaps Exp $ */
+/*     $Id: man.h,v 1.65 2014/06/20 23:02:31 schwarze Exp $ */
 /*
- * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2009, 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
@@ -17,9 +18,6 @@
 #ifndef MAN_H
 #define MAN_H
 
-/* 
- * What follows is a list of ALL possible macros. 
- */
 enum   mant {
        MAN_br = 0,
        MAN_TH,
@@ -43,11 +41,9 @@ enum mant {
        MAN_IR,
        MAN_RI,
        MAN_na,
-       MAN_i,
        MAN_sp,
        MAN_nf,
        MAN_fi,
-       MAN_r,
        MAN_RE,
        MAN_RS,
        MAN_DT,
@@ -56,36 +52,36 @@ enum        mant {
        MAN_AT,
        MAN_in,
        MAN_ft,
+       MAN_OP,
+       MAN_EX,
+       MAN_EE,
+       MAN_UR,
+       MAN_UE,
+       MAN_ll,
        MAN_MAX
 };
 
-/* 
- * Type of a syntax node. 
- */
 enum   man_type {
        MAN_TEXT,
        MAN_ELEM,
        MAN_ROOT,
        MAN_BLOCK,
        MAN_HEAD,
-       MAN_BODY
+       MAN_BODY,
+       MAN_TAIL,
+       MAN_TBL,
+       MAN_EQN
 };
 
-/* 
- * Information from prologue. 
- */
 struct man_meta {
        char            *msec; /* `TH' section (1, 3p, etc.) */
-       time_t           date; /* `TH' normalised date */
-       char            *rawdate; /* raw `TH' date */
+       char            *date; /* `TH' normalised date */
        char            *vol; /* `TH' volume */
        char            *title; /* `TH' title (e.g., FOO) */
        char            *source; /* `TH' source (e.g., GNU) */
+       int              hasbody; /* document is not empty */
 };
 
-/* 
- * Single node in tree-linked AST. 
- */
 struct man_node {
        struct man_node *parent; /* parent AST node */
        struct man_node *child; /* first child AST node */
@@ -97,32 +93,28 @@ struct      man_node {
        enum mant        tok; /* tok or MAN__MAX if none */
        int              flags;
 #define        MAN_VALID       (1 << 0) /* has been validated */
-#define        MAN_ACTED       (1 << 1) /* has been acted upon */
 #define        MAN_EOS         (1 << 2) /* at sentence boundary */
+#define        MAN_LINE        (1 << 3) /* first macro/text on line */
        enum man_type    type; /* AST node type */
        char            *string; /* TEXT node argument */
        struct man_node *head; /* BLOCK node HEAD ptr */
+       struct man_node *tail; /* BLOCK node TAIL ptr */
        struct man_node *body; /* BLOCK node BODY ptr */
+       const struct tbl_span *span; /* TBL */
+       const struct eqn *eqn; /* EQN */
 };
 
-/*
- * Names of macros.  Index is enum mant.  Indexing into this returns
- * the normalised name, e.g., man_macronames[MAN_SH] -> "SH".
- */
+/* Names of macros.  Index is enum mant. */
 extern const char *const *man_macronames;
 
 __BEGIN_DECLS
 
 struct man;
 
-void             man_free(struct man *);
-struct man      *man_alloc(struct regset *, void *, mandocmsg);
-void             man_reset(struct man *);
-int              man_parseln(struct man *, int, char *, int);
-int              man_endparse(struct man *);
-
 const struct man_node *man_node(const struct man *);
 const struct man_meta *man_meta(const struct man *);
+const struct mparse   *man_mparse(const struct man *);
+void man_deroff(char **, const struct man_node *);
 
 __END_DECLS