image/ICOFileHeaders.h
author Drew Willcoxon <adw@mozilla.com>
Fri, 09 Mar 2018 18:54:17 -0800
changeset 766943 c61f5f5ead48c78a80c80db5c489bdc7cfaf8175
parent 265097 7701abd924856d65acbf9927629cf27dd2335ec1
child 489668 cbb8fdf1daf98a15f7d57f6b08d273bdf96aa1a0
child 693329 78f6394c884cc4d87c5ac188ba4abeec314813a4
child 694109 98e2b4ee9775a2a2b5cc1bb8a390bfe901814f38
permissions -rw-r--r--
Back out bug 1426216 (show search suggestions above history in urlbar in some cases) and follow-ups on release. r=Mossop, a=ritu There are four bugs that need to be backed out: 1. https://hg.mozilla.org/releases/mozilla-release/rev/152720a4efe7 (bug 1432716) 2. https://hg.mozilla.org/releases/mozilla-release/rev/84a24eb373fa (bug 1432263) 3. https://hg.mozilla.org/releases/mozilla-release/rev/4d423fdc33dd (bug 1429974) 4. https://hg.mozilla.org/releases/mozilla-release/rev/440dbdb51f94 (bug 1426216) The original bug implementing the problematic feature (pref migration + UI) is 4, and the others are improvements to it.

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */


#ifndef mozilla_image_ICOFileHeaders_h
#define mozilla_image_ICOFileHeaders_h

namespace mozilla {
namespace image {

#define ICONFILEHEADERSIZE 6
#define ICODIRENTRYSIZE 16
#define PNGSIGNATURESIZE 8
#define BMPFILEHEADERSIZE 14

/**
 * The header that comes right at the start of an icon file. (This
 * corresponds to the Windows ICONDIR structure.)
 */
struct IconFileHeader
{
  /**
   * Must be set to 0;
   */
  uint16_t   mReserved;
  /**
   * 1 for icon (.ICO) image (or 2 for cursor (.CUR) image (icon with the
   * addition of a hotspot), but we don't support cursor).
   */
  uint16_t   mType;
  /**
   * The number of BMP/PNG images contained in the icon file.
   */
  uint16_t   mCount;
};

/**
 * For each BMP/PNG image that the icon file contains there must be a
 * corresponding icon dir entry. (This corresponds to the Windows
 * ICONDIRENTRY structure.) These entries are encoded directly after the
 * IconFileHeader.
 */
struct IconDirEntry
{
  uint8_t   mWidth;
  uint8_t   mHeight;
  /**
   * The number of colors in the color palette of the BMP/PNG that this dir
   * entry corresponds to, or 0 if the image does not use a color palette.
   */
  uint8_t   mColorCount;
  /**
   * Should be set to 0.
   */
  uint8_t   mReserved;
  union {
    uint16_t mPlanes;   // ICO
    uint16_t mXHotspot; // CUR
  };
  union {
    uint16_t mBitCount; // ICO (bits per pixel)
    uint16_t mYHotspot; // CUR
  };
  /**
   * "bytes in resource" is the length of the encoded BMP/PNG that this dir
   * entry corresponds to.
   */
  uint32_t  mBytesInRes;
  /**
   * The offset of the start of the encoded BMP/PNG that this dir entry
   * corresponds to (from the start of the icon file).
   */
  uint32_t  mImageOffset;
};


} // namespace image
} // namespace mozilla

#endif // mozilla_image_ICOFileHeaders_h