]> git.cameronkatri.com Git - mandoc.git/blobdiff - libmdoc.h
When a file is given on the command line, actually exists, and its name
[mandoc.git] / libmdoc.h
index 0e4b125f42e75f83a6ae521465e6f553a42799f1..b245213a8f22e12ea95ac64b3bb68f1c13bd357a 100644 (file)
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,6 +1,7 @@
-/*     $Id: libmdoc.h,v 1.74 2011/04/19 16:38:48 kristaps Exp $ */
+/*     $Id: libmdoc.h,v 1.96 2014/12/01 04:05:32 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, 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
@@ -14,8 +15,6 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-#ifndef LIBMDOC_H
-#define LIBMDOC_H
 
 enum   mdoc_next {
        MDOC_NEXT_SIBLING = 0,
@@ -24,8 +23,9 @@ enum  mdoc_next {
 
 struct mdoc {
        struct mparse    *parse; /* parse pointer */
+       const char       *defos; /* default argument for .Os */
+       int               quick; /* abort parse early */
        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 */
@@ -33,16 +33,20 @@ 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_KEEP        (1 << 8) /* in a word keep */
+#define        MDOC_SMOFF       (1 << 9) /* spacing is off */
+#define        MDOC_NODELIMC    (1 << 10) /* disable closing delimiter handling */
        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 regset    *regs; /* registers */
+       struct roff      *roff;
 };
 
-#define        MACRO_PROT_ARGS struct mdoc *m, \
+#define        MACRO_PROT_ARGS struct mdoc *mdoc, \
                        enum mdoct tok, \
                        int line, \
                        int ppos, \
@@ -50,14 +54,14 @@ struct      mdoc {
                        char *buf
 
 struct mdoc_macro {
-       int             (*fp)(MACRO_PROT_ARGS);
+       void            (*fp)(MACRO_PROT_ARGS);
        int               flags;
 #define        MDOC_CALLABLE    (1 << 0)
 #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 {
@@ -71,13 +75,6 @@ enum margserr {
        ARGS_PEND /* last phrase (-column) */
 };
 
-enum   margverr {
-       ARGV_ERROR,
-       ARGV_EOLN, /* end of line */
-       ARGV_ARG, /* valid argument */
-       ARGV_WORD /* normal word (or bad argument---same thing) */
-};
-
 /*
  * A punctuation delimiter is opening, closing, or "middle mark"
  * punctuation.  These govern spacing.
@@ -99,44 +96,34 @@ extern      const struct mdoc_macro *const mdoc_macros;
 
 __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_word_alloc(struct mdoc *, 
-                       int, int, const char *);
-int              mdoc_elem_alloc(struct mdoc *, int, int, 
+void             mdoc_macro(MACRO_PROT_ARGS);
+void             mdoc_word_alloc(struct mdoc *, int, int, const char *);
+void             mdoc_word_append(struct mdoc *, const char *);
+void             mdoc_elem_alloc(struct mdoc *, int, int,
                        enum mdoct, struct mdoc_arg *);
-int              mdoc_block_alloc(struct mdoc *, int, int, 
+struct mdoc_node *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);
-int              mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
-                       enum mdoct tok, struct mdoc_node *body,
-                       enum mdoc_endbody end);
+struct mdoc_node *mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
+void             mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
+struct mdoc_node *mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
+void             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_relink(struct mdoc *, struct mdoc_node *);
 void             mdoc_hash_init(void);
 enum mdoct       mdoc_hash_find(const char *);
 const char      *mdoc_a2att(const char *);
 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_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,
+void             mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
+void             mdoc_valid_post(struct mdoc *);
+void             mdoc_argv(struct mdoc *, int, enum mdoct,
                        struct mdoc_arg **, int *, 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, 
-                       int *, char *, char **);
-int              mdoc_macroend(struct mdoc *);
+void             mdoc_macroend(struct mdoc *);
 enum mdelim      mdoc_isdelim(const char *);
 
 __END_DECLS
-
-#endif /*!LIBMDOC_H*/