Fully integrate apropos(1) into mandoc(1).

[mandoc.git] / libmdoc.h

diff --git a/libmdoc.h b/libmdoc.h
index e03d82141a1bcea9453a3a18cbdbfce4680a12ba..1507a8c26fbb9104f6699e3bb57512852df9ece2 100644 (file)
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,6 +1,7 @@
-/*     $Id: libmdoc.h,v 1.75 2011/07/18 07:46:41 kristaps Exp $ */
+/*     $Id: libmdoc.h,v 1.88 2014/08/01 17:40:34 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2013 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


@@ -24,8 +25,9 @@ enum  mdoc_next {
 
 struct mdoc {
        struct mparse    *parse; /* parse pointer */
 
 struct mdoc {
        struct mparse    *parse; /* parse pointer */

+       const char       *defos; /* default argument for .Os */
+       int               quick; /* abort parse early */

        int               flags; /* parse flags */
        int               flags; /* parse flags */

-#define        MDOC_HALT        (1 << 0) /* error in parse: halt */

 #define        MDOC_LITERAL     (1 << 1) /* in a literal scope */
 #define        MDOC_PBODY       (1 << 2) /* in the document body */
 #define        MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */
 #define        MDOC_LITERAL     (1 << 1) /* in a literal scope */
 #define        MDOC_PBODY       (1 << 2) /* in the document body */
 #define        MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */


@@ -33,17 +35,19 @@ struct      mdoc {
 #define        MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
 #define        MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
 #define        MDOC_SYNOPSIS    (1 << 7) /* SYNOPSIS-style formatting */
 #define        MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
 #define        MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
 #define        MDOC_SYNOPSIS    (1 << 7) /* SYNOPSIS-style formatting */

+#define        MDOC_KEEP        (1 << 8) /* in a word keep */
+#define        MDOC_SMOFF       (1 << 9) /* spacing is off */

        enum mdoc_next    next; /* where to put the next node */
        struct mdoc_node *last; /* the last node parsed */
        struct mdoc_node *first; /* the first node parsed */
        enum mdoc_next    next; /* where to put the next node */
        struct mdoc_node *last; /* the last node parsed */
        struct mdoc_node *first; /* the first node parsed */

+       struct mdoc_node *last_es; /* the most recent Es node */

        struct mdoc_meta  meta; /* document meta-data */
        enum mdoc_sec     lastnamed;
        enum mdoc_sec     lastsec;
        struct mdoc_meta  meta; /* document meta-data */
        enum mdoc_sec     lastnamed;
        enum mdoc_sec     lastsec;

-       struct regset    *regs; /* registers */

        struct roff      *roff;
 };
 
        struct roff      *roff;
 };
 

-#define        MACRO_PROT_ARGS struct mdoc *m, \
+#define        MACRO_PROT_ARGS struct mdoc *mdoc, \

                        enum mdoct tok, \
                        int line, \
                        int ppos, \
                        enum mdoct tok, \
                        int line, \
                        int ppos, \


@@ -57,8 +61,8 @@ struct        mdoc_macro {
 #define        MDOC_PARSED      (1 << 1)
 #define        MDOC_EXPLICIT    (1 << 2)
 #define        MDOC_PROLOGUE    (1 << 3)
 #define        MDOC_PARSED      (1 << 1)
 #define        MDOC_EXPLICIT    (1 << 2)
 #define        MDOC_PROLOGUE    (1 << 3)

-#define        MDOC_IGNDELIM    (1 << 4) 
-       /* Reserved words in arguments treated as text. */
+#define        MDOC_IGNDELIM    (1 << 4)
+#define        MDOC_JOIN        (1 << 5)

 };
 
 enum   margserr {
 };
 
 enum   margserr {


@@ -100,24 +104,21 @@ extern    const struct mdoc_macro *const mdoc_macros;
 
 __BEGIN_DECLS
 
 
 __BEGIN_DECLS
 

-#define                  mdoc_pmsg(m, l, p, t) \
-                 mandoc_msg((t), (m)->parse, (l), (p), NULL)
-#define                  mdoc_nmsg(m, n, t) \
-                 mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL)

 int              mdoc_macro(MACRO_PROT_ARGS);
 int              mdoc_macro(MACRO_PROT_ARGS);

-int              mdoc_word_alloc(struct mdoc *, 
+int              mdoc_word_alloc(struct mdoc *,

                        int, int, const char *);
                        int, int, const char *);

-int              mdoc_elem_alloc(struct mdoc *, int, int, 
+void             mdoc_word_append(struct mdoc *, const char *);
+int              mdoc_elem_alloc(struct mdoc *, int, int,

                        enum mdoct, struct mdoc_arg *);
                        enum mdoct, struct mdoc_arg *);

-int              mdoc_block_alloc(struct mdoc *, int, int, 
+int              mdoc_block_alloc(struct mdoc *, int, int,

                        enum mdoct, struct mdoc_arg *);
 int              mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
 int              mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
 int              mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
                        enum mdoct, struct mdoc_arg *);
 int              mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
 int              mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
 int              mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);

-int              mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
-                       enum mdoct tok, struct mdoc_node *body,
-                       enum mdoc_endbody end);
+int              mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct,
+                       struct mdoc_node *, enum mdoc_endbody);

 void             mdoc_node_delete(struct mdoc *, struct mdoc_node *);
 void             mdoc_node_delete(struct mdoc *, struct mdoc_node *);

+int              mdoc_node_relink(struct mdoc *, struct mdoc_node *);

 void             mdoc_hash_init(void);
 enum mdoct       mdoc_hash_find(const char *);
 const char      *mdoc_a2att(const char *);
 void             mdoc_hash_init(void);
 enum mdoct       mdoc_hash_find(const char *);
 const char      *mdoc_a2att(const char *);


@@ -125,7 +126,6 @@ const char   *mdoc_a2lib(const char *);
 const char      *mdoc_a2st(const char *);
 const char      *mdoc_a2arch(const char *);
 const char      *mdoc_a2vol(const char *);
 const char      *mdoc_a2st(const char *);
 const char      *mdoc_a2arch(const char *);
 const char      *mdoc_a2vol(const char *);

-const char      *mdoc_a2msec(const char *);

 int              mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
 int              mdoc_valid_post(struct mdoc *);
 enum margverr    mdoc_argv(struct mdoc *, int, enum mdoct,
 int              mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
 int              mdoc_valid_post(struct mdoc *);
 enum margverr    mdoc_argv(struct mdoc *, int, enum mdoct,


@@ -133,7 +133,7 @@ enum margverr         mdoc_argv(struct mdoc *, int, enum mdoct,
 void             mdoc_argv_free(struct mdoc_arg *);
 enum margserr    mdoc_args(struct mdoc *, int,
                        int *, char *, enum mdoct, char **);
 void             mdoc_argv_free(struct mdoc_arg *);
 enum margserr    mdoc_args(struct mdoc *, int,
                        int *, char *, enum mdoct, char **);

-enum margserr    mdoc_zargs(struct mdoc *, int, 
+enum margserr    mdoc_zargs(struct mdoc *, int,

                        int *, char *, char **);
 int              mdoc_macroend(struct mdoc *);
 enum mdelim      mdoc_isdelim(const char *);
                        int *, char *, char **);
 int              mdoc_macroend(struct mdoc *);
 enum mdelim      mdoc_isdelim(const char *);