launcher3/model/DeviceGridState.java

/*
 * 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 com.android.launcher3.model;

import static com.android.launcher3.InvariantDeviceProfile.DeviceType;
import static com.android.launcher3.LauncherPrefs.DB_FILE;
import static com.android.launcher3.LauncherPrefs.DEVICE_TYPE;
import static com.android.launcher3.LauncherPrefs.GRID_TYPE;
import static com.android.launcher3.LauncherPrefs.HOTSEAT_COUNT;
import static com.android.launcher3.LauncherPrefs.WORKSPACE_SIZE;

import android.content.Context;
import android.text.TextUtils;

import com.android.launcher3.InvariantDeviceProfile;
import com.android.launcher3.LauncherPrefs;
import com.android.launcher3.logging.StatsLogManager.LauncherEvent;

import java.util.Locale;
import java.util.Objects;

/**
 * Utility class representing persisted grid properties.
 */
public class DeviceGridState implements Comparable<DeviceGridState> {

    public static final String KEY_WORKSPACE_SIZE = "migration_src_workspace_size";
    public static final String KEY_HOTSEAT_COUNT = "migration_src_hotseat_count";
    public static final String KEY_DEVICE_TYPE = "migration_src_device_type";
    public static final String KEY_DB_FILE = "migration_src_db_file";
    public static final String KEY_GRID_TYPE = "migration_src_grid_type";

    private final String mGridSizeString;
    private final int mNumHotseat;
    private final @DeviceType int mDeviceType;
    private final String mDbFile;
    private final int mGridType;

    public DeviceGridState(int columns, int row, int numHotseat, int deviceType, String dbFile,
            int gridType) {
        mGridSizeString = String.format(Locale.ENGLISH, "%d,%d", columns, row);
        mNumHotseat = numHotseat;
        mDeviceType = deviceType;
        mDbFile = dbFile;
        mGridType = gridType;
    }

    public DeviceGridState(InvariantDeviceProfile idp) {
        mGridSizeString = String.format(Locale.ENGLISH, "%d,%d", idp.numColumns, idp.numRows);
        mNumHotseat = idp.numDatabaseHotseatIcons;
        mDeviceType = idp.deviceType;
        mDbFile = idp.dbFile;
        mGridType = idp.gridType;
    }

    public DeviceGridState(Context context) {
        this(LauncherPrefs.get(context));
    }

    public DeviceGridState(LauncherPrefs lp) {
        mGridSizeString = lp.get(WORKSPACE_SIZE);
        mNumHotseat = lp.get(HOTSEAT_COUNT);
        mDeviceType = lp.get(DEVICE_TYPE);
        mDbFile = lp.get(DB_FILE);
        mGridType = lp.get(GRID_TYPE);
    }

    /**
     * Returns the device type for the grid
     */
    public @DeviceType int getDeviceType() {
        return mDeviceType;
    }

    /**
     * Returns the databaseFile for the grid.
     */
    public String getDbFile() {
        return mDbFile;
    }

    /**
     * Returns the number of hotseat icons.
     */
    public int getNumHotseat() {
        return mNumHotseat;
    }

    /**
     * Returns the grid type.
     */
    public int getGridType() {
        return mGridType;
    }

    /**
     * Stores the device state to shared preferences
     */
    public void writeToPrefs(Context context) {
        LauncherPrefs.get(context).put(
                WORKSPACE_SIZE.to(mGridSizeString),
                HOTSEAT_COUNT.to(mNumHotseat),
                DEVICE_TYPE.to(mDeviceType),
                DB_FILE.to(mDbFile),
                GRID_TYPE.to(mGridType));

    }

    /**
     * Returns the logging event corresponding to the grid state
     */
    public LauncherEvent getWorkspaceSizeEvent() {
        if (!TextUtils.isEmpty(mGridSizeString)) {
            switch (mGridSizeString) {
                case "2,2":
                    return LauncherEvent.LAUNCHER_GRID_SIZE_2_BY_2;
                case "3,3":
                    return LauncherEvent.LAUNCHER_GRID_SIZE_3_BY_3;
                case "4,4":
                    return LauncherEvent.LAUNCHER_GRID_SIZE_4_BY_4;
                case "4,5":
                    return LauncherEvent.LAUNCHER_GRID_SIZE_4_BY_5;
                case "4,6":
                    return LauncherEvent.LAUNCHER_GRID_SIZE_4_BY_6;
                case "5,5":
                    return LauncherEvent.LAUNCHER_GRID_SIZE_5_BY_5;
                case "5,6":
                    return LauncherEvent.LAUNCHER_GRID_SIZE_5_BY_6;
                case "6,5":
                    return LauncherEvent.LAUNCHER_GRID_SIZE_6_BY_5;
            }
        }
        return null;
    }

    @Override
    public String toString() {
        return "DeviceGridState{"
                + "mGridSizeString='" + mGridSizeString + '\''
                + ", mNumHotseat=" + mNumHotseat
                + ", mDeviceType=" + mDeviceType
                + ", mDbFile=" + mDbFile
                + '}';
    }

    /**
     * Returns true if the database from another DeviceGridState can be loaded into the current
     * DeviceGridState without migration, or false otherwise.
     */
    public boolean isCompatible(DeviceGridState other) {
        if (this == other) {
            return true;
        }
        if (other == null) {
            return false;
        }
        return Objects.equals(mDbFile, other.mDbFile);
    }

    public Integer getColumns() {
        if (TextUtils.isEmpty(mGridSizeString)) {
            return -1;
        }
        return Integer.parseInt(String.valueOf(mGridSizeString.split(",")[0]));
    }

    public Integer getRows() {
        if (TextUtils.isEmpty(mGridSizeString)) {
            return -1;
        }
        return Integer.parseInt(String.valueOf(mGridSizeString.split(",")[1]));
    }

    @Override
    public int compareTo(DeviceGridState other) {
        Integer size = getColumns() * getRows();
        Integer otherSize = other.getColumns() * other.getRows();

        return size.compareTo(otherSize);
    }

}