Skip to content

Add a new constructor to EpubParser to enable the use of a custom PositionsService #724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add a new constructor to EpubParser to enable the use of a custom PositionsService #724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ All notable changes to this project will be documented in this file. Take a look

### Added

#### Streamer

* Added a constructor to `EpubParser` to enable the use of a custom `PositionsService`.

#### Navigator

* New experimental positioning of EPUB decorations that places highlights behind text to improve legibility with opaque decorations (contributed by [@ddfreiling](https://github.com/readium/kotlin-toolkit/pull/721)).
Expand Down
20 changes: 16 additions & 4 deletions readium/streamer/src/main/java/org/readium/r2/streamer/parser/epub/EpubParser.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import org.readium.r2.shared.publication.Link
import org.readium.r2.shared.publication.Publication
import org.readium.r2.shared.publication.encryption.Encryption
import org.readium.r2.shared.publication.epub.EpubEncryptionParser
import org.readium.r2.shared.publication.services.PositionsService
import org.readium.r2.shared.publication.services.content.DefaultContentService
import org.readium.r2.shared.publication.services.content.iterators.HtmlResourceContentIterator
import org.readium.r2.shared.publication.services.search.StringSearchService
Expand Down Expand Up @@ -43,14 +44,25 @@ import org.readium.r2.streamer.parser.PublicationParser
/**
* Parses a Publication from an EPUB publication.
*
* @param reflowablePositionsStrategy Strategy used to calculate the number of positions in a
* reflowable resource.
* @constructor Creates an [EpubParser] using a custom [PositionsService] factory.
* @param positionsServiceFactory Factory to create the [PositionsService] that will be used
* by the publication.
*/
@OptIn(ExperimentalReadiumApi::class)
public class EpubParser(
private val reflowablePositionsStrategy: EpubPositionsService.ReflowableStrategy = EpubPositionsService.ReflowableStrategy.recommended,
private val positionsServiceFactory: (Publication.Service.Context) -> PositionsService,
) : PublicationParser {

/**
* Creates an [EpubParser] using the default [PositionsService] factory.
*
* @param reflowablePositionsStrategy Strategy used to calculate the number of positions in a
* reflowable resource.
*/
public constructor(
reflowablePositionsStrategy: EpubPositionsService.ReflowableStrategy = EpubPositionsService.ReflowableStrategy.recommended,
) : this(EpubPositionsService.createFactory(reflowablePositionsStrategy))

override suspend fun parse(
asset: Asset,
warnings: WarningLogger?,
Expand Down Expand Up @@ -103,7 +115,7 @@ public class EpubParser(
manifest = manifest,
container = container,
servicesBuilder = Publication.ServicesBuilder(
positions = EpubPositionsService.createFactory(reflowablePositionsStrategy),
positions = positionsServiceFactory,
search = StringSearchService.createDefaultFactory(),
content = DefaultContentService.createFactory(
resourceContentIteratorFactories = listOf(
Expand Down