LoadableType.h

Go to the documentation of this file.

/*********************************************************\
 *  File: LoadableType.h                                 *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight 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 PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLCORE_LOADABLETYPE_H__
#define __PLCORE_LOADABLETYPE_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLCore/String/String.h"
#include "PLCore/Container/Array.h"
#include "PLCore/Container/HashMap.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLCore {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class File;
class Class;
class Loader;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Class describing a loadable type
*
*  @remarks
*    This is used for managing search paths and loadable formats for a loadable type.
*/
class LoadableType {


    //[-------------------------------------------------------]
    //[ Friends                                               ]
    //[-------------------------------------------------------]
    friend class LoadableManager;


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Returns the name of the loadable type
        *
        *  @return
        *    Name of the loadable type
        */
        inline String GetName() const;

        /**
        *  @brief
        *    Returns the class of the loadable type
        *
        *  @return
        *    Class of the loadable type
        */
        inline const Class &GetClass() const;

        /**
        *  @brief
        *    Gets the relative version of an absolute file path
        *
        *  @param[in] sPath
        *    Absolute file path to get the relative version from
        *
        *  @return
        *    Relative file path, empty string on error
        *
        *  @note
        *    - The function will take the FS base directories into account, the first match
        *      will be used
        *    - MS Windows example: 'C:\test\test.bmp' -> 'test.bmp'
        */
        PLCORE_API String GetRelativeFilePath(const String &sPath) const;

        //[-------------------------------------------------------]
        //[ Formats & loaders                                     ]
        //[-------------------------------------------------------]
        /**
        *  @brief
        *    Returns the number of supported formats
        *
        *  @return
        *    The number of supported formats
        */
        inline uint32 GetNumOfFormats() const;

        /**
        *  @brief
        *    Returns a supported formats
        *
        *  @param[in] nIndex
        *    Format index
        *
        *  @return
        *    The requested supported format, empty string on error
        */
        inline String GetFormat(uint32 nIndex) const;

        /**
        *  @brief
        *    Returns the number of loaders
        *
        *  @return
        *    The number of loaders
        */
        inline uint32 GetNumOfLoaders() const;

        /**
        *  @brief
        *    Returns a loader by using an index
        *
        *  @param[in] nIndex
        *    Loader index
        *
        *  @return
        *    The requested loader, a null pointer on error
        */
        inline Loader *GetLoaderByIndex(uint32 nIndex) const;

        /**
        *  @brief
        *    Returns a loader by using a loadable extension
        *
        *  @param[in] sExtension
        *    Extension of loader
        *
        *  @return
        *    The requested loader (first found if there are multiple candidates), a null pointer on error (format is not supported)
        */
        inline Loader *GetLoaderByExtension(const String &sExtension) const;

        /**
        *  @brief
        *    Returns loaders by using a loadable extension
        *
        *  @param[in]  sExtension
        *    Extension of loadable
        *  @param[out] lstLoaders
        *    Receives the list of matching loaders (list is not cleared before new entries are added), there can be multiple candidates
        */
        PLCORE_API void GetLoadersByExtension(const String &sExtension, Array<Loader*> &lstLoaders);

        /**
        *  @brief
        *    Returns a loader for loading by using a loadable file
        *
        *  @param[in] cFile
        *    File to load from, must be opened and readable
        *
        *  @return
        *    The requested loader (first found if there are multiple candidates), a null pointer on error (format is not supported)
        */
        PLCORE_API Loader *GetLoaderForLoadingByFile(File &cFile) const;


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Default constructor
        */
        LoadableType();

        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] sName
        *    Name of the loadable type
        *  @param[in] cClass
        *    Class the loadable type
        */
        LoadableType(const String &sName, const Class &cClass);

        /**
        *  @brief
        *    Destructor
        */
        ~LoadableType();

        /**
        *  @brief
        *    Copy operator
        *
        *  @param[in] cSource
        *    Source to copy from
        *
        *  @return
        *    Reference to this instance
        */
        LoadableType &operator =(const LoadableType &cSource);

        /**
        *  @brief
        *    Adds a loader to this loadable type
        *
        *  @param[in] cLoader
        *    Loader to add, this loadable type takes over the memory control
        */
        void AddLoader(Loader &cLoader);

        /**
        *  @brief
        *    Removes a loader from this loadable type
        *
        *  @param[in] cLoader
        *    Loader to remove, when all went fine then the given reference is no longer valid after this method was successfully called
        *
        *  @return
        *    'true' if all went fine, else 'false'
        */
        bool RemoveLoader(Loader &cLoader);


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        String                       m_sName;       /**< Name of the loadable type */
        const Class                 *m_pClass;      /**< Class the loadable type, always valid! */
        Array<Loader*>               m_lstLoaders;  /**< List of loaders */
        HashMap<String, Loader*>     m_mapLoaders;  /**< Map of loaders (key = extension) */
        Array<String>                m_lstFormats;  /**< List of loadable formats */


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLCore


//[-------------------------------------------------------]
//[ Implementation                                        ]
//[-------------------------------------------------------]
#include "PLCore/Tools/LoadableType.inl"


#endif // __PLCORE_LOADABLETYPE_H__