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

Commit 4551405b authored by Soonil Nagarkar's avatar Soonil Nagarkar
Browse files

Add Executor APIs to LocationManager 

Add executor support for all LM APIs and consolidate various GNSS
listeners. Also fixes some edge cases around multithreaded listener
callback delivery.

Bug: 136212299
Test: Manual
Change-Id: I2e863e41de846e739654362e859b58a5ed45c673
parent df801fcf

api/current.txt

+10 −4
Original line number Diff line number Diff line
@@ -23089,8 +23089,9 @@ package android.location { 














  public class LocationManager {















    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean addGpsStatusListener(android.location.GpsStatus.Listener);













    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean addNmeaListener(@NonNull android.location.OnNmeaMessageListener);













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean addNmeaListener(@NonNull android.location.OnNmeaMessageListener);















    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean addNmeaListener(@NonNull android.location.OnNmeaMessageListener, @Nullable android.os.Handler);













    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean addNmeaListener(@NonNull java.util.concurrent.Executor, @NonNull android.location.OnNmeaMessageListener);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void addProximityAlert(double, double, float, long, @NonNull android.app.PendingIntent);















    method public void addTestProvider(@NonNull String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, int, int);















    method @Deprecated public void clearTestProviderEnabled(@NonNull String);









@@ -23107,12 +23108,15 @@ package android.location {













    method @NonNull public java.util.List<java.lang.String> getProviders(@NonNull android.location.Criteria, boolean);















    method public boolean isLocationEnabled();















    method public boolean isProviderEnabled(@NonNull String);













    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssMeasurementsCallback(@NonNull android.location.GnssMeasurementsEvent.Callback);













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssMeasurementsCallback(@NonNull android.location.GnssMeasurementsEvent.Callback);















    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssMeasurementsCallback(@NonNull android.location.GnssMeasurementsEvent.Callback, @Nullable android.os.Handler);













    method public boolean registerGnssNavigationMessageCallback(@NonNull android.location.GnssNavigationMessage.Callback);













    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssMeasurementsCallback(@NonNull java.util.concurrent.Executor, @NonNull android.location.GnssMeasurementsEvent.Callback);













    method @Deprecated public boolean registerGnssNavigationMessageCallback(@NonNull android.location.GnssNavigationMessage.Callback);















    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssNavigationMessageCallback(@NonNull android.location.GnssNavigationMessage.Callback, @Nullable android.os.Handler);













    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssStatusCallback(@NonNull android.location.GnssStatus.Callback);













    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssNavigationMessageCallback(@NonNull java.util.concurrent.Executor, @NonNull android.location.GnssNavigationMessage.Callback);













    method @Deprecated @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssStatusCallback(@NonNull android.location.GnssStatus.Callback);















    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssStatusCallback(@NonNull android.location.GnssStatus.Callback, @Nullable android.os.Handler);













    method @RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION) public boolean registerGnssStatusCallback(@NonNull java.util.concurrent.Executor, @NonNull android.location.GnssStatus.Callback);















    method @Deprecated public void removeGpsStatusListener(android.location.GpsStatus.Listener);















    method public void removeNmeaListener(@NonNull android.location.OnNmeaMessageListener);















    method @RequiresPermission(anyOf={"android.permission.ACCESS_COARSE_LOCATION", "android.permission.ACCESS_FINE_LOCATION"}, apis="..22") public void removeProximityAlert(@NonNull android.app.PendingIntent);









@@ -23121,7 +23125,9 @@ package android.location {













    method public void removeUpdates(@NonNull android.app.PendingIntent);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull String, long, float, @NonNull android.location.LocationListener);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull String, long, float, @NonNull android.location.LocationListener, @Nullable android.os.Looper);













    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull String, long, float, @NonNull java.util.concurrent.Executor, @NonNull android.location.LocationListener);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(long, float, @NonNull android.location.Criteria, @NonNull android.location.LocationListener, @Nullable android.os.Looper);













    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(long, float, @NonNull android.location.Criteria, @NonNull java.util.concurrent.Executor, @NonNull android.location.LocationListener);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull String, long, float, @NonNull android.app.PendingIntent);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(long, float, @NonNull android.location.Criteria, @NonNull android.app.PendingIntent);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestSingleUpdate(@NonNull String, @NonNull android.location.LocationListener, @Nullable android.os.Looper);

























api/system-current.txt



+1
−0






























Original line number
Diff line number
Diff line








@@ -3430,6 +3430,7 @@ package android.location {













    method @RequiresPermission(android.Manifest.permission.READ_DEVICE_CONFIG) public boolean isProviderPackage(@NonNull String);















    method @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) public boolean registerGnssBatchedLocationCallback(long, boolean, @NonNull android.location.BatchedLocationCallback, @Nullable android.os.Handler);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull android.location.LocationRequest, @NonNull android.location.LocationListener, @Nullable android.os.Looper);













    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull android.location.LocationRequest, @NonNull java.util.concurrent.Executor, @NonNull android.location.LocationListener);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull android.location.LocationRequest, @NonNull android.app.PendingIntent);















    method @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) public void setExtraLocationControllerPackage(@Nullable String);















    method @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) public void setExtraLocationControllerPackageEnabled(boolean);

































api/test-current.txt



+1
−0






























Original line number
Diff line number
Diff line








@@ -1085,6 +1085,7 @@ package android.location {













    method @NonNull public String[] getIgnoreSettingsWhitelist();















    method @NonNull public java.util.List<android.location.LocationRequest> getTestProviderCurrentRequests(String);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull android.location.LocationRequest, @NonNull android.location.LocationListener, @Nullable android.os.Looper);













    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull android.location.LocationRequest, @NonNull java.util.concurrent.Executor, @NonNull android.location.LocationListener);















    method @RequiresPermission(anyOf={android.Manifest.permission.ACCESS_COARSE_LOCATION, android.Manifest.permission.ACCESS_FINE_LOCATION}) public void requestLocationUpdates(@NonNull android.location.LocationRequest, @NonNull android.app.PendingIntent);















    method @RequiresPermission(android.Manifest.permission.WRITE_SECURE_SETTINGS) public void setLocationEnabledForUser(boolean, @NonNull android.os.UserHandle);















  }

































config/hiddenapi-greylist.txt



+0
−1






























Original line number
Diff line number
Diff line








@@ -218,7 +218,6 @@ Landroid/location/ILocationManager$Stub$Proxy;-><init>(Landroid/os/IBinder;)V













Landroid/location/ILocationManager$Stub;->asInterface(Landroid/os/IBinder;)Landroid/location/ILocationManager;















Landroid/location/ILocationManager$Stub;->TRANSACTION_getAllProviders:I















Landroid/location/INetInitiatedListener$Stub;-><init>()V













Landroid/location/LocationManager$ListenerTransport;-><init>(Landroid/location/LocationManager;Landroid/location/LocationListener;Landroid/os/Looper;)V















Landroid/Manifest$permission;->CAPTURE_SECURE_VIDEO_OUTPUT:Ljava/lang/String;















Landroid/Manifest$permission;->CAPTURE_VIDEO_OUTPUT:Ljava/lang/String;















Landroid/Manifest$permission;->READ_FRAME_BUFFER:Ljava/lang/String;

































location/java/android/location/AbstractListenerManager.java
0 → 100644



+139
−0






























Original line number
Diff line number
Diff line













/*













 * Copyright (C) 2014 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.location;



























import android.annotation.NonNull;













import android.annotation.Nullable;













import android.os.Binder;













import android.os.Handler;













import android.os.HandlerExecutor;













import android.os.RemoteException;













import android.util.ArrayMap;



























import com.android.internal.annotations.GuardedBy;













import com.android.internal.util.Preconditions;



























import java.util.concurrent.Executor;













import java.util.function.Consumer;



























/**













 * A base class to manage listeners that have a 1:N -> source:listener relationship.













 *













 * @hide













 */













abstract class AbstractListenerManager<T> {



























    private static class Registration<T> {













        private final Executor mExecutor;













        @Nullable private volatile T mListener;



























        private Registration(Executor executor, T listener) {













            Preconditions.checkArgument(listener != null);













            Preconditions.checkArgument(executor != null);













            mExecutor = executor;













            mListener = listener;













        }



























        private void unregister() {













            mListener = null;













        }



























        private void execute(Consumer<T> operation) {













            mExecutor.execute(() -> {













                T listener = mListener;













                if (listener == null) {













                    return;













                }



























                // we may be under the binder identity if a direct executor is used













                long identity = Binder.clearCallingIdentity();













                try {













                    operation.accept(listener);













                } finally {













                    Binder.restoreCallingIdentity(identity);













                }













            });













        }













    }



























    @GuardedBy("mListeners")













    private final ArrayMap<Object, Registration<T>> mListeners = new ArrayMap<>();



























    public boolean addListener(@NonNull T listener, @NonNull Handler handler)













            throws RemoteException {













        return addInternal(listener, handler);













    }



























    public boolean addListener(@NonNull T listener, @NonNull Executor executor)













            throws RemoteException {













        return addInternal(listener, executor);













    }



























    protected final boolean addInternal(Object listener, Handler handler) throws RemoteException {













        return addInternal(listener, new HandlerExecutor(handler));













    }



























    protected final boolean addInternal(Object listener, Executor executor) throws RemoteException {













        return addInternal(listener, new Registration<>(executor, convertKey(listener)));













    }



























    private boolean addInternal(Object key, Registration<T> registration) throws RemoteException {













        Preconditions.checkNotNull(key);













        Preconditions.checkNotNull(registration);



























        synchronized (mListeners) {













            if (mListeners.isEmpty() && !registerService()) {













                return false;













            }













            Registration<T> oldRegistration = mListeners.put(key, registration);













            if (oldRegistration != null) {













                oldRegistration.unregister();













            }













            return true;













        }













    }



























    public void removeListener(Object listener) throws RemoteException {













        synchronized (mListeners) {













            Registration<T> oldRegistration = mListeners.remove(listener);













            if (oldRegistration == null) {













                return;













            }













            oldRegistration.unregister();



























            if (mListeners.isEmpty()) {













                unregisterService();













            }













        }













    }



























    @SuppressWarnings("unchecked")













    protected T convertKey(@NonNull Object listener) {













        return (T) listener;













    }



























    protected abstract boolean registerService() throws RemoteException;













    protected abstract void unregisterService() throws RemoteException;



























    protected void execute(Consumer<T> operation) {













        synchronized (mListeners) {













            for (Registration<T> registration : mListeners.values()) {













                registration.execute(operation);













            }













        }













    }













}