mandoc/libmdoc.h - diff

Return to libmdoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/libmdoc.h between version 1.52 and 1.88

version 1.52, 2010/06/03 13:44:36

version 1.88, 2014/08/01 17:40:34

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

Line 17

Line 18

#ifndef LIBMDOC_H

#define LIBMDOC_H

#include "mdoc.h"

enum mdoc_next {

MDOC_NEXT_SIBLING = 0,

MDOC_NEXT_CHILD

};

struct mdoc {

void *data;

struct mparse *parse; /* parse pointer */

mandocmsg msg;

const char *defos; /* default argument for .Os */

int flags;

int quick; /* abort parse early */

#define MDOC_HALT (1 << 0) /* error in parse: halt */

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

int pflags;

#define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */

enum mdoc_next next;

#define MDOC_KEEP (1 << 8) /* in a word keep */

struct mdoc_node *last;

#define MDOC_SMOFF (1 << 9) /* spacing is off */

struct mdoc_node *first;

enum mdoc_next next; /* where to put the next node */

struct mdoc_meta meta;

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 *m, enum mdoct tok, \

#define MACRO_PROT_ARGS struct mdoc *mdoc, \

int line, int ppos, int *pos, char *buf

enum mdoct tok, \

int line, \

int ppos, \

int *pos, \

char *buf

struct mdoc_macro {

int (*fp)(MACRO_PROT_ARGS);

Line 54 struct mdoc_macro {

Line 61 struct mdoc_macro {

#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 {

ARGS_ERROR,

ARGS_EOLN,

ARGS_EOLN, /* end-of-line */

ARGS_WORD,

ARGS_WORD, /* normal word */

ARGS_PUNCT,

ARGS_PUNCT, /* series of punctuation */

ARGS_QWORD,

ARGS_QWORD, /* quoted word */

ARGS_PHRASE,

ARGS_PHRASE, /* Ta'd phrase (-column) */

ARGS_PPHRASE,

ARGS_PPHRASE, /* tabbed phrase (-column) */

ARGS_PEND

ARGS_PEND /* last phrase (-column) */

};

enum margverr {

ARGV_ERROR,

ARGV_EOLN,

ARGV_EOLN, /* end of line */

ARGV_ARG,

ARGV_ARG, /* valid argument */

ARGV_WORD

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_CLOSE,

DELIM_MAX

};

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 *, ...);

int mdoc_macro(MACRO_PROT_ARGS);

int mdoc_word_alloc(struct mdoc *,

int, int, const char *);

int mdoc_elem_alloc(struct mdoc *, int, int,

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,

enum mdoct, struct mdoc_arg *);

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

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

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_a2msec(const char *);

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

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,

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

int *, char *, char **);

#define ARGS_DELIM (1 << 1)

#define ARGS_TABSEP (1 << 2)

#define ARGS_NOWARN (1 << 3)

int mdoc_macroend(struct mdoc *);

enum mdelim mdoc_isdelim(const char *);

__END_DECLS

CVSweb