Prep for 2019 release
[fanfix.git] / src / jexer / bits / CellAttributes.java
index 28dbe31d95637e97a00c0231d7ab7abeefebf13a..f60fd3097f856ed6e70a098c018cfccbf1a5d2b8 100644 (file)
@@ -3,7 +3,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (C) 2017 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
@@ -33,11 +33,83 @@ package jexer.bits;
  */
 public class CellAttributes {
 
+    // ------------------------------------------------------------------------
+    // Variables --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * Bold attribute.
      */
     private boolean bold;
 
+    /**
+     * Blink attribute.
+     */
+    private boolean blink;
+
+    /**
+     * Reverse attribute.
+     */
+    private boolean reverse;
+
+    /**
+     * Underline attribute.
+     */
+    private boolean underline;
+
+    /**
+     * Protected attribute.
+     */
+    private boolean protect;
+
+    /**
+     * Foreground color.  Color.WHITE, Color.RED, etc.
+     */
+    private Color foreColor;
+
+    /**
+     * Background color.  Color.WHITE, Color.RED, etc.
+     */
+    private Color backColor;
+
+    /**
+     * 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() {
+        reset();
+    }
+
+    /**
+     * 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.
      *
@@ -56,11 +128,6 @@ public class CellAttributes {
         this.bold = bold;
     }
 
-    /**
-     * Blink attribute.
-     */
-    private boolean blink;
-
     /**
      * Getter for blink.
      *
@@ -79,11 +146,6 @@ public class CellAttributes {
         this.blink = blink;
     }
 
-    /**
-     * Reverse attribute.
-     */
-    private boolean reverse;
-
     /**
      * Getter for reverse.
      *
@@ -102,11 +164,6 @@ public class CellAttributes {
         this.reverse = reverse;
     }
 
-    /**
-     * Underline attribute.
-     */
-    private boolean underline;
-
     /**
      * Getter for underline.
      *
@@ -125,11 +182,6 @@ public class CellAttributes {
         this.underline = underline;
     }
 
-    /**
-     * Protected attribute.
-     */
-    private boolean protect;
-
     /**
      * Getter for protect.
      *
@@ -148,11 +200,6 @@ public class CellAttributes {
         this.protect = protect;
     }
 
-    /**
-     * Foreground color.  Color.WHITE, Color.RED, etc.
-     */
-    private Color foreColor;
-
     /**
      * Getter for foreColor.
      *
@@ -171,11 +218,6 @@ public class CellAttributes {
         this.foreColor = foreColor;
     }
 
-    /**
-     * Background color.  Color.WHITE, Color.RED, etc.
-     */
-    private Color backColor;
-
     /**
      * Getter for backColor.
      *
@@ -195,37 +237,64 @@ 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;
     }
 
     /**
-     * Public constructor makes a copy from another instance.
+     * Getter for backColor RGB.
      *
-     * @param that another CellAttributes instance
-     * @see #reset()
+     * @return backColor value.  Negative means unset.
      */
-    public CellAttributes(final CellAttributes that) {
-        setTo(that);
+    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() {
+        bold            = false;
+        blink           = false;
+        reverse         = false;
+        underline       = false;
+        protect         = false;
+        foreColor       = Color.WHITE;
+        backColor       = Color.BLACK;
+        foreColorRGB    = -1;
+        backColorRGB    = -1;
     }
 
     /**
@@ -243,6 +312,8 @@ public class CellAttributes {
         CellAttributes that = (CellAttributes) rhs;
         return ((foreColor == that.foreColor)
             && (backColor == that.backColor)
+            && (foreColorRGB == that.foreColorRGB)
+            && (backColorRGB == that.backColorRGB)
             && (bold == that.bold)
             && (reverse == that.reverse)
             && (underline == that.underline)
@@ -267,6 +338,8 @@ public class CellAttributes {
         hash = (B * hash) + (protect ? 1 : 0);
         hash = (B * hash) + foreColor.hashCode();
         hash = (B * hash) + backColor.hashCode();
+        hash = (B * hash) + foreColorRGB;
+        hash = (B * hash) + backColorRGB;
         return hash;
     }
 
@@ -278,13 +351,15 @@ 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.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.foreColorRGB       = that.foreColorRGB;
+        this.backColorRGB       = that.backColorRGB;
     }
 
     /**
@@ -294,12 +369,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", (bold == true ? "bold " : ""),
+            (blink == true ? "blink " : ""), foreColor, backColor);
     }
 
 }