version 1.7, 2010/06/09 19:22:56 |
version 1.16, 2011/03/22 14:05:45 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 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 LIBMANDOC_H |
#ifndef LIBMANDOC_H |
#define 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 |
|
* normalised types from the original string form. For the time being, |
|
* there's only an unsigned integer type. |
|
*/ |
|
union regval { |
|
unsigned u; /* unsigned integer */ |
|
}; |
|
|
|
/* |
|
* A single register entity. If "set" is zero, the value of the |
|
* register should be the default one, which is per-register. It's |
|
* assumed that callers know which type in "v" corresponds to which |
|
* register value. |
|
*/ |
|
struct reg { |
|
int set; /* whether set or not */ |
|
union regval v; /* parsed data */ |
|
}; |
|
|
|
/* |
|
* The primary interface to setting register values is in libroff, |
|
* although libmdoc and libman from time to time will manipulate |
|
* registers (such as `.Sh SYNOPSIS' enabling REG_nS). |
|
*/ |
|
struct regset { |
|
struct reg regs[REG__MAX]; |
|
}; |
|
|
__BEGIN_DECLS |
__BEGIN_DECLS |
|
|
|
struct roff; |
|
struct mdoc; |
|
struct man; |
|
|
|
void mandoc_msg(enum mandocerr, struct mparse *, |
|
int, int, const char *); |
|
void mandoc_vmsg(enum mandocerr, struct mparse *, |
|
int, int, const char *, ...); |
int mandoc_special(char *); |
int mandoc_special(char *); |
void *mandoc_calloc(size_t, size_t); |
|
char *mandoc_strdup(const char *); |
char *mandoc_strdup(const char *); |
void *mandoc_malloc(size_t); |
char *mandoc_getarg(struct mparse *, char **, int, int *); |
void *mandoc_realloc(void *, size_t); |
char *mandoc_normdate(struct mparse *, char *, int, int); |
time_t mandoc_a2time(int, const char *); |
int mandoc_eos(const char *, size_t, int); |
#define MTIME_CANONICAL (1 << 0) |
|
#define MTIME_REDUCED (1 << 1) |
|
#define MTIME_MDOCDATE (1 << 2) |
|
#define MTIME_ISO_8601 (1 << 3) |
|
int mandoc_eos(const char *, size_t); |
|
int mandoc_hyph(const char *, const char *); |
int mandoc_hyph(const char *, const char *); |
|
|
|
void mdoc_free(struct mdoc *); |
|
struct mdoc *mdoc_alloc(struct regset *, struct mparse *); |
|
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 *); |
|
struct man *man_alloc(struct regset *, struct mparse *); |
|
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 *); |
|
struct roff *roff_alloc(struct regset *, struct mparse *); |
|
void roff_reset(struct roff *); |
|
enum rofferr roff_parseln(struct roff *, int, |
|
char **, size_t *, int, int *); |
|
void roff_endparse(struct roff *); |
|
|
|
const struct tbl_span *roff_span(const struct roff *); |
|
const struct eqn *roff_eqn(const struct roff *); |
|
|
__END_DECLS |
__END_DECLS |
|
|