X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Fbits%2FCell.java;h=a8efa2b3c56465dc7ee93dc76fefa399bed85603;hb=12b90437b5f22c2ae6e9b9b14c3b62b60f6143e5;hp=3c0eb14a04a4c0969b4a778b6d54050379a2c89d;hpb=2b9c27db318b916730aa04f2b41bd3bff795a5dc;p=nikiroo-utils.git diff --git a/src/jexer/bits/Cell.java b/src/jexer/bits/Cell.java index 3c0eb14..a8efa2b 100644 --- a/src/jexer/bits/Cell.java +++ b/src/jexer/bits/Cell.java @@ -1,51 +1,269 @@ -/** +/* * Jexer - Java Text User Interface * - * License: LGPLv3 or later - * - * This module is licensed under the GNU Lesser General Public License - * Version 3. Please see the file "COPYING" in this directory for more - * information about the GNU Lesser General Public License Version 3. + * The MIT License (MIT) * - * Copyright (C) 2015 Kevin Lamonte + * Copyright (C) 2019 Kevin Lamonte * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License - * as published by the Free Software Foundation; either version 3 of - * the License, or (at your option) any later version. + * 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: * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. * - * You should have received a copy of the GNU Lesser General Public - * License along with this program; if not, see - * http://www.gnu.org/licenses/, or write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA + * 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 OR COPYRIGHT HOLDERS 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. * * @author Kevin Lamonte [kevin.lamonte@gmail.com] * @version 1 */ package jexer.bits; +import java.awt.Color; +import java.awt.image.BufferedImage; + /** - * This class represents a single text cell on the screen. + * This class represents a single text cell or bit of image on the screen. */ public final class Cell extends CellAttributes { + // ------------------------------------------------------------------------ + // Constants -------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * How this cell needs to be displayed if it is part of a larger glyph. + */ + public enum Width { + /** + * This cell is an entire glyph on its own. + */ + SINGLE, + + /** + * This cell is the left half of a wide glyph. + */ + LEFT, + + /** + * This cell is the right half of a wide glyph. + */ + RIGHT, + } + + /** + * The special "this cell is unset" (null) value. This is the Unicode + * "not a character" value. + */ + private static final char UNSET_VALUE = (char) 65535; + + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * The character at this cell. */ - private char ch; + private int ch = ' '; + + /** + * The display width of this cell. + */ + private Width width = Width.SINGLE; + + /** + * The image at this cell. + */ + private BufferedImage image = null; + + /** + * The image at this cell, inverted. + */ + private BufferedImage invertedImage = null; + + /** + * The background color used for the area the image portion might not + * cover. + */ + private Color background = Color.BLACK; + + /** + * hashCode() needs to call image.hashCode(), which can get quite + * expensive. + */ + private int imageHashCode = 0; + + /** + * hashCode() needs to call background.hashCode(), which can get quite + * expensive. + */ + private int backgroundHashCode = 0; + + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Public constructor sets default values of the cell to blank. + * + * @see #isBlank() + * @see #reset() + */ + public Cell() { + // NOP + } + + /** + * Public constructor sets the character. Attributes are the same as + * default. + * + * @param ch character to set to + * @see #reset() + */ + public Cell(final int ch) { + this.ch = ch; + } + + /** + * Public constructor sets the attributes. + * + * @param attr attributes to use + */ + public Cell(final CellAttributes attr) { + super(attr); + } + + /** + * Public constructor sets the character and attributes. + * + * @param ch character to set to + * @param attr attributes to use + */ + public Cell(final int ch, final CellAttributes attr) { + super(attr); + this.ch = ch; + } + + /** + * Public constructor creates a duplicate. + * + * @param cell the instance to copy + */ + public Cell(final Cell cell) { + setTo(cell); + } + + // ------------------------------------------------------------------------ + // Cell ------------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Set the image data for this cell. + * + * @param image the image for this cell + */ + public void setImage(final BufferedImage image) { + this.image = image; + imageHashCode = image.hashCode(); + width = Width.SINGLE; + } + + /** + * Get the image data for this cell. + * + * @return the image for this cell + */ + public BufferedImage getImage() { + if (invertedImage != null) { + return invertedImage; + } + return image; + } + + /** + * Get the bitmap image background color for this cell. + * + * @return the bitmap image background color + */ + public Color getBackground() { + return background; + } + + /** + * If true, this cell has image data. + * + * @return true if this cell is an image rather than a character with + * attributes + */ + public boolean isImage() { + if (image != null) { + return true; + } + return false; + } + + /** + * Restore the image in this cell to its normal version, if it has one. + */ + public void restoreImage() { + invertedImage = null; + } + + /** + * If true, this cell has image data, and that data is inverted. + * + * @return true if this cell is an image rather than a character with + * attributes, and the data is inverted + */ + public boolean isInvertedImage() { + if ((image != null) && (invertedImage != null)) { + return true; + } + return false; + } + + /** + * Invert the image in this cell, if it has one. + */ + public void invertImage() { + if (image == null) { + return; + } + if (invertedImage == null) { + invertedImage = new BufferedImage(image.getWidth(), + image.getHeight(), BufferedImage.TYPE_INT_ARGB); + + int [] rgbArray = image.getRGB(0, 0, + image.getWidth(), image.getHeight(), null, 0, image.getWidth()); + + for (int i = 0; i < rgbArray.length; i++) { + // Set the colors to fully inverted. + if (rgbArray[i] != 0x00FFFFFF) { + rgbArray[i] ^= 0x00FFFFFF; + } + // Also set alpha to non-transparent. + rgbArray[i] |= 0xFF000000; + } + invertedImage.setRGB(0, 0, image.getWidth(), image.getHeight(), + rgbArray, 0, image.getWidth()); + } + } /** * Getter for cell character. * * @return cell character */ - public char getChar() { + public int getChar() { return ch; } @@ -54,10 +272,29 @@ public final class Cell extends CellAttributes { * * @param ch new cell character */ - public void setChar(final char ch) { + public void setChar(final int ch) { this.ch = ch; } + /** + * Getter for cell width. + * + * @return Width.SINGLE, Width.LEFT, or Width.RIGHT + */ + public Width getWidth() { + return width; + } + + /** + * Setter for cell width. + * + * @param width new cell width, one of Width.SINGLE, Width.LEFT, or + * Width.RIGHT + */ + public void setWidth(final Width width) { + this.width = width; + } + /** * Reset this cell to a blank. */ @@ -65,6 +302,27 @@ public final class Cell extends CellAttributes { public void reset() { super.reset(); ch = ' '; + width = Width.SINGLE; + image = null; + imageHashCode = 0; + invertedImage = null; + background = Color.BLACK; + backgroundHashCode = 0; + } + + /** + * UNset this cell. It will not be equal to any other cell until it has + * been assigned attributes and a character. + */ + public void unset() { + super.reset(); + ch = UNSET_VALUE; + width = Width.SINGLE; + image = null; + imageHashCode = 0; + invertedImage = null; + background = Color.BLACK; + backgroundHashCode = 0; } /** @@ -75,13 +333,19 @@ public final class Cell extends CellAttributes { * @return true if this cell has default attributes. */ public boolean isBlank() { + if ((ch == UNSET_VALUE) || (image != null)) { + return false; + } if ((getForeColor().equals(Color.WHITE)) && (getBackColor().equals(Color.BLACK)) - && !getBold() - && !getBlink() - && !getReverse() - && !getUnderline() - && !getProtect() + && !isBold() + && !isBlink() + && !isReverse() + && !isUnderline() + && !isProtect() + && !isRGB() + && !isImage() + && (width == Width.SINGLE) && (ch == ' ') ) { return true; @@ -103,8 +367,72 @@ public final class Cell extends CellAttributes { } Cell that = (Cell) rhs; - return (super.equals(rhs) - && (ch == that.ch)); + + // Unsetted cells can never be equal. + if ((ch == UNSET_VALUE) || (that.ch == UNSET_VALUE)) { + return false; + } + + // If this or rhs has an image and the other doesn't, these are not + // equal. + if ((image != null) && (that.image == null)) { + return false; + } + if ((image == null) && (that.image != null)) { + return false; + } + // If this and rhs have images, both must match. + if ((image != null) && (that.image != null)) { + if ((invertedImage == null) && (that.invertedImage != null)) { + return false; + } + if ((invertedImage != null) && (that.invertedImage == null)) { + return false; + } + // Either both objects have their image inverted, or neither do. + // Now if the images are identical the cells are the same + // visually. + if (image.equals(that.image) + && (background.equals(that.background)) + ) { + return true; + } else { + return false; + } + } + + // Normal case: character and attributes must match. + if ((ch == that.ch) && (width == that.width)) { + return super.equals(rhs); + } + return false; + } + + /** + * Hashcode uses all fields in equals(). + * + * @return the hash + */ + @Override + public int hashCode() { + int A = 13; + int B = 23; + int hash = A; + hash = (B * hash) + super.hashCode(); + hash = (B * hash) + (int)ch; + hash = (B * hash) + width.hashCode(); + if (image != null) { + /* + hash = (B * hash) + image.hashCode(); + hash = (B * hash) + background.hashCode(); + */ + hash = (B * hash) + imageHashCode; + hash = (B * hash) + backgroundHashCode; + } + if (invertedImage != null) { + hash = (B * hash) + invertedImage.hashCode(); + } + return hash; } /** @@ -116,11 +444,21 @@ public final class Cell extends CellAttributes { public void setTo(final Object rhs) { // Let this throw a ClassCastException CellAttributes thatAttr = (CellAttributes) rhs; + this.image = null; + this.imageHashCode = 0; + this.backgroundHashCode = 0; + this.width = Width.SINGLE; super.setTo(thatAttr); if (rhs instanceof Cell) { Cell that = (Cell) rhs; this.ch = that.ch; + this.width = that.width; + this.image = that.image; + this.invertedImage = that.invertedImage; + this.background = that.background; + this.imageHashCode = that.imageHashCode; + this.backgroundHashCode = that.backgroundHashCode; } } @@ -130,31 +468,10 @@ public final class Cell extends CellAttributes { * @param that a CellAttributes instance */ public void setAttr(final CellAttributes that) { + image = null; super.setTo(that); } - /** - * Public constructor sets default values of the cell to blank. - * - * @see #isBlank() - * @see #reset() - */ - public Cell() { - reset(); - } - - /** - * Public constructor sets the character. Attributes are the same as - * default. - * - * @param ch character to set to - * @see #reset() - */ - public Cell(final char ch) { - reset(); - this.ch = ch; - } - /** * Make human-readable description of this Cell. * @@ -162,7 +479,7 @@ public final class Cell extends CellAttributes { */ @Override public String toString() { - return String.format("fore: %d back: %d bold: %s blink: %s ch %c", - getForeColor(), getBackColor(), getBold(), getBlink(), ch); + return String.format("fore: %s back: %s bold: %s blink: %s ch %c", + getForeColor(), getBackColor(), isBold(), isBlink(), ch); } }