/*      Id: libman.h,v 1.86 2018/12/31 10:04:39 schwarze Exp  */
/*
* Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <[email protected]>
* Copyright (c) 2014, 2015, 2018 Ingo Schwarze <[email protected]>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

struct  roff_node;
struct  roff_man;

#define MACRO_PROT_ARGS   struct roff_man *man, \
                         enum roff_tok tok, \
                         int line, \
                         int ppos, \
                         int *pos, \
                         char *buf

struct  man_macro {
       void            (*fp)(MACRO_PROT_ARGS);
       int               flags;
#define MAN_BSCOPED      (1 << 0)  /* Optional next-line block scope. */
#define MAN_ESCOPED      (1 << 1)  /* Optional next-line element scope. */
#define MAN_NSCOPED      (1 << 2)  /* Allowed in next-line element scope. */
#define MAN_XSCOPE       (1 << 3)  /* Exit next-line block scope. */
#define MAN_JOIN         (1 << 4)  /* Join arguments together. */
};

const struct man_macro *man_macro(enum roff_tok);

void              man_descope(struct roff_man *, int, int, char *);
void              man_unscope(struct roff_man *, const struct roff_node *);