Array.h

#pragma once

/* <editor-fold desc="MIT License">

Copyright(c) 2018 Robert Osfield

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.

</editor-fold> */

#include <vsg/core/Data.h>

#include <vsg/maths/mat4.h>
#include <vsg/maths/vec2.h>
#include <vsg/maths/vec3.h>
#include <vsg/maths/vec4.h>

#include <vsg/io/Input.h>
#include <vsg/io/Output.h>

#define VSG_array(N, T) \
    using N = Array<T>; \
    template<>          \
    constexpr const char* type_name<N>() noexcept { return "vsg::" #N; }

namespace vsg
{
    template<typename T>
    class Array : public Data
    {
    public:
        using value_type = T;
        using iterator = value_type*;
        using const_iterator = const value_type*;

        Array() :
            _size(0),
            _data(nullptr) {}
        Array(std::uint32_t numElements, value_type* data) :
            _size(numElements),
            _data(data) {}
        Array(std::uint32_t numElements, value_type* data, Layout layout) :
            Data(layout),
            _size(numElements),
            _data(data) {}
        explicit Array(std::initializer_list<value_type> l) :
            _size(static_cast<std::uint32_t>(l.size())),
            _data(new value_type[l.size()])
        {
            value_type* ptr = _data;
            for (value_type const& v : l) { (*ptr++) = v; }
        }
        explicit Array(std::uint32_t numElements) :
            _size(numElements),
            _data(new value_type[numElements]) {}

        template<typename... Args>
        static ref_ptr<Array> create(Args... args)
        {
            return ref_ptr<Array>(new Array(args...));
        }

        static ref_ptr<Array> create(std::initializer_list<value_type> l)
        {
            return ref_ptr<Array>(new Array(l));
        }

        std::size_t sizeofObject() const noexcept override { return sizeof(Array); }

        // implementation provided by Visitor.h
        void accept(Visitor& visitor) override;
        void accept(ConstVisitor& visitor) const override;

        const char* className() const noexcept override { return type_name<Array>(); }

        void read(Input& input) override
        {
            std::size_t original_total_size = size();

            Data::read(input);
            std::uint32_t width_size = input.readValue<std::uint32_t>("Size");
            std::size_t new_total_size = computeValueCountIncludingMipmaps(width_size, 1, 1, _layout.maxNumMipmaps);

            if (input.matchPropertyName("Data"))
            {
                if (_data) // if data already may be able to reuse it
                {
                    if (original_total_size != new_total_size) // if existing data is a different size delete old, and create new
                    {
                        delete[] _data;
                        _data = new value_type[new_total_size];
                    }
                }
                else // allocate space for data
                {
                    _data = new value_type[new_total_size];
                }

                _size = width_size;

                input.read(new_total_size, _data);
            }
        }

        void write(Output& output) const override
        {
            Data::write(output);
            output.writeValue<std::uint32_t>("Size", _size);

            output.writePropertyName("Data");
            output.write(size(), _data);
            output.writeEndOfLine();
        }

        std::size_t size() const { return (_layout.maxNumMipmaps <= 1) ? _size : computeValueCountIncludingMipmaps(_size, 1, 1, _layout.maxNumMipmaps); }

        bool empty() const { return _size == 0; }

        // should Array be fixed size?
        void clear()
        {
            _size = 0;
            if (_data) { delete[] _data; }
            _data = nullptr;
        }

        void assign(std::uint32_t numElements, value_type* data, Layout layout = Layout())
        {
            if (_data != nullptr) delete[] _data;

            _layout = layout;
            _size = numElements;
            _data = data;
        }

        // release the data so that ownership can be passed on, the local data pointer and size is set to 0 and destruction of Array will no result in the data being deleted.
        void* dataRelease() override
        {
            void* tmp = _data;
            _data = nullptr;
            _size = 0;
            return tmp;
        }

        std::size_t valueSize() const override { return sizeof(value_type); }
        std::size_t valueCount() const override { return size(); }

        std::size_t dataSize() const override { return size() * sizeof(value_type); }

        void* dataPointer() override { return _data; }
        const void* dataPointer() const override { return _data; }

        void* dataPointer(std::size_t i) override { return _data + i; }
        const void* dataPointer(std::size_t i) const override { return _data + i; }

        std::uint32_t dimensions() const override { return 1; }

        std::uint32_t width() const override { return _size; }
        std::uint32_t height() const override { return 1; }
        std::uint32_t depth() const override { return 1; }

        value_type* data() { return _data; }
        const value_type* data() const { return _data; }

        value_type& operator[](std::size_t i) { return _data[i]; }
        const value_type& operator[](std::size_t i) const { return _data[i]; }

        value_type& at(std::size_t i) { return _data[i]; }
        const value_type& at(std::size_t i) const { return _data[i]; }

        void set(std::size_t i, const value_type& v) { _data[i] = v; }

        iterator begin() { return _data; }
        const_iterator begin() const { return _data; }

        iterator end() { return _data + _size; }
        const_iterator end() const { return _data + _size; }

    protected:
        virtual ~Array()
        {
            if (_data) delete[] _data;
        }

    private:
        std::uint32_t _size;
        value_type* _data;
    };

    VSG_array(ubyteArray, std::uint8_t);
    VSG_array(ushortArray, std::uint16_t);
    VSG_array(uintArray, std::uint32_t);
    VSG_array(floatArray, float);
    VSG_array(doubleArray, double);

    VSG_array(vec2Array, vec2);
    VSG_array(vec3Array, vec3);
    VSG_array(vec4Array, vec4);

    VSG_array(dvec2Array, dvec2);
    VSG_array(dvec3Array, dvec3);
    VSG_array(dvec4Array, dvec4);

    VSG_array(ubvec2Array, ubvec2);
    VSG_array(ubvec3Array, ubvec3);
    VSG_array(ubvec4Array, ubvec4);

    VSG_array(usvec2Array, usvec2);
    VSG_array(usvec3Array, usvec3);
    VSG_array(usvec4Array, usvec4);

    VSG_array(uivec2Array, uivec2);
    VSG_array(uivec3Array, uivec3);
    VSG_array(uivec4Array, uivec4);

    VSG_array(mat4Array, mat4);
    VSG_array(dmat4Array, dmat4);

    VSG_array(block64Array, block64);
    VSG_array(block128Array, block128);

} // namespace vsg