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

Commit 2756dd3d authored by Diego Vela's avatar Diego Vela
Browse files

Merge state producer and feature producer. 

Merge device state producer and display feature producer so that
FoldingFeature data has a single data pipeline. This should make it
easier to retrigger reading data if other signals are necessary.

Bug: 205342008
Test: manual - run sample app.
Change-Id: I7b66a45be8fcbb1a66d9aa8eab235d83877526ea
parent 30846638

libs/WindowManager/Jetpack/src/androidx/window/common/CommonFoldingFeature.java

+55 −9
Original line number Diff line number Diff line
@@ -21,11 +21,14 @@ import static androidx.window.util.ExtensionHelper.isZero; 
import android.annotation.IntDef;

import android.annotation.Nullable;

import android.graphics.Rect;

import android.util.Log;



import androidx.annotation.NonNull;



import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.util.ArrayList;

import java.util.List;

import java.util.Objects;

import java.util.regex.Matcher;

import java.util.regex.Pattern;
@@ -37,6 +40,10 @@ import java.util.regex.Pattern; 
 */

public final class CommonFoldingFeature {



    private static final boolean DEBUG = false;



    public static final String TAG = CommonFoldingFeature.class.getSimpleName();



    /**

     * A common type to represent a hinge where the screen is continuous.

     */
@@ -53,6 +60,12 @@ public final class CommonFoldingFeature { 
    public @interface Type {

    }



    /**

     * A common state to represent when the state is not known. One example is if the device is

     * closed. We do not emit this value for developers but is useful for implementation reasons.

     */

    public static final int COMMON_STATE_UNKNOWN = -1;



    /**

     * A common state to represent a FLAT hinge. This is needed because the definitions in Sidecar

     * and Extensions do not match exactly.
@@ -67,7 +80,7 @@ public final class CommonFoldingFeature { 
    /**

     * The possible states for a folding hinge.

     */

    @IntDef({COMMON_STATE_FLAT, COMMON_STATE_HALF_OPENED})

    @IntDef({COMMON_STATE_UNKNOWN, COMMON_STATE_FLAT, COMMON_STATE_HALF_OPENED})

    @Retention(RetentionPolicy.SOURCE)

    public @interface State {

    }
@@ -81,15 +94,49 @@ public final class CommonFoldingFeature { 
    private static final String PATTERN_STATE_FLAT = "flat";

    private static final String PATTERN_STATE_HALF_OPENED = "half-opened";



    /**

     * Parse a {@link List} of {@link CommonFoldingFeature} from a {@link String}.

     * @param value a {@link String} representation of multiple {@link CommonFoldingFeature}

     *              separated by a ":".

     * @param hingeState a global fallback value for a {@link CommonFoldingFeature} if one is not

     *                   specified in the input.

     * @throws IllegalArgumentException if the provided string is improperly formatted or could not

     * otherwise be parsed.

     * @see #FEATURE_PATTERN

     * @return {@link List} of {@link CommonFoldingFeature}.

     */

    static List<CommonFoldingFeature> parseListFromString(@NonNull String value,

            @State int hingeState) {

        List<CommonFoldingFeature> features = new ArrayList<>();

        String[] featureStrings =  value.split(";");

        for (String featureString : featureStrings) {

            CommonFoldingFeature feature;

            try {

                feature = CommonFoldingFeature.parseFromString(featureString, hingeState);

            } catch (IllegalArgumentException e) {

                if (DEBUG) {

                    Log.w(TAG, "Failed to parse display feature: " + featureString, e);

                }

                continue;

            }

            features.add(feature);

        }

        return features;

    }



    /**

     * Parses a display feature from a string.

     *

     * @param string A {@link String} representation of a {@link CommonFoldingFeature}.

     * @param hingeState A fallback value for the {@link State} if it is not specified in the input.

     * @throws IllegalArgumentException if the provided string is improperly formatted or could not

     *                                  otherwise be parsed.

     * @return {@link CommonFoldingFeature} represented by the {@link String} value.

     * @see #FEATURE_PATTERN

     */

    @NonNull

    static CommonFoldingFeature parseFromString(@NonNull String string) {

    private static CommonFoldingFeature parseFromString(@NonNull String string,

            @State int hingeState) {

        Matcher featureMatcher = FEATURE_PATTERN.matcher(string);

        if (!featureMatcher.matches()) {

            throw new IllegalArgumentException("Malformed feature description format: " + string);
@@ -120,7 +167,7 @@ public final class CommonFoldingFeature { 
            }

            String stateString = featureMatcher.group(6);

            stateString = stateString == null ? "" : stateString;

            Integer state;

            final int state;

            switch (stateString) {

                case PATTERN_STATE_FLAT:

                    state = COMMON_STATE_FLAT;
@@ -129,7 +176,7 @@ public final class CommonFoldingFeature { 
                    state = COMMON_STATE_HALF_OPENED;

                    break;

                default:

                    state = null;

                    state = hingeState;

                    break;

            }

            return new CommonFoldingFeature(type, state, featureRect);
@@ -140,11 +187,11 @@ public final class CommonFoldingFeature { 


    private final int mType;

    @Nullable

    private final Integer mState;

    private final int mState;

    @NonNull

    private final Rect mRect;



    CommonFoldingFeature(int type, @Nullable Integer state, @NonNull Rect rect) {

    CommonFoldingFeature(int type, int state, @NonNull Rect rect) {

        assertValidState(state);

        this.mType = type;

        this.mState = state;
@@ -161,10 +208,9 @@ public final class CommonFoldingFeature { 
        return mType;

    }



    /** Returns the state of the feature, or {@code null} if the feature has no state. */

    @Nullable

    /** Returns the state of the feature.*/

    @State

    public Integer getState() {

    public int getState() {

        return mState;

    }

libs/WindowManager/Jetpack/src/androidx/window/common/DeviceStateManagerPostureProducer.java→libs/WindowManager/Jetpack/src/androidx/window/common/DeviceStateManagerFoldingFeatureProducer.java

+24 −6
Original line number Diff line number Diff line
@@ -18,11 +18,15 @@ package androidx.window.common; 


import static android.hardware.devicestate.DeviceStateManager.INVALID_DEVICE_STATE;



import static androidx.window.common.CommonFoldingFeature.COMMON_STATE_UNKNOWN;

import static androidx.window.common.CommonFoldingFeature.parseListFromString;



import android.annotation.NonNull;

import android.annotation.Nullable;

import android.content.Context;

import android.hardware.devicestate.DeviceStateManager;

import android.hardware.devicestate.DeviceStateManager.DeviceStateCallback;

import android.text.TextUtils;

import android.util.Log;

import android.util.SparseIntArray;
@@ -30,6 +34,7 @@ import androidx.window.util.BaseDataProducer; 


import com.android.internal.R;



import java.util.List;

import java.util.Optional;



/**
@@ -37,10 +42,13 @@ import java.util.Optional; 
 * by mapping the state returned from {@link DeviceStateManager} to values provided in the resources

 * config at {@link R.array#config_device_state_postures}.

 */

public final class DeviceStateManagerPostureProducer extends BaseDataProducer<Integer> {

    private static final String TAG = "ConfigDevicePostureProducer";

public final class DeviceStateManagerFoldingFeatureProducer extends

        BaseDataProducer<List<CommonFoldingFeature>> {

    private static final String TAG =

            DeviceStateManagerFoldingFeatureProducer.class.getSimpleName();

    private static final boolean DEBUG = false;



    private final Context mContext;

    private final SparseIntArray mDeviceStateToPostureMap = new SparseIntArray();



    private int mCurrentDeviceState = INVALID_DEVICE_STATE;
@@ -50,7 +58,8 @@ public final class DeviceStateManagerPostureProducer extends BaseDataProducer<In 
        notifyDataChanged();

    };



    public DeviceStateManagerPostureProducer(@NonNull Context context) {

    public DeviceStateManagerFoldingFeatureProducer(@NonNull Context context) {

        mContext = context;

        String[] deviceStatePosturePairs = context.getResources()

                .getStringArray(R.array.config_device_state_postures);

        for (String deviceStatePosturePair : deviceStatePosturePairs) {
@@ -86,8 +95,17 @@ public final class DeviceStateManagerPostureProducer extends BaseDataProducer<In 


    @Override

    @Nullable

    public Optional<Integer> getData() {

        final int posture = mDeviceStateToPostureMap.get(mCurrentDeviceState, -1);

        return posture != -1 ? Optional.of(posture) : Optional.empty();

    public Optional<List<CommonFoldingFeature>> getData() {

        final int globalHingeState = globalHingeState();

        String displayFeaturesString = mContext.getResources().getString(

                R.string.config_display_features);

        if (TextUtils.isEmpty(displayFeaturesString)) {

            return Optional.empty();

        }

        return Optional.of(parseListFromString(displayFeaturesString, globalHingeState));

    }



    private int globalHingeState() {

        return mDeviceStateToPostureMap.get(mCurrentDeviceState, COMMON_STATE_UNKNOWN);

    }

}

libs/WindowManager/Jetpack/src/androidx/window/common/ResourceConfigDisplayFeatureProducer.java

deleted100644 → 0
+0 −74
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2021 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 androidx.window.common;



import android.annotation.NonNull;

import android.annotation.Nullable;

import android.content.Context;

import android.text.TextUtils;

import android.util.Log;



import androidx.window.util.BaseDataProducer;



import com.android.internal.R;



import java.util.ArrayList;

import java.util.List;

import java.util.Optional;



/**

 * Implementation of {@link androidx.window.util.DataProducer} that produces

 * {@link CommonFoldingFeature} parsed from a string stored in the resources config at

 * {@link R.string#config_display_features}.

 */

public final class ResourceConfigDisplayFeatureProducer extends

        BaseDataProducer<List<CommonFoldingFeature>> {

    private static final boolean DEBUG = false;

    private static final String TAG = "ResourceConfigDisplayFeatureProducer";



    private final Context mContext;



    public ResourceConfigDisplayFeatureProducer(@NonNull Context context) {

        mContext = context;

    }



    @Override

    @Nullable

    public Optional<List<CommonFoldingFeature>> getData() {

        String displayFeaturesString = mContext.getResources().getString(

                R.string.config_display_features);

        if (TextUtils.isEmpty(displayFeaturesString)) {

            return Optional.empty();

        }



        List<CommonFoldingFeature> features = new ArrayList<>();

        String[] featureStrings =  displayFeaturesString.split(";");

        for (String featureString : featureStrings) {

            CommonFoldingFeature feature;

            try {

                feature = CommonFoldingFeature.parseFromString(featureString);

            } catch (IllegalArgumentException e) {

                if (DEBUG) {

                    Log.w(TAG, "Failed to parse display feature: " + featureString, e);

                }

                continue;

            }

            features.add(feature);

        }

        return Optional.of(features);

    }

}

libs/WindowManager/Jetpack/src/androidx/window/common/SettingsDevicePostureProducer.java

deleted100644 → 0
+0 −96
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2021 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 androidx.window.common;



import android.annotation.NonNull;

import android.annotation.Nullable;

import android.content.ContentResolver;

import android.content.Context;

import android.database.ContentObserver;

import android.net.Uri;

import android.os.Handler;

import android.os.Looper;

import android.provider.Settings;



import androidx.window.util.BaseDataProducer;



import java.util.Optional;



/**

 * Implementation of {@link androidx.window.util.DataProducer} that provides the device posture

 * as an {@link Integer} from a value stored in {@link Settings}.

 */

public final class SettingsDevicePostureProducer extends BaseDataProducer<Integer> {

    private static final String DEVICE_POSTURE = "device_posture";



    private final Uri mDevicePostureUri =

            Settings.Global.getUriFor(DEVICE_POSTURE);



    private final ContentResolver mResolver;

    private final ContentObserver mObserver;

    private boolean mRegisteredObservers;



    public SettingsDevicePostureProducer(@NonNull Context context) {

        mResolver = context.getContentResolver();

        mObserver = new SettingsObserver();

    }



    @Override

    @Nullable

    public Optional<Integer> getData() {

        int posture = Settings.Global.getInt(mResolver, DEVICE_POSTURE, -1);

        return posture == -1 ? Optional.empty() : Optional.of(posture);

    }



    /**

     * Registers settings observers, if needed. When settings observers are registered for this

     * producer callbacks for changes in data will be triggered.

     */

    public void registerObserversIfNeeded() {

        if (mRegisteredObservers) {

            return;

        }

        mRegisteredObservers = true;

        mResolver.registerContentObserver(mDevicePostureUri, false /* notifyForDescendants */,

                mObserver /* ContentObserver */);

    }



    /**

     * Unregisters settings observers, if needed. When settings observers are unregistered for this

     * producer callbacks for changes in data will not be triggered.

     */

    public void unregisterObserversIfNeeded() {

        if (!mRegisteredObservers) {

            return;

        }

        mRegisteredObservers = false;

        mResolver.unregisterContentObserver(mObserver);

    }



    private final class SettingsObserver extends ContentObserver {

        SettingsObserver() {

            super(new Handler(Looper.getMainLooper()));

        }



        @Override

        public void onChange(boolean selfChange, Uri uri) {

            if (mDevicePostureUri.equals(uri)) {

                notifyDataChanged();

            }

        }

    }

}

libs/WindowManager/Jetpack/src/androidx/window/common/SettingsDisplayFeatureProducer.java

+7 −23
Original line number Diff line number Diff line
@@ -16,8 +16,10 @@ 


package androidx.window.common;



import static androidx.window.common.CommonFoldingFeature.COMMON_STATE_UNKNOWN;

import static androidx.window.common.CommonFoldingFeature.parseListFromString;



import android.annotation.NonNull;

import android.annotation.Nullable;

import android.content.ContentResolver;

import android.content.Context;

import android.database.ContentObserver;
@@ -26,11 +28,10 @@ import android.os.Handler; 
import android.os.Looper;

import android.provider.Settings;

import android.text.TextUtils;

import android.util.Log;



import androidx.window.util.BaseDataProducer;



import java.util.ArrayList;

import java.util.Collections;

import java.util.List;

import java.util.Optional;
@@ -40,8 +41,6 @@ import java.util.Optional; 
 */

public final class SettingsDisplayFeatureProducer

        extends BaseDataProducer<List<CommonFoldingFeature>> {

    private static final boolean DEBUG = false;

    private static final String TAG = "SettingsDisplayFeatureProducer";

    private static final String DISPLAY_FEATURES = "display_features";



    private final Uri mDisplayFeaturesUri =
@@ -57,32 +56,17 @@ public final class SettingsDisplayFeatureProducer 
    }



    @Override

    @Nullable

    @NonNull

    public Optional<List<CommonFoldingFeature>> getData() {

        String displayFeaturesString = Settings.Global.getString(mResolver, DISPLAY_FEATURES);

        if (displayFeaturesString == null) {

            return Optional.empty();

        }



        List<CommonFoldingFeature> features = new ArrayList<>();

        if (TextUtils.isEmpty(displayFeaturesString)) {

            return Optional.of(features);

        }

        String[] featureStrings =  displayFeaturesString.split(";");



        for (String featureString : featureStrings) {

            CommonFoldingFeature feature;

            try {

                feature = CommonFoldingFeature.parseFromString(featureString);

            } catch (IllegalArgumentException e) {

                if (DEBUG) {

                    Log.w(TAG, "Failed to parse display feature: " + featureString, e);

                }

                continue;

            }

            features.add(feature);

            return Optional.of(Collections.emptyList());

        }

        return Optional.of(features);

        return Optional.of(parseListFromString(displayFeaturesString, COMMON_STATE_UNKNOWN));

    }



    /**