1 /*
2  * Copyright (C) 2022 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.settingslib.spa.framework.common
18 
19 import android.os.Bundle
20 import androidx.compose.runtime.Composable
21 import androidx.compose.runtime.remember
22 import androidx.navigation.NamedNavArgument
23 import com.android.settingslib.spa.framework.util.genPageId
24 import com.android.settingslib.spa.framework.util.normalizeArgList
25 import com.android.settingslib.spa.widget.scaffold.RegularScaffold
26 
27 private const val NULL_PAGE_NAME = "NULL"
28 
29 /**
30  * An SettingsPageProvider which is used to create Settings page instances.
31  */
32 interface SettingsPageProvider {
33 
34     /** The page provider name, needs to be *unique* and *stable*. */
35     val name: String
36 
37     /** The display name of this page provider, for better readability. */
38     val displayName: String
39         get() = name
40 
41     /** The page parameters, default is no parameters. */
42     val parameter: List<NamedNavArgument>
43         get() = emptyList()
44 
45     /**
46      * The API to indicate whether the page is enabled or not.
47      * During SPA page migration, one can use it to enable certain pages in one release.
48      * When the page is disabled, all its related functionalities, such as browsing, search,
49      * slice provider, are disabled as well.
50      */
51     fun isEnabled(arguments: Bundle?): Boolean = true
52 
53     fun getTitle(arguments: Bundle?): String = displayName
54 
55     fun buildEntry(arguments: Bundle?): List<SettingsEntry> = emptyList()
56 
57     /** The [Composable] used to render this page. */
58     @Composable
59     fun Page(arguments: Bundle?) {
60         val title = remember { getTitle(arguments) }
61         val entries = remember { buildEntry(arguments) }
62         RegularScaffold(title) {
63             for (entry in entries) {
64                 entry.UiLayout()
65             }
66         }
67     }
68 }
69 
70 fun SettingsPageProvider.createSettingsPage(arguments: Bundle? = null): SettingsPage {
71     return SettingsPage(
72         id = genPageId(name, parameter, arguments),
73         sppName = name,
74         displayName = displayName + parameter.normalizeArgList(arguments, eraseRuntimeValues = true)
75             .joinToString("") { arg -> "/$arg" },
76         parameter = parameter,
77         arguments = arguments,
78     )
79 }
80 
81 object NullPageProvider : SettingsPageProvider {
82     override val name = NULL_PAGE_NAME
83 }
84 
85 fun getPageProvider(sppName: String): SettingsPageProvider? {
86     if (!SpaEnvironmentFactory.isReady()) return null
87     val pageProviderRepository by SpaEnvironmentFactory.instance.pageProviderRepository
88     return pageProviderRepository.getProviderOrNull(sppName)
89 }
90