Improve new Web navigators

demos/navigator/build.gradle.kts

@@ -79,6 +79,7 @@ dependencies {
     implementation(libs.timber)
     implementation(libs.kotlinx.coroutines.android)
     implementation(libs.kotlinx.collections.immutable)
+    implementation(libs.kotlinx.serialization.json)
     implementation(libs.kotlin.stdlib)
     implementation(libs.bundles.compose)
     implementation(libs.google.material)

demos/navigator/src/main/java/org/readium/demo/navigator/decorations/HighlightsManager.kt

@@ -44,7 +44,7 @@ sealed class HighlightsManager<L : DecorationLocation>(
     decorationFactory: (Highlight, Long) -> List<Decoration<L>>,
 ) {
 
-    private val lastHighlightId: Long = -1
+    private var lastHighlightId: Long = -1
 
     private val highlightsMutable: MutableStateFlow<PersistentMap<Long, Highlight>> =
         MutableStateFlow(persistentMapOf())
@@ -62,7 +62,9 @@ sealed class HighlightsManager<L : DecorationLocation>(
         @ColorInt tint: Int,
         annotation: String = "",
     ): Long {
-        val id = lastHighlightId + 1
+        lastHighlightId += 1
+        val id = lastHighlightId
+
         val highlight = Highlight(
             locator = locator,
             style = style,

demos/navigator/src/main/java/org/readium/demo/navigator/preferences/UserPreferences.kt

@@ -48,7 +48,6 @@ import org.readium.r2.shared.util.Language
 /**
  * Stateful user settings component.
  */
-
 @Composable
 fun <P : Preferences<P>, S : Settings, E : PreferencesEditor<P, S>> UserPreferences(
     editor: E,

readium/navigator/src/main/java/org/readium/r2/navigator/epub/css/ReadiumCss.kt

@@ -6,7 +6,7 @@
 
 package org.readium.r2.navigator.epub.css
 
-import android.net.Uri
+import androidx.core.net.toUri
 import org.jsoup.Jsoup
 import org.jsoup.nodes.Document
 import org.jsoup.nodes.Element
@@ -130,7 +130,7 @@ internal data class ReadiumCss(
             if (googleFonts.isNotEmpty()) {
                 val families = googleFonts.joinToString("|") { it.name }
 
-                val uri = Uri.parse("https://fonts.googleapis.com/css")
+                val uri = "https://fonts.googleapis.com/css".toUri()
                     .buildUpon()
                     .appendQueryParameter("family", families)
                     .build()

readium/navigators/common/build.gradle.kts

@@ -22,11 +22,9 @@ dependencies {
     api(project(":readium:readium-shared"))
     api(project(":readium:readium-navigator"))
 
+    api(libs.androidx.compose.foundation)
     api(libs.kotlinx.collections.immutable)
 
     implementation(libs.androidx.recyclerview)
-    implementation(libs.kotlinx.serialization.json)
-    implementation(libs.bundles.compose)
     implementation(libs.timber)
-    implementation(libs.kotlinx.coroutines.android)
 }

readium/navigators/common/src/main/java/org/readium/navigator/common/LocationElements.kt

@@ -7,6 +7,16 @@
 package org.readium.navigator.common
 
 import org.readium.r2.shared.ExperimentalReadiumApi
+import org.readium.r2.shared.publication.Locator
+
+/**
+ * An HTML Id.
+ */
+@ExperimentalReadiumApi
+@JvmInline
+public value class HtmlId(
+    public val value: String,
+)
 
 /**
  * A CSS selector.
@@ -24,7 +34,11 @@ public value class CssSelector(
 @JvmInline
 public value class Progression private constructor(
     public val value: Double,
-) {
+) : Comparable<Progression> {
+
+    override fun compareTo(other: Progression): Int {
+        return value.compareTo(other.value)
+    }
 
     public companion object {
 
@@ -41,11 +55,16 @@ public value class Progression private constructor(
 @JvmInline
 public value class Position private constructor(
     public val value: Int,
-) {
+) : Comparable<Position> {
+
+    override fun compareTo(other: Position): Int {
+        return value.compareTo(other.value)
+    }
+
     public companion object {
 
-        public operator fun invoke(value: Double): Position? =
-            value.takeIf { value >= 0 }
+        public operator fun invoke(value: Int): Position? =
+            value.takeIf { value >= 1 }
                 ?.let { Position(it) }
     }
 }
@@ -60,3 +79,42 @@ public data class TextQuote(
     val prefix: String,
     val suffix: String,
 )
+
+/**
+ * Returns a [TextAnchor] to the beginning or the end of the text quote.
+ */
+@ExperimentalReadiumApi
+public fun TextQuote.toTextAnchor(end: Boolean = false): TextAnchor =
+    when (end) {
+        false -> TextAnchor(
+            textBefore = prefix,
+            textAfter = text + suffix
+        )
+        true -> TextAnchor(
+            textBefore = prefix + text,
+            textAfter = suffix
+        )
+    }
+
+/**
+ * A [TextAnchor] is a pair of short text snippets allowing to locate in a text.
+ */
+@ExperimentalReadiumApi
+public data class TextAnchor(
+    val textBefore: String,
+    val textAfter: String,
+)
+
+@ExperimentalReadiumApi
+public fun Locator.Text.toTextQuote(): TextQuote? =
+    highlight?.let { highlight ->
+        TextQuote(
+            text = highlight,
+            prefix = before.orEmpty(),
+            suffix = after.orEmpty()
+        )
+    }
+
+@ExperimentalReadiumApi
+public fun Locator.Text.toTextAnchor(end: Boolean = false): TextAnchor? =
+    toTextQuote()?.toTextAnchor(end)

readium/navigators/common/src/main/java/org/readium/navigator/common/Locations.kt

@@ -63,3 +63,9 @@ public interface PositionLocation : Location {
 
     public val position: Position
 }
+
+@ExperimentalReadiumApi
+public interface TextAnchorLocation : Location {
+
+    public val textAnchor: TextAnchor
+}

readium/navigators/web/common/build.gradle.kts

@@ -23,10 +23,7 @@ dependencies {
     api(project(":readium:readium-navigator"))
     api(project(":readium:navigators:readium-navigator-common"))
 
-    api(libs.kotlinx.collections.immutable)
+    api(libs.androidx.compose.foundation)
 
-    implementation(libs.kotlinx.serialization.json)
-    implementation(libs.bundles.compose)
     implementation(libs.timber)
-    implementation(libs.kotlinx.coroutines.android)
 }

readium/navigators/web/common/src/main/kotlin/org/readium/navigator/web/common/FontFamilyDeclarations.kt

@@ -8,10 +8,11 @@
 
 package org.readium.navigator.web.common
 
-import kotlinx.collections.immutable.*
 import kotlinx.collections.immutable.ImmutableList
+import kotlinx.collections.immutable.PersistentList
 import kotlinx.collections.immutable.persistentListOf
-import kotlinx.serialization.Serializable
+import kotlinx.collections.immutable.plus
+import kotlinx.collections.immutable.toImmutableList
 import org.readium.r2.navigator.preferences.FontFamily
 import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.util.Either
@@ -214,29 +215,3 @@ public enum class FontWeight(public val value: Int) {
     EXTRA_BOLD(800),
     BLACK(900),
 }
-
-/**
- * Typeface for a publication's text.
- *
- * For a list of vetted font families, see https://readium.org/readium-css/docs/CSS10-libre_fonts.
- */
-@ExperimentalReadiumApi
-@JvmInline
-@Serializable
-public value class FontFamily(public val name: String) {
-
-    public companion object {
-        // Generic font families
-        // See https://www.w3.org/TR/css-fonts-4/#generic-font-families
-        public val SERIF: FontFamily = FontFamily("serif")
-        public val SANS_SERIF: FontFamily = FontFamily("sans-serif")
-        public val CURSIVE: FontFamily = FontFamily("cursive")
-        public val FANTASY: FontFamily = FontFamily("fantasy")
-        public val MONOSPACE: FontFamily = FontFamily("monospace")
-
-        // Accessibility fonts embedded with Readium
-        public val ACCESSIBLE_DFA: FontFamily = FontFamily("AccessibleDfA")
-        public val IA_WRITER_DUOSPACE: FontFamily = FontFamily("IA Writer Duospace")
-        public val OPEN_DYSLEXIC: FontFamily = FontFamily("OpenDyslexic")
-    }
-}

readium/navigators/web/fixedlayout/build.gradle.kts

@@ -25,11 +25,9 @@ dependencies {
     api(project(":readium:navigators:web:readium-navigator-web-common"))
     implementation(project(":readium:navigators:web:readium-navigator-web-internals"))
 
-    implementation(libs.kotlinx.serialization.json)
-    implementation(libs.kotlinx.collections.immutable)
-    implementation(libs.bundles.compose)
+    api(libs.androidx.compose.foundation)
+
     implementation(libs.timber)
-    implementation(libs.kotlinx.coroutines.android)
     implementation(libs.androidx.webkit)
     implementation(libs.jsoup)
 }

readium/navigators/web/fixedlayout/src/main/kotlin/org/readium/navigator/web/fixedlayout/FixedWebLocations.kt

@@ -15,6 +15,9 @@ import org.readium.navigator.common.DecorationLocation
 import org.readium.navigator.common.ExportableLocation
 import org.readium.navigator.common.GoLocation
 import org.readium.navigator.common.Location
+import org.readium.navigator.common.Position
+import org.readium.navigator.common.PositionLocation
+import org.readium.navigator.common.Progression
 import org.readium.navigator.common.SelectionLocation
 import org.readium.navigator.common.TextQuote
 import org.readium.navigator.common.TextQuoteLocation
@@ -87,26 +90,32 @@ public sealed interface FixedWebDecorationLocation : DecorationLocation {
 
 internal data class FixedWebDecorationCssSelectorLocation(
     override val href: Url,
-    val cssSelector: CssSelector,
-) : FixedWebDecorationLocation
+    override val cssSelector: CssSelector,
+) : FixedWebDecorationLocation, CssSelectorLocation
 
 internal data class FixedWebDecorationTextQuoteLocation(
     override val href: Url,
-    val textQuote: TextQuote,
+    override val textQuote: TextQuote,
     val cssSelector: CssSelector?,
-) : FixedWebDecorationLocation
+) : FixedWebDecorationLocation, TextQuoteLocation
 
 @ExperimentalReadiumApi
 @ConsistentCopyVisibility
 public data class FixedWebLocation internal constructor(
     override val href: Url,
+    override val position: Position,
+    val totalProgression: Progression,
     private val mediaType: MediaType?,
-) : ExportableLocation {
+) : ExportableLocation, PositionLocation {
 
     override fun toLocator(): Locator =
         Locator(
             href = href,
-            mediaType = mediaType ?: MediaType.XHTML
+            mediaType = mediaType ?: MediaType.XHTML,
+            locations = Locator.Locations(
+                position = position.value,
+                totalProgression = totalProgression.value
+            )
         )
 }