fix: finalize indexing API; remove api versions index

Author: itsaky

.idea/compiler.xml

@@ -87,6 +87,7 @@ dependencies {
   implementation(libs.common.retrofit.gson)
   implementation(libs.common.charts)
   implementation(libs.common.hiddenApiBypass)
+  implementation(libs.aapt2.common)
 
   implementation(libs.google.auto.service.annotations)
   implementation(libs.google.gson)

core/app/build.gradle.kts

@@ -15,12 +15,12 @@
  *   along with AndroidIDE.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-package com.itsaky.androidide.indexing.core.internal.platform
+package com.itsaky.androidide.indexing.platform
 
 import com.google.auto.service.AutoService
 import com.itsaky.androidide.indexing.IIndexService
-import com.itsaky.androidide.progress.IProgressIndicator
 import com.itsaky.androidide.projects.api.Project
+import org.slf4j.LoggerFactory
 import java.io.File
 
 /**
@@ -29,19 +29,26 @@ import java.io.File
 @AutoService(IIndexService::class)
 internal class PlatformIndexService : IIndexService {
 
+  companion object {
+    private val log = LoggerFactory.getLogger(PlatformIndexService::class.java)
+  }
+
+  override val displayName: String
+    get() = "Android Platform Indexing Service"
+
   override fun scanFiles(project: Project): Collection<File> {
     return mutableListOf<File>().apply {
       project.findAndroidModules().forEach { androidModule ->
-        add(androidModule.getPlatformDir() ?: return@forEach)
+        add(androidModule.getPlatformDir()?.also {
+          log.debug("Adding {} to the list of indexable paths", it)
+        } ?: return@forEach)
       }
     }
   }
 
   override suspend fun indexFiles(
     project: Project,
-    progress: IProgressIndicator,
     files: Collection<File>
   ) {
-    TODO("Not yet implemented")
   }
 }

…nternal/platform/PlatformIndexService.kt …ndexing/platform/PlatformIndexService.ktcore/indexing-core/src/main/java/com/itsaky/androidide/indexing/core/internal/platform/PlatformIndexService.kt renamed to core/app/src/main/java/com/itsaky/androidide/indexing/platform/PlatformIndexService.kt core/indexing-core/src/main/java/com/itsaky/androidide/indexing/core/internal/platform/PlatformIndexService.kt renamed to core/app/src/main/java/com/itsaky/androidide/indexing/platform/PlatformIndexService.kt

@@ -33,7 +33,6 @@ import com.itsaky.androidide.projects.api.AndroidModule
 import com.itsaky.androidide.projects.api.ModuleProject
 import com.itsaky.androidide.projects.api.Project
 import com.itsaky.androidide.projects.builder.BuildService
-import com.itsaky.androidide.projects.util.ProjectTransformer
 import com.itsaky.androidide.tasks.executeAsync
 import com.itsaky.androidide.tooling.api.IAndroidProject
 import com.itsaky.androidide.tooling.api.IProject

core/app/src/main/java/com/itsaky/androidide/projects/ProjectManagerImpl.kt

@@ -15,7 +15,7 @@
  *   along with AndroidIDE.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-package com.itsaky.androidide.projects.util
+package com.itsaky.androidide.projects
 
 import com.itsaky.androidide.projects.api.AndroidModule
 import com.itsaky.androidide.projects.api.GradleProject

…dide/projects/util/ProjectTransformer.kt …ndroidide/projects/ProjectTransformer.ktcore/projects/src/main/java/com/itsaky/androidide/projects/util/ProjectTransformer.kt renamed to core/app/src/main/java/com/itsaky/androidide/projects/ProjectTransformer.kt core/projects/src/main/java/com/itsaky/androidide/projects/util/ProjectTransformer.kt renamed to core/app/src/main/java/com/itsaky/androidide/projects/ProjectTransformer.kt

@@ -25,9 +25,9 @@ import io.realm.Realm
  * @property params The index parameters.
  * @author Akash Yadav
  */
-abstract class AbstractDBIndex<T : IIndexable, C : IIndexParams>(
+abstract class AbstractDBIndex<T : IIndexable>(
   protected val params: IIndexParams?
-) : IIndex<T, C> {
+) : IDatabaseIndex<T> {
 
   protected abstract val realm: Realm
 

core/indexing-api/src/main/java/com/itsaky/androidide/indexing/AbstractDBIndex.kt

@@ -15,20 +15,19 @@
  *   along with AndroidIDE.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-package com.itsaky.androidide.indexing.core.platform
+package com.itsaky.androidide.indexing
 
-import com.itsaky.androidide.indexing.IIndexParams
-import com.itsaky.androidide.indexing.core.platform.IApiVersionsIndex.Params
+import io.realm.RealmQuery
 
 /**
- * Index which provides access to the API versions informations (`api-versions.xml`) from the
- * Android SDK.
+ * An index which is stored in the database.
  *
  * @author Akash Yadav
  */
-interface IApiVersionsIndex : IPlatformIndex<ClassOrMemberInfo, Params> {
+interface IDatabaseIndex<IndexableT : IIndexable> : IIndex<IndexableT> {
 
-  class Params(
-    val platformId: String
-  ) : IIndexParams
+  /**
+   * Perform a query on the Realm database.
+   */
+  fun query(): RealmQuery<IndexableT>
 }

…exing/core/platform/IApiVersionsIndex.kt …ky/androidide/indexing/IDatabaseIndex.ktcore/indexing-core/src/main/java/com/itsaky/androidide/indexing/core/platform/IApiVersionsIndex.kt renamed to core/indexing-api/src/main/java/com/itsaky/androidide/indexing/IDatabaseIndex.kt core/indexing-core/src/main/java/com/itsaky/androidide/indexing/core/platform/IApiVersionsIndex.kt renamed to core/indexing-api/src/main/java/com/itsaky/androidide/indexing/IDatabaseIndex.kt

@@ -24,7 +24,7 @@ import com.itsaky.androidide.db.IRealmProvider
  *
  * @author Akash Yadav
  */
-interface IIndex<IndexableT : IIndexable, ConfigT : IIndexParams> {
+interface IIndex<IndexableT : IIndexable> {
 
   companion object {
 
@@ -36,7 +36,7 @@ interface IIndex<IndexableT : IIndexable, ConfigT : IIndexParams> {
     /**
      * Base path for indices.
      */
-    const val INDEX_BASE_PATH = "${IRealmProvider.PATH_SEPARATOR}index"
+    val INDEX_BASE_PATH = createIndexPath("", "index")
 
     private const val DEF_IS_ASYNC = true
 
@@ -91,9 +91,9 @@ interface IIndex<IndexableT : IIndexable, ConfigT : IIndexParams> {
    *
    * @return The created sub-index.
    */
-  fun <I : IIndexable, C : IIndexParams> createSubIndex(
+  fun <I : IIndexable> createSubIndex(
     params: IIndexParams? = null
-  ): IIndex<I, C> {
+  ): IIndex<I> {
     throw UnsupportedOperationException()
   }
 

core/indexing-api/src/main/java/com/itsaky/androidide/indexing/IIndex.kt

@@ -49,7 +49,7 @@ interface IIndexFactory<I : IIndexable, P : IIndexParams> {
    * @return The created [IIndex].
    */
   @Throws(NotFoundException::class)
-  fun create(): IIndex<I, P>
+  fun create(): IIndex<I>
 
   companion object {
 
@@ -99,10 +99,10 @@ interface IIndexFactory<I : IIndexable, P : IIndexParams> {
         return factory
       }
 
-      val impls = ServiceLoader.load(symTyp).iterator()
+      val impls = ServiceLoader.load(IIndexFactory::class.java).iterator()
       while (impls.hasNext()) {
         val impl = impls.next()
-        if (impl is IIndexFactory<*, *> && symTyp == impl.indexableType()) {
+        if (symTyp == impl.indexableType()) {
           if (factory == null) {
             factory = impl as IIndexFactory<T, P>
             continue

core/indexing-api/src/main/java/com/itsaky/androidide/indexing/IIndexFactory.kt

@@ -18,7 +18,9 @@
 package com.itsaky.androidide.indexing
 
 /**
- * Index configuration
+ * Index configuration parameters. All implementations of this interface must implement the
+ * [Object.equals] and [Object.hashCode] methods properly as the parameters may be used to cache
+ * the index implementations in [IIndexFactory]s.
  *
  * @author Akash Yadav
  */