ADFA-2139: Add plugin sidebar slot limiting with manifest declaration and custom IdeNavigationRailView (max 12 items)

actions/src/main/java/com/itsaky/androidide/actions/SidebarSlotExceededException.kt

@@ -0,0 +1,20 @@
+
+
+package com.itsaky.androidide.actions
+
+class SidebarSlotExceededException(
+ requestedSlots: Int,
+ availableSlots: Int,
+ pluginId: String? = null
+) : RuntimeException(
+ buildMessage(requestedSlots, availableSlots, pluginId)
+) {
+ companion object {
+ private fun buildMessage(requested: Int, available: Int, pluginId: String?): String {
+ val pluginInfo = pluginId?.let { " Plugin '$it'" } ?: ""
+ return "Sidebar slot limit exceeded.$pluginInfo declared $requested sidebar item(s), " +
+ "but only $available slot(s) available. " +
+ "IdeNavigationRailView supports a maximum of ${SidebarSlotManager.MAX_NAVIGATION_RAIL_ITEMS} items."
+ }
+ }
+}

actions/src/main/java/com/itsaky/androidide/actions/SidebarSlotManager.kt

@@ -0,0 +1,54 @@
+
+package com.itsaky.androidide.actions
+
+import java.util.concurrent.ConcurrentHashMap
+import java.util.concurrent.atomic.AtomicInteger
+
+object SidebarSlotManager {
+
+ const val MAX_NAVIGATION_RAIL_ITEMS = 12
+
+ private val builtInItemCount = AtomicInteger(0)
+ private val reservedPluginSlots = ConcurrentHashMap<String, Int>()
+
+ fun setBuiltInItemCount(count: Int) {
+ require(count in 0..MAX_NAVIGATION_RAIL_ITEMS) {
+ "Built-in item count must be between 0 and $MAX_NAVIGATION_RAIL_ITEMS"
+ }
+ builtInItemCount.set(count)
+ }
+
+ fun getBuiltInItemCount(): Int = builtInItemCount.get()
+
+ fun getReservedPluginSlotCount(): Int = reservedPluginSlots.values.sum()
+
+ fun getTotalItemCount(): Int = builtInItemCount.get() + getReservedPluginSlotCount()
+
+ fun getAvailableSlotsForPlugins(): Int =
+ (MAX_NAVIGATION_RAIL_ITEMS - builtInItemCount.get() - getReservedPluginSlotCount())
+ .coerceAtLeast(0)
+
+ fun canAddPluginItems(count: Int): Boolean = count <= getAvailableSlotsForPlugins()
+
+ fun getDeclaredSlots(pluginId: String): Int = reservedPluginSlots[pluginId] ?: 0
+
+ @Throws(SidebarSlotExceededException::class)
+ fun reservePluginSlots(pluginId: String, count: Int) {
+ if (count <= 0) return
+
+ val available = getAvailableSlotsForPlugins()
+ if (count > available) {
+ throw SidebarSlotExceededException(count, available, pluginId)
+ }
+ reservedPluginSlots[pluginId] = count
+ }
+
+ fun releasePluginSlots(pluginId: String) {
+ reservedPluginSlots.remove(pluginId)
+ }
+
+ fun reset() {
+ builtInItemCount.set(0)
+ reservedPluginSlots.clear()
+ }
+}

apk-viewer-plugin/src/main/AndroidManifest.xml

@@ -38,6 +38,10 @@
  android:name="plugin.main_class"
  android:value="com.example.sampleplugin.ApkViewer" />
 
+ <meta-data
+ android:name="plugin.sidebar_items"
+ android:value="1" />
+
  </application>
 
 </manifest>

apk-viewer-plugin/src/main/kotlin/com/example/sampleplugin/ApkViewer.kt

@@ -8,6 +8,7 @@ import com.itsaky.androidide.plugins.extensions.EditorTabExtension
 import com.itsaky.androidide.plugins.extensions.MenuItem
 import com.itsaky.androidide.plugins.extensions.TabItem
 import com.itsaky.androidide.plugins.extensions.EditorTabItem
+import com.itsaky.androidide.plugins.extensions.NavigationItem
 import com.itsaky.androidide.plugins.services.IdeEditorTabService
 import com.example.sampleplugin.fragments.ApkAnalyzerFragment
 
@@ -79,6 +80,22 @@ class ApkViewer : IPlugin, UIExtension, EditorTabExtension {
  )
  }
 
+ // UIExtension - Sidebar navigation item
+ override fun getSideMenuItems(): List<NavigationItem> {
+ return listOf(
+ NavigationItem(
+ id = "apk_analyzer_sidebar",
+ title = "APK Analyzer",
+ icon = android.R.drawable.ic_menu_info_details,
+ isEnabled = true,
+ isVisible = true,
+ group = "tools",
+ order = 0,
+ action = { openApkAnalyzerTab() }
+ )
+ )
+ }
+
  // EditorTabExtension - Main editor tab to display the analyzer
  override fun getMainEditorTabs(): List<EditorTabItem> {
  return listOf(

app/src/main/java/com/itsaky/androidide/activities/PluginManagerActivity.kt

@@ -21,6 +21,9 @@ import com.itsaky.androidide.ui.models.PluginManagerUiEffect
 import com.itsaky.androidide.ui.models.PluginManagerUiEvent
 import com.itsaky.androidide.utils.flashError
 import com.itsaky.androidide.utils.flashSuccess
+import com.itsaky.androidide.utils.flashbarBuilder
+import com.itsaky.androidide.utils.errorIcon
+import com.itsaky.androidide.utils.showOnUiThread
 import com.itsaky.androidide.viewmodels.PluginManagerViewModel
 import kotlinx.coroutines.launch
 import org.koin.androidx.viewmodel.ext.android.viewModel
@@ -162,7 +165,10 @@ class PluginManagerActivity : EdgeToEdgeIDEActivity() {
  private fun handleUiEffect(effect: PluginManagerUiEffect) {
  when (effect) {
  is PluginManagerUiEffect.ShowError -> {
- flashError(effect.message)
+ flashbarBuilder(duration = 5000L)
+ .errorIcon()
+ .message(effect.message)
+ .showOnUiThread()
  }
  is PluginManagerUiEffect.ShowSuccess -> {
  flashSuccess(effect.message)

app/src/main/java/com/itsaky/androidide/ui/IdeNavigationRailView.kt

@@ -0,0 +1,53 @@
+package com.itsaky.androidide.ui
+
+import android.content.Context
+import android.util.AttributeSet
+import androidx.core.widget.NestedScrollView
+import com.google.android.material.navigationrail.NavigationRailView
+
+class IdeNavigationRailView @JvmOverloads constructor(
+ context: Context,
+ attrs: AttributeSet? = null,
+ defStyleAttr: Int = com.google.android.material.R.attr.navigationRailStyle
+) : NavigationRailView(context, attrs, defStyleAttr) {
+
+ companion object {
+ const val MAX_ITEM_COUNT = 12
+ }
+
+ override fun getMaxItemCount(): Int = MAX_ITEM_COUNT
+
+ override fun onAttachedToWindow() {
+ super.onAttachedToWindow()
+ enableMenuScrolling()
+ }
+
+ private fun enableMenuScrolling() {
+ post {
+ val menuView = getChildAt(0) ?: return@post
+
+ if (menuView is NestedScrollView) return@post
+
+ removeView(menuView)
+
+ val scroll = NestedScrollView(context).apply {
+ isVerticalScrollBarEnabled = false
+ addView(
+ menuView,
+ LayoutParams(
+ LayoutParams.WRAP_CONTENT,
+ LayoutParams.WRAP_CONTENT
+ )
+ )
+ }
+
+ addView(
+ scroll,
+ LayoutParams(
+ LayoutParams.WRAP_CONTENT,
+ LayoutParams.MATCH_PARENT
+ )
+ )
+ }
+ }
+}

app/src/main/java/com/itsaky/androidide/utils/EditorSidebarActions.kt

@@ -49,6 +49,7 @@ import com.itsaky.androidide.actions.sidebar.TerminalSidebarAction
 import com.itsaky.androidide.fragments.sidebar.EditorSidebarFragment
 import com.itsaky.androidide.plugins.extensions.UIExtension
 import com.itsaky.androidide.actions.PluginSidebarActionItem
+import com.itsaky.androidide.actions.SidebarSlotManager
 import com.itsaky.androidide.plugins.manager.core.PluginManager
 import java.lang.ref.WeakReference
 
@@ -77,6 +78,9 @@ internal object EditorSidebarActions {
  registry.registerAction(CloseProjectSidebarAction(context, ++order))
  registry.registerAction(HelpSideBarAction(context, ++order))
 
+ // Set built-in item count (6 items) for sidebar slot management
+ SidebarSlotManager.setBuiltInItemCount(order + 1)
+
  // Register plugin sidebar items
  registerPluginSidebarActions(context, registry, ++order)
  }
@@ -236,13 +240,22 @@ internal object EditorSidebarActions {
  pluginManager.getAllPluginInstances()
  .filterIsInstance<UIExtension>()
  .forEach { plugin ->
- try {
- plugin.getSideMenuItems().forEach { navItem ->
- val action = PluginSidebarActionItem(context, navItem, order++)
- registry.registerAction(action)
- }
- } catch (e: Exception) {
+ val pluginId = pluginManager.getPluginIdForInstance(plugin as com.itsaky.androidide.plugins.IPlugin)
+ val declaredSlots = SidebarSlotManager.getDeclaredSlots(pluginId ?: "")
+ val sideMenuItems = plugin.getSideMenuItems()
+
+ if (sideMenuItems.isEmpty()) return@forEach
+
+ if (sideMenuItems.size > declaredSlots) {
+ throw IllegalStateException(
+ "Plugin '$pluginId' returned ${sideMenuItems.size} sidebar items " +
+ "but only declared $declaredSlots in manifest"
+ )
+ }
 
+ sideMenuItems.forEach { navItem ->
+ val action = PluginSidebarActionItem(context, navItem, order++)
+ registry.registerAction(action)
  }
  }
  }

app/src/main/res/layout/fragment_editor_sidebar.xml

@@ -33,7 +33,7 @@
  app:layout_constraintStart_toEndOf="@id/navigation"
  app:layout_constraintTop_toBottomOf="@id/title" />
 
- <com.google.android.material.navigationrail.NavigationRailView
+ <com.itsaky.androidide.ui.IdeNavigationRailView
  android:id="@+id/navigation"
  android:background="?attr/colorSurface"
  android:layout_width="56dp"

keystore-generator-plugin/src/main/AndroidManifest.xml

@@ -38,6 +38,10 @@
  android:name="plugin.main_class"
  android:value="com.appdevforall.keygen.plugin.KeystoreGeneratorPlugin" />
 
+ <meta-data
+ android:name="plugin.sidebar_items"
+ android:value="1" />
+
  </application>
 
 </manifest>

plugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeSidebarService.kt

@@ -0,0 +1,16 @@
+
+
+package com.itsaky.androidide.plugins.services
+
+interface IdeSidebarService {
+
+ fun getAvailableSidebarSlots(): Int
+
+ fun canAddSidebarItems(count: Int): Boolean
+
+ fun getMaxSidebarItems(): Int
+
+ fun getCurrentSidebarItemCount(): Int
+
+ fun getDeclaredSidebarSlots(): Int
+}

plugin-manager/build.gradle.kts

@@ -33,6 +33,7 @@ android {
 dependencies {
  api(projects.pluginApi)
 
+ implementation(projects.actions)
  implementation(projects.common)
  implementation(projects.logger)
  implementation(projects.lookup)