contrib/mdocml/libman.h

   1 /*      $Id: libman.h,v 1.63 2014/08/01 21:24:17 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   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 enum    man_next {
  21         MAN_NEXT_SIBLING = 0,
  22         MAN_NEXT_CHILD
  23 };
  24
  25 struct  man {
  26         struct mparse   *parse; /* parse pointer */
  27         int              quick; /* abort parse early */
  28         int              flags; /* parse flags */
  29 #define MAN_ELINE       (1 << 1) /* Next-line element scope. */
  30 #define MAN_BLINE       (1 << 2) /* Next-line block scope. */
  31 #define MAN_LITERAL     (1 << 4) /* Literal input. */
  32 #define MAN_NEWLINE     (1 << 6) /* first macro/text in a line */
  33         enum man_next    next; /* where to put the next node */
  34         struct man_node *last; /* the last parsed node */
  35         struct man_node *first; /* the first parsed node */
  36         struct man_meta  meta; /* document meta-data */
  37         struct roff     *roff;
  38 };
  39
  40 #define MACRO_PROT_ARGS   struct man *man, \
  41                           enum mant tok, \
  42                           int line, \
  43                           int ppos, \
  44                           int *pos, \
  45                           char *buf
  46
  47 struct  man_macro {
  48         int             (*fp)(MACRO_PROT_ARGS);
  49         int               flags;
  50 #define MAN_SCOPED       (1 << 0)
  51 #define MAN_EXPLICIT     (1 << 1)       /* See blk_imp(). */
  52 #define MAN_FSCOPED      (1 << 2)       /* See blk_imp(). */
  53 #define MAN_NSCOPED      (1 << 3)       /* See in_line_eoln(). */
  54 #define MAN_NOCLOSE      (1 << 4)       /* See blk_exp(). */
  55 #define MAN_BSCOPE       (1 << 5)       /* Break BLINE scope. */
  56 };
  57
  58 extern  const struct man_macro *const man_macros;
  59
  60 __BEGIN_DECLS
  61
  62 int               man_word_alloc(struct man *, int, int, const char *);
  63 int               man_block_alloc(struct man *, int, int, enum mant);
  64 int               man_head_alloc(struct man *, int, int, enum mant);
  65 int               man_tail_alloc(struct man *, int, int, enum mant);
  66 int               man_body_alloc(struct man *, int, int, enum mant);
  67 int               man_elem_alloc(struct man *, int, int, enum mant);
  68 void              man_node_delete(struct man *, struct man_node *);
  69 void              man_hash_init(void);
  70 enum mant         man_hash_find(const char *);
  71 int               man_macroend(struct man *);
  72 int               man_valid_post(struct man *);
  73 int               man_unscope(struct man *, const struct man_node *);
  74
  75 __END_DECLS
  76
  77 #endif /*!LIBMAN_H*/