memoryMap.h

/* Copyright (c) 2009-2017, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef LUNCHBOX_MEMORYMAP_H
#define LUNCHBOX_MEMORYMAP_H

#include <boost/noncopyable.hpp>
#include <iostream>
#include <lunchbox/api.h>
#include <string>

namespace lunchbox
{
namespace detail
{
class MemoryMap;
}

class MemoryMap : public boost::noncopyable
{
public:
    LUNCHBOX_API MemoryMap();

    LUNCHBOX_API explicit MemoryMap(const std::string& filename);

    LUNCHBOX_API MemoryMap(const std::string& filename, const size_t size);

    LUNCHBOX_API ~MemoryMap();

    LUNCHBOX_API const void* map(const std::string& filename);

    LUNCHBOX_API const void* remap(const std::string& filename);

    LUNCHBOX_API void* create(const std::string& filename, const size_t size);

    LUNCHBOX_API void* recreate(const std::string& filename, size_t size);

    LUNCHBOX_API void* resize(size_t size);

    LUNCHBOX_API void unmap();

    LUNCHBOX_API const void* getAddress() const;

    LUNCHBOX_API void* getAddress();

    template <class T>
    const T* getAddress() const
    {
        return static_cast<const T*>(getAddress());
    }

    template <class T>
    T* getAddress()
    {
        return static_cast<T*>(getAddress());
    }

    template <class T>
    T& get(const size_t i)
    {
        return getAddress<T>()[i];
    }

    template <class T>
    const T& get(const size_t i) const
    {
        return getAddress<T>()[i];
    }

    LUNCHBOX_API size_t getSize() const;

private:
    detail::MemoryMap* const impl_;
};

inline std::ostream& operator<<(std::ostream& os, const MemoryMap& m)
{
    return os << "MemoryMap at " << m.getAddress() << " size " << m.getSize();
}
}

#endif // LUNCHBOX_MEMORYMAP_H