android-35/android/window/InputTransferToken.java

/*
 * Copyright (C) 2024 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 android.window;

import android.annotation.FlaggedApi;
import android.annotation.NonNull;
import android.os.IBinder;
import android.os.Looper;
import android.os.Parcel;
import android.os.Parcelable;
import android.view.Choreographer;
import android.view.SurfaceControl;
import android.view.SurfaceControlInputReceiver;
import android.view.SurfaceControlViewHost;

import com.android.window.flags.Flags;

import libcore.util.NativeAllocationRegistry;

import java.util.Objects;

/**
 * A token that can be used to request focus on or to transfer touch gesture to a
 * {@link SurfaceControlViewHost} or {@link android.view.SurfaceControl} that has an input channel.
 * <p>
 * The {@link android.view.SurfaceControl} needs to have been registered for input via
 * {@link android.view.WindowManager#registerUnbatchedSurfaceControlInputReceiver(
 * InputTransferToken, SurfaceControl, Looper, SurfaceControlInputReceiver)} or
 * {@link android.view.WindowManager#registerBatchedSurfaceControlInputReceiver(
 * InputTransferToken, SurfaceControl, Choreographer, SurfaceControlInputReceiver)} and the
 * returned token can be used to call
 * {@link android.view.WindowManager#transferTouchGesture(InputTransferToken, InputTransferToken)}
 * <p>
 * For {@link SurfaceControlViewHost}, the token can be retrieved via
 * {@link SurfaceControlViewHost.SurfacePackage#getInputTransferToken()}
 *
 * @see android.view.WindowManager#transferTouchGesture(InputTransferToken, InputTransferToken)
 */
@FlaggedApi(Flags.FLAG_SURFACE_CONTROL_INPUT_RECEIVER)
public final class InputTransferToken implements Parcelable {
    private static native long nativeCreate();
    private static native long nativeCreate(IBinder token);
    private static native void nativeWriteToParcel(long nativeObject, Parcel out);
    private static native long nativeReadFromParcel(Parcel in);
    private static native IBinder nativeGetBinderToken(long nativeObject);
    private static native long nativeGetBinderTokenRef(long nativeObject);
    private static native long nativeGetNativeInputTransferTokenFinalizer();
    private static native boolean nativeEquals(long nativeObject1, long nativeObject2);

    private static final NativeAllocationRegistry sRegistry =
            NativeAllocationRegistry.createMalloced(InputTransferToken.class.getClassLoader(),
                    nativeGetNativeInputTransferTokenFinalizer());

    /**
     * @hide
     */
    public final long mNativeObject;

    private InputTransferToken(long nativeObject) {
        mNativeObject = nativeObject;
        sRegistry.registerNativeAllocation(this, nativeObject);
    }

    /**
     * @hide
     */
    public InputTransferToken(@NonNull IBinder token) {
        this(nativeCreate(token));
    }

    /**
     * @hide
     */
    public InputTransferToken() {
        this(nativeCreate());
    }

    /**
     * @hide
     */
    public IBinder getToken() {
        return nativeGetBinderToken(mNativeObject);
    }

    private InputTransferToken(Parcel in) {
        this(nativeReadFromParcel(in));
    }

    /**
     * @hide
     */
    @Override
    public int describeContents() {
        return 0;
    }

    /**
     * @hide
     */
    @Override
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        nativeWriteToParcel(mNativeObject, dest);
    }

    public static final @NonNull Creator<InputTransferToken> CREATOR = new Creator<>() {
        public InputTransferToken createFromParcel(Parcel in) {
            return new InputTransferToken(in);
        }

        public InputTransferToken[] newArray(int size) {
            return new InputTransferToken[size];
        }
    };

    /**
     * @hide
     */
    @Override
    public int hashCode() {
        return Objects.hash(nativeGetBinderTokenRef(mNativeObject));
    }

    /**
     * @hide
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null || getClass() != obj.getClass()) return false;
        InputTransferToken other = (InputTransferToken) obj;
        if (other.mNativeObject == mNativeObject) return true;
        return nativeEquals(mNativeObject, other.mNativeObject);
    }

}