Scheme.h

/***********************************************************************
        filename:       CEGUIScheme.h
        created:        21/2/2004
        author:         Paul D Turner
        
        purpose:        Defines abstract base class for the GUI Scheme object.
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   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 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.
 ***************************************************************************/
#ifndef _CEGUIScheme_h_
#define _CEGUIScheme_h_

#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include "CEGUI/SchemeManager.h"


#include <vector>


#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT Scheme :
    public AllocatedObject<Scheme>
{
private:
    friend class Scheme_xmlHandler;
    
    /*************************************************************************
        Construction and Destruction
    *************************************************************************/
    Scheme(const String& name);
    
public:
    ~Scheme(void);
    
        void    loadResources(void);


        void    unloadResources(void);


        bool    resourcesLoaded(void) const;


        const String& getName(void) const               {return d_name;}

    static const String& getDefaultResourceGroup()
        { return d_defaultResourceGroup; }

    static void setDefaultResourceGroup(const String& resourceGroup)
        { d_defaultResourceGroup = resourceGroup; }

    void loadXMLImagesets();

    void loadImageFileImagesets();

    void loadFonts();

    void loadLookNFeels();

    void loadWindowFactories();

    void loadWindowRendererFactories();

    void loadFactoryAliases();

    void loadFalagardMappings();

    void unloadXMLImagesets();

    void unloadImageFileImagesets();

    void unloadFonts();

    void unloadLookNFeels();

    void unloadWindowFactories();

    void unloadWindowRendererFactories();

    void unloadFactoryAliases();

    void unloadFalagardMappings();

    bool areXMLImagesetsLoaded() const;

    bool areImageFileImagesetsLoaded() const;

    bool areFontsLoaded() const;

    bool areLookNFeelsLoaded() const;

    bool areWindowFactoriesLoaded() const;

    bool areWindowRendererFactoriesLoaded() const;

    bool areFactoryAliasesLoaded() const;

    bool areFalagardMappingsLoaded() const;
    
    struct LoadableUIElement
    {
        String  name;
        String  filename;
        String  resourceGroup;
    };
    
private:
    typedef std::vector<LoadableUIElement
        CEGUI_VECTOR_ALLOC(LoadableUIElement)>      LoadableUIElementList;

public:    
    typedef ConstVectorIterator<LoadableUIElementList> LoadableUIElementIterator;
    
    LoadableUIElementIterator getXMLImagesets() const;
    
    LoadableUIElementIterator getImageFileImagesets() const;
    
    LoadableUIElementIterator getFonts() const;
    
    LoadableUIElementIterator getLookNFeels() const;

private:
        /*************************************************************************
                Structs used to hold scheme information
        *************************************************************************/

    struct UIModule
    {
        String name;
        DynamicModule* dynamicModule;
        FactoryModule* factoryModule;

        typedef std::vector<String
            CEGUI_VECTOR_ALLOC(String)> TypeList;

        TypeList types;
    };

        struct AliasMapping
        {
                String aliasName;
                String targetName;
        };

    struct FalagardMapping
    {
        String windowName;
        String targetName;
        String rendererName;
        String lookName;
        String effectName;
    };

        /*************************************************************************
                Implementation Data
        *************************************************************************/
        String  d_name;                 

        LoadableUIElementList                                   d_imagesets;
        LoadableUIElementList                                   d_imagesetsFromImages;
        LoadableUIElementList                                   d_fonts;
    
    typedef std::vector<UIModule
        CEGUI_VECTOR_ALLOC(UIModule)>               UIModuleList;
        UIModuleList                                                    d_widgetModules;
    
    typedef std::vector<UIModule
        CEGUI_VECTOR_ALLOC(UIModule)>               WRModuleList;
    WRModuleList                                    d_windowRendererModules;

        typedef std::vector<AliasMapping
        CEGUI_VECTOR_ALLOC(AliasMapping)>                       AliasMappingList;
    AliasMappingList                                d_aliasMappings;

    LoadableUIElementList                               d_looknfeels;

    typedef std::vector<FalagardMapping
        CEGUI_VECTOR_ALLOC(FalagardMapping)>        FalagardMappingList;
    FalagardMappingList                             d_falagardMappings;

    static String d_defaultResourceGroup;   
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUIScheme_h_