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

Commit 351e7dcd authored by Caitlin Cassidy's avatar Caitlin Cassidy
Browse files

[Status Bar Refactor] Improvements to StatusBarIconList: 

1. Instead of StatusBarIconControllerImpl extending StatusBarIconList,
   just have the icon list as a private member variable.
2. Stop exposing slot indices from StatusBarIconList. External clients
   can always use the slot name instead, so we can keep the indices
   private.

Test: atest StatusBarIconListTest
Bug: 237533036
Change-Id: I811481558ba16f475bdff36c1b1b2b0501aa1216
parent f0d57a31

packages/SystemUI/src/com/android/systemui/statusbar/dagger/CentralSurfacesDependenciesModule.java

+11 −0
Original line number Diff line number Diff line
@@ -68,6 +68,7 @@ import com.android.systemui.statusbar.phone.ManagedProfileController; 
import com.android.systemui.statusbar.phone.ManagedProfileControllerImpl;

import com.android.systemui.statusbar.phone.StatusBarIconController;

import com.android.systemui.statusbar.phone.StatusBarIconControllerImpl;

import com.android.systemui.statusbar.phone.StatusBarIconList;

import com.android.systemui.statusbar.phone.StatusBarRemoteInputCallback;

import com.android.systemui.statusbar.phone.ongoingcall.OngoingCallController;

import com.android.systemui.statusbar.phone.ongoingcall.OngoingCallFlags;
@@ -252,6 +253,16 @@ public interface CentralSurfacesDependenciesModule { 
    StatusBarIconController provideStatusBarIconController(

            StatusBarIconControllerImpl controllerImpl);



    /**

     */

    @Provides

    @SysUISingleton

    static StatusBarIconList provideStatusBarIconList(Context context) {

        return new StatusBarIconList(

                context.getResources().getStringArray(

                        com.android.internal.R.array.config_statusBarIcons));

    }



    /**

     */

    @Provides

packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBarIconControllerImpl.java

+52 −84
Original line number Diff line number Diff line
@@ -16,6 +16,8 @@ 


package com.android.systemui.statusbar.phone;



import static com.android.systemui.statusbar.phone.StatusBarIconList.Slot;



import android.annotation.NonNull;

import android.content.Context;

import android.graphics.drawable.Icon;
@@ -56,11 +58,12 @@ import javax.inject.Inject; 
 * registered with it.

 */

@SysUISingleton

public class StatusBarIconControllerImpl extends StatusBarIconList implements Tunable,

public class StatusBarIconControllerImpl implements Tunable,

        ConfigurationListener, Dumpable, CommandQueue.Callbacks, StatusBarIconController, DemoMode {



    private static final String TAG = "StatusBarIconController";



    private final StatusBarIconList mStatusBarIconList;

    private final ArrayList<IconManager> mIconGroups = new ArrayList<>();

    private final ArraySet<String> mIconHideList = new ArraySet<>();
@@ -74,15 +77,12 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
            DemoModeController demoModeController,

            ConfigurationController configurationController,

            TunerService tunerService,

            DumpManager dumpManager) {

        super(context.getResources().getStringArray(

                com.android.internal.R.array.config_statusBarIcons));

        configurationController.addCallback(this);



            DumpManager dumpManager,

            StatusBarIconList statusBarIconList) {

        mStatusBarIconList = statusBarIconList;

        mContext = context;



        loadDimens();



        configurationController.addCallback(this);

        commandQueue.addCallback(this);

        tunerService.addTunable(this, ICON_HIDE_LIST);

        demoModeController.addCallback(this);
@@ -101,15 +101,14 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 


        group.setController(this);

        mIconGroups.add(group);

        List<Slot> allSlots = getSlots();

        List<Slot> allSlots = mStatusBarIconList.getSlots();

        for (int i = 0; i < allSlots.size(); i++) {

            Slot slot = allSlots.get(i);

            List<StatusBarIconHolder> holders = slot.getHolderListInViewOrder();

            boolean hidden = mIconHideList.contains(slot.getName());



            for (StatusBarIconHolder holder : holders) {

                int tag = holder.getTag();

                int viewIndex = getViewIndex(getSlotIndex(slot.getName()), holder.getTag());

                int viewIndex = mStatusBarIconList.getViewIndex(slot.getName(), holder.getTag());

                group.onIconAdded(viewIndex, slot.getName(), hidden, holder);

            }

        }
@@ -144,7 +143,7 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
        }

        mIconHideList.clear();

        mIconHideList.addAll(StatusBarIconController.getIconHideList(mContext, newValue));

        ArrayList<Slot> currentSlots = getSlots();

        List<Slot> currentSlots = mStatusBarIconList.getSlots();

        ArrayMap<Slot, List<StatusBarIconHolder>> slotsToReAdd = new ArrayMap<>();



        // This is a little hacky... Peel off all of the holders on all of the slots
@@ -163,17 +162,13 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
            List<StatusBarIconHolder> iconsForSlot = slotsToReAdd.get(item);

            if (iconsForSlot == null) continue;

            for (StatusBarIconHolder holder : iconsForSlot) {

                setIcon(getSlotIndex(item.getName()), holder);

            }

                setIcon(item.getName(), holder);

            }

        }



    private void loadDimens() {

    }



    private void addSystemIcon(int index, StatusBarIconHolder holder) {

        String slot = getSlotName(index);

        int viewIndex = getViewIndex(index, holder.getTag());

    private void addSystemIcon(String slot, StatusBarIconHolder holder) {

        int viewIndex = mStatusBarIconList.getViewIndex(slot, holder.getTag());

        boolean hidden = mIconHideList.contains(slot);



        mIconGroups.forEach(l -> l.onIconAdded(viewIndex, slot, hidden, holder));
@@ -182,18 +177,17 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
    /** */

    @Override

    public void setIcon(String slot, int resourceId, CharSequence contentDescription) {

        int index = getSlotIndex(slot);

        StatusBarIconHolder holder = getIcon(index, 0);

        StatusBarIconHolder holder = mStatusBarIconList.getIconHolder(slot, 0);

        if (holder == null) {

            StatusBarIcon icon = new StatusBarIcon(UserHandle.SYSTEM, mContext.getPackageName(),

                    Icon.createWithResource(

                            mContext, resourceId), 0, 0, contentDescription);

            holder = StatusBarIconHolder.fromIcon(icon);

            setIcon(index, holder);

            setIcon(slot, holder);

        } else {

            holder.getIcon().icon = Icon.createWithResource(mContext, resourceId);

            holder.getIcon().contentDescription = contentDescription;

            handleSet(index, holder);

            handleSet(slot, holder);

        }

    }
@@ -203,21 +197,18 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
     */

    @Override

    public void setSignalIcon(String slot, WifiIconState state) {



        int index = getSlotIndex(slot);



        if (state == null) {

            removeIcon(index, 0);

            removeIcon(slot, 0);

            return;

        }



        StatusBarIconHolder holder = getIcon(index, 0);

        StatusBarIconHolder holder = mStatusBarIconList.getIconHolder(slot, 0);

        if (holder == null) {

            holder = StatusBarIconHolder.fromWifiIconState(state);

            setIcon(index, holder);

            setIcon(slot, holder);

        } else {

            holder.setWifiState(state);

            handleSet(index, holder);

            handleSet(slot, holder);

        }

    }
@@ -229,8 +220,7 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
     */

    @Override

    public void setMobileIcons(String slot, List<MobileIconState> iconStates) {

        Slot mobileSlot = getSlot(slot);

        int slotIndex = getSlotIndex(slot);

        Slot mobileSlot = mStatusBarIconList.getSlot(slot);



        // Reverse the sort order to show icons with left to right([Slot1][Slot2]..).

        // StatusBarIconList has UI design that first items go to the right of second items.
@@ -241,10 +231,10 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
            StatusBarIconHolder holder = mobileSlot.getHolderForTag(state.subId);

            if (holder == null) {

                holder = StatusBarIconHolder.fromMobileIconState(state);

                setIcon(slotIndex, holder);

                setIcon(slot, holder);

            } else {

                holder.setMobileState(state);

                handleSet(slotIndex, holder);

                handleSet(slot, holder);

            }

        }

    }
@@ -256,21 +246,19 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
     */

    @Override

    public void setCallStrengthIcons(String slot, List<CallIndicatorIconState> states) {

        Slot callStrengthSlot = getSlot(slot);

        int callStrengthSlotIndex = getSlotIndex(slot);

        Slot callStrengthSlot = mStatusBarIconList.getSlot(slot);

        Collections.reverse(states);

        for (CallIndicatorIconState state : states) {

            if (!state.isNoCalling) {

                StatusBarIconHolder holder = callStrengthSlot.getHolderForTag(state.subId);

                if (holder == null) {

                    holder = StatusBarIconHolder.fromCallIndicatorState(mContext, state);

                    setIcon(callStrengthSlotIndex, holder);

                } else {

                    holder.setIcon(new StatusBarIcon(UserHandle.SYSTEM, mContext.getPackageName(),

                            Icon.createWithResource(mContext, state.callStrengthResId), 0, 0,

                            state.callStrengthDescription));

                    setIcon(callStrengthSlotIndex, holder);

                }

                setIcon(slot, holder);

            }

            setIconVisibility(slot, !state.isNoCalling, state.subId);

        }
@@ -283,21 +271,19 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
     */

    @Override

    public void setNoCallingIcons(String slot, List<CallIndicatorIconState> states) {

        Slot noCallingSlot = getSlot(slot);

        int noCallingSlotIndex = getSlotIndex(slot);

        Slot noCallingSlot = mStatusBarIconList.getSlot(slot);

        Collections.reverse(states);

        for (CallIndicatorIconState state : states) {

            if (state.isNoCalling) {

                StatusBarIconHolder holder = noCallingSlot.getHolderForTag(state.subId);

                if (holder == null) {

                    holder = StatusBarIconHolder.fromCallIndicatorState(mContext, state);

                    setIcon(noCallingSlotIndex, holder);

                } else {

                    holder.setIcon(new StatusBarIcon(UserHandle.SYSTEM, mContext.getPackageName(),

                            Icon.createWithResource(mContext, state.noCallingResId), 0, 0,

                            state.noCallingDescription));

                    setIcon(noCallingSlotIndex, holder);

                }

                setIcon(slot, holder);

            }

            setIconVisibility(slot, state.isNoCalling, state.subId);

        }
@@ -305,42 +291,31 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 


    @Override

    public void setExternalIcon(String slot) {

        int viewIndex = getViewIndex(getSlotIndex(slot), 0);

        int viewIndex = mStatusBarIconList.getViewIndex(slot, 0);

        int height = mContext.getResources().getDimensionPixelSize(

                R.dimen.status_bar_icon_drawing_size);

        mIconGroups.forEach(l -> l.onIconExternal(viewIndex, height));

    }



    //TODO: remove this (used in command queue and for 3rd party tiles?)

    @Override

    public void setIcon(String slot, StatusBarIcon icon) {

        setIcon(getSlotIndex(slot), icon);

    }



    /**

     * For backwards compatibility, in the event that someone gives us a slot and a status bar icon

     */

    private void setIcon(int index, StatusBarIcon icon) {

        String slot = getSlotName(index);

        if (icon == null) {

            removeAllIconsForSlot(slot);

            return;

        }



        StatusBarIconHolder holder = StatusBarIconHolder.fromIcon(icon);

        setIcon(index, holder);

        setIcon(slot, holder);

    }



    /** */

    @Override

    public void setIcon(int index, @NonNull StatusBarIconHolder holder) {

        boolean isNew = getIcon(index, holder.getTag()) == null;

        super.setIcon(index, holder);

    private void setIcon(String slot, @NonNull StatusBarIconHolder holder) {

        boolean isNew = mStatusBarIconList.getIconHolder(slot, holder.getTag()) == null;

        mStatusBarIconList.setIcon(slot, holder);



        if (isNew) {

            addSystemIcon(index, holder);

            addSystemIcon(slot, holder);

        } else {

            handleSet(index, holder);

            handleSet(slot, holder);

        }

    }
@@ -351,34 +326,33 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 


    /** */

    public void setIconVisibility(String slot, boolean visibility, int tag) {

        int index = getSlotIndex(slot);

        StatusBarIconHolder holder = getIcon(index, tag);

        StatusBarIconHolder holder = mStatusBarIconList.getIconHolder(slot, tag);

        if (holder == null || holder.isVisible() == visibility) {

            return;

        }



        holder.setVisible(visibility);

        handleSet(index, holder);

        handleSet(slot, holder);

    }



    /** */

    @Override

    public void setIconAccessibilityLiveRegion(String slotName, int accessibilityLiveRegion) {

        Slot slot = getSlot(slotName);

        Slot slot = mStatusBarIconList.getSlot(slotName);

        if (!slot.hasIconsInSlot()) {

            return;

        }



        int slotIndex = getSlotIndex(slotName);

        List<StatusBarIconHolder> iconsToUpdate = slot.getHolderListInViewOrder();

        for (StatusBarIconHolder holder : iconsToUpdate) {

            int viewIndex = getViewIndex(slotIndex, holder.getTag());

            int viewIndex = mStatusBarIconList.getViewIndex(slotName, holder.getTag());

            mIconGroups.forEach(l -> l.mGroup.getChildAt(viewIndex)

                    .setAccessibilityLiveRegion(accessibilityLiveRegion));

        }

    }



    /** */

    @Override

    public void removeIcon(String slot) {

        removeAllIconsForSlot(slot);

    }
@@ -386,39 +360,34 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
    /** */

    @Override

    public void removeIcon(String slot, int tag) {

        removeIcon(getSlotIndex(slot), tag);

        if (mStatusBarIconList.getIconHolder(slot, tag) == null) {

            return;

        }

        int viewIndex = mStatusBarIconList.getViewIndex(slot, tag);

        mStatusBarIconList.removeIcon(slot, tag);

        mIconGroups.forEach(l -> l.onRemoveIcon(viewIndex));

    }



    /** */

    @Override

    public void removeAllIconsForSlot(String slotName) {

        Slot slot = getSlot(slotName);

        Slot slot = mStatusBarIconList.getSlot(slotName);

        if (!slot.hasIconsInSlot()) {

            return;

        }



        int slotIndex = getSlotIndex(slotName);

        List<StatusBarIconHolder> iconsToRemove = slot.getHolderListInViewOrder();

        for (StatusBarIconHolder holder : iconsToRemove) {

            int viewIndex = getViewIndex(slotIndex, holder.getTag());

            int viewIndex = mStatusBarIconList.getViewIndex(slotName, holder.getTag());

            slot.removeForTag(holder.getTag());

            mIconGroups.forEach(l -> l.onRemoveIcon(viewIndex));

        }

    }



    /** */

    @Override

    public void removeIcon(int index, int tag) {

        if (getIcon(index, tag) == null) {

            return;

        }

        super.removeIcon(index, tag);

        int viewIndex = getViewIndex(index, 0);

        mIconGroups.forEach(l -> l.onRemoveIcon(viewIndex));

    }



    private void handleSet(int index, StatusBarIconHolder holder) {

        int viewIndex = getViewIndex(index, holder.getTag());



    private void handleSet(String slotName, StatusBarIconHolder holder) {

        int viewIndex = mStatusBarIconList.getViewIndex(slotName, holder.getTag());

        mIconGroups.forEach(l -> l.onSetIconHolder(viewIndex, holder));

    }
@@ -438,7 +407,7 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
            }

        }



        super.dump(pw);

        mStatusBarIconList.dump(pw);

    }



    /** */
@@ -482,7 +451,6 @@ public class StatusBarIconControllerImpl extends StatusBarIconList implements Tu 
    /** */

    @Override

    public void onDensityOrFontScaleChanged() {

        loadDimens();

        refreshIconGroups();

    }

}

packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBarIconList.java

+65 −34
Original line number Diff line number Diff line
@@ -25,10 +25,13 @@ import com.android.internal.annotations.VisibleForTesting; 


import java.io.PrintWriter;

import java.util.ArrayList;

import java.util.Collections;

import java.util.List;



/** A class holding the list of all the system icons that could be shown in the status bar. */

public class StatusBarIconList {

    private ArrayList<Slot> mSlots = new ArrayList<>();

    private final ArrayList<Slot> mSlots = new ArrayList<>();

    private final List<Slot> mViewOnlySlots = Collections.unmodifiableList(mSlots);



    public StatusBarIconList(String[] slots) {

        final int N = slots.length;
@@ -37,48 +40,57 @@ public class StatusBarIconList { 
        }

    }



    public int getSlotIndex(String slot) {

        final int N = mSlots.size();

        for (int i=0; i<N; i++) {

            Slot item = mSlots.get(i);

            if (item.getName().equals(slot)) {

                return i;

            }

        }

        // Auto insert new items at the beginning.

        mSlots.add(0, new Slot(slot, null));

        return 0;

    }



    protected ArrayList<Slot> getSlots() {

        return new ArrayList<>(mSlots);

    /** Returns the list of current slots. */

    public List<Slot> getSlots() {

        return mViewOnlySlots;

    }



    protected Slot getSlot(String name) {

        return mSlots.get(getSlotIndex(name));

    }



    public int size() {

        return mSlots.size();

    }



    public void setIcon(int index, @NonNull StatusBarIconHolder holder) {

        mSlots.get(index).addHolder(holder);

    /**

     * Gets the slot with the given {@code name}, or creates a new slot if we don't already have a

     * slot by that name.

     *

     * If a new slot is created, that slot will be inserted at the front of the list.

     *

     * TODO(b/237533036): Rename this to getOrCreateSlot to make it more clear that it could create

     *   a new slot. Other methods in this class will also create a new slot if we don't have one,

     *   should those be re-named too?

     */

    public Slot getSlot(String name) {

        return mSlots.get(findOrInsertSlot(name));

    }



    public void removeIcon(int index, int tag) {

        mSlots.get(index).removeForTag(tag);

    /**

     * Sets the icon in {@code holder} to be associated with the slot with the given

     * {@code slotName}.

     */

    public void setIcon(String slotName, @NonNull StatusBarIconHolder holder) {

        mSlots.get(findOrInsertSlot(slotName)).addHolder(holder);

    }



    public String getSlotName(int index) {

        return mSlots.get(index).getName();

    /**

     * Removes the icon holder that we had associated with {@code slotName}'s slot at the given

     * {@code tag}.

     */

    public void removeIcon(String slotName, int tag) {

        mSlots.get(findOrInsertSlot(slotName)).removeForTag(tag);

    }



    public StatusBarIconHolder getIcon(int index, int tag) {

        return mSlots.get(index).getHolderForTag(tag);

    /**

     * Returns the icon holder currently associated with {@code slotName}'s slot at the given

     * {@code tag}, or null if we don't have one.

     */

    @Nullable

    public StatusBarIconHolder getIconHolder(String slotName, int tag) {

        return mSlots.get(findOrInsertSlot(slotName)).getHolderForTag(tag);

    }



    public int getViewIndex(int slotIndex, int tag) {

    /**

     * Returns the index of the icon in {@code slotName}'s slot at the given {@code tag}.

     *

     * Note that a single slot can have multiple icons, and this function takes that into account.

     */

    public int getViewIndex(String slotName, int tag) {

        int slotIndex = findOrInsertSlot(slotName);

        int count = 0;

        for (int i = 0; i < slotIndex; i++) {

            Slot item = mSlots.get(i);
@@ -100,6 +112,25 @@ public class StatusBarIconList { 
        }

    }



    private int findOrInsertSlot(String slot) {

        final int N = mSlots.size();

        for (int i = 0; i < N; i++) {

            Slot item = mSlots.get(i);

            if (item.getName().equals(slot)) {

                return i;

            }

        }

        // Auto insert new items at the beginning.

        mSlots.add(0, new Slot(slot, null));

        return 0;

    }





    /**

     * A class representing one slot in the status bar system icons view.

     *

     * Note that one slot can have multiple icons associated with it.

     */

    public static class Slot {

        private final String mName;

        private StatusBarIconHolder mHolder;

packages/SystemUI/tests/src/com/android/systemui/statusbar/phone/StatusBarIconListTest.java

+84 −51

File changed.

Preview size limit exceeded, changes collapsed.