global.h

Go to the documentation of this file.

/*
 * static char *rcsid_global_h =
 *   "$Id: global.h 11578 2009-02-23 22:02:27Z lalo $";
 */

/*
    CrossFire, A Multiplayer game for X-windows

    Copyright (C) 2006 Mark Wedel & Crossfire Development Team
    Copyright (C) 1992 Frank Tore Johansen

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    The author can be reached via e-mail to crossfire-devel@real-time.com
*/

#ifndef GLOBAL_H
#define GLOBAL_H

#ifndef EXTERN
#define EXTERN extern
#endif

#include "includes.h"

/* Type defines for specific signed/unsigned variables of a certain number
 * of bits.  Not really used anyplace, but if a certain number of bits
 * is required, these type defines should then be used.  This will make
 * porting to systems that have different sized data types easier.
 *
 * Note: The type defines should just mean that the data type has at
 * least that many bits.  if a uint16 is actually 32 bits, no big deal,
 * it is just a waste of space.
 *
 * Note2:  When using something that is normally stored in a character
 * (ie strings), don't use the uint8/sint8 typdefs, use 'char' instead.
 * The signedness for char is probably not universal, and using char
 * will probably be more portable than sint8/unit8
 */

typedef unsigned int    uint32;

#ifndef UINT32_MAX
#define UINT32_MAX      4294967295U
#endif

typedef signed int      sint32;
#define SINT32_MAX      2147483647

typedef unsigned short  uint16;
#ifndef UINT16_MAX
#define UINT16_MAX      65535
#endif

typedef signed short    sint16;
#define SINT16_MAX      32767

typedef unsigned char   uint8;
#ifndef UINT8_MAX
#define UINT8_MAX       255
#endif

typedef signed char     sint8;
#define SINT8_MAX       127

typedef const char *sstring;

typedef unsigned short Fontindex;

#ifdef WIN32
/* Python plugin stuff defines SIZEOF_LONG_LONG as 8, and besides __int64 is a 64b type on MSVC...
 * So let's force the typedef */
typedef unsigned __int64        uint64;
typedef signed __int64          sint64;
/* Needed for experience */
#define atoll   _atoi64

#define FMT64                   "I64d"
#define FMT64U                  "I64u"

/* To reduce number of warnings */
#pragma warning(disable: 4244) /* conversion from 'xxx' to 'yyy', possible loss of data */
#pragma warning(disable: 4305) /* initializing float f = 0.05; instead of f = 0.05f; */

#else /* WIN32 */

#if SIZEOF_LONG == 8

typedef unsigned long       uint64;
typedef signed long         sint64;
#define FMT64               "ld"
#define FMT64U              "lu"

#elif SIZEOF_LONG_LONG == 8
typedef unsigned long long      uint64;
typedef signed long long        sint64;
#define FMT64                   "lld"
#define FMT64U                  "llu"

#else
#error do not know how to get a 64 bit value on this system.
#error correct and send mail to crossfire-devel on how to do this
#endif

#endif

/* This blob, in this order, is needed to actually define maps */
#include "face.h"
/* Include the basic defines from spells.h */
#include "attack.h" /* needs to be before material.h */
#include "material.h"
#include "living.h"
#include "object.h"
#include "map.h"
#include "tod.h"

#include "skills.h"

/* Pull in the socket structure - used in the player structure */
#include "newserver.h"

/* Pull in the player structure */
#include "player.h"

/* pull in treasure structure */
#include "treasure.h"

#include "commands.h"

/* pull in book structures */
#include "book.h"

/* ob_methods and ob_types subsystem */
#include "ob_methods.h"
#include "ob_types.h"

/*
 * So far only used when dealing with artifacts.
 * (now used by alchemy and other code too. Nov 95 b.t).
 */
typedef struct linked_char {
    const char *name;
    struct linked_char *next;
} linked_char;


/* Pull in artifacts */
#include "artifact.h"

/* Now for gods */
#include "god.h"

/* Now for races */
#include "race.h"

/* Now for recipe/alchemy */
#include "recipe.h"

/* Now for spells */
#include "spells.h"

/*****************************************************************************
 * GLOBAL VARIABLES:                                                         *
 *****************************************************************************/

extern New_Face *new_faces;

EXTERN player *first_player;                
EXTERN mapstruct *first_map;                
EXTERN region *first_region;                
EXTERN treasurelist *first_treasurelist;    
EXTERN artifactlist *first_artifactlist;    
EXTERN archetype *first_archetype;          
EXTERN objectlink *first_friendly_object;   
EXTERN godlink *first_god;                  
EXTERN racelink *first_race;                

#define NROF_COMPRESS_METHODS 4
extern const char *uncomp[NROF_COMPRESS_METHODS][3];

/*
 * Variables set by different flags (see init.c):
 */

EXTERN long warn_archetypes;       
EXTERN long init_done;             
EXTERN long trying_emergency_save; 
EXTERN long nroferrors;            
extern uint32 pticks;              
EXTERN FILE *logfile;                    
extern int reopen_logfile;
EXTERN int exiting;                      
EXTERN long nroftreasures;               
EXTERN long nrofartifacts;               
EXTERN long nrofallowedstr;              
EXTERN archetype *empty_archetype;       
EXTERN archetype *map_archeytpe;
EXTERN char first_map_path[MAX_BUF];     
EXTERN char first_map_ext_path[MAX_BUF]; 
EXTERN long ob_count;
/*
 * Used in treasure.c
 */
EXTERN archetype *ring_arch, *amulet_arch, *staff_arch, *crown_arch;
EXTERN const char *undead_name; /* Used in hit_player() in main.c */

EXTERN Animations *animations;
EXTERN int num_animations, animations_allocated, bmaps_checksum;

/* Rotate right from bsd sum. This is used in various places for checksumming */
#define ROTATE_RIGHT(c) if ((c)&01) (c) = ((c)>>1)+0x80000000; else (c) >>= 1;

#define SET_ANIMATION(ob, newanim) { if (ob->temp_animation_id) { ob->face = &new_faces[animations[ob->temp_animation_id].faces[newanim]]; } else { ob->face = &new_faces[animations[ob->animation_id].faces[newanim]]; } }
#define GET_ANIMATION(ob, anim) (ob->temp_animation_id ? animations[ob->temp_animation_id].faces[anim] : animations[ob->animation_id].faces[anim])
#define GET_ANIM_ID(ob) (ob->temp_animation_id ? ob->temp_animation_id : ob->animation_id)
/* NUM_ANIMATIONS returns the number of animations allocated.  The last
 * usuable animation will be NUM_ANIMATIONS-1 (for example, if an object
 * has 8 animations, NUM_ANIMATIONS will return 8, but the values will
 * range from 0 through 7.
 */
#define NUM_ANIMATIONS(ob) (ob->temp_animation_id ? animations[ob->temp_animation_id].num_animations : animations[ob->animation_id].num_animations)
#define NUM_FACINGS(ob) (ob->temp_animation_id ? animations[ob->temp_animation_id].facings : animations[ob->animation_id].facings)

extern short freearr_x[SIZEOFFREE], freearr_y[SIZEOFFREE];
extern int maxfree[SIZEOFFREE], freedir[SIZEOFFREE];
extern int rightof_x[9], rightof_y[9];
extern int leftof_x[9], leftof_y[9];

extern New_Face *blank_face, *empty_face;
extern New_Face *smooth_face;

extern uint32 max_time; /* loop time */
extern socket_struct *init_sockets;

#ifndef __CEXTRACT__
#include "stringbuffer.h"
#include "libproto.h"
#include "sockproto.h"
#include "typesproto.h"
#endif

#define decrease_ob(xyz) decrease_ob_nr(xyz, 1)

/* FREE_AND_CLEAR frees the pointer and then sets it to NULL.
 * This is generally done as a safety, and having this macro
 * makes the code a bit cleaner when doing so.
 */
#define FREE_AND_CLEAR(xyz) { free((void *)xyz); xyz = NULL; }
#define FREE_AND_CLEAR_STR(xyz) { free_string(xyz); xyz = NULL; }

/* FREE_AND_COPY is for the shared string - it is handy enough
 * to use all over the place.
 */
#define FREE_AND_COPY(sv, nv) { if (sv) free_string(sv); sv = add_string(nv); }

#ifdef CALLOC
#undef CALLOC
#endif

#ifdef USE_CALLOC
# define CALLOC(x, y)   calloc(x, y)
# define CFREE(x)       free(x)
#else
# define CALLOC(x, y)   malloc(x*y)
# define CFREE(x)       free(x)
#endif

#ifndef WIN32 /* ---win32 we define this stuff in win32.h */
#if HAVE_DIRENT_H
# include <dirent.h>
# define NAMLEN(dirent) strlen((dirent)->d_name)
#else
# define dirent direct
# define NAMLEN(dirent) (dirnet)->d_namlen
# if HAVE_SYS_NDIR_H
#  include <sys/ndir.h>
# endif
# if HAVE_SYS_DIR_H
#  include <sys/dir.h>
# endif
# if HAVE_NDIR_H
#  include <ndir.h>
# endif
#endif
#endif

typedef struct Settings {
    const char *logfilename;    
    uint16  csport;             
    LogLevel debug;             
    uint8   dumpvalues;         
    const char *dumparg;        
    uint8   daemonmode;         
    int     argc;               
    char    **argv;             
    const char *confdir;        
    const char *datadir;        
    const char *localdir;       
    const char *playerdir;      
    const char *mapdir;         
    const char *archetypes;     
    const char *regions;        
    const char *treasures;      
    const char *uniquedir;      
    const char *templatedir;    
    const char *tmpdir;         
    uint8   stat_loss_on_death; 
    sint16  pk_luck_penalty;    
    uint8   permanent_exp_ratio; 
    uint8   death_penalty_ratio; 
    uint8   death_penalty_level; 
    uint8   balanced_stat_loss; 
    uint8   not_permadeth;      
    uint8   simple_exp;         
    int     reset_loc_time;     
    uint8   set_title;          
    uint8   resurrection;       
    uint8   search_items;       
    uint8   spell_encumbrance;  
    uint8   spell_failure_effects; 
    uint8   casting_time;       
    uint8   real_wiz;           
    uint8   recycle_tmp_maps;   
    uint8   explore_mode;       
    uint8   spellpoint_level_depend; 
    uint16  set_friendly_fire;       
    char    who_format[MAX_BUF];     
    char    who_wiz_format[MAX_BUF]; 
    char    motd[MAX_BUF];      
    const char *rules;          
    const char *news;           
    char    dm_mail[MAX_BUF];   
    /* The meta_ is information for the metaserver.  These are set in
     * the lib/settings file.
     */
    unsigned int meta_on:1;         
    char    meta_server[MAX_BUF];   
    char    meta_host[MAX_BUF];     
    uint16  meta_port;              
    char    meta_comment[MAX_BUF];  
    uint32  worldmapstartx;         
    uint32  worldmapstarty;         
    uint32  worldmaptilesx;         
    uint32  worldmaptilesy;         
    uint32  worldmaptilesizex;      
    uint32  worldmaptilesizey;      
    uint8   fastclock;              
    char    *emergency_mapname;       
    uint16  emergency_x, emergency_y; 
    sint16  max_level;                
    float   item_power_factor;        
    int     armor_max_enchant;        
    int     armor_weight_reduction;   
    uint8   armor_weight_linear;      
    int     armor_speed_improvement;  
    uint8   armor_speed_linear;       
    uint8   no_player_stealing;       
    uint8   create_home_portals;      
    uint8   personalized_blessings;   
    sint64  pk_max_experience;        
    int     pk_max_experience_percent; 
    int     allow_denied_spells_writing; 
    int     allow_broken_converters;  
    int     log_timestamp;            
    char    *log_timestamp_format;    
} Settings;

extern Settings settings;

typedef struct Statistics {
    uint64 spell_merges;        
    uint64 spell_hash_full;     
    uint64 spell_suppressions;  
} Statistics;

extern Statistics statistics;

/* 0.94.1 - change to GETTIMEOFDAY macro - SNI systems only one one option.
 * rather than have complex #ifdefs throughout the file, lets just figure
 * it out once, here at the top.
 * Have no idea if that is the right symbol to check on for NetBSD,
 * but NetBSD does use 2 params.
 * Move this to global.h from time.c since its also used in arch.c
 */

#ifdef GETTIMEOFDAY_TWO_ARGS
#define GETTIMEOFDAY(last_time) gettimeofday(last_time, (struct timezone *)NULL);
#else
#define GETTIMEOFDAY(last_time) gettimeofday(last_time);
#endif

#define SCRIPT_FIX_ACTIVATOR 2
#define SCRIPT_FIX_ALL 1
#define SCRIPT_FIX_NOTHING 0

#include "plugin.h"

#endif /* GLOBAL_H */