version 1.16, 2011/03/22 14:05:45 |
version 1.74, 2018/08/24 23:12:33 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2009, 2010, 2011, 2012 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 |
* 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. |
*/ |
*/ |
#ifndef LIBMANDOC_H |
|
#define LIBMANDOC_H |
|
|
|
enum rofferr { |
|
ROFF_CONT, /* continue processing line */ |
|
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 */ |
|
}; |
|
|
|
enum regs { |
|
REG_nS = 0, /* nS register */ |
|
REG__MAX |
|
}; |
|
|
|
/* |
/* |
* A register (struct reg) can consist of many types: this consists of |
* Return codes passed from the roff parser to the main parser. |
* normalised types from the original string form. For the time being, |
|
* there's only an unsigned integer type. |
|
*/ |
*/ |
union regval { |
|
unsigned u; /* unsigned integer */ |
|
}; |
|
|
|
/* |
/* Main instruction: what to do with the returned line. */ |
* A single register entity. If "set" is zero, the value of the |
#define ROFF_IGN 0x000 /* Don't do anything with it. */ |
* register should be the default one, which is per-register. It's |
#define ROFF_CONT 0x001 /* Give it to the high-level parser. */ |
* assumed that callers know which type in "v" corresponds to which |
#define ROFF_RERUN 0x002 /* Re-run the roff parser with an offset. */ |
* register value. |
#define ROFF_REPARSE 0x004 /* Recursively run the main parser on it. */ |
*/ |
#define ROFF_SO 0x008 /* Include the named file. */ |
struct reg { |
#define ROFF_MASK 0x00f /* Only one of these bits should be set. */ |
int set; /* whether set or not */ |
|
union regval v; /* parsed data */ |
|
}; |
|
|
|
/* |
/* Options for further parsing, to be OR'ed with the above. */ |
* The primary interface to setting register values is in libroff, |
#define ROFF_APPEND 0x010 /* Append the next line to this one. */ |
* although libmdoc and libman from time to time will manipulate |
#define ROFF_USERCALL 0x020 /* Start execution of a new macro. */ |
* registers (such as `.Sh SYNOPSIS' enabling REG_nS). |
#define ROFF_USERRET 0x040 /* Abort execution of the current macro. */ |
*/ |
#define ROFF_WHILE 0x100 /* Start a new .while loop. */ |
struct regset { |
#define ROFF_LOOPCONT 0x200 /* Iterate the current .while loop. */ |
struct reg regs[REG__MAX]; |
#define ROFF_LOOPEXIT 0x400 /* Exit the current .while loop. */ |
|
#define ROFF_LOOPMASK 0xf00 |
|
|
|
|
|
struct buf { |
|
char *buf; |
|
size_t sz; |
|
struct buf *next; |
}; |
}; |
|
|
__BEGIN_DECLS |
|
|
|
|
struct mparse; |
struct roff; |
struct roff; |
struct mdoc; |
struct roff_man; |
struct man; |
|
|
|
void mandoc_msg(enum mandocerr, struct mparse *, |
void mandoc_msg(enum mandocerr, struct mparse *, |
int, int, const char *); |
int, int, const char *); |
void mandoc_vmsg(enum mandocerr, struct mparse *, |
void mandoc_vmsg(enum mandocerr, struct mparse *, |
int, int, const char *, ...); |
int, int, const char *, ...) |
int mandoc_special(char *); |
__attribute__((__format__ (__printf__, 5, 6))); |
char *mandoc_strdup(const char *); |
|
char *mandoc_getarg(struct mparse *, char **, int, int *); |
char *mandoc_getarg(struct mparse *, char **, int, int *); |
char *mandoc_normdate(struct mparse *, char *, int, int); |
char *mandoc_normdate(struct roff_man *, char *, int, int); |
int mandoc_eos(const char *, size_t, int); |
int mandoc_eos(const char *, size_t); |
int mandoc_hyph(const char *, const char *); |
int mandoc_strntoi(const char *, size_t, int); |
|
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 regset *, struct mparse *); |
void mdoc_endparse(struct roff_man *); |
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 regset *, struct mparse *); |
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 *); |
|
|
|
void roff_free(struct roff *); |
int preconv_cue(const struct buf *, size_t); |
struct roff *roff_alloc(struct regset *, struct mparse *); |
int preconv_encode(const struct buf *, size_t *, |
|
struct buf *, size_t *, int *); |
|
|
|
void roff_free(struct roff *); |
|
struct roff *roff_alloc(struct mparse *, 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 *, struct mparse *, |
|
const char *, int); |
|
void roff_man_reset(struct roff_man *); |
|
int roff_parseln(struct roff *, int, struct buf *, int *); |
|
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); |
const struct tbl_span *roff_span(const struct roff *); |
int roff_getreg(struct roff *, const char *); |
const struct eqn *roff_eqn(const struct roff *); |
char *roff_strdup(const struct roff *, const char *); |
|
int roff_getcontrol(const struct roff *, |
__END_DECLS |
const char *, int *); |
|
int roff_getformat(const struct roff *); |
#endif /*!LIBMANDOC_H*/ |
|