Return to libmdoc.h CVS log | Up to [cvsweb.bsd.lv] / mandoc |
version 1.56, 2010/06/27 15:52:41 | version 1.78, 2011/12/02 01:37:14 | ||
---|---|---|---|
|
|
||
/* $Id$ */ | /* $Id$ */ | ||
/* | /* | ||
* Copyright (c) 2008, 2009 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 | * Permission to use, copy, modify, and distribute this software for any | ||
* purpose with or without fee is hereby granted, provided that the above | * purpose with or without fee is hereby granted, provided that the above | ||
|
|
||
#ifndef LIBMDOC_H | #ifndef LIBMDOC_H | ||
#define LIBMDOC_H | #define LIBMDOC_H | ||
#include "regs.h" | |||
#include "mdoc.h" | |||
enum mdoc_next { | enum mdoc_next { | ||
MDOC_NEXT_SIBLING = 0, | MDOC_NEXT_SIBLING = 0, | ||
MDOC_NEXT_CHILD | MDOC_NEXT_CHILD | ||
}; | }; | ||
struct mdoc { | struct mdoc { | ||
void *data; /* private application data */ | struct mparse *parse; /* parse pointer */ | ||
mandocmsg msg; /* message callback */ | int flags; /* parse flags */ | ||
int flags; | |||
#define MDOC_HALT (1 << 0) /* error in parse: halt */ | #define MDOC_HALT (1 << 0) /* error in parse: halt */ | ||
#define MDOC_LITERAL (1 << 1) /* in a literal scope */ | #define MDOC_LITERAL (1 << 1) /* in a literal scope */ | ||
#define MDOC_PBODY (1 << 2) /* in the document body */ | #define MDOC_PBODY (1 << 2) /* in the document body */ | ||
|
|
||
#define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */ | #define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */ | ||
#define MDOC_PPHRASE (1 << 5) /* within a partial phrase */ | #define MDOC_PPHRASE (1 << 5) /* within a partial phrase */ | ||
#define MDOC_FREECOL (1 << 6) /* `It' invocation should close */ | #define MDOC_FREECOL (1 << 6) /* `It' invocation should close */ | ||
int pflags; | #define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */ | ||
enum mdoc_next next; /* where to put the next node */ | enum mdoc_next next; /* where to put the next node */ | ||
struct mdoc_node *last; /* the last node parsed */ | struct mdoc_node *last; /* the last node parsed */ | ||
struct mdoc_node *first; /* the first node parsed */ | struct mdoc_node *first; /* the first node parsed */ | ||
struct mdoc_meta meta; /* document meta-data */ | struct mdoc_meta meta; /* document meta-data */ | ||
enum mdoc_sec lastnamed; | enum mdoc_sec lastnamed; | ||
enum mdoc_sec lastsec; | enum mdoc_sec lastsec; | ||
const struct regset *regs; /* readonly registers */ | struct roff *roff; | ||
}; | }; | ||
#define MACRO_PROT_ARGS struct mdoc *m, \ | #define MACRO_PROT_ARGS struct mdoc *m, \ | ||
|
|
||
enum margserr { | enum margserr { | ||
ARGS_ERROR, | 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 { | enum margverr { | ||
ARGV_ERROR, | 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 { | enum mdelim { | ||
DELIM_NONE = 0, | DELIM_NONE = 0, | ||
DELIM_OPEN, | DELIM_OPEN, | ||
DELIM_MIDDLE, | DELIM_MIDDLE, | ||
DELIM_CLOSE | DELIM_CLOSE, | ||
DELIM_MAX | |||
}; | }; | ||
extern const struct mdoc_macro *const mdoc_macros; | extern const struct mdoc_macro *const mdoc_macros; | ||
|
|
||
__BEGIN_DECLS | __BEGIN_DECLS | ||
#define mdoc_pmsg(m, l, p, t) \ | #define mdoc_pmsg(m, l, p, t) \ | ||
(*(m)->msg)((t), (m)->data, (l), (p), NULL) | mandoc_msg((t), (m)->parse, (l), (p), NULL) | ||
#define mdoc_nmsg(m, n, t) \ | #define mdoc_nmsg(m, n, t) \ | ||
(*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL) | mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL) | ||
int mdoc_vmsg(struct mdoc *, enum mandocerr, | |||
int, int, const char *, ...); | |||
int mdoc_macro(MACRO_PROT_ARGS); | int mdoc_macro(MACRO_PROT_ARGS); | ||
int mdoc_word_alloc(struct mdoc *, | int mdoc_word_alloc(struct mdoc *, | ||
int, int, const char *); | int, int, const char *); | ||
|
|
||
int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct); | int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct); | ||
int mdoc_tail_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_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_node_delete(struct mdoc *, struct mdoc_node *); | ||
void mdoc_hash_init(void); | void mdoc_hash_init(void); | ||
enum mdoct mdoc_hash_find(const char *); | 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_a2att(const char *); | ||
const char *mdoc_a2lib(const char *); | const char *mdoc_a2lib(const char *); | ||
const char *mdoc_a2st(const char *); | const char *mdoc_a2st(const char *); | ||
const char *mdoc_a2arch(const char *); | const char *mdoc_a2arch(const char *); | ||
const char *mdoc_a2vol(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_pre(struct mdoc *, struct mdoc_node *); | ||
int mdoc_valid_post(struct mdoc *); | 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, | enum margverr mdoc_argv(struct mdoc *, int, enum mdoct, | ||
struct mdoc_arg **, int *, char *); | struct mdoc_arg **, int *, char *); | ||
void mdoc_argv_free(struct mdoc_arg *); | void mdoc_argv_free(struct mdoc_arg *); | ||
void mdoc_argn_free(struct mdoc_arg *, int); | |||
enum margserr mdoc_args(struct mdoc *, int, | enum margserr mdoc_args(struct mdoc *, int, | ||
int *, char *, enum mdoct, char **); | int *, char *, enum mdoct, char **); | ||
enum margserr mdoc_zargs(struct mdoc *, int, | 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 *); | int mdoc_macroend(struct mdoc *); | ||
enum mdelim mdoc_isdelim(const char *); | |||
__END_DECLS | __END_DECLS | ||