88 lines
3.0 KiB
C
88 lines
3.0 KiB
C
/* $Id: libmdoc.h,v 1.117 2018/12/31 04:55:46 schwarze Exp $ */
|
|
/*
|
|
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
|
|
* Copyright (c) 2013,2014,2015,2017,2018 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
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
|
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
|
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
|
|
struct roff_node;
|
|
struct roff_man;
|
|
struct mdoc_arg;
|
|
|
|
#define MACRO_PROT_ARGS struct roff_man *mdoc, \
|
|
enum roff_tok tok, \
|
|
int line, \
|
|
int ppos, \
|
|
int *pos, \
|
|
char *buf
|
|
|
|
struct mdoc_macro {
|
|
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)
|
|
#define MDOC_JOIN (1 << 5)
|
|
};
|
|
|
|
enum margserr {
|
|
ARGS_ERROR,
|
|
ARGS_EOLN, /* end-of-line */
|
|
ARGS_WORD, /* normal word */
|
|
ARGS_ALLOC, /* normal word from roff_getarg() */
|
|
ARGS_PUNCT, /* series of punctuation */
|
|
ARGS_PHRASE /* Bl -column phrase */
|
|
};
|
|
|
|
/*
|
|
* 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
|
|
};
|
|
|
|
const struct mdoc_macro *mdoc_macro(enum roff_tok);
|
|
|
|
void mdoc_elem_alloc(struct roff_man *, int, int,
|
|
enum roff_tok, struct mdoc_arg *);
|
|
struct roff_node *mdoc_block_alloc(struct roff_man *, int, int,
|
|
enum roff_tok, struct mdoc_arg *);
|
|
void mdoc_tail_alloc(struct roff_man *, int, int,
|
|
enum roff_tok);
|
|
struct roff_node *mdoc_endbody_alloc(struct roff_man *, int, int,
|
|
enum roff_tok, struct roff_node *);
|
|
void mdoc_state(struct roff_man *, struct roff_node *);
|
|
const char *mdoc_a2arch(const char *);
|
|
const char *mdoc_a2att(const char *);
|
|
const char *mdoc_a2lib(const char *);
|
|
enum roff_sec mdoc_a2sec(const char *);
|
|
const char *mdoc_a2st(const char *);
|
|
void mdoc_argv(struct roff_man *, int, enum roff_tok,
|
|
struct mdoc_arg **, int *, char *);
|
|
enum margserr mdoc_args(struct roff_man *, int,
|
|
int *, char *, enum roff_tok, char **);
|
|
enum mdelim mdoc_isdelim(const char *);
|