Implement PDF text search

Author: bashpsk

.idea/deploymentTargetSelector.xml

@@ -0,0 +1,104 @@
+package io.bashpsk.emptylibs.pdfviewer.extension
+
+import androidx.compose.ui.geometry.CornerRadius
+import androidx.compose.ui.geometry.Offset
+import androidx.compose.ui.geometry.Rect
+import androidx.compose.ui.geometry.Size
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.graphics.drawscope.DrawScope
+import androidx.compose.ui.unit.dp
+import io.bashpsk.emptylibs.pdfviewer.page.PdfPageData
+import io.bashpsk.emptylibs.pdfviewer.pdf.PdfLazyColumnProperties
+import kotlinx.collections.immutable.ImmutableList
+
+/**
+ * Draws the list of search result rectangles on the current [DrawScope].
+ *
+ * This function scales the search result coordinates from the original PDF page size
+ * to the current canvas dimensions and renders them using the search box color
+ * defined in [PdfLazyColumnProperties].
+ *
+ * @param pageData The data of the PDF page, containing the dimensions and the list of search result
+ * rectangles.
+ * @param properties The configuration properties for the PDF viewer, including the color used for
+ * search highlights.
+ */
+internal fun DrawScope.drawSearchRectList(
+    pageData: PdfPageData,
+    properties: PdfLazyColumnProperties
+) {
+
+    drawRectList(
+        pageWidth = pageData.width,
+        pageHeight = pageData.height,
+        color = properties.searchBoxColor,
+        rectList = pageData.searchRectList
+    )
+}
+
+/**
+ * Draws the list of selection rectangles onto the [DrawScope].
+ *
+ * This function scales the selection rectangles from the PDF page's coordinate system
+ * to the current canvas size and renders them using the selection color defined in [properties].
+ *
+ * @param pageData The data containing the original dimensions and the list of selection rectangles
+ * for the page.
+ * @param properties The configuration properties containing the color used for drawing selection
+ * highlights.
+ */
+internal fun DrawScope.drawSelectRectList(
+    pageData: PdfPageData,
+    properties: PdfLazyColumnProperties
+) {
+
+    drawRectList(
+        pageWidth = pageData.width,
+        pageHeight = pageData.height,
+        color = properties.selectBoxColor,
+        rectList = pageData.selectRectList
+    )
+}
+
+/**
+ * Draws a list of rounded rectangles onto the [DrawScope], scaling them from the original page
+ * coordinates to the current canvas dimensions.
+ *
+ * @param pageWidth The original width of the PDF page.
+ * @param pageHeight The original height of the PDF page.
+ * @param color The color to use for drawing the rectangles.
+ * @param rectList A nested list of [Rect] objects representing the areas to be drawn
+ * (e.g., search results or selections).
+ */
+private fun DrawScope.drawRectList(
+    pageWidth: Int,
+    pageHeight: Int,
+    color: Color,
+    rectList: ImmutableList<ImmutableList<Rect>>
+) {
+
+    if (rectList.isEmpty()) return
+
+    val scaleFactorX = size.width / pageWidth
+    val scaleFactorY = size.height / pageHeight
+
+    rectList.forEach { match ->
+
+        match.forEach { rect ->
+
+            val scaledRect = Rect(
+                left = rect.left * scaleFactorX,
+                top = rect.top * scaleFactorY,
+                right = rect.right * scaleFactorX,
+                bottom = rect.bottom * scaleFactorY
+            )
+
+            drawRoundRect(
+                topLeft = Offset(x = scaledRect.left, y = scaledRect.top),
+                size = Size(width = scaledRect.width, height = scaledRect.height),
+                cornerRadius = CornerRadius(x = 0.4.dp.toPx()),
+                color = color
+            )
+        }
+    }
+}

pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/extension/PdfPageExt.kt

@@ -0,0 +1,27 @@
+package io.bashpsk.emptylibs.pdfviewer.page
+
+import androidx.compose.runtime.Immutable
+import androidx.compose.ui.geometry.Rect
+import androidx.compose.ui.graphics.ImageBitmap
+import kotlinx.collections.immutable.ImmutableList
+import kotlinx.collections.immutable.persistentListOf
+
+/**
+ * Represents the data for a single page in a PDF document.
+ *
+ * @property page The page number.
+ * @property width The width of the page in pixels.
+ * @property height The height of the page in pixels.
+ * @property bitmap A low-quality bitmap representation of the page, used for previews.
+ * @property searchRectList A list of rectangles representing search matches in the page.
+ * @property selectRectList A list of rectangles representing selected regions in the page.
+ */
+@Immutable
+internal data class PdfPageData(
+    val page: Int = 0,
+    val width: Int = 0,
+    val height: Int = 0,
+    val bitmap: ImageBitmap? = null,
+    val searchRectList: ImmutableList<ImmutableList<Rect>> = persistentListOf(),
+    val selectRectList: ImmutableList<ImmutableList<Rect>> = persistentListOf()
+)

pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/page/PdfPageData.kt

@@ -1,4 +1,4 @@
-package io.bashpsk.emptylibs.pdfviewer.pdf
+package io.bashpsk.emptylibs.pdfviewer.page
 
 import androidx.compose.foundation.Image
 import androidx.compose.foundation.background
@@ -19,6 +19,7 @@ import androidx.compose.runtime.setValue
 import androidx.compose.runtime.snapshotFlow
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.draw.drawWithContent
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.graphics.ColorFilter
 import androidx.compose.ui.graphics.ImageBitmap
@@ -27,6 +28,9 @@ import androidx.compose.ui.layout.onFirstVisible
 import androidx.compose.ui.unit.round
 import io.bashpsk.emptylibs.formatter.format.EmptyFormat
 import io.bashpsk.emptylibs.jetpackui.layout.ZoomableLayout
+import io.bashpsk.emptylibs.pdfviewer.pdf.PdfLazyColumnDefaults
+import io.bashpsk.emptylibs.pdfviewer.pdf.PdfLazyColumnProperties
+import io.bashpsk.emptylibs.pdfviewer.pdf.PdfLazyColumnState
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.flow.collectLatest
@@ -44,6 +48,7 @@ import kotlin.time.Duration.Companion.milliseconds
  * @param isScrolling Whether the user is currently scrolling.
  * @param placeholder The color to use for the placeholder.
  * @param colorFilter The color filter to apply to the image.
+ * @param properties The properties for the PDF viewer.
  */
 @OptIn(FlowPreview::class)
 @Composable
@@ -53,7 +58,8 @@ internal fun PdfPageView(
     pageData: PdfPageData = PdfPageData(),
     isScrolling: Boolean = false,
     placeholder: Color = MaterialTheme.colorScheme.surfaceVariant,
-    colorFilter: ColorFilter? = null
+    colorFilter: ColorFilter? = null,
+    properties: PdfLazyColumnProperties = PdfLazyColumnDefaults.properties()
 ) {
 
     var scaledBitmap by retain { mutableStateOf<ImageBitmap?>(null) }
@@ -122,7 +128,13 @@ internal fun PdfPageView(
             Image(
                 modifier = Modifier
                     .fillMaxWidth()
-                    .aspectRatio(ratio = aspectRatio),
+                    .aspectRatio(ratio = aspectRatio)
+                    .drawWithContent {
+
+                        drawContent()
+//                        drawSearchRectList(pageData = pageData, properties = properties)
+//                        drawSelectRectList(pageData = pageData, properties = properties)
+                    },
                 bitmap = bitmap,
                 contentScale = ContentScale.Fit,
                 colorFilter = colorFilter,

…k/emptylibs/pdfviewer/pdf/PdfPageView.kt …/emptylibs/pdfviewer/page/PdfPageView.ktpdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/pdf/PdfPageView.kt renamed to pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/page/PdfPageView.kt pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/pdf/PdfPageView.kt renamed to pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/page/PdfPageView.kt

@@ -1,4 +1,4 @@
-package io.bashpsk.emptylibs.pdfviewer.pdf
+package io.bashpsk.emptylibs.pdfviewer.page
 
 import androidx.compose.runtime.Immutable
 import androidx.compose.ui.graphics.ImageBitmap
@@ -11,7 +11,7 @@ import androidx.compose.ui.graphics.ImageBitmap
  * @property bitmap A high-quality bitmap representation of the page.
  */
 @Immutable
-internal data class PdfQualityPageData(
+internal data class PdfScaledPageData(
     val page: Int = 0,
     val quality: Float = 1.0F,
     val bitmap: ImageBitmap? = null

…libs/pdfviewer/pdf/PdfQualityPageData.kt …libs/pdfviewer/page/PdfScaledPageData.ktpdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/pdf/PdfQualityPageData.kt renamed to pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/page/PdfScaledPageData.kt pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/pdf/PdfQualityPageData.kt renamed to pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/page/PdfScaledPageData.kt

@@ -27,6 +27,8 @@ import androidx.compose.ui.unit.Dp
 import androidx.compose.ui.unit.dp
 import io.bashpsk.emptylibs.gestureui.transform.transformableGestures
 import io.bashpsk.emptylibs.jetpackui.scrollbar.LazyListScrollBar
+import io.bashpsk.emptylibs.pdfviewer.page.PdfPageView
+import io.bashpsk.emptylibs.pdfviewer.utils.setDebug
 import kotlinx.collections.immutable.toImmutableList
 
 /**
@@ -36,6 +38,9 @@ import kotlinx.collections.immutable.toImmutableList
  * @param state The state of the PDF viewer.
  * @param pageSpace The space between pages.
  * @param scrollBarAlignment The alignment of the scrollbar.
+ * @param colorFilter The color filter to apply to the image.
+ * @param placeholder The color to use for the placeholder.
+ * @param properties The properties for the PDF viewer.
  * @param onClick A callback that is invoked when the user clicks on the PDF.
  * @param content A slot for composable content to be displayed on top of the PDF.
  */
@@ -47,6 +52,7 @@ fun PdfLazyColumn(
     scrollBarAlignment: Alignment = Alignment.TopEnd,
     colorFilter: ColorFilter? = null,
     placeholder: Color = MaterialTheme.colorScheme.surface,
+    properties: PdfLazyColumnProperties = PdfLazyColumnDefaults.properties(),
     onClick: (offset: Offset) -> Unit = {},
     content: @Composable @UiComposable BoxWithConstraintsScope.() -> Unit = {},
 ) {
@@ -67,6 +73,11 @@ fun PdfLazyColumn(
         derivedStateOf { state.transformable.touchCount == 1 }
     }
 
+    LaunchedEffect(pageDataList) {
+
+        "${pageDataList.firstOrNull()}".setDebug()
+    }
+
     BoxWithConstraints(
         modifier = modifier
             .clipToBounds()
@@ -106,7 +117,8 @@ fun PdfLazyColumn(
                     pageData = pageData,
                     isScrolling = isScrolling,
                     placeholder = placeholder,
-                    colorFilter = colorFilter
+                    colorFilter = colorFilter,
+                    properties = properties
                 )
             }
         }

pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/pdf/PdfLazyColumn.kt

@@ -0,0 +1,33 @@
+package io.bashpsk.emptylibs.pdfviewer.pdf
+
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.graphics.Color
+
+/**
+ * Contains the default values used by a PDF lazy column.
+ */
+object PdfLazyColumnDefaults {
+
+    /**
+     * Creates a [PdfLazyColumnProperties] instance with configurable colors for search and
+     * selection highlights.
+     *
+     * @param searchBoxColor The color applied to the highlight boxes when searching for text within
+     * the PDF.
+     * @param selectBoxColor The color applied to the highlight boxes when selecting text within the
+     * PDF.
+     * @return A [PdfLazyColumnProperties] object containing the specified color configurations.
+     */
+    @Composable
+    fun properties(
+        searchBoxColor: Color = MaterialTheme.colorScheme.primary.copy(alpha = 0.5F),
+        selectBoxColor: Color = MaterialTheme.colorScheme.primaryFixed.copy(alpha = 0.5F)
+    ): PdfLazyColumnProperties {
+
+        return PdfLazyColumnProperties(
+            searchBoxColor = searchBoxColor,
+            selectBoxColor = selectBoxColor
+        )
+    }
+}

pdf-viewer/src/main/kotlin/io/bashpsk/emptylibs/pdfviewer/pdf/PdfLazyColumnDefaults.kt

@@ -0,0 +1,16 @@
+package io.bashpsk.emptylibs.pdfviewer.pdf
+
+import androidx.compose.runtime.Stable
+import androidx.compose.ui.graphics.Color
+
+/**
+ * Configuration properties for styling the lazy column within a PDF viewer.
+ *
+ * @property searchBoxColor The [Color] used to highlight text matches during a search operation.
+ * @property selectBoxColor The [Color] used to highlight the background of selected text.
+ */
+@Stable
+data class PdfLazyColumnProperties(
+    val searchBoxColor: Color = Color.Unspecified,
+    val selectBoxColor: Color = Color.Unspecified
+)