/**
 * \file dll_directory.h
 * \brief CDllDirectory
 * \date 2012-08-18 09:01GMT
 * \author Jan Boon (Kaetemi)
 * CDllDirectory
 */

/*
 * Copyright (C) 2012  by authors
 *
 * This file is part of RYZOM CORE PIPELINE.
 * RYZOM CORE PIPELINE is free software: you can redistribute it
 * and/or modify it under the terms of the GNU Affero General Public
 * License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 *
 * RYZOM CORE PIPELINE 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with RYZOM CORE PIPELINE.  If not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef PIPELINE_DLL_DIRECTORY_H
#define PIPELINE_DLL_DIRECTORY_H
#include <nel/misc/types_nl.h>

// STL includes

// NeL includes

// Project includes
#include "storage_object.h"
#include "storage_value.h"
#include "dll_plugin_desc.h"

namespace PIPELINE {
namespace MAX {

/**
 * \brief CDllEntry
 * \date 2012-08-18 09:01GMT
 * \author Jan Boon (Kaetemi)
 * CDllEntry
 */
class CDllEntry : public CStorageContainer
{
public:
	CDllEntry();
	CDllEntry(const IDllPluginDescInternal *dllPluginDesc);
	virtual ~CDllEntry();

	// inherited
	virtual std::string className() const;
	virtual void toString(std::ostream &ostream, const std::string &pad = "") const;
	virtual void parse(uint16 version, uint filter = 0);
	virtual void clean();
	virtual void build(uint16 version, uint filter = 0);
	virtual void disown();

	// read access
	const ucstring &dllDescription() const { return m_DllDescription->Value; }
	const ucstring &dllFilename() const { return m_DllFilename->Value; }

	// debug
	void overrideDllFilename(const ucstring &dllFilename) { m_DllFilename->Value = dllFilename; }

protected:
	virtual IStorageObject *createChunkById(uint16 id, bool container);
	CStorageValue<ucstring> *m_DllDescription;
	CStorageValue<ucstring> *m_DllFilename;

}; /* class CDllDirectory */

/**
 * \brief CDllDirectory
 * \date 2012-08-18 09:01GMT
 * \author Jan Boon (Kaetemi)
 * This class is used for parsing the local dll indices in a max file,
 * both reading and writing is supported. It is not used at runtime,
 * and should be reset when no longer necessary. Plugins have their own
 * copy of the actual IDllPluginDescInternal. This class only contains
 * CDllEntry instances, which should not be used directly. The instance
 * of this class used to parse the max file should be kept, as there
 * might be chunks that were not parsed, which should be rewritten to
 * the stream.
 */
class CDllDirectory : public CStorageContainer
{
public:
	CDllDirectory();
	virtual ~CDllDirectory();

	// inherited
	virtual std::string className() const;
	virtual void toString(std::ostream &ostream, const std::string &pad = "") const;
	virtual void parse(uint16 version, uint filter = 0);
	virtual void clean();
	virtual void build(uint16 version, uint filter = 0);
	virtual void disown();

	// public
	// Get a dll entry corresponding to a chunk index, pointers become invalid after reset
	const CDllEntry *get(sint32 index) const;
	// Reset the dll directory, all dll entry pointers become invalid, use internal name and dll plugin registry
	void reset();
	// Get or create the chunk index for a dll by dll plugin description
	sint32 getOrCreateIndex(const IDllPluginDescInternal *dllPluginDesc);

private:
	void addInternalIndices();

protected:
	virtual IStorageObject *createChunkById(uint16 id, bool container);

private:
	TStorageObjectContainer m_ChunkCache;
	std::vector<CDllEntry *> m_Entries;
	std::map<ucstring, sint32> m_InternalNameToIndex;

	const CDllEntry m_DllEntryBuiltin;
	const CDllEntry m_DllEntryScript;

}; /* class CDllDirectory */

} /* namespace MAX */
} /* namespace PIPELINE */

#endif /* #ifndef PIPELINE_DLL_DIRECTORY_H */

/* end of file */