CompositeResourceProvider i need comment

Discussion regarding the development of CEGUI itself - as opposed to questions about CEGUI usage that should be in the help forums.

Moderators: CEGUI MVP, CEGUI Team

Hanmac
Just popping in
Just popping in
Posts: 7
Joined: Thu Jul 07, 2011 19:45

CompositeResourceProvider i need comment

Postby Hanmac » Thu Jul 14, 2011 14:56

CEGUICompositeResourceProvider.h

Code: Select all

/*******************************************************************************
Filename: CEGUICompositeResourceProvider.h
Created:  14.07.2011
Author:   Hans Mackowiak (Hanmac) hanmac@gmx.de
purpose:  Defines abstract base class for CEGUIData objects
*******************************************************************************/
/***************************************************************************
 Copyright (C) 2004 - 2011 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 _CEGUICompositeResourceProvider_h_
#define _CEGUICompositeResourceProvider_h_
#include "CEGUIBase.h"
#include "CEGUIResourceProvider.h"
#include <map>

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

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT CompositeResourceProvider : public ResourceProvider
{
public:
  /*************************************************************************
    Construction and Destruction
  *************************************************************************/
  CompositeResourceProvider();
  ~CompositeResourceProvider(void);
  /*!
      \brief
          adds a ResourceProvider

      \param prov
          A pointer to an ResourceProvider (ownership is taken).

      \param name
          A String thats names the provider inside this holder.

      \return
          Nothing.
      */
  void add(ResourceProvider *prov,const String& name);
  /*!
      \brief
          creates and add a ResourceProvider

      \param name
          A String thats names the provider inside this holder.

      \return
          Nothing.
      */
  template<typename T>void add(const String& name)
  {
    add(CEGUI_NEW T,name);
  }
  /*!
      \brief
          removes a ResourceProvider

      \param prov
          A pointer to an ResourceProvider.

      \return
          Nothing.
      */
  void remove(ResourceProvider *prov);
  /*!
      \brief
          removes a ResourceProvider

      \param name
          A String thats names the provider inside this holder.

      \return
          Nothing.
      */
  void remove(const String& name);
  /*!
      \brief
         get a ResourceProvider

      \param name
          A String thats names the provider inside this holder.

      \return
          ResourceProvider Pointer.
      */     
  *ResourceProvider get(const String& name);

  void loadRawDataContainer(const String& filename,
        RawDataContainer& output,
        const String& resourceGroup);
  size_t getResourceGroupFileNames(std::vector<String>& out_vec,
         const String& file_pattern,
         const String& resource_group);
protected:
  typedef std::map<String, *ResourceProvider, StringFastLessCompare> Providermap;
  Providermap  d_providerlist;
public:
  typedef ConstMapIterator<Providermap> ProviderIterator;
  ProviderIterator  getIterator() const;
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUICompositeResourceProvider_h_

CEGUICompositeResourceProvider.cpp

Code: Select all

/***********************************************************************
  filename:   CEGUICompositeResourceProvider.cpp
  created:  14.07.2011
  Author:   Hans Mackowiak (Hanmac) hanmac@gmx.de
*************************************************************************/
/***************************************************************************
*   Copyright (C) 2004 - 2011 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.
***************************************************************************/
#include "CEGUICompositeResourceProvider.h"
#include "CEGUIExceptions.h"

// Start of CEGUI namespace section
namespace CEGUI
{
CompositeResourceProvider::CompositeResourceProvider() : CEGUI::ResourceProvider(){}

~CompositeResourceProvider::CompositeResourceProvider(void)
{
  ProviderIterator it=getIterator();
  for(it.toStart(); !it.isAtEnd(); ++it)
  {
    CEGUI_DELETE it.getCurrentValue();
    d_providerlist.erase (it.getCurrentKey());
  }
}

void CompositeResourceProvider::add(ResourceProvider *prov,const String& name)
{
  d_providerlist.insert(pair<String,*ResourceProvider>(name,prov));
}

void CompositeResourceProvider::remove(ResourceProvider *prov)
{   
  ProviderIterator it=getIterator();
  for(it.toStart(); !it.isAtEnd(); ++it)
  {
    if(it.getCurrentValue() == prov)
      d_providerlist.erase (it.getCurrentKey());
  }
}

void CompositeResourceProvider::remove(const String& name)
{
  d_providerlist.erase(name);
}
ResourceProvider* CompositeResourceProvider::get(const String& name)
{
  return d_providerlist.find(name)->second;
}
void CompositeResourceProvider::loadRawDataContainer(const String& filename,
                         RawDataContainer& output,
                         const String& resourceGroup)
{
  if (filename.empty())
    CEGUI_THROW(InvalidRequestException("CompositeResourceProvider::load: "
      "Filename supplied for data loading must be valid"));
  ProviderIterator it=getIterator();
  for(it.toStart(); !it.isAtEnd(); ++it)
  {
    std::vector<String> out_vec;
    it.getCurrentValue()->getResourceGroupFileNames(out_vec,filename,resourceGroup);
    for (std::vector<String>::const_iterator vit = out_vec.begin(); vit != out_vec.end() && !found; ++vit)
    {
      if(*vit == filename)
      {
        it.getCurrentValue()->loadRawDataContainer(filename,output,resourceGroup);
        return;
      }
    }   
  }
  CEGUI_THROW(InvalidRequestException("CompositeResourceProvider::load: " + filename + " does not exist"));
}

size_t CompositeResourceProvider::getResourceGroupFileNames(std::vector<String>& out_vec,
                const String& file_pattern,const String& resource_group)
{
  size_t entries = 0;
  ProviderIterator it=getIterator();
  for(it.toStart(); !it.isAtEnd(); ++it)
  {
    entries += it.getCurrentValue()->getResourceGroupFileNames(out_vec,file_pattern,resource_group)
  }
  return entries;
}
CompositeResourceProvider::ProviderIterator CompositeResourceProvider::getIterator(void) const
{
  return ProviderIterator(d_providerlist.begin(), d_providerlist.end());
}
}


what does this stuff do?
its a wrapper for an list of other ResourceProvider you can simple add new to this with add<CEGUI::DefaultResourceProvider>("default") and access them with get("default")

this is usefull if later more provider chould be added like multible archive provider for more then one archive file

i hope this fits the "Coding Standards in use for CEGUI" ...
Last edited by Hanmac on Fri Jul 15, 2011 04:22, edited 2 times in total.

User avatar
Kulik
CEGUI Team
Posts: 1382
Joined: Mon Jul 26, 2010 18:47
Location: Czech Republic
Contact:

Re: CompositeResourceProvider i need comment

Postby Kulik » Thu Jul 14, 2011 16:40

Lacks your full name as author which could cause some licensing issues, IANAL so I am not sure
It uses 2 spaces for tab instead of 4
Lacks some doxygen documentation (preferably each method should have some documentation) - to let users that the CRP takes ownership of passed resource providers
Lacks constructor and destructor implementation (or am I blind?)

Other than that it seems solid, kudos!

PS: We have to discuss where this should be kept/shipped. Inside CEGUI core? Or as a contrib module? The resource providers in general are a bit messy (zziplib is included in CEGUIBase!)


Return to “CEGUI Library Development Discussion”

Who is online

Users browsing this forum: No registered users and 16 guests