libman.h

   1 /*      $Id: libman.h,v 1.34 2010/05/17 22:11:42 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         mandocmsg        msg;
  30         int              pflags; /* parse flags (see man.h) */
  31         int              flags; /* parse flags */
  32 #define MAN_HALT        (1 << 0) /* badness happened: die */
  33 #define MAN_ELINE       (1 << 1) /* Next-line element scope. */
  34 #define MAN_BLINE       (1 << 2) /* Next-line block scope. */
  35 #define MAN_ILINE       (1 << 3) /* Ignored in next-line scope. */
  36 #define MAN_LITERAL     (1 << 4) /* Literal input. */
  37 #define MAN_BPLINE      (1 << 5)
  38         enum man_next    next;
  39         struct man_node *last;
  40         struct man_node *first;
  41         struct man_meta  meta;
  42 };
  43
  44 #define MACRO_PROT_ARGS   struct man *m, enum mant tok, int line, \
  45                           int ppos, int *pos, 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 };
  56
  57 extern  const struct man_macro *const man_macros;
  58
  59 __BEGIN_DECLS
  60
  61 #define           man_pmsg(m, l, p, t) \
  62                   (*(m)->msg)((t), (m)->data, (l), (p), NULL)
  63 #define           man_nmsg(m, n, t) \
  64                   (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
  65 int               man_word_alloc(struct man *, int, int, const char *);
  66 int               man_block_alloc(struct man *, int, int, enum mant);
  67 int               man_head_alloc(struct man *, int, int, enum mant);
  68 int               man_body_alloc(struct man *, int, int, enum mant);
  69 int               man_elem_alloc(struct man *, int, int, enum mant);
  70 void              man_node_delete(struct man *, struct man_node *);
  71 void              man_hash_init(void);
  72 enum    mant      man_hash_find(const char *);
  73 int               man_macroend(struct man *);
  74 int               man_args(struct man *, int, int *, char *, char **);
  75 #define ARGS_ERROR      (-1)
  76 #define ARGS_EOLN       (0)
  77 #define ARGS_WORD       (1)
  78 #define ARGS_QWORD      (1)
  79 int               man_vmsg(struct man *, enum mandocerr,
  80                         int, int, const char *, ...);
  81 int               man_valid_post(struct man *);
  82 int               man_valid_pre(struct man *, const struct man_node *);
  83 int               man_action_post(struct man *);
  84 int               man_action_pre(struct man *, struct man_node *);
  85 int               man_unscope(struct man *,
  86                         const struct man_node *, enum mandocerr);
  87
  88 __END_DECLS
  89
  90 #endif /*!LIBMAN_H*/