// functions.h - declarations for functions & function processing.
//
// $Id: functions.h,v 1.1 2000/04/11 07:14:45 sdennis Exp $
//

#include "copyright.h"

#ifndef __FUNCTIONS_H
#define __FUNCTIONS_H

typedef struct tagFun {
    char *name; /* function name */
    void (*fun)(char *buff, char **bufc, dbref player, dbref cause, char *fargs[], int nfargs, char *cargs[], int ncargs);  /* handler */
    int nargs;      /* Number of args needed or expected */
    int flags;      /* Function flags */
    int perms;      /* Access to function */
} FUN;

typedef struct ufun {
    char *name; /* function name */
    dbref   obj;        /* Object ID */
    int atr;        /* Attribute ID */
    int flags;      /* Function flags */
    int perms;      /* Access to function */
    struct ufun *next;  /* Next ufun in chain */
} UFUN;

#define FN_VARARGS  1   // Function allows a variable # of args.
#define FN_NO_EVAL  2   // Don't evaluate args to function.
#define FN_PRIV     4   // Perform user-def function as holding obj.
#define FN_PRES     8   // Preseve r-regs before user-def functions.

#define FN_LIST     1   // Corresponds to /list switch. -not- used in
                        // UFUN structure.

/* Special handling of separators. */

#define print_sep(s,b,p) \
if (s) { \
    if (s != '\r') { \
        safe_chr(s,b,p); \
    } else { \
        safe_str((char *) "\r\n",b,p); \
    } \
}

extern void NDECL(init_functab);
extern void FDECL(list_functable, (dbref));
extern int fn_range_check(const char *fname, int nfargs, int minargs, int maxargs, char *result, char **bufc);
extern int delim_check
(
    char *fargs[], int nfargs, int sep_arg, char *sep, char *buff,
    char **bufc, int eval, dbref player, dbref cause, char *cargs[],
    int ncargs, int allow_special
);
extern int list2arr(char *arr[], int maxlen, char *list, char sep);

// This is the prototype for functions
//
#define FUNCTION(x) \
    void x(char *buff, char **bufc, dbref player, dbref cause,        \
        char *fargs[], int nfargs, char *cargs[], int ncargs)

// This is for functions that take an optional delimiter character.
//
#define varargs_preamble(xname,xnargs)                                \
    if (!fn_range_check(xname, nfargs, xnargs-1, xnargs, buff, bufc)) \
        return;                                                       \
    if (!delim_check(fargs, nfargs, xnargs, &sep, buff, bufc, 0,      \
        player, cause, cargs, ncargs, 0))                             \
        return;

#define evarargs_preamble(xname,xnargs)                               \
    if (!fn_range_check(xname, nfargs, xnargs-1, xnargs, buff, bufc)) \
        return;                                                       \
    if (!delim_check(fargs, nfargs, xnargs, &sep, buff, bufc, 1,      \
        player, cause, cargs, ncargs, 0))                             \
        return;

#define mvarargs_preamble(xname,xminargs,xnargs)                      \
    if (!fn_range_check(xname, nfargs, xminargs, xnargs, buff, bufc)) \
        return;                                                       \
    if (!delim_check(fargs, nfargs, xnargs, &sep, buff, bufc, 0,      \
        player, cause, cargs, ncargs, 0))                             \
        return;

#define svarargs_preamble(xname,xnargs)                               \
    if (!fn_range_check(xname, nfargs, xnargs-2, xnargs, buff, bufc)) \
        return;                                                       \
    if (!delim_check(fargs, nfargs, xnargs-1, &sep, buff, bufc, 0,    \
        player, cause, cargs, ncargs, 0))                             \
        return;                                                       \
    if (nfargs < xnargs)                                              \
        osep = sep;                                                   \
    else if (!delim_check(fargs, nfargs, xnargs, &osep, buff, bufc,   \
        0, player, cause, cargs, ncargs, 1))                          \
        return;

#endif