/*
 * /sys/macros.h
 *
 * This file contains various useful macros.
 */

#ifndef MACROS_DEF
#define MACROS_DEF

#include "/sys/config.h"
#include "/sys/const.h"
#include "/sys/language.h"
#include "/sys/pl.h"

/*
 * MAX(a, b) and MIN(a, b) respectively return the highest or the lowest of
 * the two arguments. ABS(a) returns 'a' with a positive sign. SNG(a) returns
 * the sign of 'a', either -1, 0 or 1.
 */
#define MAX(a, b) ((a) > (b) ? (a) : (b))
#define MIN(a, b) ((a) < (b) ? (a) : (b))
#define ABS(a)    ((a) >  0  ? (a) : -(a))
#define SGN(a)    ((a) >= 1  ? 1 : (((a) < 0) ? -1 : 0))

/*
 * MAXINT is the largest integer number the gamedriver can handle. If you
 * exceed MAXINT, it will loop and continue to count at (-MAXINT - 1). I
 * take it you are familiar with the alphabet ;-)
 */
#define MAXINT    (2147483647)
#define ALPHABET  ("abcdefghijklmnopqrstuvwxyz")

/*
 * MASTER_OB(ob) - returns the filename of 'ob' without object number.
 * MASTER        - returns the filename of this_object() without object num.
 * IS_CLONE      - true if this_object() is not the master object.
 * CLONE_COPY    - returns the objectpointer to a clone of this_object().
 * CALL_BY_CLONE - true if previous_object() is a clone of this_object().
 * CALL_BY(file) - true if previous_object() has filename 'file'.
 * OB_NUM(ob)    - returns the object number of 'ob'.
 * OB_NAME(ob)   - returns a unique add_name() for 'ob' based on OB_NUM.
 */
#define MASTER_OB(ob) (explode(file_name(ob) + "#", "#")[0])
#define MASTER        (MASTER_OB(this_object()))
#define IS_CLONE      (file_name(this_object()) != MASTER)
#define CLONE_COPY    clone_object(MASTER)
#define CALL_BY_CLONE (MASTER == MASTER_OB(previous_object()))
#define CALL_BY(file) (MASTER_OB(previous_object()) == (file))
#define OB_NUM(ob)    (explode(file_name(ob) + "#0", "#")[1])
#define OB_NAME(ob)   ("ob_" + OB_NUM(ob))

/*
 * LOAD_ERR(file) tries to load the module 'file' and if it fails, returns
 * the error message. If it is succesful, it returns 0.
 */
#define LOAD_ERR(file) catch(call_other((file), "??"))

/*
 * FCHAR(str) return the first character of 'str'.
 */
#define FCHAR(str) extract((str), 0, 0)

/*
 * LCALLfun makes a call_other to the function 'fun' in this_object(). By
 * doing so, the function is called in the shadow first rather than called
 * only internally.
 */
#define LCALL this_object()->

/*
 * FORMAT_NAME(name) returns the name 'name' in a left aligned format of
 * 11 characters. This is especially useful for displaying player names
 * in a table.
 */
#define FORMAT_NAME(name) (sprintf("%-11s", (name)))

/*
 * VBFC(fun)    - return the VBFC string for an internal call to the
 *                function 'fun'.
 * VBFC_ME(fun) - return the VBFC string for a call_other to the function
 *                'fun' in this_object().
 */
#define VBFC(fun)    ("@@" + (fun) + "@@")
#define VBFC_ME(fun) ("@@" + (fun) + ":" + file_name(this_object()) + "@@")

/*
 * UNSEEN_NAME     - the (capitalized) name of someone who is invisible.
 * MYNAME          - the real (lower case) name of this_interactive().
 * METNAME         - the 'met' (capitalized) name of this_player().
 * NONMETNAME      - the 'nonmet' (capitalized) name of this_player().
 * ART_NONMETNAME  - NONMETNAME preceided by a capitalized article A or An.
 * TART_NONMETNAME - NONMETNAME preceided by the capitalized article The.
 */
#define UNSEEN_NAME     ("Someone")
#define MYNAME          ((string)this_interactive()->query_real_name())
#define METNAME         ((string)this_player()->query_name())
#define NONMETNAME      (capitalize(this_player()->query_nonmet_name()))
#define ART_NONMETNAME  (capitalize(LANG_ADDART(this_player()->query_nonmet_name())))
#define TART_NONMETNAME ("The " + (string)this_player()->query_nonmet_name())

/*
 * Here are some useful macros for using when figuring out player names.
 * Even if MET_ACTIVE is not defined, QMET should be VBFC for the functions
 * are dependant of previous_object for visibility.
 */
#define QMET(func, ob) ("@@" + (func) + ":" + file_name(ob) + "@@")

//#define QSHORT(ob) QMET("vbfc_short", (ob))
#define QSHORT(ob, przyp) ("@@vbfc_short:" + file_name(ob) + "|" + przyp + "@@")
#define QCSHORT(ob, przyp) ("@@vbfc_cshort:" + file_name(ob) + "|" + przyp + "@@")

 /*
  * QNAME uses 'value by function call'. It returns either the name
  * of the player or the race preceded by a or an. ob is the object
  * who we want check if we know.
  */
#define QNAME(ob) QMET("query_art_name", (ob))
 /*
  * QCNAME is the same as QNAME except that it returns a capital A or An
  */
#define QCNAME(ob) QMET("query_Art_name", (ob))
 /*
  * QTNAME is the same as QNAME except that it returns 'the'
  */
#define QTNAME(ob) QMET("query_the_name", (ob))
 /*
  * QCTNAME is the same as QTNAME except that it returns a capital 'The'
  */
#define QCTNAME(ob) QMET("query_The_name", (ob))

#define QIMIE(ob, przyp) ("@@query_imie:" + file_name(ob) + "|" + przyp + "@@")
#define QCIMIE(ob, przyp) ("@@query_Imie:" + file_name(ob) + "|" + przyp + "@@")

/*
 * Can ob1 see ob2?
 */
#define CAN_SEE(ob1, ob2)	((int)ob2->check_seen(ob1))
/*
 * Can ob1 see anything in his/hers environment or is it too dark? Notice
 * that if you want to use this macro, you _must_ include <stdproperties.h>
 * as well.
 */
#define CAN_SEE_IN_ROOM(ob)	(environment(ob) && \
				(environment(ob)->query_prop(OBJ_I_LIGHT) > \
				-(ob->query_prop(LIVE_I_SEE_DARK))))

/* No definitions beyond this line. */
#endif MACROS_DEF