libman.h

   1 /*      $Id: libman.h,v 1.14 2009/07/07 09:35:40 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         void            *htab;
  31         int              pflags;
  32         int              flags;
  33 #define MAN_HALT        (1 << 0)
  34 #define MAN_NLINE       (1 << 1)
  35         enum man_next    next;
  36         struct man_node *last;
  37         struct man_node *first;
  38         struct man_meta  meta;
  39 };
  40
  41 enum    merr {
  42         WNPRINT = 0,
  43         WNMEM,
  44         WMSEC,
  45         WDATE,
  46         WLNSCOPE,
  47         WTSPACE,
  48         WTQUOTE,
  49         WNODATA,
  50         WNOTITLE,
  51         WESCAPE,
  52         WERRMAX
  53 };
  54
  55 __BEGIN_DECLS
  56
  57 #define           man_perr(m, l, p, t) \
  58                   man_err((m), (l), (p), 1, (t))
  59 #define           man_pwarn(m, l, p, t) \
  60                   man_err((m), (l), (p), 0, (t))
  61 #define           man_nerr(m, n, t) \
  62                   man_err((m), (n)->line, (n)->pos, 1, (t))
  63 #define           man_nwarn(m, n, t) \
  64                   man_err((m), (n)->line, (n)->pos, 0, (t))
  65
  66 int               man_err(struct man *, int, int, int, enum merr);
  67 int               man_word_alloc(struct man *, int, int, const char *);
  68 int               man_elem_alloc(struct man *, int, int, int);
  69 void              man_node_free(struct man_node *);
  70 void              man_node_freelist(struct man_node *);
  71 void             *man_hash_alloc(void);
  72 int               man_macro(struct man *, int,
  73                         int, int, int *, char *);
  74 int               man_hash_find(const void *, const char *);
  75 void              man_hash_free(void *);
  76 int               man_macroend(struct man *);
  77 int               man_vwarn(struct man *, int, int, const char *, ...);
  78 int               man_verr(struct man *, int, int, const char *, ...);
  79 int               man_valid_post(struct man *);
  80 int               man_action_post(struct man *);
  81
  82 __END_DECLS
  83
  84 #endif /*!LIBMAN_H*/