| 1 | /* $Id: libman.h,v 1.23 2009/10/30 05:58:36 kristaps Exp $ */ |
| 2 | /* |
| 3 | * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
| 4 | * |
| 5 | * Permission to use, copy, modify, and distribute this software for any |
| 6 | * purpose with or without fee is hereby granted, provided that the above |
| 7 | * copyright notice and this permission notice appear in all copies. |
| 8 | * |
| 9 | * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
| 10 | * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
| 11 | * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
| 12 | * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
| 13 | * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
| 14 | * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| 15 | * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 16 | */ |
| 17 | #ifndef LIBMAN_H |
| 18 | #define LIBMAN_H |
| 19 | |
| 20 | #include "man.h" |
| 21 | |
| 22 | enum man_next { |
| 23 | MAN_NEXT_SIBLING = 0, |
| 24 | MAN_NEXT_CHILD |
| 25 | }; |
| 26 | |
| 27 | struct man { |
| 28 | void *data; |
| 29 | struct man_cb cb; |
| 30 | int pflags; |
| 31 | int flags; |
| 32 | #define MAN_HALT (1 << 0) |
| 33 | #define MAN_ELINE (1 << 1) /* Next-line element scope. */ |
| 34 | #define MAN_BLINE (1 << 2) /* Next-line block scope. */ |
| 35 | #define MAN_LITERAL (1 << 3) /* Literal input. */ |
| 36 | enum man_next next; |
| 37 | struct man_node *last; |
| 38 | struct man_node *first; |
| 39 | struct man_meta meta; |
| 40 | }; |
| 41 | |
| 42 | enum merr { |
| 43 | WNPRINT = 0, |
| 44 | WMSEC, |
| 45 | WDATE, |
| 46 | WLNSCOPE, |
| 47 | WTSPACE, |
| 48 | WTQUOTE, |
| 49 | WNODATA, |
| 50 | WNOTITLE, |
| 51 | WESCAPE, |
| 52 | WNUMFMT, |
| 53 | WHEADARGS, |
| 54 | WBODYARGS, |
| 55 | WNHEADARGS, |
| 56 | WMACROFORM, |
| 57 | WEXITSCOPE, |
| 58 | WNOSCOPE, |
| 59 | WOLITERAL, |
| 60 | WNLITERAL, |
| 61 | WERRMAX |
| 62 | }; |
| 63 | |
| 64 | #define MACRO_PROT_ARGS struct man *m, int tok, int line, \ |
| 65 | int ppos, int *pos, char *buf |
| 66 | |
| 67 | struct man_macro { |
| 68 | int (*fp)(MACRO_PROT_ARGS); |
| 69 | int flags; |
| 70 | #define MAN_SCOPED (1 << 0) |
| 71 | #define MAN_EXPLICIT (1 << 1) /* See blk_imp(). */ |
| 72 | #define MAN_FSCOPED (1 << 2) /* See blk_imp(). */ |
| 73 | }; |
| 74 | |
| 75 | extern const struct man_macro *const man_macros; |
| 76 | |
| 77 | __BEGIN_DECLS |
| 78 | |
| 79 | #define man_perr(m, l, p, t) \ |
| 80 | man_err((m), (l), (p), 1, (t)) |
| 81 | #define man_pwarn(m, l, p, t) \ |
| 82 | man_err((m), (l), (p), 0, (t)) |
| 83 | #define man_nerr(m, n, t) \ |
| 84 | man_err((m), (n)->line, (n)->pos, 1, (t)) |
| 85 | #define man_nwarn(m, n, t) \ |
| 86 | man_err((m), (n)->line, (n)->pos, 0, (t)) |
| 87 | |
| 88 | int man_word_alloc(struct man *, int, int, const char *); |
| 89 | int man_block_alloc(struct man *, int, int, int); |
| 90 | int man_head_alloc(struct man *, int, int, int); |
| 91 | int man_body_alloc(struct man *, int, int, int); |
| 92 | int man_elem_alloc(struct man *, int, int, int); |
| 93 | void man_node_free(struct man_node *); |
| 94 | void man_node_freelist(struct man_node *); |
| 95 | void man_hash_init(void); |
| 96 | int man_hash_find(const char *); |
| 97 | int man_macroend(struct man *); |
| 98 | int man_args(struct man *, int, int *, char *, char **); |
| 99 | #define ARGS_ERROR (-1) |
| 100 | #define ARGS_EOLN (0) |
| 101 | #define ARGS_WORD (1) |
| 102 | #define ARGS_QWORD (1) |
| 103 | int man_err(struct man *, int, int, int, enum merr); |
| 104 | int man_vwarn(struct man *, int, int, const char *, ...); |
| 105 | int man_verr(struct man *, int, int, const char *, ...); |
| 106 | int man_valid_post(struct man *); |
| 107 | int man_valid_pre(struct man *, const struct man_node *); |
| 108 | int man_action_post(struct man *); |
| 109 | int man_action_pre(struct man *, struct man_node *); |
| 110 | int man_unscope(struct man *, const struct man_node *); |
| 111 | |
| 112 | __END_DECLS |
| 113 | |
| 114 | #endif /*!LIBMAN_H*/ |