libroff.h

   1 /*      $Id: libroff.h,v 1.11 2010/12/31 18:19:43 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2009, 2010 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 LIBROFF_H
  18 #define LIBROFF_H
  19
  20 __BEGIN_DECLS
  21
  22 enum    tbl_part {
  23         TBL_PART_OPTS, /* in options (first line) */
  24         TBL_PART_LAYOUT, /* describing layout */
  25         TBL_PART_DATA  /* creating data rows */
  26 };
  27
  28 struct  tbl {
  29         mandocmsg         msg; /* status messages */
  30         void             *data; /* privdata for messages */
  31         enum tbl_part     part;
  32         char              tab; /* cell-separator */
  33         char              decimal; /* decimal point */
  34         int               linesize;
  35         char              delims[2];
  36         int               opts;
  37 #define TBL_OPT_CENTRE   (1 << 0)
  38 #define TBL_OPT_EXPAND   (1 << 1)
  39 #define TBL_OPT_BOX      (1 << 2)
  40 #define TBL_OPT_DBOX     (1 << 3)
  41 #define TBL_OPT_ALLBOX   (1 << 4)
  42 #define TBL_OPT_NOKEEP   (1 << 5)
  43 #define TBL_OPT_NOSPACE  (1 << 6)
  44         struct tbl_row   *first_row;
  45         struct tbl_row   *last_row;
  46         struct tbl_span  *first_span;
  47         struct tbl_span  *last_span;
  48         struct tbl       *next;
  49 };
  50
  51 #define TBL_MSG(tblp, type, line, col) \
  52         (*(tblp)->msg)((type), (tblp)->data, (line), (col), NULL)
  53
  54 struct tbl      *tbl_alloc(void *, mandocmsg);
  55 void             tbl_restart(struct tbl *);
  56 void             tbl_free(struct tbl *);
  57 void             tbl_reset(struct tbl *);
  58 enum rofferr     tbl_read(struct tbl *, int, const char *, int);
  59 int              tbl_option(struct tbl *, int, const char *);
  60 int              tbl_layout(struct tbl *, int, const char *);
  61 int              tbl_data(struct tbl *, int, const char *);
  62 const struct tbl_span *tbl_span(const struct tbl *);
  63
  64 __END_DECLS
  65
  66 #endif /*LIBROFF_H*/