/**
 * \file attrib.h
 *
 * \brief Attribute-related prototypes and constants.
 */

#ifndef _ATTRIB_H
#define _ATTRIB_H

#include "mushtype.h"
#include "chunk.h"

/** An attribute on an object.
 * This structure represents an attribute set on an object.
 * Attributes form a linked list on an object, sorted alphabetically.
 */
struct attr {
  char const *name;             /**< Name of attribute */
  uint32_t flags;               /**< Attribute flags */
  chunk_reference_t data;       /**< The attribute's value, compressed */
  dbref creator;                /**< The attribute's creator's dbref */
  ATTR *next;                   /**< Pointer to next attribute in list */
};


/* Stuff that's actually in atr_tab.c */
extern ATTR *aname_hash_lookup(const char *name);
extern int alias_attribute(const char *atr, const char *alias);
extern void do_attribute_access
  (dbref player, char *name, char *perms, int retroactive);
extern void do_attribute_delete(dbref player, char *name);
extern void do_attribute_rename(dbref player, char *old, char *newname);
extern void do_attribute_info(dbref player, char *name);
extern void do_list_attribs(dbref player, int lc);
extern char *list_attribs(void);
extern void attr_init_postconfig(void);

/* From attrib.c */

/** atr_add(), atr_clr() error codes */
typedef enum {
  AE_OKAY = 0, /**< Success */
  AE_ERROR = -1, /**< general failure */
  AE_SAFE = -2, /**< attempt to overwrite a safe attribute */
  AE_BADNAME = -3, /**< invalid name */
  AE_TOOMANY = -4, /**< too many attribs */
  AE_TREE = -5, /**< unable to delete/create entire tree */
  AE_NOTFOUND = -6 /** No such attribute */
} atr_err;

extern int good_atr_name(char const *s);
extern ATTR *atr_match(char const *string);
extern ATTR *atr_sub_branch(ATTR *branch);
extern void atr_new_add(dbref thing, char const *RESTRICT atr,
                        char const *RESTRICT s, dbref player, uint32_t flags,
                        uint8_t derefs);
extern atr_err atr_add(dbref thing, char const *RESTRICT atr,
                       char const *RESTRICT s, dbref player, uint32_t flags);
extern atr_err atr_clr(dbref thing, char const *atr, dbref player);
extern atr_err wipe_atr(dbref thing, char const *atr, dbref player);
extern ATTR *atr_get(dbref thing, char const *atr);
extern ATTR *atr_get_noparent(dbref thing, char const *atr);
typedef int (*aig_func) (dbref, dbref, dbref, const char *, ATTR *, void *);
extern int atr_iter_get(dbref player, dbref thing, char const *name,
                        int mortal, aig_func func, void *args);
extern int atr_iter_get_parent(dbref player, dbref thing, char const *name,
                               int mortal, aig_func func, void *args);
extern int atr_pattern_count(dbref player, dbref thing, const char *name,
                             int doparent, int mortal);
extern ATTR *atr_complete_match(dbref player, char const *atr, dbref privs);
extern void atr_free_all(dbref thing);
extern void atr_cpy(dbref dest, dbref source);
extern char const *convert_atr(int oldatr);
extern int atr_comm_match(dbref thing, dbref player, int type, int end,
                          char const *str, int just_match, char *atrname,
                          char **abp, dbref *errobj);
extern int one_comm_match(dbref thing, dbref player, const char *atr,
                          const char *str);
extern int do_set_atr(dbref thing, char const *RESTRICT atr,
                      char const *RESTRICT s, dbref player, uint32_t flags);
extern void do_atrlock(dbref player, char const *arg1, char const *arg2);
extern void do_atrchown(dbref player, char const *arg1, char const *arg2);
int string_to_atrflag(dbref player, const char *p, privbits * bits);
int string_to_atrflagsets(dbref player, const char *p, privbits * setbits,
                          privbits * clrbits);
extern const char *atrflag_to_string(privbits mask);
extern void init_atr_name_tree(void);

extern int can_read_attr_internal(dbref player, dbref obj, ATTR *attr);
extern int can_write_attr_internal(dbref player, dbref obj, ATTR *attr,
                                   int safe);
extern unsigned const char *atr_get_compressed_data(ATTR *atr);
extern char *atr_value(ATTR *atr);
extern char *
safe_atr_value(ATTR *atr)
  __attribute_malloc__;

/* possible attribute flags */
#define AF_ODARK        0x1U    /**< OBSOLETE! Leave here but don't use */
#define AF_INTERNAL     0x2U    /**< no one can see it or set it */
#define AF_WIZARD       0x4U    /**< Wizard only can change it */
#define AF_NUKED        0x8U    /**< OBSOLETE! Leave here but don't use */
#define AF_LOCKED       0x10U   /**< Only creator of attrib can change it. */
#define AF_NOPROG       0x20U   /**< won't be searched for $ commands. */
#define AF_MDARK        0x40U   /**< Only wizards can see it */
#define AF_PRIVATE      0x80U   /**< Children don't inherit it */
#define AF_NOCOPY       0x100U  /**< atr_cpy (for @clone) doesn't copy it */
#define AF_VISUAL       0x200U  /**< Everyone can see this attribute */
#define AF_REGEXP       0x400U  /**< Match $/^ patterns using regexps */
#define AF_CASE         0x800U  /**< Match $/^ patterns case-sensitive */
#define AF_SAFE         0x1000U /**< This attribute may not be modified */
#define AF_ROOT         0x2000U /**< Root of an attribute tree */
#define AF_UNDEF1       0x4000U /**< Undefined; reserved for a future flag */
#define AF_UNDEF2       0x8000U /**< Undefined; reserved for a future flag */
#define AF_STATIC       0x10000U        /**< OBSOLETE! Leave here but don't use */
#define AF_COMMAND      0x20000U        /**< INTERNAL: value starts with $ */
#define AF_LISTEN       0x40000U        /**< INTERNAL: value starts with ^ */
#define AF_NODUMP       0x80000U        /**< INTERNAL: attribute is not saved */
#define AF_LISTED       0x100000U       /**< INTERNAL: Used in @list attribs */
#define AF_PREFIXMATCH  0x200000U       /**< Subject to prefix-matching */
#define AF_VEILED       0x400000U       /**< On ex, show presence, not value */
#define AF_DEBUG        0x800000U       /**< Show debug when evaluated */
#define AF_NEARBY       0x1000000U      /**< Override AF_VISUAL if remote */
#define AF_PUBLIC       0x2000000U      /**< Override SAFER_UFUN */
#define AF_ANON         0x4000000U      /**< INTERNAL: Attribute doesn't really
					   exist in the database */
#define AF_NONAME       0x8000000U      /**< No name in did_it */
#define AF_NOSPACE      0x10000000U     /**< No space in did_it */
#define AF_MHEAR        0x20000000U     /**< ^-listens can be triggered by %! */
#define AF_AHEAR        0x40000000U     /**< ^-listens can be triggered by anyone */
#define AF_UNDEF3       0x80000000U     /**< Undefined; reserved for a future flag */

#define AF_MAXVALUE          0x100000000U     /**< Largest attribute flag value. */

    extern ATTR attr[];
                    /**< external predefined attributes. */

#define AL_ATTR(alist)          (alist)
#define AL_NAME(alist)          ((alist)->name)
#define AL_STR(alist)           (atr_get_compressed_data((alist)))
#define AL_NEXT(alist)          ((alist)->next)
#define AL_CREATOR(alist)       ((alist)->creator)
#define AL_FLAGS(alist)         ((alist)->flags)
#define AL_DEREFS(alist)        ((alist)->data?chunk_derefs((alist)->data):0)

/** Errors from ok_player_alias */
/** Success */
#define OPAE_SUCCESS    1
/** Invalid alias */
#define OPAE_INVALID    -1
/** Too many aliases already set */
#define OPAE_TOOMANY    -2
/** Null alias */
#define OPAE_NULL       -3

#endif                          /* __ATTRIB_H */