Bitfield: Refine impl. complete get/put 32bit, add copy*(..), add synchronized delegation; TODO: Unit tests.

4 files changed, 278 insertions, 53 deletions

diff --git a/src/java/com/jogamp/common/util/Bitfield.java b/src/java/com/jogamp/common/util/Bitfield.java
index 4086578..f7eaeb0 100644
--- a/src/java/com/jogamp/common/util/Bitfield.java
+++ b/src/java/com/jogamp/common/util/Bitfield.java
@@ -27,6 +27,8 @@
  */
 package com.jogamp.common.util;
 
+import jogamp.common.util.SyncedBitfield;
+
 /**
  * Simple bitfield interface for efficient bit storage access in O(1).
  * @since 2.3.2
@@ -72,27 +74,53 @@ public interface Bitfield {
                 return new jogamp.common.util.Int32ArrayBitfield(storageBitSize);
             }
         }
+        /**
+         * Creates a synchronized {@link Bitfield} by wrapping the given {@link Bitfield} instance.
+         */
+        public static Bitfield synchronize(final Bitfield impl) {
+            return new SyncedBitfield(impl);
+        }
     }
-
     /**
      * Returns the storage size in bit units, e.g. 32 bit for implementations using one {@code int} field.
      */
     int getStorageBitSize();
 
     /**
-     * Returns the 32 bit integer mask w/ its lowest bit at the bit number {@code rightBitnum}.
-     * @param rightBitnum bit number denoting the position of the lowest bit, restricted to [0..{@link #getStorageBitSize()}-32].
+     * Returns {@code length} bits from this storage,
+     * starting with the lowest bit from the storage position {@code lowBitnum}.
+     * @param lowBitnum storage bit position of the lowest bit, restricted to [0..{@link #getStorageBitSize()}-{@code length}].
+     * @param length number of bits to read, constrained to [0..32].
      * @throws IndexOutOfBoundsException if {@code rightBitnum} is out of bounds
+     * @see #put32(int, int, int)
      */
-    int getInt32(final int rightBitnum) throws IndexOutOfBoundsException;
+    int get32(final int lowBitnum, final int length) throws IndexOutOfBoundsException;
 
     /**
-     * Sets the given 32 bit integer mask w/ its lowest bit at the bit number {@code rightBitnum}.
-     * @param rightBitnum bit number denoting the position of the lowest bit, restricted to [0..{@link #getStorageBitSize()}-32].
-     * @param mask denoting the 32 bit mask value to store
+     * Puts {@code length} bits of given {@code data} into this storage,
+     * starting w/ the lowest bit to the storage position {@code lowBitnum}.
+     * @param lowBitnum storage bit position of the lowest bit, restricted to [0..{@link #getStorageBitSize()}-{@code length}].
+     * @param length number of bits to read, constrained to [0..32].
+     * @param data the actual bits to be put into this storage
      * @throws IndexOutOfBoundsException if {@code rightBitnum} is out of bounds
+     * @see #get32(int, int)
      */
-    void putInt32(final int rightBitnum, final int mask) throws IndexOutOfBoundsException;
+    void put32(final int lowBitnum, final int length, final int data) throws IndexOutOfBoundsException;
+
+    /**
+     * Copies {@code length} bits at position {@code srcLowBitnum} to position {@code dstLowBitnum}
+     * and returning the bits.
+     * <p>
+     * Implementation shall operate as if invoking {@link #get32(int, int)}
+     * and then {@link #put32(int, int, int)} sequentially.
+     * </p>
+     * @param srcLowBitnum source bit number, restricted to [0..{@link #getStorageBitSize()}-1].
+     * @param dstLowBitnum destination bit number, restricted to [0..{@link #getStorageBitSize()}-1].
+     * @throws IndexOutOfBoundsException if {@code bitnum} is out of bounds
+     * @see #get32(int, int)
+     * @see #put32(int, int, int)
+     */
+    int copy32(final int srcLowBitnum, final int dstLowBitnum, final int length) throws IndexOutOfBoundsException;
 
     /**
      * Return <code>true</code> if the bit at position <code>bitnum</code> is set, otherwise <code>false</code>.
@@ -107,7 +135,7 @@ public interface Bitfield {
      * @param bitnum bit number, restricted to [0..{@link #getStorageBitSize()}-1].
      * @throws IndexOutOfBoundsException if {@code bitnum} is out of bounds
      */
-    boolean put(final int bitnum, final boolean bit) throws IndexOutOfBoundsException;
+    void put(final int bitnum, final boolean bit) throws IndexOutOfBoundsException;
 
     /**
      * Set the bit at position <code>bitnum</code> according to <code>bit</code>.
@@ -124,6 +152,15 @@ public interface Bitfield {
     void clear(final int bitnum) throws IndexOutOfBoundsException;
 
     /**
+     * Copies the bit at position {@code srcBitnum} to position {@code dstBitnum}
+     * and returning <code>true</code> if the bit is set, otherwise <code>false</code>.
+     * @param srcBitnum source bit number, restricted to [0..{@link #getStorageBitSize()}-1].
+     * @param dstBitnum destination bit number, restricted to [0..{@link #getStorageBitSize()}-1].
+     * @throws IndexOutOfBoundsException if {@code bitnum} is out of bounds
+     */
+    boolean copy(final int srcBitnum, final int dstBitnum) throws IndexOutOfBoundsException;
+
+    /**
      * Returns the number of set bits within this bitfield.
      * <p>
      * Utilizes {#link {@link Bitfield.Util#getBitCount(int)}}.
diff --git a/src/java/jogamp/common/util/Int32ArrayBitfield.java b/src/java/jogamp/common/util/Int32ArrayBitfield.java
index 954680c..dd18b3d 100644
--- a/src/java/jogamp/common/util/Int32ArrayBitfield.java
+++ b/src/java/jogamp/common/util/Int32ArrayBitfield.java
@@ -54,35 +54,71 @@ public class Int32ArrayBitfield implements Bitfield {
         return bitSize;
     }
 
-    private final void check(final int limit, final int bitnum) throws IndexOutOfBoundsException {
-        if( 0 > bitnum || bitnum >= limit ) {
-            throw new IndexOutOfBoundsException("Bitnum should be within [0.."+(limit-1)+"], but is "+bitnum);
+    private static final void check(final int size, final int bitnum) throws IndexOutOfBoundsException {
+        if( 0 > bitnum || bitnum >= size ) {
+            throw new IndexOutOfBoundsException("Bitnum should be within [0.."+(size-1)+"], but is "+bitnum);
         }
     }
 
     @Override
-    public final int getInt32(final int rightBitnum) throws IndexOutOfBoundsException {
-        check(bitSize-31, rightBitnum);
-        if( 0 == rightBitnum % 32 ) {
+    public final int get32(final int lowBitnum, final int length) throws IndexOutOfBoundsException {
+        if( 0 > length || length > 32 ) {
+            throw new IndexOutOfBoundsException("length should be within [0..32], but is "+length);
+        }
+        check(bitSize-length+1, lowBitnum);
+        final int u = lowBitnum >>> UNIT_SHIFT;
+        final int left = 32 - ( lowBitnum - ( u << UNIT_SHIFT ) ); // remaining bits of first chunk storage
+        if( 32 == left ) {
             // fast path
-            return storage[rightBitnum >>> UNIT_SHIFT];
+            final int m = ( 1 << length ) - 1;
+            return m & storage[u];
         } else {
             // slow path
-            throw new UnsupportedOperationException("todo: non-32bit alignment");
+            final int l = Math.min(length, left);    // length of first chunk
+            final int m = ( 1 << l ) - 1;            // mask of first chunk
+            final int d = m & ( storage[u] >>> lowBitnum );
+            final int l2 = length - l;               // length of last chunk
+            if( l2 > 0 ) {
+                final int m2 = ( 1 << l2 ) - 1;      // mask of last chunk
+                return d | ( ( m2 & storage[u+1] ) << l );
+            } else {
+                return d;
+            }
         }
     }
-
     @Override
-    public final void putInt32(final int rightBitnum, final int mask) throws IndexOutOfBoundsException {
-        check(bitSize-31, rightBitnum);
-        if( 0 == rightBitnum % 32 ) {
+    public final void put32(final int lowBitnum, final int length, final int data) throws IndexOutOfBoundsException {
+        if( 0 > length || length > 32 ) {
+            throw new IndexOutOfBoundsException("length should be within [0..32], but is "+length);
+        }
+        check(bitSize-length+1, lowBitnum);
+        final int u = lowBitnum >>> UNIT_SHIFT;
+        final int left = 32 - ( lowBitnum - ( u << UNIT_SHIFT ) ); // remaining bits of first chunk storage
+        if( 32 == left ) {
             // fast path
-            storage[rightBitnum >>> UNIT_SHIFT] = mask;
+            final int m = ( 1 << length ) - 1;       // mask of chunk
+            storage[u] = ( ( ~m ) & storage[u] )     // keep non-written storage bits
+                         | ( m & data );             // overwrite storage w/ used data bits
         } else {
             // slow path
-            throw new UnsupportedOperationException("todo: non-32bit alignment");
+            final int l = Math.min(length, left);    // length of first chunk
+            final int m = ( 1 << l ) - 1;            // mask of first chunk
+            storage[u] = ( ( ~( m << lowBitnum ) ) & storage[u] ) // keep non-written storage bits
+                         | ( ( m & data ) << lowBitnum );         // overwrite storage w/ used data bits
+            final int l2 = length - l;               // length of last chunk
+            if( l2 > 0 ) {
+                final int m2 = ( 1 << l2 ) - 1;      // mask of last chunk
+                storage[u] = ( ( ~m2 ) & storage[u+1] ) // keep non-written storage bits
+                             | ( m2 & ( data >>> l ) ); // overwrite storage w/ used data bits
+            }
         }
     }
+    @Override
+    public final int copy32(final int srcBitnum, final int dstBitnum, final int length) throws IndexOutOfBoundsException {
+        final int data = get32(srcBitnum, length);
+        put32(dstBitnum, length, data);
+        return data;
+    }
 
     @Override
     public final boolean get(final int bitnum) throws IndexOutOfBoundsException {
@@ -93,20 +129,16 @@ public class Int32ArrayBitfield implements Bitfield {
     }
 
     @Override
-    public final boolean put(final int bitnum, final boolean bit) throws IndexOutOfBoundsException {
+    public final void put(final int bitnum, final boolean bit) throws IndexOutOfBoundsException {
         check(bitSize, bitnum);
         final int u = bitnum >>> UNIT_SHIFT;
         final int b = bitnum - ( u << UNIT_SHIFT );
         final int m = 1 << b;
-        final boolean prev = 0 != ( storage[u] & m ) ;
-        if( prev != bit ) {
-            if( bit ) {
-                storage[u] |=  m;
-            } else {
-                storage[u] &= ~m;
-            }
+        if( bit ) {
+            storage[u] |=  m;
+        } else {
+            storage[u] &= ~m;
         }
-        return prev;
     }
     @Override
     public final void set(final int bitnum) throws IndexOutOfBoundsException {
@@ -117,13 +149,35 @@ public class Int32ArrayBitfield implements Bitfield {
         storage[u] |=  m;
     }
     @Override
-    public final void clear (final int bitnum) throws IndexOutOfBoundsException {
+    public final void clear(final int bitnum) throws IndexOutOfBoundsException {
         check(bitSize, bitnum);
         final int u = bitnum >>> UNIT_SHIFT;
         final int b = bitnum - ( u << UNIT_SHIFT );
         final int m = 1 << b;
         storage[u] &= ~m;
     }
+    @Override
+    public final boolean copy(final int srcBitnum, final int dstBitnum) throws IndexOutOfBoundsException {
+        check(bitSize, srcBitnum);
+        check(bitSize, dstBitnum);
+        final boolean bit;
+        // get
+        {
+            final int u = srcBitnum >>> UNIT_SHIFT;
+            final int b = srcBitnum - ( u << UNIT_SHIFT );
+            bit = 0 != ( storage[u] & ( 1 << b ) ) ;
+        }
+        // put
+        final int u = dstBitnum >>> UNIT_SHIFT;
+        final int b = dstBitnum - ( u << UNIT_SHIFT );
+        final int m = 1 << b;
+        if( bit ) {
+            storage[u] |=  m;
+        } else {
+            storage[u] &= ~m;
+        }
+        return bit;
+    }
 
     @Override
     public int getBitCount() {
diff --git a/src/java/jogamp/common/util/Int32Bitfield.java b/src/java/jogamp/common/util/Int32Bitfield.java
index f81b486..6119a00 100644
--- a/src/java/jogamp/common/util/Int32Bitfield.java
+++ b/src/java/jogamp/common/util/Int32Bitfield.java
@@ -49,22 +49,55 @@ public class Int32Bitfield implements Bitfield {
         return UNIT_SIZE;
     }
 
-    private final void check(final int limit, final int bitnum) throws IndexOutOfBoundsException {
-        if( 0 > bitnum || bitnum >= limit ) {
-            throw new IndexOutOfBoundsException("Bitnum should be within [0.."+(limit-1)+"], but is "+bitnum);
+    private static final void check(final int size, final int bitnum) throws IndexOutOfBoundsException {
+        if( 0 > bitnum || bitnum >= size ) {
+            throw new IndexOutOfBoundsException("Bitnum should be within [0.."+(size-1)+"], but is "+bitnum);
         }
     }
 
     @Override
-    public final int getInt32(final int rightBitnum) throws IndexOutOfBoundsException {
-        check(UNIT_SIZE-31, rightBitnum);
-        return storage;
+    public final int get32(final int lowBitnum, final int length) throws IndexOutOfBoundsException {
+        if( 0 > length || length > 32 ) {
+            throw new IndexOutOfBoundsException("length should be within [0..32], but is "+length);
+        }
+        check(UNIT_SIZE-length+1, lowBitnum);
+        final int left = 32 - lowBitnum;             // remaining bits of first chunk
+        if( 32 == left ) {
+            // fast path
+            final int m = ( 1 << length ) - 1;
+            return m & storage;
+        } else {
+            // slow path
+            final int l = Math.min(length, left);    // length of first chunk
+            final int m = ( 1 << l ) - 1;            // mask of first chunk
+            return m & ( storage >>> lowBitnum );
+        }
     }
-
     @Override
-    public final void putInt32(final int rightBitnum, final int mask) throws IndexOutOfBoundsException {
-        check(UNIT_SIZE-31, rightBitnum);
-        storage = mask;
+    public final void put32(final int lowBitnum, final int length, final int data) throws IndexOutOfBoundsException {
+        if( 0 > length || length > 32 ) {
+            throw new IndexOutOfBoundsException("length should be within [0..32], but is "+length);
+        }
+        check(UNIT_SIZE-length+1, lowBitnum);
+        final int left = 32 - lowBitnum;             // remaining bits of first chunk storage
+        if( 32 == left ) {
+            // fast path
+            final int m = ( 1 << length ) - 1;       // mask of chunk
+            storage = ( ( ~m ) & storage )           // keep non-written storage bits
+                      | ( m & data );                // overwrite storage w/ used data bits
+        } else {
+            // slow path
+            final int l = Math.min(length, left);    // length of first chunk
+            final int m = ( 1 << l ) - 1;            // mask of first chunk
+            storage = ( ( ~( m << lowBitnum ) ) & storage ) // keep non-written storage bits
+                      | ( ( m & data ) << lowBitnum );      // overwrite storage w/ used data bits
+        }
+    }
+    @Override
+    public final int copy32(final int srcBitnum, final int dstBitnum, final int length) throws IndexOutOfBoundsException {
+        final int data = get32(srcBitnum, length);
+        put32(dstBitnum, length, data);
+        return data;
     }
 
     @Override
@@ -72,20 +105,15 @@ public class Int32Bitfield implements Bitfield {
         check(UNIT_SIZE, bitnum);
         return 0 != ( storage & ( 1 << bitnum ) ) ;
     }
-
     @Override
-    public final boolean put(final int bitnum, final boolean bit) throws IndexOutOfBoundsException {
+    public final void put(final int bitnum, final boolean bit) throws IndexOutOfBoundsException {
         check(UNIT_SIZE, bitnum);
         final int m = 1 << bitnum;
-        final boolean prev = 0 != ( storage & m ) ;
-        if( prev != bit ) {
-            if( bit ) {
-                storage |=  m;
-            } else {
-                storage &= ~m;
-            }
+        if( bit ) {
+            storage |=  m;
+        } else {
+            storage &= ~m;
         }
-        return prev;
     }
     @Override
     public final void set(final int bitnum) throws IndexOutOfBoundsException {
@@ -99,6 +127,21 @@ public class Int32Bitfield implements Bitfield {
         final int m = 1 << bitnum;
         storage &= ~m;
     }
+    @Override
+    public final boolean copy(final int srcBitnum, final int dstBitnum) throws IndexOutOfBoundsException {
+        check(UNIT_SIZE, srcBitnum);
+        check(UNIT_SIZE, dstBitnum);
+        // get
+        final boolean bit = 0 != ( storage & ( 1 << srcBitnum ) ) ;
+        // put
+        final int m = 1 << dstBitnum;
+        if( bit ) {
+            storage |=  m;
+        } else {
+            storage &= ~m;
+        }
+        return bit;
+    }
 
     @Override
     public int getBitCount() {
diff --git a/src/java/jogamp/common/util/SyncedBitfield.java b/src/java/jogamp/common/util/SyncedBitfield.java
new file mode 100644
index 0000000..783fb91
--- /dev/null
+++ b/src/java/jogamp/common/util/SyncedBitfield.java
@@ -0,0 +1,91 @@
+/**
+ * Copyright 2015 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``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 JogAmp Community 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.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+package jogamp.common.util;
+
+import com.jogamp.common.util.Bitfield;
+
+/**
+ * Simple synchronized {@link Bitfield} by wrapping an existing {@link Bitfield}.
+ */
+public class SyncedBitfield implements Bitfield {
+    private final Bitfield impl;
+
+    public SyncedBitfield(final Bitfield impl) {
+        this.impl = impl;
+    }
+
+    @Override
+    public final synchronized int getStorageBitSize() {
+        return impl.getStorageBitSize();
+    }
+
+    @Override
+    public final synchronized int get32(final int lowBitnum, final int length) throws IndexOutOfBoundsException {
+        return impl.get32(lowBitnum, length);
+    }
+
+    @Override
+    public final synchronized void put32(final int lowBitnum, final int length, final int data) throws IndexOutOfBoundsException {
+        impl.put32(lowBitnum, length, data);
+    }
+
+    @Override
+    public final synchronized int copy32(final int srcLowBitnum, final int dstLowBitnum, final int length) throws IndexOutOfBoundsException {
+        return impl.copy32(srcLowBitnum, dstLowBitnum, length);
+    }
+
+    @Override
+    public final synchronized boolean get(final int bitnum) throws IndexOutOfBoundsException {
+        return impl.get(bitnum);
+    }
+
+    @Override
+    public final synchronized void put(final int bitnum, final boolean bit) throws IndexOutOfBoundsException {
+        impl.put(bitnum, bit);
+    }
+
+    @Override
+    public final synchronized void set(final int bitnum) throws IndexOutOfBoundsException {
+        impl.set(bitnum);
+    }
+
+    @Override
+    public final synchronized void clear(final int bitnum) throws IndexOutOfBoundsException {
+        impl.clear(bitnum);
+    }
+
+    @Override
+    public final synchronized boolean copy(final int srcBitnum, final int dstBitnum) throws IndexOutOfBoundsException {
+        return impl.copy(srcBitnum, dstBitnum);
+    }
+
+    @Override
+    public final synchronized int getBitCount() {
+        return impl.getBitCount();
+    }
+}
\ No newline at end of file