Engine directory for ticket #1

Engine/source/sim/netStringTable.h

@@ -0,0 +1,161 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2012 GarageGames, LLC
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+#ifndef _NETSTRINGTABLE_H_
+#define _NETSTRINGTABLE_H_
+
+#ifndef _DATACHUNKER_H_
+#include "core/dataChunker.h"
+#endif
+#ifndef _CONSOLE_H_
+#include "console/console.h"
+#endif
+
+class NetConnection;
+
+class NetStringHandle;
+extern U32 GameAddTaggedString(const char *string);
+
+class NetStringTable
+{
+   friend class NetStringHandle;
+   friend U32 GameAddTaggedString(const char *string);
+
+#ifdef TORQUE_DEBUG_NET
+   friend class RemoteCommandEvent;
+#endif
+
+   enum Constants {
+      InitialSize = 16,
+      InvalidEntry = 0xFFFFFFFF,
+      HashTableSize = 2128,
+      DataChunkerSize = 65536
+   };
+   struct Entry
+   {
+      char *string;
+      U32 refCount;
+      U32 scriptRefCount;
+      U32 next;
+      U32 link;
+      U32 prevLink;
+      U32 seq;
+   };
+   U32 size;
+   U32 firstFree;
+   U32 firstValid;
+   U32 sequenceCount;
+
+   Entry *table;
+   U32 hashTable[HashTableSize];
+   DataChunker *allocator;
+
+    NetStringTable();
+   ~NetStringTable();
+
+   U32         addString(const char *string);
+
+// XA: Moved this ones to public to avoid using the friend_ConsoleMethod hack.
+public:
+   const char *lookupString(U32 id);
+   void        removeString(U32 id, bool script = false);
+   void        incStringRefScript(U32 id);
+
+private:
+   void        incStringRef(U32 id);
+
+   void repack();
+public:
+   static void create();
+   static void destroy();
+
+   static void expandString(NetStringHandle &string, char *buf, U32 bufSize, U32 argc, const char **argv);
+
+#if defined(TORQUE_DEBUG)
+   void dumpToConsole();
+#endif // DEBUG
+};
+
+extern NetStringTable *gNetStringTable;
+
+// This class represents what is known as a "tagged string" in script.
+// It is essentially a networked version of the string table. The full string
+// is only transmitted once; then future references only need to transmit
+// the id.
+
+class NetStringHandle
+{
+   U32 index;
+public:
+   NetStringHandle() { index = 0; }
+   NetStringHandle(const NetStringHandle &string) {
+      index = string.index;
+      if(index)
+         gNetStringTable->incStringRef(index);
+   }
+   NetStringHandle(const char *string) {
+      index = gNetStringTable->addString(string);
+   }
+   NetStringHandle(U32 initIndex)
+   {
+      index = initIndex;
+      if(index)
+         gNetStringTable->incStringRef(index);
+   }
+   ~NetStringHandle()
+   {
+      if(index)
+         gNetStringTable->removeString(index);
+   }
+
+   void setFromIndex(U32 newIndex)
+   {
+      if(index)
+         gNetStringTable->removeString(index);
+      index = newIndex;
+   }
+
+   bool operator==(const NetStringHandle &s) const { return index == s.index; }
+   bool operator!=(const NetStringHandle &s) const { return index != s.index; }
+
+   NetStringHandle &operator=(const NetStringHandle &s)
+   {
+      if(index)
+         gNetStringTable->removeString(index);
+      index = s.index;
+      if(index)
+         gNetStringTable->incStringRef(index);
+     return *this;
+   }
+   const char *getString() const
+   {
+      if(index)
+         return gNetStringTable->lookupString(index);
+      else
+         return NULL;
+   }
+   bool isNull() const { return index == 0; }
+   bool isValidString() const { return index != 0; }
+   U32 getIndex() const { return index; }
+};
+
+#endif