Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit eea0b8b0 authored by Yohei Yukawa's avatar Yohei Yukawa
Browse files

Fix inconsistencies in CursorAnchorInfo#equals 

This CL addresses some inconsistencies found in
CursorAnchorInfo#equals.

- #mComposingText is now taken into consideration when
  compared with other instances.
- NaN is now treated as if it was just a number in
  CursorAnchorInfo#equals if and only if NaN is used in
  -- #mInsertionMarkerHorizontal
  -- #mInsertionMarkerTop
  -- #mInsertionMarkerBaseline
  -- #mInsertionMarkerBottom.
  This is useful if we want to use NaN as a marker to
  indicate that no value is specified.

Change-Id: Ibff31bc34b9d488731b294ad38240c567a06b627
parent 6b1e88e5

core/java/android/view/inputmethod/CursorAnchorInfo.java

+28 −8
Original line number Diff line number Diff line
@@ -139,6 +139,17 @@ public final class CursorAnchorInfo implements Parcelable { 
        return hash;

    }



    /**

     * Compares two float values. Returns {@code true} if {@code a} and {@code b} are

     * {@link Float#NaN} at the same time.

     */

    private static boolean areSameFloatImpl(final float a, final float b) {

        if (Float.isNaN(a) && Float.isNaN(b)) {

            return true;

        }

        return a == b;

    }



    @Override

    public boolean equals(Object obj){

        if (obj == null) {
@@ -154,9 +165,17 @@ public final class CursorAnchorInfo implements Parcelable { 
        if (hashCode() != that.hashCode()) {

            return false;

        }

        if (mSelectionStart != that.mSelectionStart

                || mSelectionEnd != that.mSelectionEnd

                || mComposingTextStart != that.mComposingTextStart) {

        if (mSelectionStart != that.mSelectionStart || mSelectionEnd != that.mSelectionEnd) {

            return false;

        }

        if (mComposingTextStart != that.mComposingTextStart

                || !Objects.equals(mComposingText, that.mComposingText)) {

            return false;

        }

        if (!areSameFloatImpl(mInsertionMarkerHorizontal, that.mInsertionMarkerHorizontal)

                || !areSameFloatImpl(mInsertionMarkerTop, that.mInsertionMarkerTop)

                || !areSameFloatImpl(mInsertionMarkerBaseline, that.mInsertionMarkerBaseline)

                || !areSameFloatImpl(mInsertionMarkerBottom, that.mInsertionMarkerBottom)) {

            return false;

        }

        if (!Objects.equals(mComposingTextStart, that.mComposingTextStart)) {
@@ -355,7 +374,7 @@ public final class CursorAnchorInfo implements Parcelable { 


    /**

     * Returns the index where the selection starts.

     * @return -1 if there is no selection.

     * @return {@code -1} if there is no selection.

     */

    public int getSelectionStart() {

        return mSelectionStart;
@@ -363,7 +382,7 @@ public final class CursorAnchorInfo implements Parcelable { 


    /**

     * Returns the index where the selection ends.

     * @return -1 if there is no selection.

     * @return {@code -1} if there is no selection.

     */

    public int getSelectionEnd() {

        return mSelectionEnd;
@@ -371,7 +390,7 @@ public final class CursorAnchorInfo implements Parcelable { 


    /**

     * Returns the index where the composing text starts.

     * @return -1 if there is no composing text.

     * @return {@code -1} if there is no composing text.

     */

    public int getComposingTextStart() {

        return mComposingTextStart;
@@ -379,7 +398,7 @@ public final class CursorAnchorInfo implements Parcelable { 


    /**

     * Returns the entire composing text.

     * @return null if there is no composition.

     * @return {@code null} if there is no composition.

     */

    public CharSequence getComposingText() {

        return mComposingText;
@@ -435,7 +454,8 @@ public final class CursorAnchorInfo implements Parcelable { 
     * @return a new instance of {@link RectF} that represents the location of the character in

     * local coordinates. null if the character is invisible or the application did not provide

     * the location. Note that the {@code left} field can be greater than the {@code right} field

     * if the character is in RTL text.

     * if the character is in RTL text. Returns {@code null} if no location information is

     * available.

     */

    // TODO: Prepare a document about the expected behavior for surrogate pairs, combining

    // characters, and non-graphical chars.

core/tests/inputmethodtests/src/android/os/CursorAnchorInfoTest.java

+149 −6
Original line number Diff line number Diff line
@@ -24,6 +24,8 @@ import android.text.TextUtils; 
import android.view.inputmethod.CursorAnchorInfo;

import android.view.inputmethod.CursorAnchorInfo.Builder;



import java.util.Objects;



public class CursorAnchorInfoTest extends InstrumentationTestCase {

    // null represents a character that is invisible, for example because it's overlapped by some

    // other UI elements.
@@ -86,9 +88,11 @@ public class CursorAnchorInfoTest extends InstrumentationTestCase { 
        assertEquals(INSERTION_MARKER_BOTOM, info.getInsertionMarkerBottom());

        assertEquals(TRANSFORM_MATRIX, info.getMatrix());

        for (int i = 0; i < MANY_RECTS.length; i++) {

            final RectF rect = MANY_RECTS[i];

            assertEquals(rect, info.getCharacterRect(i));

            final RectF expectedRect = MANY_RECTS[i];

            assertEquals(expectedRect, info.getCharacterRect(i));

        }

        assertNull(info.getCharacterRect(-1));

        assertNull(info.getCharacterRect(MANY_RECTS.length + 1));



        // Make sure that the builder can reproduce the same object.

        final CursorAnchorInfo info2 = builder.build();
@@ -102,9 +106,11 @@ public class CursorAnchorInfoTest extends InstrumentationTestCase { 
        assertEquals(INSERTION_MARKER_BOTOM, info2.getInsertionMarkerBottom());

        assertEquals(TRANSFORM_MATRIX, info2.getMatrix());

        for (int i = 0; i < MANY_RECTS.length; i++) {

            final RectF rect = MANY_RECTS[i];

            assertEquals(rect, info2.getCharacterRect(i));

            final RectF expectedRect = MANY_RECTS[i];

            assertEquals(expectedRect, info2.getCharacterRect(i));

        }

        assertNull(info2.getCharacterRect(-1));

        assertNull(info2.getCharacterRect(MANY_RECTS.length + 1));

        assertEquals(info, info2);

        assertEquals(info.hashCode(), info2.hashCode());
@@ -120,9 +126,11 @@ public class CursorAnchorInfoTest extends InstrumentationTestCase { 
        assertEquals(INSERTION_MARKER_BOTOM, info3.getInsertionMarkerBottom());

        assertEquals(TRANSFORM_MATRIX, info3.getMatrix());

        for (int i = 0; i < MANY_RECTS.length; i++) {

            final RectF rect = MANY_RECTS[i];

            assertEquals(rect, info3.getCharacterRect(i));

            final RectF expectedRect = MANY_RECTS[i];

            assertEquals(expectedRect, info3.getCharacterRect(i));

        }

        assertNull(info3.getCharacterRect(-1));

        assertNull(info3.getCharacterRect(MANY_RECTS.length + 1));

        assertEquals(info.hashCode(), info3.hashCode());



        builder.reset();
@@ -138,6 +146,141 @@ public class CursorAnchorInfoTest extends InstrumentationTestCase { 
        assertEquals(Matrix.IDENTITY_MATRIX, uninitializedInfo.getMatrix());

    }



    private static void assertNotEquals(final CursorAnchorInfo reference,

            final CursorAnchorInfo actual) {

        assertFalse(Objects.equals(reference, actual));

    }



    @SmallTest

    public void testEquality() throws Exception {

        final Matrix MATRIX1 = new Matrix();

        MATRIX1.setTranslate(10.0f, 20.0f);

        final Matrix MATRIX2 = new Matrix();

        MATRIX2.setTranslate(110.0f, 120.0f);

        final Matrix NAN_MATRIX = new Matrix();

        NAN_MATRIX.setValues(new float[]{

                Float.NaN, Float.NaN, Float.NaN,

                Float.NaN, Float.NaN, Float.NaN,

                Float.NaN, Float.NaN, Float.NaN});

        final int SELECTION_START1 = 2;

        final int SELECTION_END1 = 7;

        final String COMPOSING_TEXT1 = "0123456789";

        final int COMPOSING_TEXT_START1 = 0;

        final float INSERTION_MARKER_HORIZONTAL1 = 10.5f;

        final float INSERTION_MARKER_TOP1 = 100.1f;

        final float INSERTION_MARKER_BASELINE1 = 110.4f;

        final float INSERTION_MARKER_BOTOM1 = 111.0f;

        final int SELECTION_START2 = 4;

        final int SELECTION_END2 = 8;

        final String COMPOSING_TEXT2 = "9876543210";

        final int COMPOSING_TEXT_START2 = 3;

        final float INSERTION_MARKER_HORIZONTAL2 = 14.5f;

        final float INSERTION_MARKER_TOP2 = 200.1f;

        final float INSERTION_MARKER_BASELINE2 = 210.4f;

        final float INSERTION_MARKER_BOTOM2 = 211.0f;



        // Default instance should be equal.

        assertEquals(new Builder().build(), new Builder().build());



        assertEquals(

                new Builder().setSelectionRange(SELECTION_START1, SELECTION_END1).build(),

                new Builder().setSelectionRange(SELECTION_START1, SELECTION_END1).build());

        assertNotEquals(

                new Builder().setSelectionRange(SELECTION_START1, SELECTION_END1).build(),

                new Builder().setSelectionRange(SELECTION_START1, SELECTION_END2).build());

        assertNotEquals(

                new Builder().setSelectionRange(SELECTION_START1, SELECTION_END1).build(),

                new Builder().setSelectionRange(SELECTION_START2, SELECTION_END1).build());

        assertNotEquals(

                new Builder().setSelectionRange(SELECTION_START1, SELECTION_END1).build(),

                new Builder().setSelectionRange(SELECTION_START2, SELECTION_END2).build());

        assertEquals(

                new Builder().setComposingText(COMPOSING_TEXT_START1, COMPOSING_TEXT1).build(),

                new Builder().setComposingText(COMPOSING_TEXT_START1, COMPOSING_TEXT1).build());

        assertNotEquals(

                new Builder().setComposingText(COMPOSING_TEXT_START1, COMPOSING_TEXT1).build(),

                new Builder().setComposingText(COMPOSING_TEXT_START2, COMPOSING_TEXT1).build());

        assertNotEquals(

                new Builder().setComposingText(COMPOSING_TEXT_START1, COMPOSING_TEXT1).build(),

                new Builder().setComposingText(COMPOSING_TEXT_START1, COMPOSING_TEXT2).build());

        assertNotEquals(

                new Builder().setComposingText(COMPOSING_TEXT_START1, COMPOSING_TEXT1).build(),

                new Builder().setComposingText(COMPOSING_TEXT_START2, COMPOSING_TEXT2).build());



        // For insertion marker locations, {@link Float#NaN} is treated as if it was a number.

        assertEquals(

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        Float.NaN, Float.NaN, Float.NaN, Float.NaN).build(),

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        Float.NaN, Float.NaN, Float.NaN, Float.NaN).build());



        // Check Matrix.

        assertEquals(

                new Builder().setMatrix(MATRIX1).build(),

                new Builder().setMatrix(MATRIX1).build());

        assertNotEquals(

                new Builder().setMatrix(MATRIX1).build(),

                new Builder().setMatrix(MATRIX2).build());

        assertNotEquals(

                new Builder().setMatrix(MATRIX1).build(),

                new Builder().setMatrix(NAN_MATRIX).build());

        // Unlike insertion marker locations, {@link Float#NaN} in the matrix is treated as just a

        // NaN as usual (NaN == NaN -> false).

        assertNotEquals(

                new Builder().setMatrix(NAN_MATRIX).build(),

                new Builder().setMatrix(NAN_MATRIX).build());



        assertEquals(

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build(),

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build());

        assertNotEquals(

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        Float.NaN, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build(),

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build());

        assertNotEquals(

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build(),

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL2, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build());

        assertNotEquals(

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build(),

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP2,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build());

        assertNotEquals(

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build(),

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE2, INSERTION_MARKER_BOTOM1).build());

        assertNotEquals(

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build(),

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL2, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build());

        assertNotEquals(

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM1).build(),

                new Builder().setMatrix(MATRIX1).setInsertionMarkerLocation(

                        INSERTION_MARKER_HORIZONTAL1, INSERTION_MARKER_TOP1,

                        INSERTION_MARKER_BASELINE1, INSERTION_MARKER_BOTOM2).build());

    }



    @SmallTest

    public void testMatrixIsCopied() throws Exception {

        final Matrix MATRIX1 = new Matrix();