version 1.87, 2010/06/12 12:10:55 |
version 1.113, 2010/12/26 14:44:13 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009, 2010 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 MDOC_H |
#ifndef MDOC_H |
#define MDOC_H |
#define MDOC_H |
|
|
/* |
/* |
* This library implements a validating scanner/parser for ``mdoc'' roff |
* What follows is a list of ALL possible macros. |
* macro documents, a.k.a. BSD manual page documents. The mdoc.c file |
|
* drives the parser, while macro.c describes the macro ontologies. |
|
* validate.c pre- and post-validates parsed macros, and action.c |
|
* performs actions on parsed and validated macros. |
|
*/ |
*/ |
|
|
/* What follows is a list of ALL possible macros. */ |
|
|
|
enum mdoct { |
enum mdoct { |
MDOC_Ap = 0, |
MDOC_Ap = 0, |
MDOC_Dd, |
MDOC_Dd, |
|
|
MDOC_MAX |
MDOC_MAX |
}; |
}; |
|
|
/* What follows is a list of ALL possible macro arguments. */ |
/* |
|
* What follows is a list of ALL possible macro arguments. |
|
*/ |
|
enum mdocargt { |
|
MDOC_Split, |
|
MDOC_Nosplit, |
|
MDOC_Ragged, |
|
MDOC_Unfilled, |
|
MDOC_Literal, |
|
MDOC_File, |
|
MDOC_Offset, |
|
MDOC_Bullet, |
|
MDOC_Dash, |
|
MDOC_Hyphen, |
|
MDOC_Item, |
|
MDOC_Enum, |
|
MDOC_Tag, |
|
MDOC_Diag, |
|
MDOC_Hang, |
|
MDOC_Ohang, |
|
MDOC_Inset, |
|
MDOC_Column, |
|
MDOC_Width, |
|
MDOC_Compact, |
|
MDOC_Std, |
|
MDOC_Filled, |
|
MDOC_Words, |
|
MDOC_Emphasis, |
|
MDOC_Symbolic, |
|
MDOC_Nested, |
|
MDOC_Centred, |
|
MDOC_ARG_MAX |
|
}; |
|
|
#define MDOC_Split 0 |
/* |
#define MDOC_Nosplit 1 |
* Type of a syntax node. |
#define MDOC_Ragged 2 |
*/ |
#define MDOC_Unfilled 3 |
|
#define MDOC_Literal 4 |
|
#define MDOC_File 5 |
|
#define MDOC_Offset 6 |
|
#define MDOC_Bullet 7 |
|
#define MDOC_Dash 8 |
|
#define MDOC_Hyphen 9 |
|
#define MDOC_Item 10 |
|
#define MDOC_Enum 11 |
|
#define MDOC_Tag 12 |
|
#define MDOC_Diag 13 |
|
#define MDOC_Hang 14 |
|
#define MDOC_Ohang 15 |
|
#define MDOC_Inset 16 |
|
#define MDOC_Column 17 |
|
#define MDOC_Width 18 |
|
#define MDOC_Compact 19 |
|
#define MDOC_Std 20 |
|
#define MDOC_Filled 21 |
|
#define MDOC_Words 22 |
|
#define MDOC_Emphasis 23 |
|
#define MDOC_Symbolic 24 |
|
#define MDOC_Nested 25 |
|
#define MDOC_Centred 26 |
|
#define MDOC_ARG_MAX 27 |
|
|
|
/* Type of a syntax node. */ |
|
enum mdoc_type { |
enum mdoc_type { |
MDOC_TEXT, |
MDOC_TEXT, |
MDOC_ELEM, |
MDOC_ELEM, |
Line 195 enum mdoc_type { |
|
Line 193 enum mdoc_type { |
|
MDOC_ROOT |
MDOC_ROOT |
}; |
}; |
|
|
/* Section (named/unnamed) of `Sh'. */ |
/* |
|
* Section (named/unnamed) of `Sh'. Note that these appear in the |
|
* conventional order imposed by mdoc.7. |
|
*/ |
enum mdoc_sec { |
enum mdoc_sec { |
SEC_NONE, /* No section, yet. */ |
SEC_NONE = 0, /* No section, yet. */ |
SEC_NAME, |
SEC_NAME, |
SEC_LIBRARY, |
SEC_LIBRARY, |
SEC_SYNOPSIS, |
SEC_SYNOPSIS, |
|
|
SEC_CAVEATS, |
SEC_CAVEATS, |
SEC_BUGS, |
SEC_BUGS, |
SEC_SECURITY, |
SEC_SECURITY, |
SEC_CUSTOM, /* User-defined. */ |
SEC_CUSTOM, /* User-defined. */ |
SEC__MAX |
SEC__MAX |
}; |
}; |
|
|
/* Information from prologue. */ |
/* |
|
* Information from prologue. |
|
*/ |
struct mdoc_meta { |
struct mdoc_meta { |
char *msec; |
char *msec; /* `Dt' section (1, 3p, etc.) */ |
char *vol; |
char *vol; /* `Dt' volume (implied) */ |
char *arch; |
char *arch; /* `Dt' arch (i386, etc.) */ |
time_t date; |
time_t date; /* `Dd' normalised date */ |
char *title; |
char *title; /* `Dt' title (FOO, etc.) */ |
char *os; |
char *os; /* `Os' system (OpenBSD, etc.) */ |
char *name; |
char *name; /* leading `Nm' name */ |
}; |
}; |
|
|
/* An argument to a macro (multiple values = `It -column'). */ |
/* |
|
* An argument to a macro (multiple values = `-column xxx yyy'). |
|
*/ |
struct mdoc_argv { |
struct mdoc_argv { |
int arg; |
enum mdocargt arg; /* type of argument */ |
int line; |
int line; |
int pos; |
int pos; |
size_t sz; |
size_t sz; /* elements in "value" */ |
char **value; |
char **value; /* argument strings */ |
}; |
}; |
|
|
|
/* |
|
* Reference-counted macro arguments. These are refcounted because |
|
* blocks have multiple instances of the same arguments spread across |
|
* the HEAD, BODY, TAIL, and BLOCK node types. |
|
*/ |
struct mdoc_arg { |
struct mdoc_arg { |
size_t argc; |
size_t argc; |
struct mdoc_argv *argv; |
struct mdoc_argv *argv; |
unsigned int refcnt; |
unsigned int refcnt; |
}; |
}; |
|
|
|
/* |
|
* Indicates that a BODY's formatting has ended, but the scope is still |
|
* open. Used for syntax-broken blocks. |
|
*/ |
|
enum mdoc_endbody { |
|
ENDBODY_NOT = 0, |
|
ENDBODY_SPACE, /* is broken: append a space */ |
|
ENDBODY_NOSPACE /* is broken: don't append a space */ |
|
}; |
|
|
|
/* |
|
* Normalised `Bl' list type. |
|
*/ |
enum mdoc_list { |
enum mdoc_list { |
LIST__NONE = 0, |
LIST__NONE = 0, |
LIST_bullet, |
LIST_bullet, |
Line 260 enum mdoc_list { |
|
Line 283 enum mdoc_list { |
|
LIST_inset, |
LIST_inset, |
LIST_item, |
LIST_item, |
LIST_ohang, |
LIST_ohang, |
LIST_tag |
LIST_tag, |
|
LIST_MAX |
}; |
}; |
|
|
|
/* |
|
* Normalised `Bd' display type. |
|
*/ |
enum mdoc_disp { |
enum mdoc_disp { |
DISP__NONE = 0, |
DISP__NONE = 0, |
DISP_centred, |
DISP_centred, |
Line 272 enum mdoc_disp { |
|
Line 299 enum mdoc_disp { |
|
DISP_literal |
DISP_literal |
}; |
}; |
|
|
|
/* |
|
* Normalised `An' splitting argument. |
|
*/ |
|
enum mdoc_auth { |
|
AUTH__NONE = 0, |
|
AUTH_split, |
|
AUTH_nosplit |
|
}; |
|
|
|
/* |
|
* Normalised `Bf' font type. |
|
*/ |
|
enum mdoc_font { |
|
FONT__NONE = 0, |
|
FONT_Em, |
|
FONT_Li, |
|
FONT_Sy |
|
}; |
|
|
|
/* |
|
* Normalised arguments for `Bd'. |
|
*/ |
struct mdoc_bd { |
struct mdoc_bd { |
const char *offs; /* -offset */ |
const char *offs; /* -offset */ |
enum mdoc_disp type; /* -ragged, etc. */ |
enum mdoc_disp type; /* -ragged, etc. */ |
int comp; /* -compact */ |
int comp; /* -compact */ |
}; |
}; |
|
|
|
/* |
|
* Normalised arguments for `Bl'. |
|
*/ |
struct mdoc_bl { |
struct mdoc_bl { |
|
const char *width; /* -width */ |
|
const char *offs; /* -offset */ |
enum mdoc_list type; /* -tag, -enum, etc. */ |
enum mdoc_list type; /* -tag, -enum, etc. */ |
int comp; /* -compact */ |
int comp; /* -compact */ |
|
size_t ncols; /* -column arg count */ |
|
const char **cols; /* -column val ptr */ |
}; |
}; |
|
|
/* Node in AST. */ |
/* |
|
* Normalised arguments for `Bf'. |
|
*/ |
|
struct mdoc_bf { |
|
enum mdoc_font font; /* font */ |
|
}; |
|
|
|
/* |
|
* Normalised arguments for `An'. |
|
*/ |
|
struct mdoc_an { |
|
enum mdoc_auth auth; /* -split, etc. */ |
|
}; |
|
|
|
struct mdoc_rs { |
|
struct mdoc_node *child_J; /* pointer to %J */ |
|
}; |
|
|
|
/* |
|
* Consists of normalised node arguments. These should be used instead |
|
* of iterating through the mdoc_arg pointers of a node: defaults are |
|
* provided, etc. |
|
*/ |
|
union mdoc_data { |
|
struct mdoc_an An; |
|
struct mdoc_bd Bd; |
|
struct mdoc_bf Bf; |
|
struct mdoc_bl Bl; |
|
struct mdoc_rs Rs; |
|
}; |
|
|
|
/* |
|
* Single node in tree-linked AST. |
|
*/ |
struct mdoc_node { |
struct mdoc_node { |
struct mdoc_node *parent; /* parent AST node */ |
struct mdoc_node *parent; /* parent AST node */ |
struct mdoc_node *child; /* first child AST node */ |
struct mdoc_node *child; /* first child AST node */ |
|
struct mdoc_node *last; /* last child AST node */ |
struct mdoc_node *next; /* sibling AST node */ |
struct mdoc_node *next; /* sibling AST node */ |
struct mdoc_node *prev; /* prior sibling AST node */ |
struct mdoc_node *prev; /* prior sibling AST node */ |
int nchild; /* number children */ |
int nchild; /* number children */ |
Line 295 struct mdoc_node { |
|
Line 385 struct mdoc_node { |
|
enum mdoct tok; /* tok or MDOC__MAX if none */ |
enum mdoct tok; /* tok or MDOC__MAX if none */ |
int flags; |
int flags; |
#define MDOC_VALID (1 << 0) /* has been validated */ |
#define MDOC_VALID (1 << 0) /* has been validated */ |
#define MDOC_ACTED (1 << 1) /* has been acted upon */ |
|
#define MDOC_EOS (1 << 2) /* at sentence boundary */ |
#define MDOC_EOS (1 << 2) /* at sentence boundary */ |
#define MDOC_LINE (1 << 3) /* first macro/text on line */ |
#define MDOC_LINE (1 << 3) /* first macro/text on line */ |
|
#define MDOC_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting */ |
|
#define MDOC_ENDED (1 << 5) /* rendering has been ended */ |
enum mdoc_type type; /* AST node type */ |
enum mdoc_type type; /* AST node type */ |
enum mdoc_sec sec; /* current named section */ |
enum mdoc_sec sec; /* current named section */ |
struct mdoc_arg *args; /* BLOCK/ELEM */ |
union mdoc_data *norm; /* normalised args */ |
#ifdef UGLY |
/* FIXME: these can be union'd to shave a few bytes. */ |
struct mdoc_node *pending; /* BLOCK */ |
struct mdoc_arg *args; /* BLOCK/ELEM */ |
#endif |
struct mdoc_node *pending; /* BLOCK */ |
struct mdoc_node *head; /* BLOCK */ |
struct mdoc_node *head; /* BLOCK */ |
struct mdoc_node *body; /* BLOCK */ |
struct mdoc_node *body; /* BLOCK */ |
struct mdoc_node *tail; /* BLOCK */ |
struct mdoc_node *tail; /* BLOCK */ |
char *string; /* TEXT */ |
char *string; /* TEXT */ |
|
enum mdoc_endbody end; /* BODY */ |
union { |
|
struct mdoc_bl Bl; |
|
struct mdoc_bd Bd; |
|
} data; |
|
}; |
}; |
|
|
#define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */ |
/* |
#define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */ |
* Names of macros. Index is enum mdoct. Indexing into this returns |
#define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */ |
* the normalised name, e.g., mdoc_macronames[MDOC_Sh] -> "Sh". |
|
*/ |
/* See mdoc.3 for documentation. */ |
|
|
|
extern const char *const *mdoc_macronames; |
extern const char *const *mdoc_macronames; |
|
|
|
/* |
|
* Names of macro args. Index is enum mdocargt. Indexing into this |
|
* returns the normalised name, e.g., mdoc_argnames[MDOC_File] -> |
|
* "file". |
|
*/ |
extern const char *const *mdoc_argnames; |
extern const char *const *mdoc_argnames; |
|
|
__BEGIN_DECLS |
__BEGIN_DECLS |
|
|
struct mdoc; |
struct mdoc; |
|
|
/* See mdoc.3 for documentation. */ |
|
|
|
void mdoc_free(struct mdoc *); |
void mdoc_free(struct mdoc *); |
struct mdoc *mdoc_alloc(void *, int, mandocmsg); |
struct mdoc *mdoc_alloc(struct regset *, void *, mandocmsg); |
void mdoc_reset(struct mdoc *); |
void mdoc_reset(struct mdoc *); |
int mdoc_parseln(struct mdoc *, int, char *, int); |
int mdoc_parseln(struct mdoc *, int, char *, int); |
const struct mdoc_node *mdoc_node(const struct mdoc *); |
const struct mdoc_node *mdoc_node(const struct mdoc *); |