psyc-mirrors/psyclpc
1
0
Fork 0
mirror of git://git.psyced.org/git/psyclpc synced 2024-08-15 03:20:16 +00:00
Code Issues Releases Wiki Activity
psyclpc/src/object.h
psyc://psyced.org/~lynX c0325c31e6 merge with ldmud distribution
2009-05-22 00:41:07 +02:00

381 lines
12 KiB
C
Raw Blame History

#ifndef OBJECT_H__
#define OBJECT_H__ 1
#include "driver.h"
#include "typedefs.h"
#include "sent.h" /* O_GET_* */
#ifdef USE_EXPAT
#include<expat.h>
#endif
#ifdef USE_PARANOIA
#include <stdio.h> /* printf() for refcount tracing */
#endif
/* --- Types --- */
/* --- struct object: the base structure of every object
*/
struct object_s
{
unsigned short flags; /* Bits or'ed together, see below */
p_int ref; /* Reference count. */
#ifdef USE_INVENTORIES
#ifdef USE_SET_LIGHT
short total_light; /* Total light */
#endif
#endif
#if 1 /* USE_RESETS */
mp_int time_reset; /* Time of next reset, or 0 if none */
#endif
#if 1 /* USE_SWAP.. TODO!!!! */
mp_int time_of_ref; /* Time when last referenced. Used by swap */
#endif
#if 1 /* USE_CLEANUP */
mp_int time_cleanup; /* Time when the next variable cleanup is due. */
#endif
#if 1 /* what are these so important for? */
mp_int load_time; /* Time when the object was created. */
p_int load_id; /* Load-ID within the time the object was created */
#endif
#ifdef USE_PARANOIA
p_int extra_ref; /* Used to check ref count. */
#endif
program_t *prog; /* Program code for this object */
string_t *name;
/* name of the object (untabled), always w/o leading '/' */
string_t *load_name;
/* name of the object's blueprint (tabled), in compat
* mode without leading '/'
*/
object_t *next_all; /* Next object in global list */
object_t *prev_all; /* Previous object in global list */
object_t *next_hash; /* Next object in chain in the otable */
#ifdef USE_INVENTORIES
object_t *next_inv; /* Next object in the current environment */
object_t *contains; /* First contained object */
object_t *super; /* Current environment */
#endif
sentence_t *sent; /* Sentences, shadows, interactive data */
#if 1 // USE_WIZLIST
wiz_list_t *user; /* What wizard defined this object */
wiz_list_t *eff_user; /* Effective user */
#endif
#ifdef USE_PARANOIA
int extra_num_variables;
/* amylaar : used to determine where to check ref counts at all... */
#endif
#ifdef USE_SQLITE
/* should probably be implemented as a 'sent' extension (see above) */
Bool open_sqlite_db; /* does this object have an open sqlite db? */
#endif
#ifdef USE_EXPAT
/* should probably be implemented as a 'sent' extension (see above) */
Bool xml_error;
XML_Parser xml_parser; /* does this object have an expat xml parser? */
#endif
svalue_t *variables;
/* All variables to this object: an array of svalues, allocated
* in a separate block.
*/
#if 1 /* USE_EVALUATION_COST */
unsigned long ticks, gigaticks;
/* Evalcost used by this object. The total cost
* is computed with gigaticks*1E9+ticks.
*/
#endif
};
/* Values of object_t.flags: */
#define O_HEART_BEAT 0x01 /* Does it have an heart beat? */
#ifdef USE_SET_IS_WIZARD
#define O_IS_WIZARD 0x02 /* Is it a wizard player.c? */
#endif
#define O_ENABLE_COMMANDS 0x04 /* Can it execute commands? */
#define O_CLONE 0x08 /* Is it cloned from a master copy? */
#define O_DESTRUCTED 0x10 /* Is it destructed ? */
#define O_SWAPPED 0x20 /* Is it swapped to file */
#define O_ONCE_INTERACTIVE 0x40 /* Has it ever been interactive? */
#define O_UNUSED_80 0x80
#define O_RESET_STATE 0x100 /* Object in a 'reset':ed state ? */
#define O_WILL_CLEAN_UP 0x200 /* clean_up will be called next time */
#define O_LAMBDA_REFERENCED 0x400 /* be careful with replace_program() */
#define O_SHADOW 0x800 /* Is the object shadowed/shadowing? */
#define O_REPLACED 0x1000 /* Was the program replaced? */
/* If an object's program or variables are swapped out, the values
* of .prog resp. .variables are replaced with the associated (even)
* swap number assigned by the swapper, and the lowest bit of the number
* is set. The swap number '-1' means 'not swapped'.
* TODO: This assumes that pointers are always even.
*/
#define P_PROG_SWAPPED(p) ((p_int)(p) & 1)
/* Is the program <p> swapped out?
*/
#define O_PROG_SWAPPED(ob) ((p_int)(ob)->prog & 1)
/* Is the program of <ob> swapped out?
*/
#define O_VAR_SWAPPED(ob) ((p_int)(ob)->variables & 1)
/* Are the variables of <ob> swapped out?
*/
#define O_SWAP_NUM(ob) \
(O_PROG_SWAPPED(ob) ? (p_int)(ob)->prog & ~1 : (ob)->prog->swap_num)
/* The swap number for the program of <ob>.
*/
#define O_IS_INTERACTIVE(o) \
(((o)->flags & O_SHADOW) && (NULL != O_GET_INTERACTIVE(o)) )
/* Bool O_IS_INTERACTIVE(object_t *o)
* Return TRUE if ob is an interactive object.
*/
#define O_SET_INTERACTIVE(ip,o) \
( ( ((o)->flags & O_SHADOW) && (NULL != (ip = O_GET_INTERACTIVE(o))) ) \
|| ( (ip = NULL), MY_FALSE ) )
/* Bool O_SET_INTERACTIVE(interactive_t *ip, object_t *o)
* Return TRUE if ob is an interactive object and set ip to the interactive
* structure. Return FALSE is not and clear ip.
*/
/* --- struct replace_ob_s: one scheduled program replacement
*
* A list of this structure (obj_list_replace) keeps track of all
* requested replace_program()s during one backend round.
*
* It is possible, though not very useful, to replace an object's
* program by the very same program.
*/
struct replace_ob_s
{
object_t *ob; /* Object requesting the new program */
program_t *new_prog; /* Requested new program */
int var_offset; /* Variable offset of .new_prog */
int fun_offset; /* Function offset of .new_prog */
replace_ob_t *next; /* Link pointer for list */
struct lambda_replace_program_protector *lambda_rpp;
/* Additional information about lambdas bound to the program
* after the replacement was scheduled. The exact information
* is private to closure.c.
*/
};
/* --- Macros --- */
/* object_t *ref_object(object_t *o, char *from)
* Add another ref to object <o> from function <from>
* and return the object <o>.
*/
#ifndef USE_PARANOIA
# define ref_object(o,from) ((o)->ref++, (o))
#else
# define ref_object(o,from) (\
(o)->ref++,\
d_flag > 1 ? printf("Add ref to object %s: %"PRIdPINT" (%s) %s %d\n" \
, get_txt((o)->name), (o)->ref, from, __FILE__, __LINE__) : 0, \
(o))
#endif
/* object_t *ref_valid_object(object_t *o, char *from)
* Add another ref to object <o> from function <from> if <o>
* is not a destructed object or the NULL pointer.
* Return <o>, or NULL if <o> is destructed.
*/
#define ref_valid_object(o,from) \
( ((o) && !((o)->flags & O_DESTRUCTED)) \
? ref_object(o,from) : NULL)
/* void free_object(object_t *o, char *)
* Subtract one ref from object <o> from function <o>, and free the
* object fully if the refcount reaches zero.
*/
#ifndef USE_PARANOIA
#ifndef CHECK_OBJECT_REF
# define free_object(o,from) MACRO( \
object_t * tmp_ = o; \
if (tmp_->ref == 2) dest_last_ref_gone = MY_TRUE; \
if (--(tmp_->ref) <= 0) dealloc_object(tmp_);\
)
#else
# define free_object(o,from) MACRO( \
object_t * tmp_ = o; \
if (tmp_->ref == 2) dest_last_ref_gone = MY_TRUE; \
if (--(tmp_->ref) <= 0) dealloc_object(tmp_, __FILE__, __LINE__); \
)
#endif
#else
#ifndef CHECK_OBJECT_REF
# define free_object(o,from) MACRO(\
object_t * tmp_ = o; \
if (tmp_->ref == 2) dest_last_ref_gone = MY_TRUE; \
tmp_->ref--;\
if (d_flag > 1) printf("Sub ref from object %s: %"PRIdPINT" (%s) %s %d\n"\
, get_txt(tmp_->name), tmp_->ref, from, __FILE__, __LINE__);\
if (tmp_->ref <= 0) dealloc_object(tmp_); \
)
#else
# define free_object(o,from) MACRO(\
object_t * tmp_ = o; \
if (tmp_->ref == 2) dest_last_ref_gone = MY_TRUE; \
tmp_->ref--;\
if (d_flag > 1) printf("Sub ref from object %s: %"PRIdPINT" (%s) %s %d\n"\
, get_txt(tmp_->name), tmp_->ref, from, __FILE__, __LINE__);\
if (tmp_->ref <= 0) dealloc_object(tmp_, __FILE__, __LINE__); \
)
#endif
#endif
/* void deref_object(object_t *o, char *from)
* Subtract one ref from object <o> from function <from>, but don't
* check if it needs to be freed.
*/
#ifndef USE_PARANOIA
# define deref_object(o, from) (--(o)->ref)
#else
# define deref_object(o,from) (--(o)->ref, \
d_flag > 1 ? printf("Sub ref from object %s: %"PRIdPINT" (%s)\n" \
, get_txt((o)->name), (o)->ref, from) : 0)
#endif
#define check_object(o) ((o)&&((o)->flags&O_DESTRUCTED) ? NULL :(o))
/* Return NULL, if object <o> is NULL or destructed,
* return <o> else.
*/
#ifdef CHECK_OBJECT_REF
#define free_prog(p,f) _free_prog(p,f, __FILE__, __LINE__)
#endif
/* --- Variables --- */
extern replace_ob_t *obj_list_replace;
extern long tot_alloc_object;
extern long tot_alloc_object_size;
extern object_t NULL_object;
extern Bool dest_last_ref_gone;
/* --- Prototypes --- */
extern int32 renumber_programs(void);
extern void tell_object(object_t *, string_t *);
/* extern void tell_object_str(object_t *, const char *); */
extern void tell_npc(object_t *, string_t *);
extern void tell_npc_str(object_t *, const char *);
extern void reference_prog(program_t *, char *);
#ifdef DEALLOCATE_MEMORY_AT_SHUTDOWN
extern void remove_all_objects(void);
#endif
extern void do_free_sub_strings(int num_strings, string_t ** strings
, int num_variables, variable_t *variables
, int num_includes, include_t *includes
#ifdef USE_STRUCTS
,int num_structs, struct_def_t *struct_defs
#endif /* USE_STRUCTS */
);
#ifndef CHECK_OBJECT_REF
extern void free_prog(program_t *progp, Bool free_all);
#else
extern void _free_prog(program_t *progp, Bool free_all, const char * file, int line);
#endif
extern void reset_object(object_t *ob, int arg);
extern void logon_object (object_t *ob);
extern void replace_programs(void);
extern Bool shadow_catch_message(object_t *ob, const char *str);
#ifndef CHECK_OBJECT_REF
extern void dealloc_object(object_t *);
#else
extern void dealloc_object(object_t *, const char * file, int line);
#endif
extern object_t *get_empty_object(int num_var);
extern void init_object_variables (object_t *ob, object_t *templ);
extern svalue_t *v_function_exists(svalue_t *sp, int num_arg);
extern svalue_t *f_functionlist(svalue_t *sp);
extern svalue_t *v_variable_exists (svalue_t *sp, int num_arg);
extern svalue_t *f_variable_list (svalue_t *sp);
extern svalue_t *v_include_list (svalue_t *sp, int num_arg);
extern svalue_t *v_inherit_list(svalue_t *sp, int num_arg);
extern svalue_t *f_load_name(svalue_t *sp);
extern svalue_t *f_object_name(svalue_t *sp);
extern svalue_t *f_object_time(svalue_t *sp);
extern svalue_t *f_program_name(svalue_t *sp);
extern svalue_t *f_program_time(svalue_t *sp);
extern svalue_t *f_query_once_interactive(svalue_t *sp);
extern svalue_t *f_rename_object(svalue_t *sp);
extern svalue_t *v_replace_program(svalue_t *sp, int num_arg);
extern svalue_t *f_tell_object(svalue_t *sp);
extern svalue_t *f_set_next_reset(svalue_t *sp);
extern svalue_t *f_export_uid(svalue_t *sp);
extern svalue_t *f_geteuid(svalue_t *sp);
extern svalue_t *f_seteuid(svalue_t *sp);
extern svalue_t *f_getuid(svalue_t *sp);
#ifdef USE_INVENTORIES
extern svalue_t *v_all_environment(svalue_t *sp, int num_arg);
extern svalue_t *f_all_inventory(svalue_t *sp);
#if defined(USE_PARSE_COMMAND)
extern vector_t *deep_inventory(object_t *ob, Bool take_top, p_int depth);
/* needed by parse.c */
#endif
extern svalue_t *v_deep_inventory(svalue_t *sp, int num_arg);
extern svalue_t *v_environment(svalue_t *sp, int num_arg);
extern svalue_t *f_first_inventory(svalue_t *sp);
extern svalue_t *f_next_inventory(svalue_t *sp);
extern svalue_t *f_move_object (svalue_t *sp);
extern svalue_t *v_present(svalue_t *sp, int num_arg);
extern svalue_t *v_say(svalue_t *sp, int num_arg);
extern svalue_t *v_tell_room(svalue_t *sp, int num_arg);
extern svalue_t *f_set_environment(svalue_t *sp);
#ifdef USE_DEPRECATED
extern svalue_t *f_transfer(svalue_t *svp);
#endif
#ifdef USE_SET_LIGHT
extern void add_light(object_t *p, int n);
extern svalue_t *f_set_light(svalue_t *sp);
#endif
#endif
extern svalue_t *v_save_object(svalue_t *sp, int numarg);
extern svalue_t *v_save_value(svalue_t *sp, int numarg);
extern svalue_t *f_restore_object(svalue_t *sp);
extern svalue_t *f_restore_value(svalue_t *sp);
extern void free_save_object_buffers(void);
#endif /* OBJECT_H__ */
Reference in a new issue View git blame Copy permalink