com.twelvemonkeys.imageio.plugins.ico.DirectoryEntry Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2009, Harald Kuhr
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name "TwelveMonkeys" nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.twelvemonkeys.imageio.plugins.ico;

import javax.imageio.IIOException;
import java.io.DataInput;
import java.io.IOException;
import java.awt.*;

/**
 * DirectoryEntry
 *
 * @author Harald Kuhr
 * @author last modified by $Author: haraldk$
 * @version $Id: DirectoryEntry.java,v 1.0 Apr 4, 2009 4:29:53 PM haraldk Exp$
 * @see Wikipedia
 */
abstract class DirectoryEntry {
    private int width;
    private int height;
    private int colorCount;
    int planes;
    int bitCount;
    private int size;
    private int offset;

    private DirectoryEntry() {
    }

    public static DirectoryEntry read(final int pType, final DataInput pStream) throws IOException {
        DirectoryEntry entry = createEntry(pType);
        entry.read(pStream);
        return entry;
    }

    private static DirectoryEntry createEntry(int pType) throws IIOException {
        switch (pType) {
            case DIB.TYPE_ICO:
                return new ICOEntry();
            case DIB.TYPE_CUR:
                return new CUREntry();
            default:
                throw new IIOException(
                        String.format(
                                "Unknown DIB type: %s, expected: %s (ICO) or %s (CUR)",
                                pType, DIB.TYPE_ICO, DIB.TYPE_CUR
                        )
                );
        }
    }

    protected void read(final DataInput pStream) throws IOException {
        // Width/height = 0, means 256
        int w = pStream.readUnsignedByte();
        width = w == 0 ? 256 : w;
        int h = pStream.readUnsignedByte();
        height = h == 0 ? 256 : h;
        
        // Color count = 0, means 256 or more colors
        colorCount = pStream.readUnsignedByte();

        // Ignore. Should be 0, but .NET (System.Drawing.Icon.Save) sets this value to 255, according to Wikipedia
        pStream.readUnsignedByte();

        planes = pStream.readUnsignedShort();     // Should be 0 or 1 for ICO, x hotspot for CUR
        bitCount = pStream.readUnsignedShort();   // bit count for ICO, y hotspot for CUR

        // Size of bitmap in bytes
        size = pStream.readInt();
        offset = pStream.readInt();
    }

    public String toString() {
        return String.format(
                "%s: width: %d, height: %d, colors: %d, planes: %d, bit count: %d, size: %d, offset: %d",
                getClass().getSimpleName(),
                width, height, colorCount, planes, bitCount, size, offset
        );
    }

    public int getBitCount() {
        return bitCount;
    }

    public int getColorCount() {
        return colorCount;
    }

    public int getHeight() {
        return height;
    }

    public int getOffset() {
        return offset;
    }

    public int getPlanes() {
        return planes;
    }

    public int getSize() {
        return size;
    }

    public int getWidth() {
        return width;
    }

    /**
     * Cursor directory entry.
     */
    static class CUREntry extends DirectoryEntry {
        private int xHotspot;
        private int yHotspot;

        @Override
        protected void read(final DataInput pStream) throws IOException {
            super.read(pStream);

            // NOTE: This is a hack...
            xHotspot = planes;
            yHotspot = bitCount;

            planes = 1;    // Always 1 for all BMP types
            bitCount = 0;
        }

        public Point getHotspot() {
            return new Point(xHotspot, yHotspot);
        }
    }

    /**
     * Icon directory entry.
     */
    static final class ICOEntry extends DirectoryEntry {
    }
}