Added possibility to write value in exact number of bits

Arcidev · Apr 19, 2017 · 00694a6 · 00694a6
1 parent da52f04
commit 00694a6
Show file tree

Hide file tree

Showing 7 changed files with 209 additions and 0 deletions.
diff --git a/Arci.Networking.Tests.NetCore/BuilderTests/PacketBuilderTests.cs b/Arci.Networking.Tests.NetCore/BuilderTests/PacketBuilderTests.cs
@@ -34,6 +34,8 @@ public void TestPacketBuild()
             packet.WriteGuidByteStreamInOrder(123456, 1, 2, 3, 4, 5, 6, 7, 0);
 
             Assert.True(buildedPacket.Data.SequenceEqual(packet.Data));
+            packet.Dispose();
+            buildedPacket.Dispose();
         }
     }
 }
diff --git a/Arci.Networking.Tests/DataTests/ByteBufferTests.cs b/Arci.Networking.Tests/DataTests/ByteBufferTests.cs
@@ -37,5 +37,35 @@ public void AppendByteBufferTest()
                 }
             }
         }
+
+        [TestMethod]
+        public void TestWriteBits()
+        {
+            byte val = 0x1 + 0x4 + 0x10;
+            var packet1 = new Packet(packetOpcode);
+            packet1.WriteBits(val, 5);
+            packet1.FlushBits();
+
+            var packet2 = new Packet(packet1.Data);
+            Assert.AreEqual(val, packet2.ReadBits(5));
+
+            packet1.Dispose();
+            packet1.Dispose();
+        }
+
+        [TestMethod]
+        public void TestWriteBits2()
+        {
+            var val = uint.MaxValue;
+            var packet1 = new Packet(packetOpcode);
+            packet1.WriteBits(val, 16);
+            packet1.FlushBits();
+
+            var packet2 = new Packet(packet1.Data);
+            Assert.AreEqual(ushort.MaxValue, packet2.ReadBits(16));
+
+            packet1.Dispose();
+            packet1.Dispose();
+        }
     }
 }
diff --git a/Arci.Networking/Builder/PacketBuilderTemplate.cs b/Arci.Networking/Builder/PacketBuilderTemplate.cs
@@ -27,6 +27,18 @@ public PacketBuilder WriteBit(Int16 bit)
             packet.WriteBit(bit);
             return this;
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        /// <returns>This PacketBuilder</returns>
+        public PacketBuilder WriteBits(Int16 value, byte bitsCount)
+        {
+            packet.WriteBits(value, bitsCount);
+            return this;
+        }
 
         /// <summary>
         /// Writes Int32 value to packet
@@ -49,6 +61,18 @@ public PacketBuilder WriteBit(Int32 bit)
             packet.WriteBit(bit);
             return this;
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        /// <returns>This PacketBuilder</returns>
+        public PacketBuilder WriteBits(Int32 value, byte bitsCount)
+        {
+            packet.WriteBits(value, bitsCount);
+            return this;
+        }
 
         /// <summary>
         /// Writes SByte value to packet
@@ -71,6 +95,18 @@ public PacketBuilder WriteBit(SByte bit)
             packet.WriteBit(bit);
             return this;
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        /// <returns>This PacketBuilder</returns>
+        public PacketBuilder WriteBits(SByte value, byte bitsCount)
+        {
+            packet.WriteBits(value, bitsCount);
+            return this;
+        }
 
         /// <summary>
         /// Writes UInt16 value to packet
@@ -93,6 +129,18 @@ public PacketBuilder WriteBit(UInt16 bit)
             packet.WriteBit(bit);
             return this;
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        /// <returns>This PacketBuilder</returns>
+        public PacketBuilder WriteBits(UInt16 value, byte bitsCount)
+        {
+            packet.WriteBits(value, bitsCount);
+            return this;
+        }
 
         /// <summary>
         /// Writes UInt32 value to packet
@@ -115,6 +163,18 @@ public PacketBuilder WriteBit(UInt32 bit)
             packet.WriteBit(bit);
             return this;
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        /// <returns>This PacketBuilder</returns>
+        public PacketBuilder WriteBits(UInt32 value, byte bitsCount)
+        {
+            packet.WriteBits(value, bitsCount);
+            return this;
+        }
 
         /// <summary>
         /// Writes Byte value to packet
@@ -137,6 +197,18 @@ public PacketBuilder WriteBit(Byte bit)
             packet.WriteBit(bit);
             return this;
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        /// <returns>This PacketBuilder</returns>
+        public PacketBuilder WriteBits(Byte value, byte bitsCount)
+        {
+            packet.WriteBits(value, bitsCount);
+            return this;
+        }
 
         /// <summary>
         /// Writes bit value to stream

diff --git a/Arci.Networking/Builder/PacketBuilderTemplate.tt b/Arci.Networking/Builder/PacketBuilderTemplate.tt
@@ -41,6 +41,18 @@ namespace Arci.Networking.Builder
             packet.WriteBit(bit);
             return this;
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        /// <returns>This PacketBuilder</returns>
+        public PacketBuilder WriteBits(<#= type.Name #> value, byte bitsCount)
+        {
+            packet.WriteBits(value, bitsCount);
+            return this;
+        }
         <# 
         } #>
 

diff --git a/Arci.Networking/Data/ByteBuffer.cs b/Arci.Networking/Data/ByteBuffer.cs
@@ -84,6 +84,22 @@ public bool ReadBit()
             return ((curBitVal >> (7 - bitPos)) & 1) != 0;
         }
 
+        /// <summary>
+        /// Reads exact number of bits and return result as a value
+        /// </summary>
+        /// <param name="bitsCount">Bits to be read</param>
+        /// <returns>Value represented by bits that have been read</returns>
+        public UInt32 ReadBits(byte bitsCount)
+        {
+            UInt32 value = 0;
+            for (int i = bitsCount - 1; i >= 0; i--)
+            {
+                if (ReadBit())
+                    value |= (UInt32)1 << i;
+            }
+            return value;
+        }
+
         /// <summary>
         /// Writes string value
         /// </summary>

diff --git a/Arci.Networking/Data/ByteBufferGenericTemplate.cs b/Arci.Networking/Data/ByteBufferGenericTemplate.cs
@@ -37,6 +37,17 @@ public void WriteBit(Int16 bit)
             if (bitPos == 0)
                 WriteCurBitVal();
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        public void WriteBits(Int16 value, byte bitsCount)
+        {
+            for (int i = bitsCount - 1; i >= 0; i--)
+                WriteBit(((Int16)1 << i) & value);
+        }
 
         /// <summary>
         /// Reads Int32 value from stream
@@ -69,6 +80,17 @@ public void WriteBit(Int32 bit)
             if (bitPos == 0)
                 WriteCurBitVal();
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        public void WriteBits(Int32 value, byte bitsCount)
+        {
+            for (int i = bitsCount - 1; i >= 0; i--)
+                WriteBit(((Int32)1 << i) & value);
+        }
 
         /// <summary>
         /// Reads SByte value from stream
@@ -101,6 +123,17 @@ public void WriteBit(SByte bit)
             if (bitPos == 0)
                 WriteCurBitVal();
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        public void WriteBits(SByte value, byte bitsCount)
+        {
+            for (int i = bitsCount - 1; i >= 0; i--)
+                WriteBit(((SByte)1 << i) & value);
+        }
 
         /// <summary>
         /// Reads UInt16 value from stream
@@ -133,6 +166,17 @@ public void WriteBit(UInt16 bit)
             if (bitPos == 0)
                 WriteCurBitVal();
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        public void WriteBits(UInt16 value, byte bitsCount)
+        {
+            for (int i = bitsCount - 1; i >= 0; i--)
+                WriteBit(((UInt16)1 << i) & value);
+        }
 
         /// <summary>
         /// Reads UInt32 value from stream
@@ -165,6 +209,17 @@ public void WriteBit(UInt32 bit)
             if (bitPos == 0)
                 WriteCurBitVal();
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        public void WriteBits(UInt32 value, byte bitsCount)
+        {
+            for (int i = bitsCount - 1; i >= 0; i--)
+                WriteBit(((UInt32)1 << i) & value);
+        }
 
         /// <summary>
         /// Reads Byte value from stream
@@ -197,6 +252,17 @@ public void WriteBit(Byte bit)
             if (bitPos == 0)
                 WriteCurBitVal();
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        public void WriteBits(Byte value, byte bitsCount)
+        {
+            for (int i = bitsCount - 1; i >= 0; i--)
+                WriteBit(((Byte)1 << i) & value);
+        }
 
         /// <summary>
         /// Writes bit value to stream

diff --git a/Arci.Networking/Data/ByteBufferGenericTemplate.tt b/Arci.Networking/Data/ByteBufferGenericTemplate.tt
@@ -51,6 +51,17 @@ namespace Arci.Networking.Data
             if (bitPos == 0)
                 WriteCurBitVal();
         }
+
+        /// <summary>
+        /// Writes value with specified number of bits
+        /// </summary>
+        /// <param name="value">Value to be written</param>
+        /// <param name="bitsCount">Number of bits that value should written with</param>
+        public void WriteBits(<#= type.Name #> value, byte bitsCount)
+        {
+            for (int i = bitsCount - 1; i >= 0; i--)
+                WriteBit(((<#= type.Name #>)1 << i) & value);
+        }
         <# 
         } #>