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

Commit a42e8efc authored by Christian Göllner's avatar Christian Göllner
Browse files

Create API for WM to send letterbox info to SysUI. 

+ Creates a new LetterboxDetails parcelable class
+ Adds LetterboxDetails as a parameter to IStatusBar#onSystemBarAttributesChanged

Test: Manually by checking that the device works without crashing
Fixes: 236829652
Change-Id: Ib4e615f6e4eb44d0fc4fb753b27a04b908e7bd24
parent 15456ce9

core/java/com/android/internal/statusbar/IStatusBar.aidl

+4 −1
Original line number Diff line number Diff line
@@ -33,6 +33,7 @@ import android.view.InsetsVisibilities; 


import com.android.internal.statusbar.IAddTileResultCallback;

import com.android.internal.statusbar.IUndoMediaTransferCallback;

import com.android.internal.statusbar.LetterboxDetails;

import com.android.internal.statusbar.StatusBarIcon;

import com.android.internal.view.AppearanceRegion;
@@ -202,10 +203,12 @@ oneway interface IStatusBar 
     * @param behavior the behavior of the focused window.

     * @param requestedVisibilities the collection of the requested visibilities of system insets.

     * @param packageName the package name of the focused app.

     * @param letterboxDetails a set of letterbox details of apps visible on the screen.

     */

    void onSystemBarAttributesChanged(int displayId, int appearance,

            in AppearanceRegion[] appearanceRegions, boolean navbarColorManagedByIme,

            int behavior, in InsetsVisibilities requestedVisibilities, String packageName);

            int behavior, in InsetsVisibilities requestedVisibilities, String packageName,

            in LetterboxDetails[] letterboxDetails);



    /**

     * Notifies System UI to show transient bars. The transient bars are system bars, e.g., status

core/java/com/android/internal/statusbar/LetterboxDetails.aidl

0 → 100644
+19 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.internal.statusbar;



parcelable LetterboxDetails;

core/java/com/android/internal/statusbar/LetterboxDetails.java

0 → 100644
+243 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.internal.statusbar;



import android.annotation.NonNull;

import android.annotation.Nullable;

import android.graphics.Rect;

import android.os.Parcel;

import android.os.Parcelable;

import android.view.InsetsFlags;

import android.view.ViewDebug;

import android.view.WindowInsetsController.Appearance;



import com.android.internal.util.DataClass;



/**

 * Details about the letterbox state of an app.

 */

@DataClass(

        genParcelable = true,

        genAidl = true,

        genToString = true,

        genGetters = false,

        genEqualsHashCode = true

)

public class LetterboxDetails implements Parcelable {



    @NonNull

    private final Rect mLetterboxInnerBounds;

    @NonNull

    private final Rect mLetterboxFullBounds;

    private final int mAppAppearance;



    /**

     * Returns the bounds of the inner letterbox (app content).

     *

     * <p>When an app is letterboxed, it is not using the full bounds of its window. Here we return

     * the bounds that are being used for the app content.

     *

     * <pre>

     * +-------+---------+-------+

     * |       |         |       |

     * |       |         |       |

     * | Outer |  Inner  | Outer |

     * |       |         |       |

     * |       |         |       |

     * +-------+-------- +-------+

     * <pre>

     */

    @NonNull

    public Rect getLetterboxInnerBounds() {

        return mLetterboxInnerBounds;

    }



    /**

     * Returns the full bounds of the letterbox.

     *

     * <p>These are the entire bounds of the window where the app is placed. We cannot assume that

     * the full bounds are the bounds of the screen, as the app can be in split-screen, or can have

     * some margin due to display cutouts.

     *

     * <pre>

     * ---- Full bounds width ----

     * +-------+---------+-------+ |

     * |       |         |       | |

     * |       |         |       | |

     * | Outer |  Inner  | Outer | + Full bounds height

     * |       |         |       | |

     * |       |         |       | |

     * +-------+-------- +-------+ |

     * </pre>

     */

    @NonNull

    public Rect getLetterboxFullBounds() {

        return mLetterboxFullBounds;

    }



    /**

     * Returns the {@link Appearance} of the inner letterbox (app content).

     */

    @Appearance

    public int getAppAppearance() {

        return mAppAppearance;

    }



    /** Returns a string representation of the {@link #getAppAppearance()} property. */

    public String appAppearanceToString() {

        return ViewDebug.flagsToString(InsetsFlags.class, "appearance", mAppAppearance);

    }







    // Code below generated by codegen v1.0.23.

    //

    // DO NOT MODIFY!

    // CHECKSTYLE:OFF Generated code

    //

    // To regenerate run:

    // $ codegen $ANDROID_BUILD_TOP/frameworks/base/core/java/com/android/internal/statusbar/LetterboxDetails.java

    //

    // To exclude the generated code from IntelliJ auto-formatting enable (one-time):

    //   Settings > Editor > Code Style > Formatter Control

    //@formatter:off





    @DataClass.Generated.Member

    public LetterboxDetails(

            @NonNull Rect letterboxInnerBounds,

            @NonNull Rect letterboxFullBounds,

            int appAppearance) {

        this.mLetterboxInnerBounds = letterboxInnerBounds;

        com.android.internal.util.AnnotationValidations.validate(

                NonNull.class, null, mLetterboxInnerBounds);

        this.mLetterboxFullBounds = letterboxFullBounds;

        com.android.internal.util.AnnotationValidations.validate(

                NonNull.class, null, mLetterboxFullBounds);

        this.mAppAppearance = appAppearance;



        // onConstructed(); // You can define this method to get a callback

    }



    @Override

    @DataClass.Generated.Member

    public String toString() {

        // You can override field toString logic by defining methods like:

        // String fieldNameToString() { ... }



        return "LetterboxDetails { " +

                "letterboxInnerBounds = " + mLetterboxInnerBounds + ", " +

                "letterboxFullBounds = " + mLetterboxFullBounds + ", " +

                "appAppearance = " + appAppearanceToString() +

        " }";

    }



    @Override

    @DataClass.Generated.Member

    public boolean equals(@Nullable Object o) {

        // You can override field equality logic by defining either of the methods like:

        // boolean fieldNameEquals(LetterboxDetails other) { ... }

        // boolean fieldNameEquals(FieldType otherValue) { ... }



        if (this == o) return true;

        if (o == null || getClass() != o.getClass()) return false;

        @SuppressWarnings("unchecked")

        LetterboxDetails that = (LetterboxDetails) o;

        //noinspection PointlessBooleanExpression

        return true

                && java.util.Objects.equals(mLetterboxInnerBounds, that.mLetterboxInnerBounds)

                && java.util.Objects.equals(mLetterboxFullBounds, that.mLetterboxFullBounds)

                && mAppAppearance == that.mAppAppearance;

    }



    @Override

    @DataClass.Generated.Member

    public int hashCode() {

        // You can override field hashCode logic by defining methods like:

        // int fieldNameHashCode() { ... }



        int _hash = 1;

        _hash = 31 * _hash + java.util.Objects.hashCode(mLetterboxInnerBounds);

        _hash = 31 * _hash + java.util.Objects.hashCode(mLetterboxFullBounds);

        _hash = 31 * _hash + mAppAppearance;

        return _hash;

    }



    @Override

    @DataClass.Generated.Member

    public void writeToParcel(@NonNull Parcel dest, int flags) {

        // You can override field parcelling by defining methods like:

        // void parcelFieldName(Parcel dest, int flags) { ... }



        dest.writeTypedObject(mLetterboxInnerBounds, flags);

        dest.writeTypedObject(mLetterboxFullBounds, flags);

        dest.writeInt(mAppAppearance);

    }



    @Override

    @DataClass.Generated.Member

    public int describeContents() { return 0; }



    /** @hide */

    @SuppressWarnings({"unchecked", "RedundantCast"})

    @DataClass.Generated.Member

    protected LetterboxDetails(@NonNull Parcel in) {

        // You can override field unparcelling by defining methods like:

        // static FieldType unparcelFieldName(Parcel in) { ... }



        Rect letterboxInnerBounds = (Rect) in.readTypedObject(Rect.CREATOR);

        Rect letterboxFullBounds = (Rect) in.readTypedObject(Rect.CREATOR);

        int appAppearance = in.readInt();



        this.mLetterboxInnerBounds = letterboxInnerBounds;

        com.android.internal.util.AnnotationValidations.validate(

                NonNull.class, null, mLetterboxInnerBounds);

        this.mLetterboxFullBounds = letterboxFullBounds;

        com.android.internal.util.AnnotationValidations.validate(

                NonNull.class, null, mLetterboxFullBounds);

        this.mAppAppearance = appAppearance;



        // onConstructed(); // You can define this method to get a callback

    }



    @DataClass.Generated.Member

    public static final @NonNull Parcelable.Creator<LetterboxDetails> CREATOR

            = new Parcelable.Creator<LetterboxDetails>() {

        @Override

        public LetterboxDetails[] newArray(int size) {

            return new LetterboxDetails[size];

        }



        @Override

        public LetterboxDetails createFromParcel(@NonNull Parcel in) {

            return new LetterboxDetails(in);

        }

    };



    @DataClass.Generated(

            time = 1656941109526L,

            codegenVersion = "1.0.23",

            sourceFile = "frameworks/base/core/java/com/android/internal/statusbar/LetterboxDetails.java",

            inputSignatures = "private final @android.annotation.NonNull android.graphics.Rect mLetterboxInnerBounds\nprivate final @android.annotation.NonNull android.graphics.Rect mLetterboxFullBounds\nprivate final  int mAppAppearance\npublic @android.annotation.NonNull android.graphics.Rect getLetterboxInnerBounds()\npublic @android.annotation.NonNull android.graphics.Rect getLetterboxFullBounds()\npublic @android.view.WindowInsetsController.Appearance int getAppAppearance()\npublic  java.lang.String appAppearanceToString()\nclass LetterboxDetails extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genParcelable=true, genAidl=true, genToString=true, genGetters=false, genEqualsHashCode=true)")

    @Deprecated

    private void __metadata() {}





    //@formatter:on

    // End of generated code



}

core/java/com/android/internal/statusbar/RegisterStatusBarResult.java

+9 −2
Original line number Diff line number Diff line
@@ -43,12 +43,14 @@ public final class RegisterStatusBarResult implements Parcelable { 
    public final InsetsVisibilities mRequestedVisibilities;

    public final String mPackageName;

    public final int[] mTransientBarTypes;

    public final LetterboxDetails[] mLetterboxDetails;



    public RegisterStatusBarResult(ArrayMap<String, StatusBarIcon> icons, int disabledFlags1,

            int appearance, AppearanceRegion[] appearanceRegions, int imeWindowVis,

            int imeBackDisposition, boolean showImeSwitcher, int disabledFlags2, IBinder imeToken,

            boolean navbarColorManagedByIme, int behavior, InsetsVisibilities requestedVisibilities,

            String packageName, @NonNull int[] transientBarTypes) {

            String packageName, @NonNull int[] transientBarTypes,

            LetterboxDetails[] letterboxDetails) {

        mIcons = new ArrayMap<>(icons);

        mDisabledFlags1 = disabledFlags1;

        mAppearance = appearance;
@@ -63,6 +65,7 @@ public final class RegisterStatusBarResult implements Parcelable { 
        mRequestedVisibilities = requestedVisibilities;

        mPackageName = packageName;

        mTransientBarTypes = transientBarTypes;

        mLetterboxDetails = letterboxDetails;

    }



    @Override
@@ -86,6 +89,7 @@ public final class RegisterStatusBarResult implements Parcelable { 
        dest.writeTypedObject(mRequestedVisibilities, 0);

        dest.writeString(mPackageName);

        dest.writeIntArray(mTransientBarTypes);

        dest.writeParcelableArray(mLetterboxDetails, flags);

    }



    /**
@@ -112,10 +116,13 @@ public final class RegisterStatusBarResult implements Parcelable { 
                            source.readTypedObject(InsetsVisibilities.CREATOR);

                    final String packageName = source.readString();

                    final int[] transientBarTypes = source.createIntArray();

                    final LetterboxDetails[] letterboxDetails =

                            source.readParcelableArray(null, LetterboxDetails.class);

                    return new RegisterStatusBarResult(icons, disabledFlags1, appearance,

                            appearanceRegions, imeWindowVis, imeBackDisposition, showImeSwitcher,

                            disabledFlags2, imeToken, navbarColorManagedByIme, behavior,

                            requestedVisibilities, packageName, transientBarTypes);

                            requestedVisibilities, packageName, transientBarTypes,

                            letterboxDetails);

                }



                @Override

core/tests/coretests/src/com/android/internal/statusbar/RegisterStatusBarResultTest.java

+9 −2
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@ import static android.view.WindowInsetsController.BEHAVIOR_SHOW_TRANSIENT_BARS_B 


import static com.google.common.truth.Truth.assertThat;



import android.graphics.Rect;

import android.os.Binder;

import android.os.Parcel;

import android.os.UserHandle;
@@ -48,7 +49,11 @@ public class RegisterStatusBarResultTest { 
        final ArrayMap<String, StatusBarIcon> iconMap = new ArrayMap<>();

        iconMap.put(dumyIconKey, new StatusBarIcon("com.android.internal.statusbar.test",

                UserHandle.of(100), 123, 1, 2, "dummyIconDescription"));



        final LetterboxDetails letterboxDetails = new LetterboxDetails(

                /* letterboxInnerBounds= */ new Rect(1, 2, 3, 4),

                /* letterboxFullBounds= */ new Rect(5, 6, 7, 8),

                /* appAppearance= */ 321

        );

        final RegisterStatusBarResult original = new RegisterStatusBarResult(iconMap,

                0x2 /* disabledFlags1 */,

                0x4 /* appearance */,
@@ -62,7 +67,8 @@ public class RegisterStatusBarResultTest { 
                BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE,

                new InsetsVisibilities() /* requestedVisibilities */,

                "test" /* packageName */,

                new int[0] /* transientBarTypes */);

                new int[0] /* transientBarTypes */,

                new LetterboxDetails[] {letterboxDetails});



        final RegisterStatusBarResult copy = clone(original);
@@ -84,6 +90,7 @@ public class RegisterStatusBarResultTest { 
        assertThat(copy.mRequestedVisibilities).isEqualTo(original.mRequestedVisibilities);

        assertThat(copy.mPackageName).isEqualTo(original.mPackageName);

        assertThat(copy.mTransientBarTypes).isEqualTo(original.mTransientBarTypes);

        assertThat(copy.mLetterboxDetails).isEqualTo(original.mLetterboxDetails);

    }



    private RegisterStatusBarResult clone(RegisterStatusBarResult original) {