ImageSharp/tests/ImageSharp.Tests/Memory/Buffer2DTests.cs

// Copyright (c) Six Labors and contributors.
// Licensed under the Apache License, Version 2.0.

using System;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

using SixLabors.ImageSharp.PixelFormats;
using SixLabors.Memory;
using SixLabors.Primitives;

using Xunit;

// ReSharper disable InconsistentNaming

namespace SixLabors.ImageSharp.Tests.Memory
{
    public class Buffer2DTests
    {
        // ReSharper disable once ClassNeverInstantiated.Local
        private class Assert : Xunit.Assert
        {
            public static void SpanPointsTo<T>(Span<T> span, IBuffer<T> buffer, int bufferOffset = 0)
                where T : struct
            {
                ref T actual = ref MemoryMarshal.GetReference(span);
                ref T expected = ref Unsafe.Add(ref buffer.GetReference(), bufferOffset);

                Assert.True(Unsafe.AreSame(ref expected, ref actual), "span does not point to the expected position");
            }
        }

        private MemoryAllocator MemoryAllocator { get; } = new TestMemoryAllocator();

        [Theory]
        [InlineData(7, 42)]
        [InlineData(1025, 17)]
        public void Construct(int width, int height)
        {
            using (Buffer2D<TestStructs.Foo> buffer = this.MemoryAllocator.Allocate2D<TestStructs.Foo>(width, height))
            {
                Assert.Equal(width, buffer.Width);
                Assert.Equal(height, buffer.Height);
                Assert.Equal(width * height, buffer.Buffer.Length());
            }
        }

        [Fact]
        public void CreateClean()
        {
            using (Buffer2D<int> buffer = this.MemoryAllocator.Allocate2D<int>(42, 42, AllocationOptions.Clean))
            {
                Span<int> span = buffer.GetSpan();
                for (int j = 0; j < span.Length; j++)
                {
                    Assert.Equal(0, span[j]);
                }
            }
        }

        [Theory]
        [InlineData(7, 42, 0)]
        [InlineData(7, 42, 10)]
        [InlineData(17, 42, 41)]
        public void GetRowSpanY(int width, int height, int y)
        {
            using (Buffer2D<TestStructs.Foo> buffer = this.MemoryAllocator.Allocate2D<TestStructs.Foo>(width, height))
            {
                Span<TestStructs.Foo> span = buffer.GetRowSpan(y);

                // Assert.Equal(width * y, span.Start);
                Assert.Equal(width, span.Length);
                Assert.SpanPointsTo(span, buffer.Buffer, width * y);
            }
        }

        [Theory]
        [InlineData(7, 42, 0, 0)]
        [InlineData(7, 42, 3, 10)]
        [InlineData(17, 42, 0, 41)]
        public void GetRowSpanXY(int width, int height, int x, int y)
        {
            using (Buffer2D<TestStructs.Foo> buffer = this.MemoryAllocator.Allocate2D<TestStructs.Foo>(width, height))
            {
                Span<TestStructs.Foo> span = buffer.GetRowSpan(x, y);

                // Assert.Equal(width * y + x, span.Start);
                Assert.Equal(width - x, span.Length);
                Assert.SpanPointsTo(span, buffer.Buffer, width * y + x);
            }
        }

        [Theory]
        [InlineData(42, 8, 0, 0)]
        [InlineData(400, 1000, 20, 10)]
        [InlineData(99, 88, 98, 87)]
        public void Indexer(int width, int height, int x, int y)
        {
            using (Buffer2D<TestStructs.Foo> buffer = this.MemoryAllocator.Allocate2D<TestStructs.Foo>(width, height))
            {
                Span<TestStructs.Foo> span = buffer.Buffer.GetSpan();

                ref TestStructs.Foo actual = ref buffer[x, y];

                ref TestStructs.Foo expected = ref span[y * width + x];

                Assert.True(Unsafe.AreSame(ref expected, ref actual));
            }
        }
        
        public class SwapOrCopyContent
        {
            private MemoryAllocator MemoryAllocator { get; } = new TestMemoryAllocator();
            
            [Fact]
            public void WhenBothBuffersAreMemoryOwners_ShouldSwap()
            {
                using (Buffer2D<int> a = this.MemoryAllocator.Allocate2D<int>(10, 5))
                using (Buffer2D<int> b = this.MemoryAllocator.Allocate2D<int>(3, 7))
                {
                    IBuffer<int> aa = a.Buffer;
                    IBuffer<int> bb = b.Buffer;

                    Buffer2D<int>.SwapOrCopyContent(a, b);

                    Assert.Equal(bb, a.Buffer);
                    Assert.Equal(aa, b.Buffer);
                      
                    Assert.Equal(new Size(3, 7), a.Size());
                    Assert.Equal(new Size(10, 5), b.Size());
                }
            }

            [Fact]
            public void WhenDestIsNotMemoryOwner_SameSize_ShouldCopy()
            {
                var data = new Rgba32[3 * 7];
                var color = new Rgba32(1, 2, 3, 4);
                
                var mmg = new TestMemoryManager<Rgba32>(data);
                var aBuff = new ConsumedBuffer<Rgba32>(mmg.Memory);

                using (Buffer2D<Rgba32> a = new Buffer2D<Rgba32>(aBuff, 3, 7))
                {
                    IBuffer<Rgba32> aa = a.Buffer;

                    // Precondition:
                    Assert.Equal(aBuff, aa);

                    using (Buffer2D<Rgba32> b = this.MemoryAllocator.Allocate2D<Rgba32>(3, 7))
                    {
                        IBuffer<Rgba32> bb = b.Buffer;
                        bb.GetSpan()[10] = color;

                        // Act:
                        Buffer2D<Rgba32>.SwapOrCopyContent(a, b);

                        // Assert:
                        Assert.Equal(aBuff, a.Buffer);
                        Assert.Equal(bb, b.Buffer);
                    }

                    // Assert:
                    Assert.Equal(color, a.Buffer.GetSpan()[10]);
                }
            }

            [Fact]
            public void WhenDestIsNotMemoryOwner_DifferentSize_Throws()
            {
                var data = new Rgba32[3 * 7];
                var color = new Rgba32(1, 2, 3, 4);
                data[10] = color;

                var mmg = new TestMemoryManager<Rgba32>(data);
                var aBuff = new ConsumedBuffer<Rgba32>(mmg.Memory);

                using (Buffer2D<Rgba32> a = new Buffer2D<Rgba32>(aBuff, 3, 7))
                {
                    IBuffer<Rgba32> aa = a.Buffer;
                    using (Buffer2D<Rgba32> b = this.MemoryAllocator.Allocate2D<Rgba32>(3, 8))
                    {
                        IBuffer<Rgba32> bb = b.Buffer;

                        Assert.ThrowsAny<InvalidOperationException>(
                            () =>
                                {
                                    Buffer2D<Rgba32>.SwapOrCopyContent(a, b);
                                });
                    }

                    Assert.Equal(color, a.Buffer.GetSpan()[10]);
                }
            }

        }
    }
}