mandoc/libmdoc.h - diff

Return to libmdoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/libmdoc.h between version 1.74 and 1.103

version 1.74, 2011/04/19 16:38:48

version 1.103, 2015/04/19 13:50:25

Line 1

/* $Id$ */

* 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 AUTHOR DISCLAIMS ALL WARRANTIES

* 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 AUTHOR BE LIABLE FOR

* 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.

#ifndef LIBMDOC_H

#define LIBMDOC_H

enum mdoc_next {

#define MACRO_PROT_ARGS struct roff_man *mdoc, \

MDOC_NEXT_SIBLING = 0,

int tok, \

MDOC_NEXT_CHILD

};

struct mdoc {

struct mparse *parse; /* parse pointer */

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 */

#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 */

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;

struct regset *regs; /* registers */

};

#define MACRO_PROT_ARGS struct mdoc *m, \

enum mdoct tok, \

int line, \

int ppos, \

int *pos, \

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_JOIN (1 << 5)

};

enum margserr {

Line 71 enum margserr {

Line 45 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.

Line 99 extern const struct mdoc_macro *const mdoc_macros;

Line 66 extern const struct mdoc_macro *const mdoc_macros;

__BEGIN_DECLS

#define mdoc_pmsg(m, l, p, t) \

void mdoc_macro(MACRO_PROT_ARGS);

mandoc_msg((t), (m)->parse, (l), (p), NULL)

void mdoc_word_alloc(struct roff_man *, int, int, const char *);

#define mdoc_nmsg(m, n, t) \

void mdoc_word_append(struct roff_man *, const char *);

mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL)

void mdoc_elem_alloc(struct roff_man *, int, int,

int mdoc_macro(MACRO_PROT_ARGS);

int, struct mdoc_arg *);

int mdoc_word_alloc(struct mdoc *,

struct roff_node *mdoc_block_alloc(struct roff_man *, int, int,

int, int, const char *);

int, struct mdoc_arg *);

int mdoc_elem_alloc(struct mdoc *, int, int,

void mdoc_tail_alloc(struct roff_man *, int, int, int);

enum mdoct, struct mdoc_arg *);

struct roff_node *mdoc_endbody_alloc(struct roff_man *, int, int, int,

int mdoc_block_alloc(struct mdoc *, int, int,

struct roff_node *, enum mdoc_endbody);

enum mdoct, struct mdoc_arg *);

void mdoc_node_relink(struct roff_man *, struct roff_node *);

int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);

int mdoc_hash_find(const char *);

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);

void mdoc_node_delete(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 *);

void mdoc_valid_pre(struct roff_man *, struct roff_node *);

const char *mdoc_a2msec(const char *);

void mdoc_valid_post(struct roff_man *);

int mdoc_valid_pre(struct mdoc *, struct mdoc_node *);

void mdoc_argv(struct roff_man *, int, int,

int mdoc_valid_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 margserr mdoc_args(struct mdoc *, int,

enum margserr mdoc_args(struct roff_man *, int,

int *, char *, enum mdoct, char **);

int *, char *, int, char **);

enum margserr mdoc_zargs(struct mdoc *, int,

void mdoc_macroend(struct roff_man *);

int *, char *, char **);

int mdoc_macroend(struct mdoc *);

enum mdelim mdoc_isdelim(const char *);

__END_DECLS

#endif /*!LIBMDOC_H*/

CVSweb