[6/n] Implement LetterboxCommandHandler (aaf72fec) · Commits · e / os / android_frameworks_base

libs/WindowManager/Shell/src/com/android/wm/shell/compatui/letterbox/LetterboxCommandHandler.kt

0 → 100644

+184 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright 2024 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.wm.shell.compatui.letterbox

			import android.content.Context
			import android.graphics.Color
			import com.android.internal.protolog.ProtoLog
			import com.android.window.flags.Flags
			import com.android.wm.shell.dagger.WMSingleton
			import com.android.wm.shell.protolog.ShellProtoLogGroup.WM_SHELL_APP_COMPAT
			import com.android.wm.shell.sysui.ShellCommandHandler
			import com.android.wm.shell.sysui.ShellCommandHandler.ShellCommandActionHandler
			import com.android.wm.shell.sysui.ShellInit
			import java.io.PrintWriter
			import javax.inject.Inject

			/**
			* Handles the shell commands for the CompatUI.
			*
			* <p> Use with [adb shell dumpsys activity service SystemUIService WMShell letterbox
			* <command>].
			*/
			@WMSingleton
			class LetterboxCommandHandler @Inject constructor(
			private val context: Context,
			shellInit: ShellInit,
			shellCommandHandler: ShellCommandHandler,
			private val letterboxConfiguration: LetterboxConfiguration
			) : ShellCommandActionHandler {

			companion object {
			@JvmStatic
			private val TAG = "LetterboxCommandHandler"
			}

			init {
			if (Flags.appCompatRefactoring()) {
			ProtoLog.v(
			WM_SHELL_APP_COMPAT,
			"%s: %s",
			TAG,
			"Initializing LetterboxCommandHandler"
			)
			shellInit.addInitCallback({
			shellCommandHandler.addCommandCallback("letterbox", this, this)
			}, this)
			}
			}

			override fun onShellCommand(args: Array<out String>?, pw: PrintWriter?): Boolean {
			if (args == null \|\| pw == null) {
			pw!!.println("Missing arguments.")
			return false
			}
			return when (args.size) {
			1 -> onShellDisplayCommand(args[0], pw)
			2 -> onShellUpdateCommand(args[0], args[1], pw)
			else -> {
			pw.println("Invalid command: " + args[0])
			return false
			}
			}
			}

			override fun printShellCommandHelp(pw: PrintWriter?, prefix: String?) {
			pw?.println(
			"""
			$prefix backgroundColor color"
			$prefix Color of letterbox which is to be used when letterbox background
			$prefix type is 'solid-color'. See Color#parseColor for allowed color
			$prefix formats (#RRGGBB and some colors by name, e.g. magenta or olive).
			$prefix backgroundColorResource resource_name"
			$prefix Color resource name of letterbox background which is used when
			$prefix background type is 'solid-color'. Parameter is a color resource
			$prefix name, for example, @android:color/system_accent2_50.
			$prefix backgroundColorReset"
			$prefix Resets the background color to the default value."
			""".trimIndent()
			)
			}

			private fun onShellUpdateCommand(command: String, value: String, pw: PrintWriter): Boolean {
			when (command) {
			"backgroundColor" -> {
			return invokeWhenValid(
			pw,
			value,
			::strToColor,
			{ color ->
			letterboxConfiguration.setLetterboxBackgroundColor(color)
			},
			{ c -> "$c is not a valid color." }
			)
			}

			"backgroundColorResource" -> return invokeWhenValid(
			pw,
			value,
			::nameToColorId,
			{ color ->
			letterboxConfiguration.setLetterboxBackgroundColorResourceId(color)
			},
			{ c ->
			"$c is not a valid resource. Color in '@android:color/resource_name'" +
			" format should be provided as an argument."
			}
			)

			"backgroundColorReset" -> {
			letterboxConfiguration.resetLetterboxBackgroundColor()
			return true
			}

			else -> {
			pw.println("Invalid command: $value")
			return false
			}
			}
			}

			private fun onShellDisplayCommand(command: String, pw: PrintWriter): Boolean {
			when (command) {
			"backgroundColor" -> {
			pw.println(
			" Background color: " + Integer.toHexString(
			letterboxConfiguration.getLetterboxBackgroundColor()
			.toArgb()
			)
			)
			return true
			}

			else -> {
			pw.println("Invalid command: $command")
			return false
			}
			}
			}

			private fun <T> invokeWhenValid(
			pw: PrintWriter,
			input: String,
			converter: (String) -> T?,
			consumer: (T) -> Unit,
			errorMessage: (String) -> String = { value -> " Wrong input value: $value." }
			): Boolean {
			converter(input)?.let {
			consumer(it)
			return true
			}
			pw.println(errorMessage(input))
			return false
			}

			// Converts a String to Color if possible or it returns null otherwise.
			private fun strToColor(str: String): Color? =
			try {
			Color.valueOf(Color.parseColor(str))
			} catch (e: IllegalArgumentException) {
			null
			}

			// Converts a resource id to Color if possible or it returns null otherwise.
			private fun nameToColorId(str: String): Int? =
			try {
			context.resources.getIdentifier(str, "color", "com.android.internal")
			} catch (e: IllegalArgumentException) {
			null
			}
			}

libs/WindowManager/Shell/src/com/android/wm/shell/compatui/letterbox/LetterboxConfiguration.kt

+2 −3

Original line number	Original line	Diff line number	Diff line
	@@ -30,9 +30,8 @@ import javax.inject.Inject
	class LetterboxConfiguration @Inject constructor(		class LetterboxConfiguration @Inject constructor(
	private val context: Context		private val context: Context
	) {		) {
			// Color to use for the solid color letterbox background type.
	// TODO(b/370940685): Integrate CommandHandler in LetterboxConfiguration.		private var letterboxBackgroundColorOverride: Color? = null
	private var letterboxBackgroundColorOverride: Color? = Color.valueOf(Color.YELLOW)

	// Color resource id for the solid color letterbox background type.		// Color resource id for the solid color letterbox background type.
	private var letterboxBackgroundColorResourceIdOverride: Int? = null		private var letterboxBackgroundColorResourceIdOverride: Int? = null

libs/WindowManager/Shell/src/com/android/wm/shell/dagger/WMShellModule.java

+2 −0

Original line number	Original line	Diff line number	Diff line
	@@ -63,6 +63,7 @@ import com.android.wm.shell.common.MultiInstanceHelper;
	import com.android.wm.shell.common.ShellExecutor;		import com.android.wm.shell.common.ShellExecutor;
	import com.android.wm.shell.common.SyncTransactionQueue;		import com.android.wm.shell.common.SyncTransactionQueue;
	import com.android.wm.shell.common.TaskStackListenerImpl;		import com.android.wm.shell.common.TaskStackListenerImpl;
			import com.android.wm.shell.compatui.letterbox.LetterboxCommandHandler;
	import com.android.wm.shell.compatui.letterbox.LetterboxController;		import com.android.wm.shell.compatui.letterbox.LetterboxController;
	import com.android.wm.shell.compatui.letterbox.LetterboxTransitionObserver;		import com.android.wm.shell.compatui.letterbox.LetterboxTransitionObserver;
	import com.android.wm.shell.dagger.back.ShellBackAnimationModule;		import com.android.wm.shell.dagger.back.ShellBackAnimationModule;
	@@ -1233,6 +1234,7 @@ public abstract class WMShellModule {
	static Object provideIndependentShellComponentsToCreate(		static Object provideIndependentShellComponentsToCreate(
	DragAndDropController dragAndDropController,		DragAndDropController dragAndDropController,
	@NonNull LetterboxTransitionObserver letterboxTransitionObserver,		@NonNull LetterboxTransitionObserver letterboxTransitionObserver,
			@NonNull LetterboxCommandHandler letterboxCommandHandler,
	Optional<DesktopTasksTransitionObserver> desktopTasksTransitionObserverOptional,		Optional<DesktopTasksTransitionObserver> desktopTasksTransitionObserverOptional,
	Optional<DesktopDisplayEventHandler> desktopDisplayEventHandler) {		Optional<DesktopDisplayEventHandler> desktopDisplayEventHandler) {
	return new Object();		return new Object();