Typo fix

[wxWidgets.git] / src / common / xpmdecod.cpp

diff --git a/src/common/xpmdecod.cpp b/src/common/xpmdecod.cpp
index 3b33170ab78a8f26b60f15a77afbe00092d54a35..709cc6e7dcbace751e0f48afabc8f35e2ee11b28 100644 (file)
--- a/src/common/xpmdecod.cpp
+++ b/src/common/xpmdecod.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        xpmdecod.cpp
+// Name:        src/common/xpmdecod.cpp

 // Purpose:     wxXPMDecoder
 // Author:      John Cristy, Vaclav Slavik
 // RCS-ID:      $Id$
 // Purpose:     wxXPMDecoder
 // Author:      John Cristy, Vaclav Slavik
 // RCS-ID:      $Id$


@@ -90,58 +90,61 @@ license is as follows:
  * in this Software without prior written authorization from GROUPE BULL.
  */
 
  * in this Software without prior written authorization from GROUPE BULL.
  */
 

-#ifdef __GNUG__
-#pragma implementation "xpmdecod.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#  pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+#if wxUSE_IMAGE && wxUSE_XPM
+
+#include "wx/xpmdecod.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-#  include "wx/defs.h"
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/utils.h"
+    #include "wx/hashmap.h"
+    #include "wx/stream.h"
+    #include "wx/image.h"

 #endif
 
 #endif
 

-#if wxUSE_IMAGE && wxUSE_XPM
-
-#include "wx/stream.h"
-#include "wx/image.h"
-#include "wx/utils.h"
-#include "wx/log.h"
-#include "wx/intl.h"

 #include <string.h>
 #include <string.h>

-
-#include "wx/xpmdecod.h"
+#include <ctype.h>

 
 #if wxUSE_STREAMS
 bool wxXPMDecoder::CanRead(wxInputStream& stream)
 {
     unsigned char buf[9];
 
 
 #if wxUSE_STREAMS
 bool wxXPMDecoder::CanRead(wxInputStream& stream)
 {
     unsigned char buf[9];
 

-    stream.Read(buf, 9);
-    stream.SeekI(-9, wxFromCurrent);
+    if ( !stream.Read(buf, WXSIZEOF(buf)) )
+        return false;
+
+    stream.SeekI(-(wxFileOffset)WXSIZEOF(buf), wxFromCurrent);

 
 

-    return (memcmp(buf, "/* XPM */", 9) == 0);
+    return memcmp(buf, "/* XPM */", WXSIZEOF(buf)) == 0;

 }
 
 wxImage wxXPMDecoder::ReadFile(wxInputStream& stream)
 {
     size_t length = stream.GetSize();
 }
 
 wxImage wxXPMDecoder::ReadFile(wxInputStream& stream)
 {
     size_t length = stream.GetSize();

-    wxCHECK_MSG(length != 0, wxNullImage, wxT("Cannot read XPM from stream of unknown size"));
+    wxCHECK_MSG( length != 0, wxNullImage,
+                 wxT("Cannot read XPM from stream of unknown size") );

 
 

-    char *xpm_buffer = new char[length];
-    char *p, *q;
-    size_t i;
+    // use a smart buffer to be sure to free memory even when we return on
+    // error
+    wxCharBuffer buffer(length);

 
 

-    if ( stream.Read(xpm_buffer, length).LastError() != wxSTREAM_NO_ERROR )
-        return FALSE;
+    char *xpm_buffer = (char *)buffer.data();
+    if ( stream.Read(xpm_buffer, length).GetLastError() == wxSTREAM_READ_ERROR )
+        return wxNullImage;
+    xpm_buffer[length] = '\0';

 
     /*
      *  Remove comments from the file:
      */
 
     /*
      *  Remove comments from the file:
      */

+    char *p, *q;

     for (p = xpm_buffer; *p != '\0'; p++)
     {
         if ( (*p == '"') || (*p == '\'') )
     for (p = xpm_buffer; *p != '\0'; p++)
     {
         if ( (*p == '"') || (*p == '\'') )


@@ -169,13 +172,16 @@ wxImage wxXPMDecoder::ReadFile(wxInputStream& stream)
             if ( (*q == '*') && (*(q + 1) == '/') )
                 break;
         }
             if ( (*q == '*') && (*(q + 1) == '/') )
                 break;
         }

-        strcpy(p, q + 2);
+
+        // memmove allows overlaps (unlike strcpy):
+        size_t cpylen = strlen(q + 2) + 1;
+        memmove(p, q + 2, cpylen);

     }
 
     /*
      *  Remove unquoted characters:
      */
     }
 
     /*
      *  Remove unquoted characters:
      */

-    i = 0;
+    size_t i = 0;

     for (p = xpm_buffer; *p != '\0'; p++)
     {
         if ( *p != '"' )
     for (p = xpm_buffer; *p != '\0'; p++)
     {
         if ( *p != '"' )


@@ -203,7 +209,13 @@ wxImage wxXPMDecoder::ReadFile(wxInputStream& stream)
             lines_cnt++;
     }
 
             lines_cnt++;
     }
 

-    xpm_lines = new const char*[lines_cnt];
+    if ( !lines_cnt )
+    {
+        // this doesn't really look an XPM image
+        return wxNullImage;
+    }
+
+    xpm_lines = new const char*[lines_cnt + 1];

     xpm_lines[0] = xpm_buffer;
     line = 1;
     for (p = xpm_buffer; (*p != '\0') && (line < lines_cnt); p++)
     xpm_lines[0] = xpm_buffer;
     line = 1;
     for (p = xpm_buffer; (*p != '\0') && (line < lines_cnt); p++)


@@ -216,17 +228,15 @@ wxImage wxXPMDecoder::ReadFile(wxInputStream& stream)
         }
     }
 
         }
     }
 

+    xpm_lines[lines_cnt] = NULL;
+

     /*
      *  Read the image:
      */
     wxImage img = ReadData(xpm_lines);
 
     /*
      *  Read the image:
      */
     wxImage img = ReadData(xpm_lines);
 

-    delete[] xpm_buffer;
-#ifdef __WIN16__
-    delete[] (char**) xpm_lines;
-#else

     delete[] xpm_lines;
     delete[] xpm_lines;

-#endif
+

     return img;
 }
 #endif // wxUSE_STREAMS
     return img;
 }
 #endif // wxUSE_STREAMS


@@ -249,7 +259,7 @@ wxImage wxXPMDecoder::ReadFile(wxInputStream& stream)
 
 typedef struct
 {
 
 typedef struct
 {

-    char *name;
+    const char *name;

     wxUint32 rgb;
 } rgbRecord;
 
     wxUint32 rgb;
 } rgbRecord;
 


@@ -473,6 +483,7 @@ static rgbRecord theRGBRecords[] =
     {"seagreen", myRGB(82, 149, 132)},
     {"seashell", myRGB(255, 245, 238)},
     {"sienna", myRGB(150, 82, 45)},
     {"seagreen", myRGB(82, 149, 132)},
     {"seashell", myRGB(255, 245, 238)},
     {"sienna", myRGB(150, 82, 45)},

+    {"silver", myRGB(192, 192, 192)},

     {"skyblue", myRGB(114, 159, 255)},
     {"slateblue", myRGB(126, 136, 171)},
     {"slategray", myRGB(112, 128, 144)},
     {"skyblue", myRGB(114, 159, 255)},
     {"slateblue", myRGB(126, 136, 171)},
     {"slategray", myRGB(112, 128, 144)},


@@ -493,25 +504,25 @@ static rgbRecord theRGBRecords[] =
     {"yellowgreen", myRGB(50, 216, 56)},
     {NULL, myRGB(0, 0, 0)}
 };
     {"yellowgreen", myRGB(50, 216, 56)},
     {NULL, myRGB(0, 0, 0)}
 };

-static int numTheRGBRecords = 234;
+static int numTheRGBRecords = 235;

 
 static unsigned char ParseHexadecimal(char digit1, char digit2)
 {
     unsigned char i1, i2;
 
     if (digit1 >= 'a')
 
 static unsigned char ParseHexadecimal(char digit1, char digit2)
 {
     unsigned char i1, i2;
 
     if (digit1 >= 'a')

-        i1 = digit1 - 'a' + 0x0A;
+        i1 = (unsigned char)(digit1 - 'a' + 0x0A);

     else if (digit1 >= 'A')
     else if (digit1 >= 'A')

-        i1 = digit1 - 'A' + 0x0A;
+        i1 = (unsigned char)(digit1 - 'A' + 0x0A);

     else
     else

-        i1 = digit1 - '0';
+        i1 = (unsigned char)(digit1 - '0');

     if (digit2 >= 'a')
     if (digit2 >= 'a')

-        i2 = digit2 - 'a' + 0x0A;
+        i2 = (unsigned char)(digit2 - 'a' + 0x0A);

     else if (digit2 >= 'A')
     else if (digit2 >= 'A')

-        i2 = digit2 - 'A' + 0x0A;
+        i2 = (unsigned char)(digit2 - 'A' + 0x0A);

     else
     else

-        i2 = digit2 - '0';
-    return (0x10 * i1 + i2);
+        i2 = (unsigned char)(digit2 - '0');
+    return (unsigned char)(0x10 * i1 + i2);

 }
 
 static bool GetRGBFromName(const char *inname, bool *isNone,
 }
 
 static bool GetRGBFromName(const char *inname, bool *isNone,


@@ -523,17 +534,19 @@ static bool GetRGBFromName(const char *inname, bool *isNone,
     char *name;
     char *grey, *p;
 
     char *name;
     char *grey, *p;
 

-    // #rrggbb are not in database, we parse them directly
-    if ( *inname == '#' && strlen(inname) == 7 )
+    // Neither #rrggbb nor #rrrrggggbbbb are in database, we parse them directly
+    size_t inname_len = strlen(inname);
+    if ( *inname == '#' && (inname_len == 7 || inname_len == 13))

     {
     {

+        size_t ofs = (inname_len == 7) ? 2 : 4;

         *r = ParseHexadecimal(inname[1], inname[2]);
         *r = ParseHexadecimal(inname[1], inname[2]);

-        *g = ParseHexadecimal(inname[3], inname[4]);
-        *b = ParseHexadecimal(inname[5], inname[6]);
-        *isNone = FALSE;
-        return TRUE;
+        *g = ParseHexadecimal(inname[1*ofs+1], inname[1*ofs+2]);
+        *b = ParseHexadecimal(inname[2*ofs+1], inname[2*ofs+2]);
+        *isNone = false;
+        return true;

     }
 
     }
 

-    name = strdup(inname);
+    name = wxStrdupA(inname);

 
     // theRGBRecords[] has no names with spaces, and no grey, but a
     // lot of gray...
 
     // theRGBRecords[] has no names with spaces, and no grey, but a
     // lot of gray...


@@ -551,7 +564,7 @@ static bool GetRGBFromName(const char *inname, bool *isNone,
     p = name;
     while (*p)
     {
     p = name;
     while (*p)
     {

-        *p = tolower(*p);
+        *p = (char)tolower(*p);

         p++;
     }
 
         p++;
     }
 


@@ -561,41 +574,47 @@ static bool GetRGBFromName(const char *inname, bool *isNone,
         grey[2] = 'a';
 
     // check for special 'none' colour:
         grey[2] = 'a';
 
     // check for special 'none' colour:

+    bool found;

     if ( strcmp(name, "none") == 0 )
     {
     if ( strcmp(name, "none") == 0 )
     {

-        *isNone = TRUE;
-        return TRUE;
+        *isNone = true;
+        found = true;

     }
     }

-
-    // binary search:
-    left = 0;
-    right = numTheRGBRecords - 1;
-    do
+    else // not "None"

     {
     {

-        middle = (left + right) / 2;
-        cmp = strcmp(name, theRGBRecords[middle].name);
-        if ( cmp == 0 )
-        {
-            rgbVal = theRGBRecords[middle].rgb;
-            *r = (unsigned char)((rgbVal >> 16) & 0xFF);
-            *g = (unsigned char)((rgbVal >> 8) & 0xFF);
-            *b = (unsigned char)((rgbVal) & 0xFF);
-            *isNone = FALSE;
-            free(name);
-            return TRUE;
-        }
-        else if ( cmp < 0 )
+        found = false;
+
+        // binary search:
+        left = 0;
+        right = numTheRGBRecords - 1;
+        do

         {
         {

-            right = middle - 1;
-        }
-        else
-        {           // > 0
-            left = middle + 1;
-        }
-    } while (left <= right);
+            middle = (left + right) / 2;
+            cmp = strcmp(name, theRGBRecords[middle].name);
+            if ( cmp == 0 )
+            {
+                rgbVal = theRGBRecords[middle].rgb;
+                *r = (unsigned char)((rgbVal >> 16) & 0xFF);
+                *g = (unsigned char)((rgbVal >> 8) & 0xFF);
+                *b = (unsigned char)((rgbVal) & 0xFF);
+                *isNone = false;
+                found = true;
+                break;
+            }
+            else if ( cmp < 0 )
+            {
+                right = middle - 1;
+            }
+            else // cmp > 0
+            {
+                left = middle + 1;
+            }
+        } while (left <= right);
+    }

 
     free(name);
 
     free(name);

-    return FALSE;
+
+    return found;

 }
 
 static const char *ParseColor(const char *data)
 }
 
 static const char *ParseColor(const char *data)


@@ -630,33 +649,37 @@ static const char *ParseColor(const char *data)
     return NULL;
 }
 
     return NULL;
 }
 

-class wxXPMColourMapData : public wxObject
+struct wxXPMColourMapData

 {
 {

-    public:
-        unsigned char R,G,B;
+    wxXPMColourMapData() { R = G = B = 0; }
+    unsigned char R,G,B;

 };
 };

+WX_DECLARE_STRING_HASH_MAP(wxXPMColourMapData, wxXPMColourMap);

 
 

-wxImage wxXPMDecoder::ReadData(const char **xpm_data)
+wxImage wxXPMDecoder::ReadData(const char* const* xpm_data)

 {
 {

+    wxCHECK_MSG(xpm_data, wxNullImage, wxT("NULL XPM data") );
+

     wxImage img;
     int count;
     unsigned width, height, colors_cnt, chars_per_pixel;
     wxImage img;
     int count;
     unsigned width, height, colors_cnt, chars_per_pixel;

-    unsigned i, j;
-    char key[64];
+    size_t i, j, i_key;
+    wxChar key[64];

     const char *clr_def;
     bool hasMask;
     const char *clr_def;
     bool hasMask;

-    wxXPMColourMapData *clr_data;
-    wxHashTable clr_tbl(wxKEY_STRING);
+    wxXPMColourMap clr_tbl;
+    wxXPMColourMap::iterator it;
+    wxString maskKey;

 
     /*
      *  Read hints and initialize structures:
      */
 
     /*
      *  Read hints and initialize structures:
      */

-     
+

     count = sscanf(xpm_data[0], "%u %u %u %u",
                    &width, &height, &colors_cnt, &chars_per_pixel);
     if ( count != 4 || width * height * colors_cnt == 0 )
     {
     count = sscanf(xpm_data[0], "%u %u %u %u",
                    &width, &height, &colors_cnt, &chars_per_pixel);
     if ( count != 4 || width * height * colors_cnt == 0 )
     {

-        wxLogError(_T("XPM: Not XPM data!"));
+        wxLogError(_("XPM: incorrect header format!"));

         return wxNullImage;
     }
 
         return wxNullImage;
     }
 


@@ -665,55 +688,79 @@ wxImage wxXPMDecoder::ReadData(const char **xpm_data)
     //     8bit RGB...
     wxCHECK_MSG(chars_per_pixel < 64, wxNullImage, wxT("XPM colormaps this large not supported."));
 
     //     8bit RGB...
     wxCHECK_MSG(chars_per_pixel < 64, wxNullImage, wxT("XPM colormaps this large not supported."));
 

-    img.Create(width, height);
-    if ( !img.Ok() ) return img;
+    if ( !img.Create(width, height) )
+        return wxNullImage;

 
 

-    img.SetMask(FALSE);
-    key[chars_per_pixel] = '\0';
-    hasMask = FALSE;
-    clr_tbl.DeleteContents(TRUE);
+    img.SetMask(false);
+    key[chars_per_pixel] = wxT('\0');
+    hasMask = false;

 
     /*
      *  Create colour map:
      */
 
     /*
      *  Create colour map:
      */

+    wxXPMColourMapData clr_data;

     for (i = 0; i < colors_cnt; i++)
     {
     for (i = 0; i < colors_cnt; i++)
     {

-        memcpy(key, xpm_data[1 + i], chars_per_pixel);
-        clr_def = ParseColor(xpm_data[1 + i]);
-        clr_data = new wxXPMColourMapData;
+        const char *xmpColLine = xpm_data[1 + i];
+
+        // we must have at least " x y" after the colour index, hence +5
+        if ( !xmpColLine || strlen(xmpColLine) < chars_per_pixel + 5 )
+        {
+            wxLogError(_("XPM: incorrect colour description in line %d"),
+                       (int)(1 + i));
+            return wxNullImage;
+        }
+
+        for (i_key = 0; i_key < chars_per_pixel; i_key++)
+            key[i_key] = (wxChar)xmpColLine[i_key];
+        clr_def = ParseColor(xmpColLine + chars_per_pixel);

 
         if ( clr_def == NULL )
         {
 
         if ( clr_def == NULL )
         {

-            wxLogError(_("XPM: malformed colour definition '%s'!"), xpm_data[1+i]);
-            clr_data->R = 255, clr_data->G = 0, clr_data->B = 255;
+            wxLogError(_("XPM: malformed colour definition '%s' at line %d!"),
+                       xmpColLine, (int)(1 + i));
+            return wxNullImage;

         }
         }

-        else
+
+        bool isNone = false;
+        if ( !GetRGBFromName(clr_def, &isNone,
+                             &clr_data.R, &clr_data.G, &clr_data.B) )

         {
         {

-            bool isNone;
-            if ( !GetRGBFromName(clr_def, &isNone,
-                                 &clr_data->R, &clr_data->G, &clr_data->B) )
-            {
-                wxLogError(_("XPM: malformed colour definition '%s'!"), xpm_data[1+i]);
-                clr_data->R = 255, clr_data->G = 0, clr_data->B = 255;
-            }
-            else
+            wxLogError(_("XPM: malformed colour definition '%s' at line %d!"),
+                       xmpColLine, (int)(1 + i));
+            return wxNullImage;
+        }
+
+        if ( isNone )
+        {
+            img.SetMask(true);
+            img.SetMaskColour(255, 0, 255);
+            clr_data.R =
+            clr_data.B = 255;
+            clr_data.G = 0;
+            hasMask = true;
+            maskKey = key;
+        }
+
+        clr_tbl[key] = clr_data;
+    }
+
+    /*
+     *  Modify colour entries with RGB = (255,0,255) to (255,0,254) if
+     *  mask colour is present (so that existing pixels with (255,0,255)
+     *  magenta colour are not incorrectly made transparent):
+     */
+    if (hasMask)
+    {
+        for (it = clr_tbl.begin(); it != clr_tbl.end(); ++it)
+        {
+            if (it->second.R == 255 && it->second.G == 0 &&
+                it->second.B == 255 &&
+                it->first != maskKey)

             {
             {

-                if ( isNone )
-                {
-                    img.SetMask(TRUE);
-                    img.SetMaskColour(255, 0, 255);
-                    hasMask = TRUE;
-                    clr_data->R = 255, clr_data->G = 0, clr_data->B = 255;
-                }
-                else
-                {
-                    if ( hasMask && clr_data->R == 255 &&
-                                    clr_data->G == 0 && clr_data->B == 255 )
-                        clr_data->B = 254;
-                }
+                it->second.B = 254;

             }
         }
             }
         }

-        clr_tbl.Put(key, clr_data);

     }
 
     /*
     }
 
     /*


@@ -721,23 +768,42 @@ wxImage wxXPMDecoder::ReadData(const char **xpm_data)
      */
 
     unsigned char *img_data = img.GetData();
      */
 
     unsigned char *img_data = img.GetData();

+    wxXPMColourMap::iterator entry;
+    wxXPMColourMap::iterator end = clr_tbl.end();
+

     for (j = 0; j < height; j++)
     {
         for (i = 0; i < width; i++, img_data += 3)
         {
     for (j = 0; j < height; j++)
     {
         for (i = 0; i < width; i++, img_data += 3)
         {

-            memcpy(key,
-                   xpm_data[1 + colors_cnt + j] + chars_per_pixel * i,
-                   chars_per_pixel);
-            clr_data = (wxXPMColourMapData*) clr_tbl.Get(key);
-            if ( clr_data == NULL )
+            const char *xpmImgLine = xpm_data[1 + colors_cnt + j];
+            if ( !xpmImgLine || strlen(xpmImgLine) < width*chars_per_pixel )
+            {
+                wxLogError(_("XPM: truncated image data at line %d!"),
+                           (int)(1 + colors_cnt + j));
+                return wxNullImage;
+            }
+
+            for (i_key = 0; i_key < chars_per_pixel; i_key++)
+            {
+                key[i_key] = (wxChar)xpmImgLine[chars_per_pixel * i + i_key];
+            }
+
+            entry = clr_tbl.find(key);
+            if ( entry == end )

             {
                 wxLogError(_("XPM: Malformed pixel data!"));
             {
                 wxLogError(_("XPM: Malformed pixel data!"));

+
+                // better return right now as otherwise we risk to flood the
+                // user with error messages as something seems to be seriously
+                // wrong with the file and so we could give this message for
+                // each remaining pixel if we don't bail out
+                return wxNullImage;

             }
             else
             {
             }
             else
             {

-                img_data[0] = clr_data->R;
-                img_data[1] = clr_data->G;
-                img_data[2] = clr_data->B;
+                img_data[0] = entry->second.R;
+                img_data[1] = entry->second.G;
+                img_data[2] = entry->second.B;

             }
         }
     }
             }
         }
     }


@@ -745,5 +811,4 @@ wxImage wxXPMDecoder::ReadData(const char **xpm_data)
     return img;
 }
 
     return img;
 }
 

-

 #endif // wxUSE_IMAGE && wxUSE_XPM
 #endif // wxUSE_IMAGE && wxUSE_XPM