ModernUO/Projects/Server/Buffers/SpanReader.cs

/*************************************************************************
 * ModernUO                                                              *
 * Copyright 2019-2020 - ModernUO Development Team                       *
 * Email: hi@modernuo.com                                                *
 * File: SpanReader.cs                                                   *
 *                                                                       *
 * This program is free software: you can redistribute it and/or modify  *
 * it under the terms of the GNU General Public License as published by  *
 * the Free Software Foundation, either version 3 of the License, or     *
 * (at your option) any later version.                                   *
 *                                                                       *
 * You should have received a copy of the GNU General Public License     *
 * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
 *************************************************************************/

using System.Buffers.Binary;
using System.Diagnostics;
using System.IO;
using System.Runtime.CompilerServices;
using System.Text;
using Server;
using Server.Text;

namespace System.Buffers
{
    public ref struct SpanReader
    {
        private readonly ReadOnlySpan<byte> _buffer;

        public int Length { get; }
        public int Position { get; private set; }
        public int Remaining => Length - Position;

        public SpanReader(ReadOnlySpan<byte> span)
        {
            _buffer = span;
            Position = 0;
            Length = span.Length;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public byte ReadByte()
        {
            if (Position >= Length)
            {
                throw new OutOfMemoryException();
            }

            return _buffer[Position++];
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public bool ReadBoolean() => ReadByte() > 0;

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public sbyte ReadSByte() => (sbyte)ReadByte();

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public short ReadInt16()
        {
            if (!BinaryPrimitives.TryReadInt16BigEndian(_buffer[Position..], out var value))
            {
                throw new OutOfMemoryException();
            }

            Position += 2;
            return value;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public short ReadInt16LE()
        {
            if (!BinaryPrimitives.TryReadInt16LittleEndian(_buffer[Position..], out var value))
            {
                throw new OutOfMemoryException();
            }

            Position += 2;
            return value;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public ushort ReadUInt16()
        {
            if (!BinaryPrimitives.TryReadUInt16BigEndian(_buffer[Position..], out var value))
            {
                throw new OutOfMemoryException();
            }

            Position += 2;
            return value;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public ushort ReadUInt16LE()
        {
            if (!BinaryPrimitives.TryReadUInt16LittleEndian(_buffer[Position..], out var value))
            {
                throw new OutOfMemoryException();
            }

            Position += 2;
            return value;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public int ReadInt32()
        {
            if (!BinaryPrimitives.TryReadInt32BigEndian(_buffer[Position..], out var value))
            {
                throw new OutOfMemoryException();
            }

            Position += 4;
            return value;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public uint ReadUInt32()
        {
            if (!BinaryPrimitives.TryReadUInt32BigEndian(_buffer[Position..], out var value))
            {
                throw new OutOfMemoryException();
            }

            Position += 4;
            return value;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public uint ReadUInt32LE()
        {
            if (!BinaryPrimitives.TryReadUInt32LittleEndian(_buffer[Position..], out var value))
            {
                throw new OutOfMemoryException();
            }

            Position += 4;
            return value;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public long ReadInt64()
        {
            if (!BinaryPrimitives.TryReadInt64BigEndian(_buffer[Position..], out var value))
            {
                throw new OutOfMemoryException();
            }

            Position += 8;
            return value;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public ulong ReadUInt64()
        {
            if (!BinaryPrimitives.TryReadUInt64BigEndian(_buffer[Position..], out var value))
            {
                throw new OutOfMemoryException();
            }

            Position += 8;
            return value;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadString(Encoding encoding, bool safeString = false, int fixedLength = -1)
        {
            int sizeT = TextEncoding.GetByteLengthForEncoding(encoding);

            bool isFixedLength = fixedLength > -1;

            var remaining = Remaining;
            int size;
            if (isFixedLength)
            {
                size = fixedLength * sizeT;
                if (size > Remaining)
                {
                    throw new OutOfMemoryException();
                }
            }
            else
            {
                // In case the remaining is not evenly divisible
                size = remaining - (remaining & (sizeT - 1));
                int index = _buffer.Slice(Position, size).IndexOfTerminator(sizeT);
                size = index < 0 ? size : index;
            }

            var span = _buffer.Slice(Position, size);
            Position += size;
            return TextEncoding.GetString(span, encoding, safeString);
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadLittleUniSafe(int fixedLength) => ReadString(TextEncoding.UnicodeLE, true, fixedLength);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadLittleUniSafe() => ReadString(TextEncoding.UnicodeLE, true);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadLittleUni(int fixedLength) => ReadString(TextEncoding.UnicodeLE, false, fixedLength);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadLittleUni() => ReadString(TextEncoding.UnicodeLE);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadBigUniSafe(int fixedLength) => ReadString(TextEncoding.Unicode, true, fixedLength);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadBigUniSafe() => ReadString(TextEncoding.Unicode, true);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadBigUni(int fixedLength) => ReadString(TextEncoding.Unicode, false, fixedLength);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadBigUni() => ReadString(TextEncoding.Unicode);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadUTF8Safe(int fixedLength) => ReadString(TextEncoding.UTF8, true, fixedLength);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadUTF8Safe() => ReadString(TextEncoding.UTF8, true);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadUTF8() => ReadString(TextEncoding.UTF8);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadAsciiSafe(int fixedLength) => ReadString(Encoding.ASCII, true, fixedLength);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadAsciiSafe() => ReadString(Encoding.ASCII, true);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadAscii(int fixedLength) => ReadString(Encoding.ASCII, false, fixedLength);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public string ReadAscii() => ReadString(Encoding.ASCII);

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public int Seek(int offset, SeekOrigin origin)
        {
            Debug.Assert(
                origin != SeekOrigin.End || offset <= 0,
                "Attempting to seek to a position beyond capacity using SeekOrigin.End"
            );

            Debug.Assert(
                origin != SeekOrigin.End || offset >= -_buffer.Length,
                "Attempting to seek to a negative position using SeekOrigin.End"
            );

            Debug.Assert(
                origin != SeekOrigin.Begin || offset >= 0,
                "Attempting to seek to a negative position using SeekOrigin.Begin"
            );

            Debug.Assert(
                origin != SeekOrigin.Begin || offset <= _buffer.Length,
                "Attempting to seek to a position beyond the capacity using SeekOrigin.Begin"
            );

            Debug.Assert(
                origin != SeekOrigin.Current || Position + offset >= 0,
                "Attempting to seek to a negative position using SeekOrigin.Current"
            );

            Debug.Assert(
                origin != SeekOrigin.Current || Position + offset <= _buffer.Length,
                "Attempting to seek to a position beyond the capacity using SeekOrigin.Current"
            );

            return Position = Math.Max(0, origin switch
            {
                SeekOrigin.Current => Position + offset,
                SeekOrigin.End     => _buffer.Length + offset,
                _                  => offset // Begin
            });
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public bool Read(Span<byte> bytes)
        {
            if (bytes.Length < Length)
            {
                throw new ArgumentOutOfRangeException(nameof(bytes));
            }

            return _buffer.TryCopyTo(bytes);
        }
    }
}