version 1.47, 2014/11/01 04:08:43 |
version 1.80, 2021/06/27 17:57:54 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
|
* Copyright (c) 2013-2015,2017,2018,2020 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2009, 2010, 2011, 2012 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 |
* 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 |
* copyright notice and this permission notice appear in all copies. |
* 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 |
* 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 |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
* |
|
* Internal interfaces for parser utilities needed by multiple parsers |
|
* and the top-level functions to call the mdoc, man, and roff parsers. |
*/ |
*/ |
#ifndef LIBMANDOC_H |
|
#define LIBMANDOC_H |
|
|
|
enum rofferr { |
/* |
ROFF_CONT, /* continue processing line */ |
* Return codes passed from the roff parser to the main parser. |
ROFF_RERUN, /* re-run roff interpreter with offset */ |
*/ |
ROFF_APPEND, /* re-run main parser, appending next line */ |
|
ROFF_REPARSE, /* re-run main parser on the result */ |
|
ROFF_SO, /* include another file */ |
|
ROFF_IGN, /* ignore current line */ |
|
ROFF_TBL, /* a table row was successfully parsed */ |
|
ROFF_EQN, /* an equation was successfully parsed */ |
|
ROFF_ERR /* badness: puke and stop */ |
|
}; |
|
|
|
|
/* Main instruction: what to do with the returned line. */ |
|
#define ROFF_IGN 0x000 /* Don't do anything with it. */ |
|
#define ROFF_CONT 0x001 /* Give it to the high-level parser. */ |
|
#define ROFF_RERUN 0x002 /* Re-run the roff parser with an offset. */ |
|
#define ROFF_REPARSE 0x004 /* Recursively run the main parser on it. */ |
|
#define ROFF_SO 0x008 /* Include the named file. */ |
|
#define ROFF_MASK 0x00f /* Only one of these bits should be set. */ |
|
|
|
/* Options for further parsing, to be OR'ed with the above. */ |
|
#define ROFF_APPEND 0x010 /* Append the next line to this one. */ |
|
#define ROFF_USERCALL 0x020 /* Start execution of a new macro. */ |
|
#define ROFF_USERRET 0x040 /* Abort execution of the current macro. */ |
|
#define ROFF_WHILE 0x100 /* Start a new .while loop. */ |
|
#define ROFF_LOOPCONT 0x200 /* Iterate the current .while loop. */ |
|
#define ROFF_LOOPEXIT 0x400 /* Exit the current .while loop. */ |
|
#define ROFF_LOOPMASK 0xf00 |
|
|
|
|
struct buf { |
struct buf { |
char *buf; |
char *buf; |
size_t sz; |
size_t sz; |
|
struct buf *next; |
}; |
}; |
|
|
__BEGIN_DECLS |
|
|
|
struct roff; |
struct roff; |
struct mdoc; |
struct roff_man; |
struct man; |
struct roff_node; |
|
|
void mandoc_msg(enum mandocerr, struct mparse *, |
char *mandoc_normdate(struct roff_node *, struct roff_node *); |
int, int, const char *); |
|
#if __GNUC__ - 0 >= 4 |
|
__attribute__((__format__ (__printf__, 5, 6))) |
|
#endif |
|
void mandoc_vmsg(enum mandocerr, struct mparse *, |
|
int, int, const char *, ...); |
|
char *mandoc_getarg(struct mparse *, char **, int, int *); |
|
char *mandoc_normdate(struct mparse *, char *, int, int); |
|
int mandoc_eos(const char *, size_t); |
int mandoc_eos(const char *, size_t); |
int mandoc_strntoi(const char *, size_t, int); |
int mandoc_strntoi(const char *, size_t, int); |
const char *mandoc_a2msec(const char*); |
const char *mandoc_a2msec(const char*); |
|
|
void mdoc_free(struct mdoc *); |
int mdoc_parseln(struct roff_man *, int, char *, int); |
struct mdoc *mdoc_alloc(struct roff *, struct mparse *, |
void mdoc_endparse(struct roff_man *); |
const char *, int); |
|
void mdoc_reset(struct mdoc *); |
|
int mdoc_parseln(struct mdoc *, int, char *, int); |
|
int mdoc_endparse(struct mdoc *); |
|
int mdoc_addspan(struct mdoc *, const struct tbl_span *); |
|
int mdoc_addeqn(struct mdoc *, const struct eqn *); |
|
|
|
void man_free(struct man *); |
int man_parseln(struct roff_man *, int, char *, int); |
struct man *man_alloc(struct roff *, struct mparse *, int); |
void man_endparse(struct roff_man *); |
void man_reset(struct man *); |
|
int man_parseln(struct man *, int, char *, int); |
|
int man_endparse(struct man *); |
|
int man_addspan(struct man *, const struct tbl_span *); |
|
int man_addeqn(struct man *, const struct eqn *); |
|
|
|
int preconv_cue(const struct buf *, size_t); |
int preconv_cue(const struct buf *, size_t); |
int preconv_encode(struct buf *, size_t *, |
int preconv_encode(const struct buf *, size_t *, |
struct buf *, size_t *, int *); |
struct buf *, size_t *, int *); |
|
|
void roff_free(struct roff *); |
void roff_free(struct roff *); |
struct roff *roff_alloc(struct mparse *, const struct mchars *, int); |
struct roff *roff_alloc(int); |
void roff_reset(struct roff *); |
void roff_reset(struct roff *); |
enum rofferr roff_parseln(struct roff *, int, |
void roff_man_free(struct roff_man *); |
char **, size_t *, int, int *); |
struct roff_man *roff_man_alloc(struct roff *, const char *, int); |
|
void roff_man_reset(struct roff_man *); |
|
int roff_parseln(struct roff *, int, struct buf *, int *, size_t); |
|
void roff_userret(struct roff *); |
void roff_endparse(struct roff *); |
void roff_endparse(struct roff *); |
void roff_setreg(struct roff *, const char *, int, char sign); |
void roff_setreg(struct roff *, const char *, int, char); |
int roff_getreg(const struct roff *, const char *); |
int roff_getreg(struct roff *, const char *); |
char *roff_strdup(const struct roff *, const char *); |
char *roff_strdup(const struct roff *, const char *); |
|
char *roff_getarg(struct roff *, char **, int, int *); |
int roff_getcontrol(const struct roff *, |
int roff_getcontrol(const struct roff *, |
const char *, int *); |
const char *, int *); |
int roff_getformat(const struct roff *); |
int roff_getformat(const struct roff *); |
|
|
const struct tbl_span *roff_span(const struct roff *); |
|
const struct eqn *roff_eqn(const struct roff *); |
|
|
|
__END_DECLS |
|
|
|
#endif /*!LIBMANDOC_H*/ |
|