]> git.cameronkatri.com Git - mandoc.git/blobdiff - libmdoc.h
1) Remove documentation of the groff-1.15 compatibility quirk
[mandoc.git] / libmdoc.h
index e6d1583f3dd25eb36bd0f98d9811e21466a0269e..518470222700a0862a5bbeea18bcccc8eeb05d23 100644 (file)
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,6 +1,6 @@
-/*     $Id: libmdoc.h,v 1.71 2011/03/22 14:28:48 kristaps Exp $ */
+/*     $Id: libmdoc.h,v 1.80 2012/07/18 11:11:12 schwarze Exp $ */
 /*
- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -17,8 +17,6 @@
 #ifndef LIBMDOC_H
 #define LIBMDOC_H
 
-#include "mdoc.h"
-
 enum   mdoc_next {
        MDOC_NEXT_SIBLING = 0,
        MDOC_NEXT_CHILD
@@ -26,6 +24,7 @@ enum  mdoc_next {
 
 struct mdoc {
        struct mparse    *parse; /* parse pointer */
+       char             *defos; /* default argument for .Os */
        int               flags; /* parse flags */
 #define        MDOC_HALT        (1 << 0) /* error in parse: halt */
 #define        MDOC_LITERAL     (1 << 1) /* in a literal scope */
@@ -41,7 +40,7 @@ struct        mdoc {
        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, \
@@ -64,20 +63,20 @@ struct      mdoc_macro {
 
 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,
-       ARGV_EOLN,
-       ARGV_ARG,
-       ARGV_WORD
+       ARGV_EOLN, /* end of line */
+       ARGV_ARG, /* valid argument */
+       ARGV_WORD /* normal word (or bad argument---same thing) */
 };
 
 /*
@@ -119,6 +118,7 @@ int           mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
                        enum mdoct tok, struct mdoc_node *body,
                        enum mdoc_endbody end);
 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 *);
@@ -126,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_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,
@@ -135,14 +134,8 @@ 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 *, 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 *);
-
-#define        DELIMSZ   6 /* hint: max possible size of a delimiter */
 enum mdelim      mdoc_isdelim(const char *);
 
 __END_DECLS