crown-engine/engine/resource/PackageResource.h

/*
Copyright (c) 2013 Daniele Bartolini, Michele Rossi
Copyright (c) 2012 Daniele Bartolini, Simone Boscaratto

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

#pragma once

#include "Types.h"
#include "Resource.h"
#include "Bundle.h"
#include "Allocator.h"
#include "File.h"

namespace crown
{

// All offsets are absolute
struct PackageHeader
{
	uint32_t num_textures;
	uint32_t textures_offset;
	uint32_t num_scripts;
	uint32_t scripts_offset;
	uint32_t num_sounds;
	uint32_t sounds_offset;
	uint32_t num_meshes;
	uint32_t meshes_offset;
	uint32_t num_units;
	uint32_t units_offset;
	uint32_t num_sprites;
	uint32_t sprites_offset;
	uint32_t num_physics;
	uint32_t physics_offset;
	uint32_t num_materials;
	uint32_t materials_offset;
	uint32_t num_guis;
	uint32_t guis_offset;
};

struct PackageResource
{
	//-----------------------------------------------------------------------------
	static void* load(Allocator& allocator, Bundle& bundle, ResourceId id)
	{
		File* file = bundle.open(id);
		const size_t file_size = file->size();

		void* res = allocator.allocate(file_size);
		file->read(res, file_size);

		bundle.close(file);

		return res;
	}

	//-----------------------------------------------------------------------------
	static void online(void* /*resource*/)
	{
	}

	//-----------------------------------------------------------------------------
	static void unload(Allocator& allocator, void* resource)
	{
		CE_ASSERT_NOT_NULL(resource);
		allocator.deallocate(resource);
	}

	//-----------------------------------------------------------------------------
	static void offline(void* /*resource*/)
	{
	}

	//-----------------------------------------------------------------------------
	uint32_t num_textures() const
	{
		return ((PackageHeader*) this)->num_textures;
	}

	//-----------------------------------------------------------------------------
	uint32_t num_scripts() const
	{
		return ((PackageHeader*) this)->num_scripts;
	}

	//-----------------------------------------------------------------------------
	uint32_t num_sounds() const
	{
		return ((PackageHeader*) this)->num_sounds;
	}

	//-----------------------------------------------------------------------------
	uint32_t num_meshes() const
	{
		return ((PackageHeader*) this)->num_meshes;
	}

	//-----------------------------------------------------------------------------
	uint32_t num_units() const
	{
		return ((PackageHeader*) this)->num_units;
	}

	//-----------------------------------------------------------------------------
	uint32_t num_sprites() const
	{
		return ((PackageHeader*) this)->num_sprites;
	}

	//-----------------------------------------------------------------------------
	uint32_t num_physics() const
	{
		return ((PackageHeader*) this)->num_physics;
	}

	//-----------------------------------------------------------------------------
	uint32_t num_materials() const
	{
		return ((PackageHeader*) this)->num_materials;
	}

	//-----------------------------------------------------------------------------
	uint32_t num_guis() const
	{
		return ((PackageHeader*) this)->num_guis;
	}

	//-----------------------------------------------------------------------------
	ResourceId get_texture_id(uint32_t i) const
	{
		CE_ASSERT(i < num_textures(), "Index out of bounds");

		ResourceId* begin = (ResourceId*) ((char*) this + ((PackageHeader*) this)->textures_offset);
		return begin[i];
	}

	//-----------------------------------------------------------------------------
	ResourceId get_script_id(uint32_t i) const
	{
		CE_ASSERT(i < num_scripts(), "Index out of bounds");

		ResourceId* begin = (ResourceId*) ((char*) this + ((PackageHeader*) this)->scripts_offset);
		return begin[i];
	}

	//-----------------------------------------------------------------------------
	ResourceId get_sound_id(uint32_t i) const
	{
		CE_ASSERT(i < num_sounds(), "Index out of bounds");

		ResourceId* begin = (ResourceId*) ((char*) this + ((PackageHeader*) this)->sounds_offset);
		return begin[i];
	}

	//-----------------------------------------------------------------------------
	ResourceId get_mesh_id(uint32_t i) const
	{
		CE_ASSERT(i < num_meshes(), "Index out of bounds");

		ResourceId* begin = (ResourceId*) ((char*) this + ((PackageHeader*) this)->meshes_offset);
		return begin[i];
	}

	//-----------------------------------------------------------------------------
	ResourceId get_unit_id(uint32_t i) const
	{
		CE_ASSERT(i < num_units(), "Index out of bounds");

		ResourceId* begin = (ResourceId*) ((char*) this + ((PackageHeader*) this)->units_offset);
		return begin[i];
	}

	//-----------------------------------------------------------------------------
	ResourceId get_sprite_id(uint32_t i) const
	{
		CE_ASSERT(i < num_sprites(), "Index out of bounds");

		ResourceId* begin = (ResourceId*) ((char*) this + ((PackageHeader*) this)->sprites_offset);
		return begin[i];
	}

	//-----------------------------------------------------------------------------
	ResourceId get_physics_id(uint32_t i) const
	{
		CE_ASSERT(i < num_physics(), "Index out of bounds");

		ResourceId* begin = (ResourceId*) ((char*) this + ((PackageHeader*) this)->physics_offset);
		return begin[i];
	}

	//-----------------------------------------------------------------------------
	ResourceId get_material_id(uint32_t i) const
	{
		CE_ASSERT(i < num_materials(), "Index out of bounds");

		ResourceId* begin = (ResourceId*) ((char*) this + ((PackageHeader*) this)->materials_offset);
		return begin[i];
	}

	//-----------------------------------------------------------------------------
	ResourceId get_gui_id(uint32_t i) const
	{
		CE_ASSERT(i < num_guis(), "Index out of bounds");

		ResourceId* begin = (ResourceId*) ((char*) this + ((PackageHeader*) this)->guis_offset);
		return begin[i];
	}


private:

	// Disable construction
	PackageResource();
};

} // namespace crown