document -Q and -T; from OpenBSD

[mandoc.git] / man.h

diff --git a/man.h b/man.h
index f41ba9b43a4cd7f7cf6bf0172e590c385877f648..26c2747bf3e78de747306632ef16aa3136d60bf5 100644 (file)
--- a/man.h
+++ b/man.h
@@ -1,6 +1,7 @@
-/*     $Id: man.h,v 1.55 2011/03/20 16:02:05 kristaps Exp $ */
+/*     $Id: man.h,v 1.64 2014/03/30 19:47:48 schwarze Exp $ */

 /*
  * Copyright (c) 2009, 2010, 2011 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
  *
  * 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
 
 #ifndef MAN_H
 #define MAN_H
 

-/* 
- * What follows is a list of ALL possible macros. 
- */

 enum   mant {
        MAN_br = 0,
        MAN_TH,
 enum   mant {
        MAN_br = 0,
        MAN_TH,


@@ -54,12 +52,15 @@ enum        mant {
        MAN_AT,
        MAN_in,
        MAN_ft,
        MAN_AT,
        MAN_in,
        MAN_ft,

+       MAN_OP,
+       MAN_EX,
+       MAN_EE,
+       MAN_UR,
+       MAN_UE,
+       MAN_ll,

        MAN_MAX
 };
 
        MAN_MAX
 };
 

-/* 
- * Type of a syntax node. 
- */

 enum   man_type {
        MAN_TEXT,
        MAN_ELEM,
 enum   man_type {
        MAN_TEXT,
        MAN_ELEM,


@@ -67,13 +68,11 @@ enum        man_type {
        MAN_BLOCK,
        MAN_HEAD,
        MAN_BODY,
        MAN_BLOCK,
        MAN_HEAD,
        MAN_BODY,

+       MAN_TAIL,

        MAN_TBL,
        MAN_EQN
 };
 
        MAN_TBL,
        MAN_EQN
 };
 

-/* 
- * Information from prologue. 
- */

 struct man_meta {
        char            *msec; /* `TH' section (1, 3p, etc.) */
        char            *date; /* `TH' normalised date */
 struct man_meta {
        char            *msec; /* `TH' section (1, 3p, etc.) */
        char            *date; /* `TH' normalised date */


@@ -82,9 +81,6 @@ struct        man_meta {
        char            *source; /* `TH' source (e.g., GNU) */
 };
 
        char            *source; /* `TH' source (e.g., GNU) */
 };
 

-/* 
- * Single node in tree-linked AST. 
- */

 struct man_node {
        struct man_node *parent; /* parent AST node */
        struct man_node *child; /* first child AST node */
 struct man_node {
        struct man_node *parent; /* parent AST node */
        struct man_node *child; /* first child AST node */


@@ -101,32 +97,23 @@ struct     man_node {
        enum man_type    type; /* AST node type */
        char            *string; /* TEXT node argument */
        struct man_node *head; /* BLOCK node HEAD ptr */
        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 */
 };
 
        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;
 
 extern const char *const *man_macronames;
 
 __BEGIN_DECLS
 
 struct man;
 

-void             man_free(struct man *);
-struct man      *man_alloc(struct regset *, struct mparse *);
-void             man_reset(struct man *);
-int              man_parseln(struct man *, int, char *, int);
-int              man_endparse(struct man *);
-int              man_addspan(struct man *,
-                       const struct tbl_span *);
-int              man_addeqn(struct man *, const struct eqn *);
-

 const struct man_node *man_node(const struct man *);
 const struct man_meta *man_meta(const 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
 
 
 __END_DECLS