regs.h

   1 /*      $Id: regs.h,v 1.4 2010/07/03 16:02:12 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 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 REGS_H
  18 #define REGS_H
  19
  20 __BEGIN_DECLS
  21
  22 enum    regs {
  23         REG_nS = 0,     /* nS */
  24         REG__MAX
  25 };
  26
  27 struct  reg {
  28         int              set; /* whether set or not */
  29         union {
  30                 unsigned u; /* unsigned integer */
  31         } v;
  32 };
  33
  34 /*
  35  * Registers are non-scoped state.  These can be manipulated directly in
  36  * libroff or indirectly in libman or libmdoc by macros.  These should
  37  * be implemented sparingly (we are NOT roffdoc!) and documented fully
  38  * in roff.7.
  39  */
  40 struct  regset {
  41         struct reg       regs[REG__MAX];
  42 };
  43
  44 char             *roff_setstr(const char *, const char *);
  45 char             *roff_getstr(const char *);
  46 char             *roff_getstrn(const char *, size_t);
  47 void              roff_freestr(void);
  48
  49 __END_DECLS
  50
  51 #endif /*!REGS_H*/