diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6096d12 --- /dev/null +++ b/.gitignore @@ -0,0 +1,391 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.tlog +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Nuget personal access tokens and Credentials +nuget.config + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# VS Code files for those working on multiple tools +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +# Windows Installer files from build outputs +*.cab +*.msi +*.msix +*.msm +*.msp + +# JetBrains Rider +.idea/ +*.sln.iml + +# XML Documentation +TransparencyAndConsentFramework/Bidtellect.Tcf.xml diff --git a/Bidtellect.Serialization.Tests/Bidtellect.Serialization.Tests.csproj b/Bidtellect.Serialization.Tests/Bidtellect.Serialization.Tests.csproj new file mode 100644 index 0000000..4243b2c --- /dev/null +++ b/Bidtellect.Serialization.Tests/Bidtellect.Serialization.Tests.csproj @@ -0,0 +1,21 @@ + + + + net6.0 + enable + + false + + + + + + + + + + + + + + diff --git a/Bidtellect.Serialization.Tests/SerializationRoundTripTests.cs b/Bidtellect.Serialization.Tests/SerializationRoundTripTests.cs new file mode 100644 index 0000000..e146804 --- /dev/null +++ b/Bidtellect.Serialization.Tests/SerializationRoundTripTests.cs @@ -0,0 +1,180 @@ +using Microsoft.VisualStudio.TestTools.UnitTesting; +using System; +using System.Linq; + +namespace Bidtellect.Serialization.Tests +{ + [TestClass] + public class SerializationTest + { + [TestMethod] + public void RoundTrip() + { + byte[] message; + + var bytes = new byte[] { 0x55, 0x32, 0xFF }; + + using (var stream = new System.IO.MemoryStream()) + { + using (var binaryWriter = new System.IO.BinaryWriter(stream)) + using (var bitWriter = new BitWriter(binaryWriter)) + { + bitWriter.Write(true); + bitWriter.WriteBase2(32, 8); + bitWriter.WriteFib(21); + bitWriter.Write(bytes); + bitWriter.WriteString("Test!\0overrun"); + } + + message = stream.ToArray(); + } + + var bitReader = new BitReader(message); + + Assert.AreEqual(true, bitReader.ReadBit()); + Assert.AreEqual(32, (int)bitReader.ReadBase2(8)); + Assert.AreEqual(21, bitReader.ReadFib()); + Assert.IsTrue(bytes.SequenceEqual(bitReader.ReadBytes(bytes.Length))); + Assert.AreEqual("Test!", bitReader.ReadString()); + } + + [TestMethod] + public void BitRoundTripTest() + { + byte[] bytes; + + using (var stream = new System.IO.MemoryStream()) + { + using (var binaryWriter = new System.IO.BinaryWriter(stream)) + using (var bitWriter = new BitWriter(binaryWriter)) + { + bitWriter.Write(true); + bitWriter.Write(false); + bitWriter.Write(true); + } + + bytes = stream.ToArray(); + } + + var reader = new BitReader(bytes); + + Assert.AreEqual(true, reader.ReadBit()); + Assert.AreEqual(false, reader.ReadBit()); + Assert.AreEqual(true, reader.ReadBit()); + } + + [TestMethod] + public void ByteRoundTripTest() + { + byte[] bytes; + + using (var stream = new System.IO.MemoryStream()) + { + using (var binaryWriter = new System.IO.BinaryWriter(stream)) + using (var bitWriter = new BitWriter(binaryWriter)) + { + bitWriter.Write(0x22); + bitWriter.Write(0x72); + bitWriter.Write(0x6C); + } + + bytes = stream.ToArray(); + } + + var reader = new BitReader(bytes); + + Assert.AreEqual(0x22, reader.ReadByte()); + Assert.AreEqual(0x72, reader.ReadByte()); + Assert.AreEqual(0x6C, reader.ReadByte()); + } + + [TestMethod] + public void Base2RoundTripTest() + { + byte[] bytes; + + using (var stream = new System.IO.MemoryStream()) + { + using (var binaryWriter = new System.IO.BinaryWriter(stream)) + using (var bitWriter = new BitWriter(binaryWriter)) + { + bitWriter.WriteBase2(5, 4); + bitWriter.WriteBase2(200, 8); + bitWriter.WriteBase2(int.MaxValue, 32); + bitWriter.WriteBase2(long.MaxValue, 64); + } + + bytes = stream.ToArray(); + } + + var reader = new BitReader(bytes); + + Assert.AreEqual(5, (int)reader.ReadBase2(4)); + Assert.AreEqual(200, (int)reader.ReadBase2(8)); + Assert.AreEqual(int.MaxValue, (int)reader.ReadBase2(32)); + Assert.AreEqual(long.MaxValue, (long)reader.ReadBase2(64)); + } + + [TestMethod] + public void FibRoundTripTest() + { + byte[] bytes; + + using (var stream = new System.IO.MemoryStream()) + { + using (var binaryWriter = new System.IO.BinaryWriter(stream)) + using (var bitWriter = new BitWriter(binaryWriter)) + { + bitWriter.WriteFib(int.MaxValue-1); + bitWriter.WriteFib(13); + } + + bytes = stream.ToArray(); + } + + var reader = new BitReader(bytes); + + Assert.AreEqual(int.MaxValue-1, (int)reader.ReadFib()); + Assert.AreEqual(13, (int)reader.ReadFib()); + } + + [TestMethod] + public void StringRoundTripTest() + { + byte[] bytes; + + using (var stream = new System.IO.MemoryStream()) + { + using (var binaryWriter = new System.IO.BinaryWriter(stream)) + using (var bitWriter = new BitWriter(binaryWriter)) + { + bitWriter.WriteString("Hello world!"); + bitWriter.WriteString("Unicode Support ✅"); + bitWriter.WriteString("Does not write pass null.\0 Skip this part"); + } + + bytes = stream.ToArray(); + } + + var reader = new BitReader(bytes); + + Assert.AreEqual("Hello world!", reader.ReadString()); + Assert.AreEqual("Unicode Support ✅", reader.ReadString()); + Assert.AreEqual("Does not write pass null.", reader.ReadString()); + } + + protected byte[] GetBytes(Action action) + { + using (var stream = new System.IO.MemoryStream()) + { + using (var binaryWriter = new System.IO.BinaryWriter(stream)) + using (var bitWriter = new BitWriter(binaryWriter)) + { + action.Invoke(bitWriter); + } + + return stream.ToArray(); + } + } + } +} diff --git a/Bidtellect.Serialization/Base64Converter.cs b/Bidtellect.Serialization/Base64Converter.cs new file mode 100644 index 0000000..f7e30ef --- /dev/null +++ b/Bidtellect.Serialization/Base64Converter.cs @@ -0,0 +1,70 @@ +using System; +using System.Text; + +namespace Bidtellect.Serialization +{ + /// + /// Converts byte arrays to base64 encoded strings and vice versa. + /// + public static class Base64Converter + { + /// + /// Encodes a value using base64 encoding (RFC-4648). + /// + /// A byte array to encode. + /// + /// A base64 encoded string representation of the value. + /// + public static string Encode(byte[] value) + { + return Encode(value, 0, value.Length); + } + + /// + /// Encodes a value using base64 encoding (RFC-4648). + /// + /// A byte array to encode. + /// A 0-based offset in the value. + /// The number of bytes to encode. + /// + /// A base64 encoded string representation of the value. + /// + public static string Encode(byte[] value, int offset, int length) + { + var builder = new StringBuilder(Convert.ToBase64String(value, offset, length)); + + builder.Replace("+", "-"); + builder.Replace("/", "_"); + + // Remove padding + builder.Replace("=", ""); + + return builder.ToString(); + } + + /// + /// Decodes a value using base64 encoding (RFC-4648). + /// + /// A string encoded in base64. + /// + /// A byte array representation of the value. + /// + public static byte[] Decode(string value) + { + var builder = new StringBuilder(value); + + builder.Replace("-", "+"); + builder.Replace("_", "/"); + + var remainder = builder.Length % 4; + + // Add padding, if needed + if (remainder > 0) + { + builder.Append('=', 4 - remainder); + } + + return Convert.FromBase64String(builder.ToString()); + } + } +} diff --git a/Bidtellect.Serialization/Bidtellect.Serialization.csproj b/Bidtellect.Serialization/Bidtellect.Serialization.csproj new file mode 100644 index 0000000..4a39ece --- /dev/null +++ b/Bidtellect.Serialization/Bidtellect.Serialization.csproj @@ -0,0 +1,34 @@ + + + + netstandard2.0 + True + 1.0.0 + Bidtellect Team + Bidtellect + A library that provides functionality to serialize and deserialize data. + Copyright © 2022 Bidtellect, Inc. + https://github.com/bidtellect/serialization + bidtellect.png + README.md + https://github.com/bidtellect/serialization.git + git + serialization;bit + Apache-2.0 + + + + + True + \ + + + + + + True + \ + + + + diff --git a/Bidtellect.Serialization/BitReader.cs b/Bidtellect.Serialization/BitReader.cs new file mode 100644 index 0000000..7024d66 --- /dev/null +++ b/Bidtellect.Serialization/BitReader.cs @@ -0,0 +1,246 @@ +using System; +using System.Collections.Generic; +using System.Text; + +namespace Bidtellect.Serialization +{ + /// + /// Reads individual bits sequentially from a byte array. + /// + public class BitReader + { + protected byte[] byteArray; + protected int byteIndex = 0; + + protected byte byteBuffer; + protected byte bitMask; + + /// + /// Initializes a new instance of BitReader. + /// + /// The array from which to read. + public BitReader(byte[] byteArray) + { + this.byteArray = byteArray; + + Reset(); + } + + /// + /// Reads a single bit as a boolean value where + /// true represents 1 and + /// false represents 0. + /// + public bool ReadBit() + { + var value = (byteBuffer & bitMask) > 0; + + bitMask >>= 1; + + if (bitMask <= 0) + { + byteIndex += 1; + Reset(); + } + + return value; + } + + /// + /// Reads multiple bits as boolean values where + /// true represents 1 and + /// false represents 0. + /// + /// An array of boolean values into which the bits will be read. + /// An offset (0-based) from which to begin storing the bits read. + /// The number of bits to be read. + public void ReadBits(bool[] array, int offset, int length) + { + for (var i = offset; i < length; i += 1) + { + array[i] = ReadBit(); + } + } + + /// + /// Reads multiple bits as boolean values where + /// true represents 1 and + /// false represents 0. + /// + /// An array of boolean values into which the bits will be read. + public void ReadBits(bool[] array) + { + ReadBits(array, 0, array.Length); + } + + /// + /// Reads multiple bits as boolean values where + /// true represents 1 and + /// false represents 0. + /// + /// The number of bits to be read. + public bool[] ReadBits(int length) + { + var array = new bool[length]; + + ReadBits(array); + + return array; + } + + /// + /// Reads a byte value. + /// + public byte ReadByte() + { + return (byte)ReadBase2(8); + } + + /// + /// Reads multiple byte values. + /// + /// The number of bytes to read. + /// An array containing the bytes. + public byte[] ReadBytes(int length) + { + var bytes = new byte[length]; + + ReadBytes(bytes, 0, length); + + return bytes; + } + + /// + /// Reads multiple byte values into the given array. + /// + /// An array of bytes into which the bytes will be read. + /// An offset (0-based) from which to begin storing the bytes read. + /// The number of bytes to be read. + /// + /// Thrown when the offset or length values are out of range. + /// + public void ReadBytes(byte[] value, int offset, int length) + { + if (offset < 0 || offset > value.Length) + { + throw new ArgumentOutOfRangeException(nameof(offset)); + } + + if (length + offset > value.Length) + { + throw new ArgumentOutOfRangeException(nameof(length)); + } + + for (var i = offset; i < length; i += 1) + { + value[i] = ReadByte(); + } + } + + /// + /// Reads a base2 encoded unsigned integer. + /// + /// The number of bits to be read. + public ulong ReadBase2(int length) + { + if (length > 64 || length <= 0) + { + throw new ArgumentOutOfRangeException(nameof(length)); + } + + var value = 0UL; + + if (ReadBit()) + { + value |= 1; + } + + for (var i = 1; i < length; i += 1) + { + value <<= 1; + + if (ReadBit()) + { + value |= 1; + } + } + + return value; + } + + /// + /// Reads a Fibonacci encoded unsigned integer. + /// + public long ReadFib() + { + var a = 0L; + var b = 1L; + + var accumulator = 0L; + + var lastBit = false; + + while (true) + { + var sum = a + b; + + if (ReadBit()) + { + // If there are two 1s in a row, we stop. + if (lastBit) + { + break; + } + + accumulator += sum; + lastBit = true; + } + else + { + lastBit = false; + } + + a = b; + b = sum; + } + + return accumulator; + } + + /// + /// Reads a null-terminated string encoded using UTF-8. + /// + public string ReadString() + { + var sequence = new List(); + + var value = ReadByte(); + + while (value != 0) + { + sequence.Add(value); + value = ReadByte(); + } + + return Encoding.UTF8.GetString(sequence.ToArray()); + } + + /// + /// Resets the bitMask and gets the next byte into the byteBuffer. + /// The byteBuffer will be set to 0 if there are no more bytes to read. + /// + protected void Reset() + { + bitMask = 0b1000_0000; + + if (byteIndex < byteArray.Length) + { + byteBuffer = byteArray[byteIndex]; + } + else + { + byteBuffer = 0; + } + } + } +} diff --git a/Bidtellect.Serialization/BitWriter.cs b/Bidtellect.Serialization/BitWriter.cs new file mode 100644 index 0000000..abaed1e --- /dev/null +++ b/Bidtellect.Serialization/BitWriter.cs @@ -0,0 +1,309 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text; +using System.Linq; + +namespace Bidtellect.Serialization +{ + /// + /// Writes individual bits sequentially using a System.IO.BinaryWriter. + /// + public class BitWriter : IDisposable + { + protected BinaryWriter binaryWriter; + + protected const byte DefaultMask = 0b1000_0000; + + protected byte byteBuffer; + protected byte bitMask; + + /// + /// Gets the current position (in bits, starting at 0). + /// + public int Position { get; protected set; } + + /// + /// Initializes a new instance of BitWriter. + /// + /// + /// The binary writer used to write the bits. + /// + public BitWriter(BinaryWriter binaryWriter) + { + this.binaryWriter = binaryWriter; + + Reset(); + } + + /// + /// Writes a boolean value where + /// true is represented as 1 and + /// false is represented as 0. + /// + /// The value to write. + public void Write(bool value) + { + if (value) + { + byteBuffer |= bitMask; + } + + AdvancePosition(); + } + + /// + /// Writes a byte value. + /// + /// The value to write. + public void Write(byte value) + { + WriteBase2(value, 8); + } + + /// + /// Writes multiple byte values from the given array. + /// + /// An array of bytes from which to get the bytes to be written. + /// An offset (0-based) from which to begin writting the bytes. + /// The number of bytes to be written. + /// + /// Thrown when the offset or length values are out of range. + /// + public void Write(byte[] value, int offset, int length) + { + if (offset < 0 || offset > value.Length) + { + throw new ArgumentOutOfRangeException(nameof(offset)); + } + + if (length + offset > value.Length) + { + throw new ArgumentOutOfRangeException(nameof(length)); + } + + for (var i = offset; i < length; i += 1) + { + Write(value[i]); + } + } + + /// + /// Writes multiple byte values from the given array. + /// + /// An array of bytes from which to get the bytes to be written. + public void Write(byte[] value) + { + Write(value, 0, value.Length); + } + + /// + /// Writes a series of boolean values where + /// true is represented as 1 and + /// false is represented as 0. + /// + /// An enumerable collection of values to write. + public void Write(IEnumerable values) + { + foreach (var value in values) + { + Write(value); + } + } + + /// + /// Writes an unsigned integer using base2 encoding. + /// + /// The value to write. + /// The number of bits used to encode the value. + public void WriteBase2(int value, int length) + { + WriteBase2((uint)value, length); + } + + /// + /// Writes an unsigned integer using base2 encoding. + /// + /// The value to write. + /// The number of bits used to encode the value. + public void WriteBase2(uint value, int length) + { + WriteBase2((ulong)value, length); + } + + /// + /// Writes an unsigned long integer using base2 encoding. + /// + /// The value to write. + /// The number of bits used to encode the value. + public void WriteBase2(long value, int length) + { + WriteBase2((ulong)value, length); + } + + /// + /// Writes an unsigned long integer using base2 encoding. + /// + /// The value to write. + /// The number of bits used to encode the value. + public void WriteBase2(ulong value, int length) + { + var mask = 1UL << length - 1; + + while (mask > 0) + { + Write((value & mask) > 0); + + mask >>= 1; + } + } + + /// + public void WriteFib(int value) + { + if (value <= 0) + { + throw new ArgumentOutOfRangeException(nameof(value)); + } + + WriteFib((uint)value); + } + + /// + /// Writes an unsigned integer in Fibonacci encoding. + /// + /// The value to write. + public void WriteFib(uint value) + { + var fib = ComputeFib(value); + + var lastBit = false; + + for (var i = 0; ; i += 1) + { + var bit = (fib & 1UL << i) > 0; + + Write(bit); + + if (lastBit && bit) + { + break; + } + else + { + lastBit = bit; + } + } + } + + public void WriteString(string value) + { + var bytes = Encoding.UTF8.GetBytes(value); + + for (int i = 0; i < bytes.Length; i += 1) + { + Write(bytes[i]); + + // If the value string contains the NUL character, then stop. + if (bytes[i] == 0) + { + return; + } + } + + // Write a NUL character to denote the end of the string. + Write(0); + } + + /// + /// Flushes whatever is in the buffer to the underlying binary writer. + /// + public void Flush() + { + binaryWriter.Write(byteBuffer); + } + + public void Dispose() + { + if (bitMask != DefaultMask) + { + Flush(); + } + } + + /// + /// Resets the bitMask and clears the byteBuffer. + /// + protected void Reset() + { + bitMask = DefaultMask; + byteBuffer = 0; + } + + /// + /// Moves the position to the next bit; flushing and reseting if needed. + /// + protected void AdvancePosition() + { + bitMask >>= 1; + + if (bitMask <= 0) + { + Flush(); + Reset(); + } + + Position += 1; + } + + protected static ulong ComputeFib(ulong value) + { + var a = 0UL; + var b = 1UL; + + var n = 0; + + while (true) + { + var sum = a + b; + + if (sum > value) + { + break; + } + + a = b; + b = sum; + n += 1; + } + + var bitField = 1UL << n; + + while (value > 0) + { + ulong difference; + + n -= 1; + + if (value >= b) + { + bitField |= 1UL << n; + + value -= b; + + difference = b - a; + b = a; + a = difference; + + n -= 1; + } + + difference = b - a; + b = a; + a = difference; + } + + return bitField; + } + } +} diff --git a/Bidtellect.Serialization/bidtellect.png b/Bidtellect.Serialization/bidtellect.png new file mode 100644 index 0000000..876d290 Binary files /dev/null and b/Bidtellect.Serialization/bidtellect.png differ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..f573fee --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 Bidtellect, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cdb38cb --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Bidtellect.Serialization + +A library written in C# which provides functionality to serialize and deserialize data. diff --git a/Serialization.sln b/Serialization.sln new file mode 100644 index 0000000..854d0bc --- /dev/null +++ b/Serialization.sln @@ -0,0 +1,31 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.1.32328.378 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bidtellect.Serialization", "Bidtellect.Serialization\Bidtellect.Serialization.csproj", "{7E25B773-7DF8-4E59-BEB0-C9EF750218A1}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bidtellect.Serialization.Tests", "Bidtellect.Serialization.Tests\Bidtellect.Serialization.Tests.csproj", "{66108C17-62E8-498C-B7BB-A540E6913A06}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {7E25B773-7DF8-4E59-BEB0-C9EF750218A1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {7E25B773-7DF8-4E59-BEB0-C9EF750218A1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {7E25B773-7DF8-4E59-BEB0-C9EF750218A1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {7E25B773-7DF8-4E59-BEB0-C9EF750218A1}.Release|Any CPU.Build.0 = Release|Any CPU + {66108C17-62E8-498C-B7BB-A540E6913A06}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {66108C17-62E8-498C-B7BB-A540E6913A06}.Debug|Any CPU.Build.0 = Debug|Any CPU + {66108C17-62E8-498C-B7BB-A540E6913A06}.Release|Any CPU.ActiveCfg = Release|Any CPU + {66108C17-62E8-498C-B7BB-A540E6913A06}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {23E5D660-F4C6-4D84-A6B9-DD8ABF912999} + EndGlobalSection +EndGlobal