private.h

   1 /* $Id: private.h,v 1.45 2008/12/28 00:34:20 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2008 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
   7  * above copyright notice and this permission notice appear in all
   8  * copies.
   9  *
  10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  * PERFORMANCE OF THIS SOFTWARE.
  18  */
  19 #ifndef PRIVATE_H
  20 #define PRIVATE_H
  21
  22 #include "mdoc.h"
  23
  24 struct  mdoc {
  25         void             *data;
  26         struct mdoc_cb    cb;
  27         void             *htab;
  28         struct mdoc_node *last;
  29         struct mdoc_node *first;
  30         struct mdoc_meta  meta;
  31         enum mdoc_sec     sec_lastn;
  32         enum mdoc_sec     sec_last;
  33 };
  34
  35 struct  mdoc_macro {
  36         int     (*fp)(struct mdoc *, int, int, int *, char *);
  37         int       flags;
  38 #define MDOC_CALLABLE   (1 << 0)
  39 #define MDOC_EXPLICIT   (1 << 1)
  40 };
  41
  42 extern  const struct mdoc_macro *const mdoc_macros;
  43
  44 #define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, \
  45                         int ppos, int *pos, char *buf
  46
  47 __BEGIN_DECLS
  48
  49 int               mdoc_err(struct mdoc *, int, int, enum mdoc_err);
  50 int               mdoc_warn(struct mdoc *, int, int, enum mdoc_warn);
  51 void              mdoc_msg(struct mdoc *, int, const char *, ...);
  52 int               mdoc_macro(struct mdoc *, int, int, int *, char *);
  53 int               mdoc_find(const struct mdoc *, const char *);
  54 void              mdoc_word_alloc(struct mdoc *, int, const char *);
  55 void              mdoc_elem_alloc(struct mdoc *, int, int,
  56                         size_t, const struct mdoc_arg *,
  57                         size_t, const char **);
  58 void              mdoc_block_alloc(struct mdoc *, int, int,
  59                         size_t, const struct mdoc_arg *);
  60 void              mdoc_head_alloc(struct mdoc *,
  61                         int, int, size_t, const char **);
  62 void              mdoc_body_alloc(struct mdoc *, int, int);
  63 void              mdoc_node_free(struct mdoc_node *);
  64 void              mdoc_sibling(struct mdoc *, int, struct mdoc_node **,
  65                         struct mdoc_node **, struct mdoc_node *);
  66 void             *mdoc_tokhash_alloc(void);
  67 int               mdoc_tokhash_find(const void *, const char *);
  68 void              mdoc_tokhash_free(void *);
  69 int               mdoc_isdelim(const char *);
  70 int               mdoc_iscdelim(char);
  71 enum    mdoc_sec  mdoc_atosec(size_t, const char **);
  72 enum    mdoc_msec mdoc_atomsec(const char *);
  73 enum    mdoc_vol  mdoc_atovol(const char *);
  74 enum    mdoc_arch mdoc_atoarch(const char *);
  75 time_t            mdoc_atotime(const char *);
  76
  77 int               mdoc_argv(struct mdoc *, int,
  78                         struct mdoc_arg *, int *, char *);
  79 void              mdoc_argv_free(int, struct mdoc_arg *);
  80 int               mdoc_args(struct mdoc *, int,
  81                         int *, char *, int, char **);
  82 #define ARGS_ERROR      (-1)
  83 #define ARGS_EOLN       (0)
  84 #define ARGS_WORD       (1)
  85 #define ARGS_PUNCT      (2)
  86
  87 #define ARGS_QUOTED     (1 << 0)
  88 #define ARGS_DELIM      (1 << 1)
  89
  90 int               xstrlcat(char *, const char *, size_t);
  91 int               xstrlcpy(char *, const char *, size_t);
  92 int               xstrcmp(const char *, const char *);
  93 void             *xcalloc(size_t, size_t);
  94 char             *xstrdup(const char *);
  95
  96 int               macro_text(MACRO_PROT_ARGS);
  97 int               macro_scoped_implicit(MACRO_PROT_ARGS);
  98 int               macro_scoped_explicit(MACRO_PROT_ARGS);
  99 int               macro_prologue_ddate(MACRO_PROT_ARGS);
 100 int               macro_prologue_dtitle(MACRO_PROT_ARGS);
 101 int               macro_prologue_os(MACRO_PROT_ARGS);
 102
 103 __END_DECLS
 104
 105 #endif /*!PRIVATE_H*/