MANDOCERR_BADTAB needs checking, but .UR/.UE is done

[mandoc.git] / libmdoc.h

diff --git a/libmdoc.h b/libmdoc.h
index e0d96a58e9a2e3545c309f0fe0f64f7935f25a86..cd0ce9d302d692a358b94f081fbb852dda7df68b 100644 (file)
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,6 +1,7 @@
-/*     $Id: libmdoc.h,v 1.54 2010/06/26 15:36:37 kristaps Exp $ */
+/*     $Id: libmdoc.h,v 1.83 2014/01/05 20:26:36 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 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


@@ -17,18 +18,16 @@
 #ifndef LIBMDOC_H
 #define LIBMDOC_H
 
 #ifndef LIBMDOC_H
 #define LIBMDOC_H
 

-#include "regs.h"
-#include "mdoc.h"
-

 enum   mdoc_next {
        MDOC_NEXT_SIBLING = 0,
        MDOC_NEXT_CHILD
 };
 
 struct mdoc {
 enum   mdoc_next {
        MDOC_NEXT_SIBLING = 0,
        MDOC_NEXT_CHILD
 };
 
 struct mdoc {

-       void             *data;
-       mandocmsg         msg;
-       int               flags;
+       struct mparse    *parse; /* parse pointer */
+       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_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 */


@@ -36,17 +35,24 @@ struct      mdoc {
 #define        MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
 #define        MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
 #define        MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
 #define        MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
 #define        MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
 #define        MDOC_FREECOL     (1 << 6) /* `It' invocation should close */

-       int               pflags;
-       enum mdoc_next    next;
-       struct mdoc_node *last;
-       struct mdoc_node *first;
-       struct mdoc_meta  meta;
+#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 */
+       struct mdoc_meta  meta; /* document meta-data */

        enum mdoc_sec     lastnamed;
        enum mdoc_sec     lastsec;
        enum mdoc_sec     lastnamed;
        enum mdoc_sec     lastsec;

+       struct roff      *roff;

 };
 
 };
 

-#define        MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \
-                       int line, int ppos, int *pos, char *buf
+#define        MACRO_PROT_ARGS struct mdoc *mdoc, \
+                       enum mdoct tok, \
+                       int line, \
+                       int ppos, \
+                       int *pos, \
+                       char *buf

 
 struct mdoc_macro {
        int             (*fp)(MACRO_PROT_ARGS);
 
 struct mdoc_macro {
        int             (*fp)(MACRO_PROT_ARGS);


@@ -55,48 +61,57 @@ 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 {
        ARGS_ERROR,
 };
 
 enum   margserr {
        ARGS_ERROR,

-       ARGS_EOLN,
-       ARGS_WORD,
-       ARGS_PUNCT,
-       ARGS_QWORD,
-       ARGS_PHRASE,
-       ARGS_PPHRASE,
-       ARGS_PEND
+       ARGS_EOLN, /* end-of-line */
+       ARGS_WORD, /* normal word */
+       ARGS_PUNCT, /* series of punctuation */
+       ARGS_QWORD, /* quoted word */
+       ARGS_PHRASE, /* Ta'd phrase (-column) */
+       ARGS_PPHRASE, /* tabbed phrase (-column) */
+       ARGS_PEND /* last phrase (-column) */

 };
 
 enum   margverr {
        ARGV_ERROR,
 };
 
 enum   margverr {
        ARGV_ERROR,

-       ARGV_EOLN,
-       ARGV_ARG,
-       ARGV_WORD
+       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.
+ * Opening punctuation (e.g., the opening parenthesis) suppresses the
+ * following space; closing punctuation (e.g., the closing parenthesis)
+ * suppresses the leading space; middle punctuation (e.g., the vertical
+ * bar) can do either.  The middle punctuation delimiter bends the rules
+ * depending on usage.
+ */

 enum   mdelim {
        DELIM_NONE = 0,
        DELIM_OPEN,
        DELIM_MIDDLE,
 enum   mdelim {
        DELIM_NONE = 0,
        DELIM_OPEN,
        DELIM_MIDDLE,

-       DELIM_CLOSE
+       DELIM_CLOSE,
+       DELIM_MAX

 };
 
 extern const struct mdoc_macro *const mdoc_macros;
 
 __BEGIN_DECLS
 
 };
 
 extern const struct mdoc_macro *const mdoc_macros;
 
 __BEGIN_DECLS
 

-#define                  mdoc_pmsg(m, l, p, t) \
-                 (*(m)->msg)((t), (m)->data, (l), (p), NULL)
-#define                  mdoc_nmsg(m, n, t) \
-                 (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
-int              mdoc_vmsg(struct mdoc *, enum mandocerr, 
-                       int, int, const char *, ...);
+#define                  mdoc_pmsg(mdoc, l, p, t) \
+                 mandoc_msg((t), (mdoc)->parse, (l), (p), NULL)
+#define                  mdoc_nmsg(mdoc, n, t) \
+                 mandoc_msg((t), (mdoc)->parse, (n)->line, (n)->pos, NULL)

 int              mdoc_macro(MACRO_PROT_ARGS);
 int              mdoc_word_alloc(struct mdoc *, 
                        int, int, const char *);
 int              mdoc_macro(MACRO_PROT_ARGS);
 int              mdoc_word_alloc(struct mdoc *, 
                        int, int, const char *);

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

 int              mdoc_elem_alloc(struct mdoc *, int, int, 
                        enum mdoct, struct mdoc_arg *);
 int              mdoc_block_alloc(struct mdoc *, int, int, 
 int              mdoc_elem_alloc(struct mdoc *, int, int, 
                        enum mdoct, struct mdoc_arg *);
 int              mdoc_block_alloc(struct mdoc *, int, int, 


@@ -104,39 +119,28 @@ int                 mdoc_block_alloc(struct mdoc *, int, int,
 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_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 *, 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 *);
 void             mdoc_hash_init(void);
 enum mdoct       mdoc_hash_find(const char *);

-enum mdelim      mdoc_iscdelim(char);
-enum mdelim      mdoc_isdelim(const char *);
-size_t           mdoc_isescape(const char *);
-enum   mdoc_sec  mdoc_str2sec(const char *);
-time_t           mdoc_atotime(const char *);
-size_t           mdoc_macro2len(enum mdoct);

 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_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 *);
 int              mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
 int              mdoc_valid_post(struct mdoc *);

-int              mdoc_action_pre(struct mdoc *, 
-                       struct mdoc_node *);
-int              mdoc_action_post(struct mdoc *);

 enum margverr    mdoc_argv(struct mdoc *, int, enum mdoct,
                        struct mdoc_arg **, int *, char *);
 void             mdoc_argv_free(struct mdoc_arg *);
 enum margverr    mdoc_argv(struct mdoc *, int, enum mdoct,
                        struct mdoc_arg **, int *, char *);
 void             mdoc_argv_free(struct mdoc_arg *);

-void             mdoc_argn_free(struct mdoc_arg *, int);

 enum margserr    mdoc_args(struct mdoc *, int,
                        int *, char *, enum mdoct, char **);
 enum margserr    mdoc_zargs(struct mdoc *, int, 
 enum margserr    mdoc_args(struct mdoc *, int,
                        int *, char *, enum mdoct, char **);
 enum margserr    mdoc_zargs(struct mdoc *, int, 

-                       int *, char *, int, char **);
-#define        ARGS_DELIM      (1 << 1)
-#define        ARGS_TABSEP     (1 << 2)
-#define        ARGS_NOWARN     (1 << 3)
-
+                       int *, char *, char **);

 int              mdoc_macroend(struct mdoc *);
 int              mdoc_macroend(struct mdoc *);

+enum mdelim      mdoc_isdelim(const char *);

 
 __END_DECLS
 
 
 __END_DECLS