com.hp.jipp.pdl.RenderableDocument.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jipp-pdl Show documentation

PWG-Raster and PCLm conversions

There is a newer version: 0.7.16

// Copyright 2018 HP Development Company, L.P.
// SPDX-License-Identifier: MIT

package com.hp.jipp.pdl

import com.hp.jipp.model.Sides

/** A document, consisting of a collection of [RenderablePage] objects. */
abstract class RenderableDocument : Iterable {
    /** Dots-per-inch used when rendering this document. */
    abstract val dpi: Int

    /** Return a new [RenderableDocument] from this one after transforming its pages. */
    fun mapPages(
        transform: (RenderableDocument) -> Iterable
    ): RenderableDocument =
        let { doc ->
            object : RenderableDocument() {
                override val dpi = doc.dpi
                private val pages = transform(doc)
                override fun iterator() = pages.iterator()
            }
        }

    /** Return a document with any necessary page insertions or re-orderings for two-sided output. */
    fun handleSides(settings: OutputSettings) =
        when (settings.sides) {
            Sides.oneSided -> this
            else -> handleSidesExtraBlank()
        }.handleReversed(settings)

    /** For a two-sided output document, return a document with an extra blank page added if necessary. */
    private fun handleSidesExtraBlank() =
        when {
            count().isOdd -> mapPages { it + listOf(it.last().blank()) }
            else -> this
        }

    /** For any document, return a document with the correct stacking order. */
    private fun handleReversed(settings: OutputSettings) =
        when {
            settings.reversed -> mapPages { it.reversed() }
            else -> this
        }
}