-/* $Id: libmdoc.h,v 1.8 2009/06/15 09:55:43 kristaps Exp $ */
+/* $Id: libmdoc.h,v 1.91 2014/11/28 03:14:18 schwarze Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * 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
#ifndef LIBMDOC_H
#define LIBMDOC_H
-#include "mdoc.h"
-
enum mdoc_next {
MDOC_NEXT_SIBLING = 0,
MDOC_NEXT_CHILD
};
struct mdoc {
- void *data;
- struct mdoc_cb cb;
- void *htab;
- int flags;
-#define MDOC_HALT (1 << 0)
-#define MDOC_LITERAL (1 << 1)
- int pflags;
- enum mdoc_next next;
- struct mdoc_node *last;
- struct mdoc_node *first;
- struct mdoc_meta meta;
+ struct mparse *parse; /* parse pointer */
+ const char *defos; /* default argument for .Os */
+ int quick; /* abort parse early */
+ int flags; /* parse flags */
+#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_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_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 roff *roff;
};
-
-#define MACRO_PROT_ARGS struct mdoc *mdoc, int 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);
#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,
+ 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, /* 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,
+ DELIM_CLOSE,
+ DELIM_MAX
};
extern const struct mdoc_macro *const mdoc_macros;
__BEGIN_DECLS
-/*
- * When GCC2 is deprecated, most of these can be reverted to #define
- * as mdoc_vmsg using __VA_ARGS__. Until then, use real functions.
- */
-int mdoc_vwarn(struct mdoc *, int, int,
- enum mdoc_warn, const char *, ...);
-void mdoc_vmsg(struct mdoc *, int, int,
- const char *, ...);
-int mdoc_verr(struct mdoc *, int, int,
- const char *, ...);
-int mdoc_nwarn(struct mdoc *, const struct mdoc_node *,
- enum mdoc_warn, const char *, ...);
-int mdoc_nerr(struct mdoc *, const struct mdoc_node *,
- const char *, ...);
-int mdoc_warn(struct mdoc *, enum mdoc_warn, const char *, ...);
-int mdoc_err(struct mdoc *, const char *, ...);
-void mdoc_msg(struct mdoc *, const char *, ...);
-void mdoc_pmsg(struct mdoc *, int, int, const char *, ...);
-int mdoc_pwarn(struct mdoc *, int, int,
- enum mdoc_warn,const char *, ...);
-int mdoc_perr(struct mdoc *, int, int, const char *, ...);
int mdoc_macro(MACRO_PROT_ARGS);
-int mdoc_word_alloc(struct mdoc *,
- int, int, const char *);
-int mdoc_elem_alloc(struct mdoc *, int, int,
- int, struct mdoc_arg *);
-int mdoc_block_alloc(struct mdoc *, int, int,
- int, struct mdoc_arg *);
-int mdoc_head_alloc(struct mdoc *, int, int, int);
-int mdoc_tail_alloc(struct mdoc *, int, int, int);
-int mdoc_body_alloc(struct mdoc *, int, int, int);
-void mdoc_node_free(struct mdoc_node *);
-void mdoc_node_freelist(struct mdoc_node *);
-void *mdoc_hash_alloc(void);
-int mdoc_hash_find(const void *, const char *);
-void mdoc_hash_free(void *);
-int mdoc_iscdelim(char);
-int mdoc_isdelim(const char *);
-size_t mdoc_isescape(const char *);
-enum mdoc_sec mdoc_atosec(const char *);
-time_t mdoc_atotime(const char *);
-
-size_t mdoc_macro2len(int);
+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 *);
+struct mdoc_node *mdoc_block_alloc(struct mdoc *, int, int,
+ enum mdoct, struct mdoc_arg *);
+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 *,
- const struct mdoc_node *);
-int mdoc_valid_post(struct mdoc *);
-int mdoc_action_pre(struct mdoc *,
- const struct mdoc_node *);
-int mdoc_action_post(struct mdoc *);
-int mdoc_argv(struct mdoc *, int, int,
+void mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
+void mdoc_valid_post(struct mdoc *);
+enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
struct mdoc_arg **, int *, char *);
-#define ARGV_ERROR (-1)
-#define ARGV_EOLN (0)
-#define ARGV_ARG (1)
-#define ARGV_WORD (2)
void mdoc_argv_free(struct mdoc_arg *);
-int mdoc_args(struct mdoc *, int,
- int *, char *, int, char **);
-#define ARGS_ERROR (-1)
-#define ARGS_EOLN (0)
-#define ARGS_WORD (1)
-#define ARGS_PUNCT (2)
-#define ARGS_QWORD (3)
-#define ARGS_PHRASE (4)
-
+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 *);
+enum mdelim mdoc_isdelim(const char *);
__END_DECLS
git.ckatri.com / mandoc.git / blobdiff