unify(imagecollection): Merge ImageCollection code (#1771)

Author: xezon

Generals/Code/GameEngine/Include/GameClient/Image.h

@@ -33,6 +33,7 @@
 #include "Common/AsciiString.h"
 #include "Common/GameMemory.h"
 #include "Common/SubsystemInterface.h"
+#include <map>
 
 struct FieldParse;
 class INI;
@@ -106,8 +107,6 @@ friend class ImageCollection;
 	void *m_rawTextureData;		///< raw texture data
 	UnsignedInt m_status;			///< status bits from ImageStatus
 
-	Image *m_next;						///< for maintaining lists as collections
-
 	static const FieldParse m_imageFieldParseTable[];		///< the parse table for INI definition
 
 };
@@ -130,25 +129,28 @@ class ImageCollection : public SubsystemInterface
 	void load( Int textureSize );												 ///< load images
 
 	const Image *findImageByName( const AsciiString& name );					 ///< find image based on name
-	const Image *findImageByFilename( const AsciiString& name );  ///< find image based on filename
 
-	Image *firstImage( void );						///< return first image in list
-	Image *nextImage( Image *image );			///< return next image
+  /// adds the given image to the collection, transfers ownership to this object
+  void addImage(Image *image);
 
-	Image *newImage( void );							///< return a new, linked image
+  /// enumerates the list of existing images
+  Image *Enum(unsigned index)
+  {
+    for (std::map<unsigned,Image *>::iterator i=m_imageMap.begin();i!=m_imageMap.end();++i)
+      if (!index--)
+        return i->second;
+    return NULL;
+  }
 
 protected:
-
-	Image *m_imageList;  ///< the image list
-
+  std::map<unsigned,Image *> m_imageMap;  ///< maps named keys to images
 };
 
 // INLINING ///////////////////////////////////////////////////////////////////////////////////////
 inline void Image::setName( AsciiString name ) { m_name = name; }
 inline AsciiString Image::getName( void ) const { return m_name; }
 inline void Image::setFilename( AsciiString name ) { m_filename = name; }
 inline AsciiString Image::getFilename( void ) const { return m_filename; }
-inline Image *ImageCollection::firstImage( void ) { return m_imageList; }
 inline void Image::setUV( Region2D *uv ) { if( uv ) m_UVCoords = *uv; }
 inline const Region2D *Image::getUV( void ) const { return &m_UVCoords; }
 inline void Image::setTextureWidth( Int width ) { m_textureSize.x = width; }

Generals/Code/GameEngine/Source/Common/INI/INIMappedImage.cpp

@@ -66,8 +66,9 @@ void INI::parseMappedImageDefinition( INI* ini )
 	{
 
 		// image not found, create a new one
-		image = TheMappedImageCollection->newImage();
+  	image = newInstance(Image);
 		image->setName( name );
+		TheMappedImageCollection->addImage(image);
 		DEBUG_ASSERTCRASH( image, ("parseMappedImage: unable to allocate image for '%s'",
 															name.str()) );
 

Generals/Code/GameEngine/Source/GameClient/MapUtil.cpp

@@ -1104,7 +1104,7 @@ Image *getMapPreviewImage( AsciiString mapName )
 
 		if (success)
 		{
-			image = TheMappedImageCollection->newImage();
+    	image = newInstance(Image);
 			image->setName(tempName);
 			//image->setFullPath("mission.tga");
 			image->setFilename(name);
@@ -1117,6 +1117,7 @@ Image *getMapPreviewImage( AsciiString mapName )
 			image->setUV(&uv);
 			image->setTextureHeight(128);
 			image->setTextureWidth(128);
+			TheMappedImageCollection->addImage(image);
 		}
 		else
 		{

Generals/Code/GameEngine/Source/GameClient/System/Image.cpp

@@ -39,7 +39,7 @@
 #include "Common/INI.h"
 #include "Common/GlobalData.h"
 #include "GameClient/Image.h"
-
+#include "Common/NameKeyGenerator.h"
 
 // PRIVATE DATA ///////////////////////////////////////////////////////////////////////////////////
 const FieldParse Image::m_imageFieldParseTable[] =
@@ -154,7 +154,6 @@ Image::Image( void )
 	m_imageSize.y = 0;
 	m_rawTextureData = NULL;
 	m_status = IMAGE_STATUS_NONE;
-	m_next = NULL;
 
 }
 
@@ -199,113 +198,31 @@ UnsignedInt Image::clearStatus( UnsignedInt bit )
 //-------------------------------------------------------------------------------------------------
 ImageCollection::ImageCollection( void )
 {
-
-	m_imageList = NULL;
-
 }
 
 //-------------------------------------------------------------------------------------------------
 //-------------------------------------------------------------------------------------------------
 ImageCollection::~ImageCollection( void )
 {
-	Image *image, *next;
-
-	// delete the images
-	image = m_imageList;
-	while( image )
-	{
-
-		next = image->m_next;
-		deleteInstance(image);
-		image = next;
-
-	}
-	m_imageList = NULL;
-
+  for (std::map<unsigned,Image *>::iterator i=m_imageMap.begin();i!=m_imageMap.end();++i)
+    deleteInstance(i->second);
 }
 
 //-------------------------------------------------------------------------------------------------
 /** Return the next image in the collection */
 //-------------------------------------------------------------------------------------------------
-Image *ImageCollection::nextImage( Image *image )
+void ImageCollection::addImage( Image *image )
 {
-
-	if( image )
-		return image->m_next;
-
-	return NULL;
-
-}
-
-//-------------------------------------------------------------------------------------------------
-/** Allocate a new image, tie to the image list and return it */
-//-------------------------------------------------------------------------------------------------
-Image *ImageCollection::newImage( void )
-{
-	Image *image = newInstance(Image);
-
-	// attach to collection list
-	image->m_next = m_imageList;
-	m_imageList = image;
-
-	return image;
-
+  m_imageMap[TheNameKeyGenerator->nameToLowercaseKey(image->getName())]=image;
 }
 
 //-------------------------------------------------------------------------------------------------
 /** Find an image given the image name */
 //-------------------------------------------------------------------------------------------------
 const Image *ImageCollection::findImageByName( const AsciiString& name )
 {
-	Image *image;
-
-	/** @todo this needs to be more intelligent if this image collection
-	becomes a real system we use a lot */
-
-	// search the images
-	image = m_imageList;
-	while( image )
-	{
-
-		//
-		// want to do a case insensitive compare here cause image INI files are
-		// autogenerated from filenames using the image packer tool
-		//
-		if( image->getName().compareNoCase( name.str() ) == 0 )
-			return image;
-		image = image->m_next;
-
-	}
-
-	// not found
-	return NULL;
-
-}
-
-//-------------------------------------------------------------------------------------------------
-/** Find image given image filename */
-//-------------------------------------------------------------------------------------------------
-const Image *ImageCollection::findImageByFilename( const AsciiString& filename )
-{
-	Image *image;
-
-	/** @todo this needs to be more intelligent if this image collection
-	becomes a real system we use a lot */
-
-	// search the images
-	image = m_imageList;
-	while( image )
-	{
-
-		if( image->getFilename() == filename )
-			return image;
-		image = image->m_next;
-
-	}
-
-	// not found
-	return NULL;
-
+  std::map<unsigned,Image *>::iterator i=m_imageMap.find(TheNameKeyGenerator->nameToLowercaseKey(name));
+  return i==m_imageMap.end()?NULL:i->second;
 }
 
 //-------------------------------------------------------------------------------------------------

Generals/Code/Tools/GUIEdit/Source/Properties.cpp

@@ -1176,9 +1176,7 @@ void LoadImageListComboBox( HWND comboBox )
 	SendMessage( comboBox, CB_RESETCONTENT, 0, 0 );
 
 	// load the combo box with string names from the GUI image collection
-	for( image = TheMappedImageCollection->firstImage();
-			 image;
-			 image = TheMappedImageCollection->nextImage( image ) )
+  for (unsigned index=0;(image=TheMappedImageCollection->Enum(index))!=NULL;index++)
 	{
 
 		SendMessage( comboBox, CB_ADDSTRING, 0, (LPARAM)image->getName().str() );