/*
    This file is part of Magnum.

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019
              Vladimír Vondruš <mosra@centrum.cz>

    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.
*/

#include <sstream>
#include <Corrade/TestSuite/Tester.h>
#include <Corrade/TestSuite/Compare/Numeric.h>
#include <Corrade/Utility/DebugStl.h>
#include <Corrade/Utility/Configuration.h>

#include "Magnum/PixelFormat.h"
#include "Magnum/Math/Vector3.h"

namespace Magnum { namespace Test { namespace {

struct PixelFormatTest: TestSuite::Tester {
    explicit PixelFormatTest();

    void mapping();
    void compressedMapping();

    void size();
    void sizeInvalid();
    void sizeImplementationSpecific();

    void compressedBlockSize();
    void compressedBlockSizeInvalid();
    void compressedBlockSizeImplementationSpecific();

    void isImplementationSpecific();
    void wrap();
    void wrapInvalid();
    void unwrap();
    void unwrapInvalid();

    void compressedIsImplementationSpecific();
    void compressedWrap();
    void compressedWrapInvalid();
    void compressedUnwrap();
    void compressedUnwrapInvalid();

    void debug();
    void debugImplementationSpecific();

    void compressedDebug();
    void compressedDebugImplementationSpecific();

    void configuration();
    void compresedConfiguration();
};

PixelFormatTest::PixelFormatTest() {
    addTests({&PixelFormatTest::mapping,
              &PixelFormatTest::compressedMapping,

              &PixelFormatTest::size,
              &PixelFormatTest::sizeInvalid,
              &PixelFormatTest::sizeImplementationSpecific,

              &PixelFormatTest::compressedBlockSize,
              &PixelFormatTest::compressedBlockSizeInvalid,
              &PixelFormatTest::compressedBlockSizeImplementationSpecific,

              &PixelFormatTest::isImplementationSpecific,
              &PixelFormatTest::wrap,
              &PixelFormatTest::wrapInvalid,
              &PixelFormatTest::unwrap,
              &PixelFormatTest::unwrapInvalid,

              &PixelFormatTest::compressedIsImplementationSpecific,
              &PixelFormatTest::compressedWrap,
              &PixelFormatTest::compressedWrapInvalid,
              &PixelFormatTest::compressedUnwrap,
              &PixelFormatTest::compressedUnwrapInvalid,

              &PixelFormatTest::debug,
              &PixelFormatTest::debugImplementationSpecific,

              &PixelFormatTest::compressedDebug,
              &PixelFormatTest::compressedDebugImplementationSpecific,

              &PixelFormatTest::configuration,
              &PixelFormatTest::compresedConfiguration});
}

void PixelFormatTest::mapping() {
    /* This goes through the first 16 bits, which should be enough. Going
       through 32 bits takes 8 seconds, too much. */
    UnsignedInt firstUnhandled = 0xffff;
    UnsignedInt nextHandled = 1; /* 0 is an invalid format */
    for(UnsignedInt i = 1; i <= 0xffff; ++i) {
        const auto format = PixelFormat(i);
        /* Each case verifies:
           - that the cases are ordered by number (so insertion here is done in
             proper place)
           - that there was no gap (unhandled value inside the range)
           - that a particular pixel format maps to a particular GL format
           - that a particular pixel type maps to a particular GL type */
        #ifdef __GNUC__
        #pragma GCC diagnostic push
        #pragma GCC diagnostic error "-Wswitch"
        #endif
        switch(format) {
            #define _c(format) \
                case PixelFormat::format: \
                    CORRADE_COMPARE(nextHandled, i); \
                    CORRADE_COMPARE(firstUnhandled, 0xffff); \
                    ++nextHandled; \
                    continue;
            #include "Magnum/Implementation/pixelFormatMapping.hpp"
            #undef _c
        }
        #ifdef __GNUC__
        #pragma GCC diagnostic pop
        #endif

        /* Not handled by any value, remember -- we might either be at the end
           of the enum range (which is okay) or some value might be unhandled
           here */
        firstUnhandled = i;
    }

    CORRADE_COMPARE(firstUnhandled, 0xffff);
}

void PixelFormatTest::compressedMapping() {
    /* This goes through the first 16 bits, which should be enough. Going
       through 32 bits takes 8 seconds, too much. */
    UnsignedInt firstUnhandled = 0xffff;
    UnsignedInt nextHandled = 1; /* 0 is an invalid format */
    for(UnsignedInt i = 1; i <= 0xffff; ++i) {
        const auto format = CompressedPixelFormat(i);
        /* Each case verifies:
           - that the cases are ordered by number (so insertion here is done in
             proper place)
           - that there was no gap (unhandled value inside the range)
           - that a particular pixel format maps to a particular GL format
           - that a particular pixel type maps to a particular GL type */
        #ifdef __GNUC__
        #pragma GCC diagnostic push
        #pragma GCC diagnostic error "-Wswitch"
        #endif
        switch(format) {
            #define _c(format, width, height, depth, size) \
                case CompressedPixelFormat::format: \
                    CORRADE_COMPARE(nextHandled, i); \
                    CORRADE_COMPARE(firstUnhandled, 0xffff); \
                    CORRADE_COMPARE(Magnum::compressedBlockSize(CompressedPixelFormat::format), (Vector3i{width, height, depth})); \
                    CORRADE_COMPARE(compressedBlockDataSize(CompressedPixelFormat::format), size/8); \
                    CORRADE_COMPARE(size % 8, 0); \
                    CORRADE_COMPARE_AS(width, 16, TestSuite::Compare::LessOrEqual); \
                    CORRADE_COMPARE_AS(height, 16, TestSuite::Compare::LessOrEqual); \
                    CORRADE_COMPARE_AS(depth, 16, TestSuite::Compare::LessOrEqual); \
                    CORRADE_COMPARE_AS(size/8, 16, TestSuite::Compare::LessOrEqual); \
                    ++nextHandled; \
                    continue;
            #include "Magnum/Implementation/compressedPixelFormatMapping.hpp"
            #undef _c
        }
        #ifdef __GNUC__
        #pragma GCC diagnostic pop
        #endif

        /* Not handled by any value, remember -- we might either be at the end
           of the enum range (which is okay) or some value might be unhandled
           here */
        firstUnhandled = i;
    }

    CORRADE_COMPARE(firstUnhandled, 0xffff);
}

void PixelFormatTest::size() {
    CORRADE_COMPARE(pixelSize(PixelFormat::R8I), 1);
    CORRADE_COMPARE(pixelSize(PixelFormat::R16UI), 2);
    CORRADE_COMPARE(pixelSize(PixelFormat::RGB8Unorm), 3);
    CORRADE_COMPARE(pixelSize(PixelFormat::RGBA8Snorm), 4);
    CORRADE_COMPARE(pixelSize(PixelFormat::RGB16I), 6);
    CORRADE_COMPARE(pixelSize(PixelFormat::RGBA16F), 8);
    CORRADE_COMPARE(pixelSize(PixelFormat::RGB32UI), 12);
    CORRADE_COMPARE(pixelSize(PixelFormat::RGBA32F), 16);
}

void PixelFormatTest::sizeInvalid() {
    std::ostringstream out;
    Error redirectError{&out};

    pixelSize(PixelFormat{});
    pixelSize(PixelFormat(0xdead));

    CORRADE_COMPARE(out.str(),
        "pixelSize(): invalid format PixelFormat(0x0)\n"
        "pixelSize(): invalid format PixelFormat(0xdead)\n");
}

void PixelFormatTest::sizeImplementationSpecific() {
    std::ostringstream out;
    Error redirectError{&out};

    pixelSize(pixelFormatWrap(0xdead));

    CORRADE_COMPARE(out.str(), "pixelSize(): can't determine size of an implementation-specific format\n");
}

void PixelFormatTest::compressedBlockSize() {
    CORRADE_COMPARE(Magnum::compressedBlockSize(CompressedPixelFormat::Etc2RGB8A1Srgb), (Vector3i{4, 4, 1}));
    CORRADE_COMPARE(compressedBlockDataSize(CompressedPixelFormat::Etc2RGB8A1Srgb), 8);
    CORRADE_COMPARE(Magnum::compressedBlockSize(CompressedPixelFormat::Astc5x4RGBAUnorm), (Vector3i{5, 4, 1}));
    CORRADE_COMPARE(compressedBlockDataSize(CompressedPixelFormat::Astc5x4RGBAUnorm), 16);
    CORRADE_COMPARE(Magnum::compressedBlockSize(CompressedPixelFormat::Astc12x10RGBAUnorm), (Vector3i{12, 10, 1}));
    CORRADE_COMPARE(compressedBlockDataSize(CompressedPixelFormat::Astc12x10RGBAUnorm), 16);
    CORRADE_COMPARE(Magnum::compressedBlockSize(CompressedPixelFormat::PvrtcRGBA2bppUnorm), (Vector3i{8, 4, 1}));
    CORRADE_COMPARE(compressedBlockDataSize(CompressedPixelFormat::PvrtcRGBA2bppUnorm), 8);

    /* The rest tested in compressedMapping() */
}

void PixelFormatTest::compressedBlockSizeInvalid() {
    std::ostringstream out;
    Error redirectError{&out};

    Magnum::compressedBlockSize(CompressedPixelFormat{});
    Magnum::compressedBlockSize(CompressedPixelFormat(0xdead));
    compressedBlockDataSize(CompressedPixelFormat{});
    compressedBlockDataSize(CompressedPixelFormat(0xdead));

    CORRADE_COMPARE(out.str(),
        "compressedBlockSize(): invalid format CompressedPixelFormat(0x0)\n"
        "compressedBlockSize(): invalid format CompressedPixelFormat(0xdead)\n"
        "compressedBlockDataSize(): invalid format CompressedPixelFormat(0x0)\n"
        "compressedBlockDataSize(): invalid format CompressedPixelFormat(0xdead)\n");
}

void PixelFormatTest::compressedBlockSizeImplementationSpecific() {
    std::ostringstream out;
    Error redirectError{&out};

    Magnum::compressedBlockSize(compressedPixelFormatWrap(0xdead));
    compressedBlockDataSize(compressedPixelFormatWrap(0xdead));

    CORRADE_COMPARE(out.str(),
        "compressedBlockSize(): can't determine size of an implementation-specific format\n"
        "compressedBlockDataSize(): can't determine size of an implementation-specific format\n");
}

void PixelFormatTest::isImplementationSpecific() {
    constexpr bool a = isPixelFormatImplementationSpecific(PixelFormat::RGBA8Unorm);
    constexpr bool b = isPixelFormatImplementationSpecific(PixelFormat(0x8000dead));
    CORRADE_VERIFY(!a);
    CORRADE_VERIFY(b);
}

void PixelFormatTest::wrap() {
    constexpr PixelFormat a = pixelFormatWrap(0xdead);
    CORRADE_COMPARE(UnsignedInt(a), 0x8000dead);
}

void PixelFormatTest::wrapInvalid() {
    std::ostringstream out;
    Error redirectError{&out};

    pixelFormatWrap(0xdeadbeef);

    CORRADE_COMPARE(out.str(), "pixelFormatWrap(): implementation-specific value already wrapped or too large\n");
}

void PixelFormatTest::unwrap() {
    constexpr UnsignedInt a = pixelFormatUnwrap(PixelFormat(0x8000dead));
    CORRADE_COMPARE(a, 0xdead);
}

void PixelFormatTest::unwrapInvalid() {
    std::ostringstream out;
    Error redirectError{&out};

    pixelFormatUnwrap(PixelFormat(0xdead));

    CORRADE_COMPARE(out.str(), "pixelFormatUnwrap(): format doesn't contain a wrapped implementation-specific value\n");
}

void PixelFormatTest::compressedIsImplementationSpecific() {
    CORRADE_VERIFY(!isPixelFormatImplementationSpecific(PixelFormat::RGBA8Unorm));
    CORRADE_VERIFY(isPixelFormatImplementationSpecific(pixelFormatWrap(0xdead)));
}

void PixelFormatTest::compressedWrap() {
    CORRADE_COMPARE(UnsignedInt(pixelFormatWrap(0xdead)), 0x8000dead);
}

void PixelFormatTest::compressedWrapInvalid() {
    std::ostringstream out;
    Error redirectError{&out};

    compressedPixelFormatWrap(0xdeadbeef);

    CORRADE_COMPARE(out.str(), "compressedPixelFormatWrap(): implementation-specific value already wrapped or too large\n");
}

void PixelFormatTest::compressedUnwrap() {
    CORRADE_COMPARE(UnsignedInt(compressedPixelFormatUnwrap(CompressedPixelFormat(0x8000dead))), 0xdead);
}

void PixelFormatTest::compressedUnwrapInvalid() {
    std::ostringstream out;
    Error redirectError{&out};

    compressedPixelFormatUnwrap(CompressedPixelFormat(0xdead));

    CORRADE_COMPARE(out.str(), "compressedPixelFormatUnwrap(): format doesn't contain a wrapped implementation-specific value\n");
}

void PixelFormatTest::debug() {
    std::ostringstream out;
    Debug{&out} << PixelFormat::RG16Snorm << PixelFormat(0xdead);

    CORRADE_COMPARE(out.str(), "PixelFormat::RG16Snorm PixelFormat(0xdead)\n");
}

void PixelFormatTest::debugImplementationSpecific() {
    std::ostringstream out;
    Debug{&out} << pixelFormatWrap(0xdead);

    CORRADE_COMPARE(out.str(), "PixelFormat::ImplementationSpecific(0xdead)\n");
}

void PixelFormatTest::compressedDebug() {
    std::ostringstream out;
    Debug{&out} << CompressedPixelFormat::Bc3RGBAUnorm << CompressedPixelFormat(0xdead);

    CORRADE_COMPARE(out.str(), "CompressedPixelFormat::Bc3RGBAUnorm CompressedPixelFormat(0xdead)\n");
}

void PixelFormatTest::compressedDebugImplementationSpecific() {
    std::ostringstream out;
    Debug{&out} << compressedPixelFormatWrap(0xdead);

    CORRADE_COMPARE(out.str(), "CompressedPixelFormat::ImplementationSpecific(0xdead)\n");
}

void PixelFormatTest::configuration() {
    Utility::Configuration c;

    c.setValue("format", PixelFormat::RGB8Srgb);
    CORRADE_COMPARE(c.value("format"), "RGB8Srgb");
    CORRADE_COMPARE(c.value<PixelFormat>("format"), PixelFormat::RGB8Srgb);

    c.setValue("zero", PixelFormat(0));
    CORRADE_COMPARE(c.value("zero"), "");
    CORRADE_COMPARE(c.value<PixelFormat>("zero"), PixelFormat{});

    c.setValue("invalid", PixelFormat(0xdead));
    CORRADE_COMPARE(c.value("invalid"), "");
    CORRADE_COMPARE(c.value<PixelFormat>("invalid"), PixelFormat{});
}

void PixelFormatTest::compresedConfiguration() {
    Utility::Configuration c;

    c.setValue("format", CompressedPixelFormat::Astc3x3x3RGBASrgb);
    CORRADE_COMPARE(c.value("format"), "Astc3x3x3RGBASrgb");
    CORRADE_COMPARE(c.value<CompressedPixelFormat>("format"), CompressedPixelFormat::Astc3x3x3RGBASrgb);

    c.setValue("zero", CompressedPixelFormat(0));
    CORRADE_COMPARE(c.value("zero"), "");
    CORRADE_COMPARE(c.value<CompressedPixelFormat>("zero"), CompressedPixelFormat{});

    c.setValue("invalid", CompressedPixelFormat(0xdead));
    CORRADE_COMPARE(c.value("invalid"), "");
    CORRADE_COMPARE(c.value<CompressedPixelFormat>("invalid"), CompressedPixelFormat{});
}

}}}

CORRADE_TEST_MAIN(Magnum::Test::PixelFormatTest)