--- deliantra/server/include/client.h 2006/12/16 03:08:26 1.4 +++ deliantra/server/include/client.h 2007/01/06 14:42:30 1.23 @@ -1,6 +1,7 @@ /* CrossFire, A Multiplayer game for the X Window System + Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team Copyright (C) 2002 Mark Wedel & Crossfire Development Team Copyright (C) 1992 Frank Tore Johansen @@ -25,9 +26,11 @@ #define CLIENT_H #include +#include +#include // (possibly) max. number of objects "per page" in the ground container -#define NUM_LOOK_OBJECTS 50 +#define FLOORBOX_PAGESIZE 50 struct MapCell { @@ -68,18 +71,15 @@ * are using. */ -enum Sock_Status { Ns_Add, Ns_Dead }; - /* Only one map mode can actually be used, so lets make it a switch * instead of having a bunch of different fields that needed to * get toggled. */ enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; -/* The following is the setup for a ring buffer for storing outbut +/* The following is the setup for a ring buffer for storing output * data that the OS can't handle right away. */ - struct Buffer { char data[SOCKETBUFSIZE]; @@ -87,11 +87,22 @@ int len; }; +// states the socket can be in +enum { + ST_DEAD, // socket is dead + ST_SETUP, // initial handshake / setup / login + ST_PLAYING, // logged in an playing + ST_CUSTOM, // waiting for custom reply + + ST_CONFIRM_QUIT, + ST_CHANGE_CLASS, + ST_GET_PARTY_PASSWORD, +}; + // a handler for a specific type of packet enum { - PF_PLAYER = 0x01, // must have valid player - PF_IMMEDIATE = 0x02, // TODO: hack, can be executed immediately - PF_PLAYING = 0x04, // must be in playing state + PF_PLAYER = 0x01, // must have valid player / will by synchronised + PF_PLAYING = 0x02, // must be in playing state }; struct packet_type @@ -108,51 +119,87 @@ char *data; int datalen; - command (tstamp stamp, const packet_type *handler, char *data, int datalen) - : stamp (stamp), handler (handler), data (data), datalen (datalen) + ~command () { + sfree (data, datalen + 1); } }; +struct refitem +{ + object_ptr op; +}; + +// this represents a container on the client side. +// right now, there are only ever two of them: +// the inventory and the floor/open container +//TODO: unused as of yet +struct client_container : vector< refitem, slice_allocator > +{ + client *ns; + enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type; + + bool item_changed; // one of the items in here possibly changed + + // for mapspace and container + int x, y; + maptile *map; + + // for container + object *env; + + client_container (client *ns) + : ns (ns), type (CC_NONE) { } + + tag_t tag () const; + + inline iterator merge_item (iterator i, object *op); + + void clear (); + void update (); + + void set_mapspace (maptile *map, int x, int y); + void set_container (object *env); +}; + /* how many times we are allowed to give the wrong password before being kicked. */ #define MAX_PASSWORD_FAILURES 5 -ACC_CLASS (client) // should become player when newsocket is a baseclass of player -struct client : zero_initialised, attachable_base +INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player +struct client : zero_initialised, attachable { - enum Sock_Status status; int ACC (RW, fd); unsigned int inbuf_len; // number of bytes valid in inbuf - struct Map lastmap; - size_t faces_sent_len; /* This is the number of elements allocated in faces_sent[] */ - uint8 *faces_sent; /* This is a bitmap on sent face status */ - uint8 anims_sent[MAXANIMNUM]; - struct statsinfo stats; + uint8 *faces_sent; // This is a bitmap on sent face status + statsinfo stats; + + client_container cc_inv, cc_other; + Buffer outputbuffer; char *ACC (RW, host); /* Which host it is connected from (ip address) */ + uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ - Buffer outputbuffer; /* For undeliverable data */ - bool ACC (RW, facecache); /* If true, client is caching images */ - bool ACC (RW, sent_scroll); - bool ACC (RW, sound); /* does the client want sound */ - bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */ - bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ - bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ - bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ - bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ - bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ - bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ - bool ACC (RW, darkness); /* True if client wants darkness information */ - bool ACC (RW, image2); /* Client wants image2/face2 commands */ - bool ACC (RW, update_look); /* If true, we need to send the look window */ - bool ACC (RW, has_readable_type); /* If true client accept additional text information */ - /* used to arrange text in books, scrolls, or scripted dialogs */ - bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ - bool ACC (RW, ext_mapinfos); /* If true client accept additionnal info on maps */ - /* Below are flags for extedend infos to pass to client - * with S->C mapextended command */ - bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ + bool ACC (RW, afk); /* player is afk */ + bool ACC (RW, facecache); /* If true, client is caching images */ + bool ACC (RW, sent_scroll); + bool ACC (RW, sound); /* does the client want sound */ + bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ + bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ + bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ + bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ + bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ + bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ + bool ACC (RW, darkness); /* True if client wants darkness information */ + bool ACC (RW, image2); /* Client wants image2/face2 commands */ + bool ACC (RW, update_look); /* If true, we need to send the look window */ + bool ACC (RW, has_readable_type); /* If true client accept additional text information */ + /* used to arrange text in books, scrolls, or scripted dialogs */ + bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ + bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ + /* Below are flags for extedend infos to pass to client + * with S->C mapextended command */ + bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ @@ -164,43 +211,58 @@ maptile *ACC (RW, current_map); // CF+ last/current player map int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position - char ACC (RW, version)[64]; // CF+ client name/version + char ACC (RW, version)[64]; // CF+ client name/version - // if we get an incomplete packet, this is used to hold the data. - // we add 2 byte for the header, one for the trailing 0 byte - uint8 inbuf[MAXSOCKBUF + 2 + 1]; - player *ACC (RO, pl);//TODO should not be here, preferably + player_ptr ACC (RO, pl); int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ - client (int fd, const char *from_ip); - ~client (); - void destroy (); + void do_destroy (); + void gather_callbacks (AV *&callbacks, event_type event) const; iw cmd_ev; void cmd_cb (iw &w); iow socket_ev; void socket_cb (iow &w, int got); std::deque< command, slice_allocator > cmd_queue; - // those should probably be client methods + // large structures at the end please + struct Map lastmap; + std::bitset anims_sent; + // if we get an incomplete packet, this is used to hold the data. + // we add 2 byte for the header, one for the trailing 0 byte + uint8 inbuf[MAXSOCKBUF + 2 + 1]; + bool may_execute (const packet_type *pkt) const; void execute (const packet_type *pkt, char *data, int datalen); void queue_command (packet_type *handler, char *data, int datalen); - bool handle_command (); + MTH bool handle_command (); + // resets movement state + MTH void reset_state (); - bool handle_packet (); + MTH bool handle_packet (); int next_packet (); // returns length of packet or 0 void skip_packet (int len); // we have processed the packet, skip it - void flush (); - void write_outputbuffer (); + MTH void flush (); + MTH void write_outputbuffer (); void send (void *buf_, int len); void send_packet (const char *buf); void send_packet (const char *buf, int len); void send_packet_printf (const char *format, ...); void send_packet (packet &sl); + + // called when something under the player changes + MTH void floorbox_update () { update_look = 1; } + // called when the player has been moved + MTH void floorbox_reset () { look_position = 0; floorbox_update (); } + + MTH static client *create (int fd, const char *peername); + +protected: + client (int fd, const char *from_ip); + ~client (); }; #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\