ryzom/common/src/game_share/string_mgr_module.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef R2_STRING_MGR_MODULE_H
  18 #define R2_STRING_MGR_MODULE_H
  19
  20 #include "stdpch.h"
  21
  22 #include "nel/misc/types_nl.h"
  23
  24 #include "nel/net/module.h"
  25 #include "nel/net/module_socket.h"
  26 #include "nel/net/message.h"
  27
  28 #include "game_share/small_string_manager.h"
  29 #include "game_share/r2_messages.h"
  30 #include "game_share/dms.h"
  31
  32 #include "game_share/base_types.h"
  33 #include "game_share/chat_group.h"
  34 #include "game_share/dyn_chat.h"
  35
  36 #include <map>
  37 #include <vector>
  38 namespace R2
  39 {
  40
  41
  42
  43         /*
  44         Used to manage the creation / Destruction of Dynamic channel channel.
  45         When we can speak as a npc 'In this case we open a channel' and when we write in this channel we simulate that the npc is speaking
  46         When a npc is controlled and he want to talk. Its message are forwarded to this channel
  47         */
  48         class CStringManagerModule;
  49
  50         struct CDsrHandler
  51         {
  52         public:
  53                 CStringManagerModule* Module;
  54                 NLNET::TModuleId ModuleId;
  55                 virtual void execute(TDataSetRow& dsr)=0;
  56         };
  57
  58         struct TIncarn{
  59         public:
  60                 TChanID ChanId;
  61                 TDataSetRow NpcId;
  62                 void release();
  63         };
  64
  65         struct ClientInfo{
  66         public:
  67                 NLNET::IModuleProxy* Proxy;
  68                 TSessionId SessionId;
  69
  70                 ~ClientInfo();
  71
  72                 TDataSetRow getIncarnation(TChanID chanId);
  73
  74                 TChanID getIncarnation(TDataSetRow npcId);
  75
  76                 bool incarn(TDataSetRow npcId);
  77
  78                 void addIncarnation(TChanID chanId,TDataSetRow& npcId);
  79
  80                 //release all channels used by this client
  81                 void clear();
  82
  83                 void removeIncarnation(TDataSetRow& npcId);
  84
  85         private:
  86
  87                 std::vector<TIncarn> _Incarnations;
  88         };
  89
  90
  91
  92
  93         class CStringManagerModule : public NLNET::CModuleBase, public CStringTableManager
  94         {
  95         public:
  96                 CStringManagerModule();
  97
  98                 ~CStringManagerModule();
  99
 100                 void init(NLNET::IModuleSocket* clientGW,CDynamicMapService* server);
 101
 102                 virtual void onServiceUp(const std::string &serviceName, NLNET::TServiceId serviceId) { }
 103
 104                 virtual void onServiceDown(const std::string &serviceName, NLNET::TServiceId serviceId) {}
 105
 106                 virtual void onModuleUpdate() {}
 107
 108                 virtual void onApplicationExit();
 109
 110                 virtual void onModuleUp(NLNET::IModuleProxy *moduleProxy);
 111
 112                 virtual void onModuleDown(NLNET::IModuleProxy *moduleProxy);
 113
 114                 virtual bool onProcessModuleMessage(NLNET::IModuleProxy *senderModuleProxy, const NLNET::CMessage &message);
 115
 116                 virtual void onModuleSecurityChange(NLNET::IModuleProxy *moduleProxy);
 117
 118                 virtual void onModuleSocketEvent(NLNET::IModuleSocket *moduleSocket, TModuleSocketEvent eventType) {}
 119
 120                 virtual void registerTableRequested(TSessionId sessionId,CObject* table);
 121
 122                 virtual void registerTableRequested(const NLNET::CMessage& msgin);
 123
 124                 virtual void registerTableRequested(TSessionId sessionId,std::vector<std::pair<std::string,std::string> >& entries);
 125
 126                 virtual void unregisterTableRequested(TSessionId sessionId);
 127
 128                 virtual void translateAndForward(TDataSetRow senderId,CChatGroup::TGroupType groupType,std::string id,TSessionId sessionId);
 129
 130                 virtual void translateAndForwardWithArg(TDataSetRow senderId,CChatGroup::TGroupType groupType,std::string id,TSessionId sessionId,std::vector<float>& val);
 131
 132                 virtual void talkAs(NLNET::TModuleId& id, TDataSetRow& creaturRowId,std::string& name,TSessionId sessionId);
 133
 134                 virtual void stopTalkAs(NLNET::TModuleId& id,TDataSetRow& npcId);
 135
 136                 virtual void forwardIncarnChat(TChanID id,TDataSetRow senderId,ucstring sentence);
 137
 138                 virtual void sendTable(TSessionId sessionId,NLNET::IModuleProxy *moduleProxy);
 139
 140                 virtual void sendIdList(TSessionId sessionId,NLNET::IModuleProxy* senderModuleProxy);
 141
 142                 virtual void sendStringValue(TSessionId sessionId,NLNET::IModuleProxy* moduleProxy,std::string id);
 143
 144                 virtual void releaseChannels(TSessionId sessionId);
 145
 146
 147         private:
 148                 static TChanID initChannel(std::string name="",bool forwardInput=true);
 149
 150                 virtual void send(TDataSetRow& senderId,CChatGroup::TGroupType groupType,const std::string& toSend);
 151
 152                 virtual void insertClient(NLNET::IModuleProxy *moduleProxy,TChanID channelId);
 153
 154                 virtual void removeClient(NLNET::IModuleProxy *moduleProxy);
 155
 156                 virtual void addAnimSession(NLNET::TModuleId id,TSessionId scenarioId);
 157
 158                 void requestDsr( ucstring& name);
 159
 160         private:
 161                 std::map<uint32,TChanID> _AnimChans;
 162
 163                 std::map<NLNET::TModuleId,ClientInfo* > _ClientChannels;
 164                 bool _AnimChan;
 165         };
 166 }
 167
 168
 169
 170
 171 #endif //STRING_MGR_MODULE_H