Render roff escape sequences contained in manual page descriptions

[mandoc.git] / man.h

diff --git a/man.h b/man.h
index d31d20c0b425180d6a6d0679872d1028ace3979c..26c2747bf3e78de747306632ef16aa3136d60bf5 100644 (file)
--- a/man.h
+++ b/man.h
@@ -1,6 +1,7 @@
-/*     $Id: man.h,v 1.44 2010/10/02 10:14:37 kristaps Exp $ */
+/*     $Id: man.h,v 1.64 2014/03/30 19:47:48 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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -17,22 +18,102 @@
 #ifndef MAN_H
 #define MAN_H
 
 #ifndef MAN_H
 #define MAN_H
 

-#include <time.h>
+enum   mant {
+       MAN_br = 0,
+       MAN_TH,
+       MAN_SH,
+       MAN_SS,
+       MAN_TP,
+       MAN_LP,
+       MAN_PP,
+       MAN_P,
+       MAN_IP,
+       MAN_HP,
+       MAN_SM,
+       MAN_SB,
+       MAN_BI,
+       MAN_IB,
+       MAN_BR,
+       MAN_RB,
+       MAN_R,
+       MAN_B,
+       MAN_I,
+       MAN_IR,
+       MAN_RI,
+       MAN_na,
+       MAN_sp,
+       MAN_nf,
+       MAN_fi,
+       MAN_RE,
+       MAN_RS,
+       MAN_DT,
+       MAN_UC,
+       MAN_PD,
+       MAN_AT,
+       MAN_in,
+       MAN_ft,
+       MAN_OP,
+       MAN_EX,
+       MAN_EE,
+       MAN_UR,
+       MAN_UE,
+       MAN_ll,
+       MAN_MAX
+};

 
 

+enum   man_type {
+       MAN_TEXT,
+       MAN_ELEM,
+       MAN_ROOT,
+       MAN_BLOCK,
+       MAN_HEAD,
+       MAN_BODY,
+       MAN_TAIL,
+       MAN_TBL,
+       MAN_EQN
+};
+
+struct man_meta {
+       char            *msec; /* `TH' section (1, 3p, etc.) */
+       char            *date; /* `TH' normalised date */
+       char            *vol; /* `TH' volume */
+       char            *title; /* `TH' title (e.g., FOO) */
+       char            *source; /* `TH' source (e.g., GNU) */
+};
+
+struct man_node {
+       struct man_node *parent; /* parent AST node */
+       struct man_node *child; /* first child AST node */
+       struct man_node *next; /* sibling AST node */
+       struct man_node *prev; /* prior sibling AST node */
+       int              nchild; /* number children */
+       int              line;
+       int              pos;
+       enum mant        tok; /* tok or MAN__MAX if none */
+       int              flags;
+#define        MAN_VALID       (1 << 0) /* has been validated */
+#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. */

 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 *, 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 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