Add 'src/jexer/' from commit 'cf01c92f5809a0732409e280fb0f32f27393618d'
[nikiroo-utils.git] / src / jexer / bits / CellAttributes.java
index 0ea0d88579929249825a8d9b13cd21c31358924a..99366fda690740b738563493fef900a506436d7d 100644 (file)
@@ -1,29 +1,27 @@
 /*
  * Jexer - Java Text User Interface
  *
- * License: LGPLv3 or later
+ * The MIT License (MIT)
  *
- * 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.
+ * Copyright (C) 2019 Kevin Lamonte
  *
- *     Copyright (C) 2015  Kevin Lamonte
+ * 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 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.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * 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.
- *
- * 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
@@ -35,10 +33,92 @@ package jexer.bits;
  */
 public class CellAttributes {
 
+    // ------------------------------------------------------------------------
+    // Constants --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * Bold attribute.
      */
-    private boolean bold;
+    private static final int BOLD       = 0x01;
+
+    /**
+     * Blink attribute.
+     */
+    private static final int BLINK      = 0x02;
+
+    /**
+     * Reverse attribute.
+     */
+    private static final int REVERSE    = 0x04;
+
+    /**
+     * Underline attribute.
+     */
+    private static final int UNDERLINE  = 0x08;
+
+    /**
+     * Protected attribute.
+     */
+    private static final int PROTECT    = 0x10;
+
+
+    // ------------------------------------------------------------------------
+    // Variables --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * Boolean flags.
+     */
+    private int flags = 0;
+
+    /**
+     * Foreground color.  Color.WHITE, Color.RED, etc.
+     */
+    private Color foreColor = Color.WHITE;
+
+    /**
+     * Background color.  Color.WHITE, Color.RED, etc.
+     */
+    private Color backColor = Color.BLACK;
+
+    /**
+     * Foreground color as 24-bit RGB value.  Negative value means not set.
+     */
+    private int foreColorRGB = -1;
+
+    /**
+     * Background color as 24-bit RGB value.  Negative value means not set.
+     */
+    private int backColorRGB = -1;
+
+    // ------------------------------------------------------------------------
+    // Constructors -----------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * Public constructor sets default values of the cell to white-on-black,
+     * no bold/blink/reverse/underline/protect.
+     *
+     * @see #reset()
+     */
+    public CellAttributes() {
+        // NOP
+    }
+
+    /**
+     * Public constructor makes a copy from another instance.
+     *
+     * @param that another CellAttributes instance
+     * @see #reset()
+     */
+    public CellAttributes(final CellAttributes that) {
+        setTo(that);
+    }
+
+    // ------------------------------------------------------------------------
+    // CellAttributes ---------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
      * Getter for bold.
@@ -46,7 +126,7 @@ public class CellAttributes {
      * @return bold value
      */
     public final boolean isBold() {
-        return bold;
+        return ((flags & BOLD) == 0 ? false : true);
     }
 
     /**
@@ -55,21 +135,20 @@ public class CellAttributes {
      * @param bold new bold value
      */
     public final void setBold(final boolean bold) {
-        this.bold = bold;
+        if (bold) {
+            flags |= BOLD;
+        } else {
+            flags &= ~BOLD;
+        }
     }
 
-    /**
-     * Blink attribute.
-     */
-    private boolean blink;
-
     /**
      * Getter for blink.
      *
      * @return blink value
      */
     public final boolean isBlink() {
-        return blink;
+        return ((flags & BLINK) == 0 ? false : true);
     }
 
     /**
@@ -78,21 +157,20 @@ public class CellAttributes {
      * @param blink new blink value
      */
     public final void setBlink(final boolean blink) {
-        this.blink = blink;
+        if (blink) {
+            flags |= BLINK;
+        } else {
+            flags &= ~BLINK;
+        }
     }
 
-    /**
-     * Reverse attribute.
-     */
-    private boolean reverse;
-
     /**
      * Getter for reverse.
      *
      * @return reverse value
      */
     public final boolean isReverse() {
-        return reverse;
+        return ((flags & REVERSE) == 0 ? false : true);
     }
 
     /**
@@ -101,21 +179,20 @@ public class CellAttributes {
      * @param reverse new reverse value
      */
     public final void setReverse(final boolean reverse) {
-        this.reverse = reverse;
+        if (reverse) {
+            flags |= REVERSE;
+        } else {
+            flags &= ~REVERSE;
+        }
     }
 
-    /**
-     * Underline attribute.
-     */
-    private boolean underline;
-
     /**
      * Getter for underline.
      *
      * @return underline value
      */
     public final boolean isUnderline() {
-        return underline;
+        return ((flags & UNDERLINE) == 0 ? false : true);
     }
 
     /**
@@ -124,21 +201,20 @@ public class CellAttributes {
      * @param underline new underline value
      */
     public final void setUnderline(final boolean underline) {
-        this.underline = underline;
+        if (underline) {
+            flags |= UNDERLINE;
+        } else {
+            flags &= ~UNDERLINE;
+        }
     }
 
-    /**
-     * Protected attribute.
-     */
-    private boolean protect;
-
     /**
      * Getter for protect.
      *
      * @return protect value
      */
     public final boolean isProtect() {
-        return protect;
+        return ((flags & PROTECT) == 0 ? false : true);
     }
 
     /**
@@ -147,14 +223,13 @@ public class CellAttributes {
      * @param protect new protect value
      */
     public final void setProtect(final boolean protect) {
-        this.protect = protect;
+        if (protect) {
+            flags |= PROTECT;
+        } else {
+            flags &= ~PROTECT;
+        }
     }
 
-    /**
-     * Foreground color.  Color.WHITE, Color.RED, etc.
-     */
-    private Color foreColor;
-
     /**
      * Getter for foreColor.
      *
@@ -173,11 +248,6 @@ public class CellAttributes {
         this.foreColor = foreColor;
     }
 
-    /**
-     * Background color.  Color.WHITE, Color.RED, etc.
-     */
-    private Color backColor;
-
     /**
      * Getter for backColor.
      *
@@ -197,27 +267,60 @@ public class CellAttributes {
     }
 
     /**
-     * Set to default: white foreground on black background, no
-     * bold/underline/blink/rever/protect.
+     * Getter for foreColor RGB.
+     *
+     * @return foreColor value.  Negative means unset.
      */
-    public void reset() {
-        bold      = false;
-        blink     = false;
-        reverse   = false;
-        underline = false;
-        protect   = false;
-        foreColor = Color.WHITE;
-        backColor = Color.BLACK;
+    public final int getForeColorRGB() {
+        return foreColorRGB;
     }
 
     /**
-     * Public constructor sets default values of the cell to white-on-black,
-     * no bold/blink/reverse/underline/protect.
+     * Setter for foreColor RGB.
      *
-     * @see #reset()
+     * @param foreColorRGB new foreColor RGB value
      */
-    public CellAttributes() {
-        reset();
+    public final void setForeColorRGB(final int foreColorRGB) {
+        this.foreColorRGB = foreColorRGB;
+    }
+
+    /**
+     * Getter for backColor RGB.
+     *
+     * @return backColor value.  Negative means unset.
+     */
+    public final int getBackColorRGB() {
+        return backColorRGB;
+    }
+
+    /**
+     * Setter for backColor RGB.
+     *
+     * @param backColorRGB new backColor RGB value
+     */
+    public final void setBackColorRGB(final int backColorRGB) {
+        this.backColorRGB = backColorRGB;
+    }
+
+    /**
+     * See if this cell uses RGB or ANSI colors.
+     *
+     * @return true if this cell has a RGB color
+     */
+    public final boolean isRGB() {
+        return (foreColorRGB >= 0) || (backColorRGB >= 0);
+    }
+
+    /**
+     * Set to default: white foreground on black background, no
+     * bold/underline/blink/rever/protect.
+     */
+    public void reset() {
+        flags           = 0;
+        foreColor       = Color.WHITE;
+        backColor       = Color.BLACK;
+        foreColorRGB    = -1;
+        backColorRGB    = -1;
     }
 
     /**
@@ -233,13 +336,11 @@ public class CellAttributes {
         }
 
         CellAttributes that = (CellAttributes) rhs;
-        return ((bold == that.bold)
-            && (blink == that.blink)
-            && (reverse == that.reverse)
-            && (underline == that.underline)
-            && (protect == that.protect)
+        return ((flags == that.flags)
             && (foreColor == that.foreColor)
-            && (backColor == that.backColor));
+            && (backColor == that.backColor)
+            && (foreColorRGB == that.foreColorRGB)
+            && (backColorRGB == that.backColorRGB));
     }
 
     /**
@@ -252,13 +353,11 @@ public class CellAttributes {
         int A = 13;
         int B = 23;
         int hash = A;
-        hash = (B * hash) + (bold ? 1 : 0);
-        hash = (B * hash) + (blink ? 1 : 0);
-        hash = (B * hash) + (underline ? 1 : 0);
-        hash = (B * hash) + (reverse ? 1 : 0);
-        hash = (B * hash) + (protect ? 1 : 0);
+        hash = (B * hash) + flags;
         hash = (B * hash) + foreColor.hashCode();
         hash = (B * hash) + backColor.hashCode();
+        hash = (B * hash) + foreColorRGB;
+        hash = (B * hash) + backColorRGB;
         return hash;
     }
 
@@ -270,13 +369,11 @@ public class CellAttributes {
     public void setTo(final Object rhs) {
         CellAttributes that = (CellAttributes) rhs;
 
-        this.bold      = that.bold;
-        this.blink     = that.blink;
-        this.reverse   = that.reverse;
-        this.underline = that.underline;
-        this.protect   = that.protect;
-        this.foreColor = that.foreColor;
-        this.backColor = that.backColor;
+        this.flags              = that.flags;
+        this.foreColor          = that.foreColor;
+        this.backColor          = that.backColor;
+        this.foreColorRGB       = that.foreColorRGB;
+        this.backColorRGB       = that.backColorRGB;
     }
 
     /**
@@ -286,12 +383,13 @@ public class CellAttributes {
      */
     @Override
     public String toString() {
-        if (bold) {
-            return String.format("bold %s on %s",
-                foreColor, backColor);
-        } else {
-            return String.format("%s on %s", foreColor, backColor);
+        if ((foreColorRGB >= 0) || (backColorRGB >= 0)) {
+            return String.format("RGB: #%06x on #%06x",
+                (foreColorRGB & 0xFFFFFF),
+                (backColorRGB & 0xFFFFFF));
         }
+        return String.format("%s%s%s on %s", (isBold() ? "bold " : ""),
+            (isBlink() ? "blink " : ""), foreColor, backColor);
     }
 
 }