Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/network/NetworkFunction.h @ 7329

Last change on this file since 7329 was 7284, checked in by landauf, 14 years ago

merged consolecommands3 branch back to trunk.

note: the console command interface has changed completely, but the documentation is not yet up to date. just copy an existing command and change it to your needs, it's pretty self-explanatory. also the include files related to console commands are now located in core/command/. in the game it should work exactly like before, except for some changes in the auto-completion.

  • Property svn:eol-style set to native
File size: 10.7 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Oliver Scheuss
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _NetworkFunction_H__
30#define _NetworkFunction_H__
31
32#include "NetworkPrereqs.h"
33
34#include <cassert>
35#include <cstring>
36#include <map>
37#include <string>
38#include <boost/preprocessor/cat.hpp>
39#include <boost/static_assert.hpp>
40
41#include "core/Identifier.h"
42#include "core/command/Functor.h"
43#include "FunctionCallManager.h"
44#include "synchronisable/Synchronisable.h"
45
46namespace orxonox
47{
48
49#if defined(ORXONOX_COMPILER_GCC) && defined(ORXONOX_ARCH_32)
50static const unsigned int MAX_FUNCTION_POINTER_SIZE = 8;
51#else
52static const unsigned int MAX_FUNCTION_POINTER_SIZE = 16;
53#endif //ORXONOX_COMPILER_GCC
54static const unsigned int MAX_FUNCTION_POINTER_INTS = (MAX_FUNCTION_POINTER_SIZE-1)/4+1;
55
56struct _NetworkExport NetworkFunctionPointer {
57  uint32_t pointer[MAX_FUNCTION_POINTER_INTS];
58  bool operator<(const NetworkFunctionPointer& b) const
59  {
60#if defined(ORXONOX_COMPILER_GCC) && defined(ORXONOX_ARCH_32)
61    return pointer[0]<b.pointer[0] ? true : pointer[1]<b.pointer[1];
62#else //ORXONOX_COMPILER_GCC
63    return pointer[0]<b.pointer[0] ? true : ( pointer[1]<b.pointer[1] ? true : ( pointer[2]<b.pointer[2] ? true : pointer[3]<b.pointer[3] ) );
64#endif //ORXONOX_COMPILER_GCC
65  }
66};
67
68
69
70
71
72class _NetworkExport NetworkFunctionBase: virtual public OrxonoxClass {
73  public:
74    NetworkFunctionBase(const std::string& name);
75    ~NetworkFunctionBase();
76
77    virtual void        setNetworkID(uint32_t id)       { this->networkID_ = id; }
78    inline uint32_t     getNetworkID() const            { return this->networkID_; }
79    inline const std::string& getName() const           { return name_; }
80    static inline bool  isStatic( uint32_t networkID )  { return isStaticMap_[networkID]; }
81
82    static inline void setNetworkID(const std::string& name, uint32_t id)
83    {
84        std::map<std::string, NetworkFunctionBase*>& map = NetworkFunctionBase::getNameMap();
85        assert( map.find(name)!=map.end() );
86        map[name]->setNetworkID(id);
87    }
88
89    static void destroyAllNetworkFunctions();
90
91  protected:
92    static std::map<uint32_t, bool> isStaticMap_;
93
94  private:
95    static std::map<std::string, NetworkFunctionBase*>& getNameMap();
96    uint32_t networkID_;
97    std::string name_;
98
99};
100
101
102class _NetworkExport NetworkFunctionStatic: public NetworkFunctionBase {
103  public:
104    NetworkFunctionStatic(const FunctorStaticPtr& functor, const std::string& name, const NetworkFunctionPointer& p);
105
106    inline void call(){ (*this->functor_)(); }
107    inline void call(const MultiType& mt1){ (*this->functor_)(mt1); }
108    inline void call(const MultiType& mt1, const MultiType& mt2){ (*this->functor_)(mt1, mt2); }
109    inline void call(const MultiType& mt1, const MultiType& mt2, const MultiType& mt3){ (*this->functor_)(mt1, mt2, mt3); }
110    inline void call(const MultiType& mt1, const MultiType& mt2, const MultiType& mt3, const MultiType& mt4){ (*this->functor_)(mt1, mt2, mt3, mt4); }
111    inline void call(const MultiType& mt1, const MultiType& mt2, const MultiType& mt3, const MultiType& mt4, const MultiType& mt5){ (*this->functor_)(mt1, mt2, mt3, mt4, mt5); }
112
113    virtual void setNetworkID( uint32_t id )
114        { NetworkFunctionBase::setNetworkID( id ); NetworkFunctionStatic::getIdMap()[id] = this; }
115    static inline NetworkFunctionStatic* getNetworkFunction( uint32_t id)
116        { assert( NetworkFunctionStatic::getIdMap().find(id)!=NetworkFunctionStatic::getIdMap().end() ); return NetworkFunctionStatic::getIdMap()[id]; }
117    static NetworkFunctionStatic* getFunction( uint32_t id )
118        { assert( NetworkFunctionStatic::getIdMap().find(id) != NetworkFunctionStatic::getIdMap().end() ); return NetworkFunctionStatic::getIdMap()[id]; }
119    static NetworkFunctionStatic* getFunction( const NetworkFunctionPointer& p )
120        { assert( NetworkFunctionStatic::getFunctorMap().find(p) != NetworkFunctionStatic::getFunctorMap().end() ); return NetworkFunctionStatic::getFunctorMap()[p]; }
121
122  private:
123    static std::map<NetworkFunctionPointer, NetworkFunctionStatic*>& getFunctorMap();
124    static std::map<uint32_t, NetworkFunctionStatic*>& getIdMap();
125    FunctorStaticPtr functor_;
126
127};
128
129
130class _NetworkExport NetworkMemberFunctionBase: public NetworkFunctionBase {
131  public:
132    NetworkMemberFunctionBase(const std::string& name, const NetworkFunctionPointer& p);
133    ~NetworkMemberFunctionBase();
134
135    virtual void setNetworkID( uint32_t id ){ NetworkFunctionBase::setNetworkID( id ); idMap_[id] = this; }
136    static inline NetworkMemberFunctionBase* getNetworkFunction( uint32_t id){ assert( idMap_.find(id)!=idMap_.end() ); return idMap_[id]; }
137    static NetworkMemberFunctionBase* getFunction( uint32_t id ){ assert( idMap_.find(id) != idMap_.end() ); return idMap_[id]; }
138    static NetworkMemberFunctionBase* getFunction( const NetworkFunctionPointer& p ){ assert( functorMap_.find(p) != functorMap_.end() ); return functorMap_[p]; }
139
140    //
141    virtual void call(uint32_t objectID)=0;
142    virtual void call(uint32_t objectID, const MultiType& mt1)=0;
143    virtual void call(uint32_t objectID, const MultiType& mt1, const MultiType& mt2)=0;
144    virtual void call(uint32_t objectID, const MultiType& mt1, const MultiType& mt2, const MultiType& mt3)=0;
145    virtual void call(uint32_t objectID, const MultiType& mt1, const MultiType& mt2, const MultiType& mt3, const MultiType& mt4)=0;
146    virtual void call(uint32_t objectID, const MultiType& mt1, const MultiType& mt2, const MultiType& mt3, const MultiType& mt4, const MultiType& mt5)=0;
147
148  private:
149    static std::map<NetworkFunctionPointer, NetworkMemberFunctionBase*> functorMap_;
150    static std::map<uint32_t, NetworkMemberFunctionBase*> idMap_;
151};
152
153
154template <class T> class NetworkMemberFunction: public NetworkMemberFunctionBase {
155  public:
156    NetworkMemberFunction(const FunctorMemberPtr<T>& functor, const std::string& name, const NetworkFunctionPointer& p);
157
158    inline void call(uint32_t objectID)
159    {
160      if ( Synchronisable::getSynchronisable(objectID)!=0 )
161        (*this->functor_)(orxonox_cast<T*>(Synchronisable::getSynchronisable(objectID)));
162    }
163    inline void call(uint32_t objectID, const MultiType& mt1)
164    {
165      if ( Synchronisable::getSynchronisable(objectID)!=0 )
166        (*this->functor_)(orxonox_cast<T*>(Synchronisable::getSynchronisable(objectID)), mt1);
167    }
168    inline void call(uint32_t objectID, const MultiType& mt1, const MultiType& mt2)
169    {
170      if ( Synchronisable::getSynchronisable(objectID)!=0 )
171        (*this->functor_)(orxonox_cast<T*>(Synchronisable::getSynchronisable(objectID)), mt1, mt2);
172    }
173    inline void call(uint32_t objectID, const MultiType& mt1, const MultiType& mt2, const MultiType& mt3)
174    {
175      if ( Synchronisable::getSynchronisable(objectID)!=0 )
176        (*this->functor_)(orxonox_cast<T*>(Synchronisable::getSynchronisable(objectID)), mt1, mt2, mt3);
177    }
178    inline void call(uint32_t objectID, const MultiType& mt1, const MultiType& mt2, const MultiType& mt3, const MultiType& mt4)
179    {
180      if ( Synchronisable::getSynchronisable(objectID)!=0 )
181        (*this->functor_)(orxonox_cast<T*>(Synchronisable::getSynchronisable(objectID)), mt1, mt2, mt3, mt4);
182    }
183    inline void call(uint32_t objectID, const MultiType& mt1, const MultiType& mt2, const MultiType& mt3, const MultiType& mt4, const MultiType& mt5)
184    {
185      if ( Synchronisable::getSynchronisable(objectID)!=0 )
186        (*this->functor_)(orxonox_cast<T*>(Synchronisable::getSynchronisable(objectID)), mt1, mt2, mt3, mt4, mt5);
187    }
188
189  private:
190    FunctorMemberPtr<T> functor_;
191};
192
193template <class T> NetworkMemberFunction<T>::NetworkMemberFunction(const FunctorMemberPtr<T>& functor, const std::string& name, const NetworkFunctionPointer& p):
194    NetworkMemberFunctionBase(name, p), functor_(functor)
195{
196}
197
198template<class T> inline void copyPtr( T ptr, NetworkFunctionPointer& destptr)
199{
200  if( sizeof(NetworkFunctionPointer)-sizeof(T) > 0)
201    memset((uint8_t*)&destptr + sizeof(T), 0, sizeof(NetworkFunctionPointer)-sizeof(T));
202  T p2 = ptr;
203  memcpy( &destptr, &p2, sizeof(T) );
204//   for(unsigned int i=0; i<(sizeof(T)-1/4)+1; i++)
205//     *((uint32_t*)destptr+i) = p2>>32*i;
206}
207
208template<class T> inline void* registerStaticNetworkFunctionFct( T ptr, const std::string& name )
209{
210  BOOST_STATIC_ASSERT( sizeof(T)<=sizeof(NetworkFunctionPointer) ); // if this fails your compiler uses bigger pointers for static functions than defined above
211  NetworkFunctionPointer destptr;
212  copyPtr( ptr, destptr );
213  new NetworkFunctionStatic( createFunctor(ptr), name, destptr );
214  return 0;
215}
216
217template<class T, class PT> inline void* registerMemberNetworkFunctionFct( PT ptr, const std::string& name )
218{
219  BOOST_STATIC_ASSERT( sizeof(PT)<=sizeof(NetworkFunctionPointer) ); // if this fails your compiler uses bigger pointers for a specific kind of member functions than defined above
220  NetworkFunctionPointer destptr;
221  copyPtr( ptr, destptr );
222  new NetworkMemberFunction<T>( createFunctor(ptr), name, destptr );
223  return 0;
224}
225
226#define registerStaticNetworkFunction( functionPointer ) \
227  static void* BOOST_PP_CAT( NETWORK_FUNCTION_, __LINE__ ) = registerStaticNetworkFunctionFct( functionPointer, #functionPointer );
228#define registerMemberNetworkFunction( class, function ) \
229  static void* BOOST_PP_CAT( NETWORK_FUNCTION_##class, __LINE__ ) = registerMemberNetworkFunctionFct<class>( &class::function, #class "_" #function);
230  // call it with functionPointer, clientID, args
231#define callStaticNetworkFunction( functionPointer, ...) \
232  { \
233    NetworkFunctionPointer p1; \
234    copyPtr( functionPointer, p1 ); \
235    FunctionCallManager::addCallStatic(NetworkFunctionStatic::getFunction(p1)->getNetworkID(), __VA_ARGS__); \
236  }
237  // call it with class, function, objectID, clientID, args
238#define callMemberNetworkFunction( class, function, objectID, ...) \
239  { \
240    NetworkFunctionPointer p1; \
241    copyPtr( &class::function, p1 ); \
242    FunctionCallManager::addCallMember(NetworkMemberFunctionBase::getFunction(p1)->getNetworkID(), objectID, __VA_ARGS__); \
243  }
244
245
246}
247
248#endif /* _NetworkFunction_H__ */
Note: See TracBrowser for help on using the repository browser.