4 Commits

Author SHA1 Message Date
shahondin1624
62aa32c13d feat: use Worte/Weise labels and render metadata at page bottom (Closes #5)
Add metadata_labels ("abbreviated"/"german") and metadata_position
("top"/"bottom") options to LayoutConfig. German labels use "Worte:" and
"Weise:" instead of "T:" and "M:", with "Worte und Weise:" when lyricist
and composer are the same person. Metadata at bottom position renders
after notes with word-wrapping. MeasurementEngine accounts for two-line
metadata in German label mode.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-17 09:41:48 +01:00
shahondin1624
0139327034 feat: highlight the current book's column in the TOC (Closes #6)
Add TocConfig with highlightColumn field to BookConfig. TocRenderer now
applies a light gray background shading to the designated column header
and data cells, making it easy to visually distinguish the current book's
page numbers from reference book columns.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-17 09:35:47 +01:00
shahondin1624
ba035159f7 feat: display reference book page numbers in song page footer (Closes #3)
Render a two-row footer at the bottom of each song page showing reference
book abbreviations as column headers with corresponding page numbers below.
A thin separator line is drawn above the footer. MeasurementEngine now
reserves vertical space for the reference footer when reference books are
configured and the song has references.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-17 09:32:52 +01:00
shahondin1624
8e4728c55a feat: add support for foreword/preface pages (Closes #1)
Add ForewordConfig to BookConfig, Foreword model type, ForewordParser for
text files (quote/paragraphs/signatures), ForewordPage in PageContent,
pipeline integration to insert foreword after TOC, and PDF rendering with
styled quote, horizontal rule separator, word-wrapped paragraphs, and
right-aligned signatures.

Also adds Gradle wrapper and adjusts build toolchain for JDK 25 compat.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-17 09:27:00 +01:00
17 changed files with 1118 additions and 34 deletions

View File

@@ -2,6 +2,7 @@ package de.pfadfinder.songbook.app
import de.pfadfinder.songbook.model.* import de.pfadfinder.songbook.model.*
import de.pfadfinder.songbook.parser.* import de.pfadfinder.songbook.parser.*
import de.pfadfinder.songbook.parser.ForewordParser
import de.pfadfinder.songbook.layout.* import de.pfadfinder.songbook.layout.*
import de.pfadfinder.songbook.renderer.pdf.* import de.pfadfinder.songbook.renderer.pdf.*
import mu.KotlinLogging import mu.KotlinLogging
@@ -80,6 +81,19 @@ class SongbookPipeline(private val projectDir: File) {
logger.info { "Parsed ${sortedSongs.size} songs" } logger.info { "Parsed ${sortedSongs.size} songs" }
// 2b. Parse foreword (if configured)
var foreword: Foreword? = null
val forewordConfig = config.foreword
if (forewordConfig != null) {
val forewordFile = File(projectDir, forewordConfig.file)
if (forewordFile.exists()) {
logger.info { "Parsing foreword: ${forewordFile.absolutePath}" }
foreword = ForewordParser.parseFile(forewordFile)
} else {
logger.warn { "Foreword file not found: ${forewordFile.absolutePath}" }
}
}
// 3. Measure songs // 3. Measure songs
val fontMetrics = PdfFontMetrics() val fontMetrics = PdfFontMetrics()
val measurementEngine = MeasurementEngine(fontMetrics, config) val measurementEngine = MeasurementEngine(fontMetrics, config)
@@ -89,14 +103,25 @@ class SongbookPipeline(private val projectDir: File) {
val tocGenerator = TocGenerator(config) val tocGenerator = TocGenerator(config)
val tocPages = tocGenerator.estimateTocPages(sortedSongs) val tocPages = tocGenerator.estimateTocPages(sortedSongs)
val paginationEngine = PaginationEngine(config) // Foreword always takes 2 pages (for double-sided printing)
val pages = paginationEngine.paginate(measuredSongs, tocPages) val forewordPages = if (foreword != null) 2 else 0
val tocEntries = tocGenerator.generate(pages, tocPages) val paginationEngine = PaginationEngine(config)
val pages = paginationEngine.paginate(measuredSongs, tocPages + forewordPages)
val tocEntries = tocGenerator.generate(pages, tocPages + forewordPages)
// Build final page list with foreword pages inserted before song content
val allPages = mutableListOf<PageContent>()
if (foreword != null) {
allPages.add(PageContent.ForewordPage(foreword, 0))
allPages.add(PageContent.ForewordPage(foreword, 1))
}
allPages.addAll(pages)
val layoutResult = LayoutResult( val layoutResult = LayoutResult(
tocPages = tocPages, tocPages = tocPages,
pages = pages, pages = allPages,
tocEntries = tocEntries tocEntries = tocEntries
) )

View File

@@ -2,8 +2,15 @@ plugins {
kotlin("jvm") kotlin("jvm")
} }
java {
sourceCompatibility = JavaVersion.VERSION_21
targetCompatibility = JavaVersion.VERSION_21
}
kotlin { kotlin {
jvmToolchain(21) compilerOptions {
jvmTarget.set(org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_21)
}
} }
tasks.withType<Test> { tasks.withType<Test> {

View File

@@ -1 +1 @@
org.gradle.java.home=/usr/lib/jvm/java-21-openjdk org.gradle.java.home=/usr/lib/jvm/java-25-openjdk

BIN
gradle/wrapper/gradle-wrapper.jar vendored Normal file

Binary file not shown.

View File

@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.1-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

248
gradlew vendored Executable file
View File

@@ -0,0 +1,248 @@
#!/bin/sh
#
# Copyright © 2015 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
#
##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
echo "$*"
} >&2
die () {
echo
echo "$*"
echo
exit 1
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
if ! command -v java >/dev/null 2>&1
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Collect all arguments for the java command:
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
"$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"

93
gradlew.bat vendored Normal file
View File

@@ -0,0 +1,93 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@rem SPDX-License-Identifier: Apache-2.0
@rem
@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if %ERRORLEVEL% equ 0 goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:execute
@rem Setup the command line
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
:end
@rem End local scope for the variables with windows NT shell
if %ERRORLEVEL% equ 0 goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

View File

@@ -15,9 +15,16 @@ class MeasurementEngine(
// Title height // Title height
heightMm += fontMetrics.measureLineHeight(config.fonts.title, config.fonts.title.size) * 1.5f heightMm += fontMetrics.measureLineHeight(config.fonts.title, config.fonts.title.size) * 1.5f
// Metadata line (composer/lyricist) // Metadata lines (composer/lyricist) - may be 1 or 2 lines depending on label style
if (song.composer != null || song.lyricist != null) { if (song.composer != null || song.lyricist != null) {
heightMm += fontMetrics.measureLineHeight(config.fonts.metadata, config.fonts.metadata.size) * 1.8f val metaLineHeight = fontMetrics.measureLineHeight(config.fonts.metadata, config.fonts.metadata.size) * 1.8f
val useGerman = config.layout.metadataLabels == "german"
if (useGerman && song.lyricist != null && song.composer != null && song.lyricist != song.composer) {
// Two separate lines: "Worte: ..." and "Weise: ..."
heightMm += metaLineHeight * 2
} else {
heightMm += metaLineHeight
}
} }
// Key/capo line // Key/capo line
@@ -66,6 +73,13 @@ class MeasurementEngine(
} }
} }
// Reference book footer: reserve space for abbreviation row + page number row + separator line
if (config.referenceBooks.isNotEmpty() && song.references.isNotEmpty()) {
val metaLineHeight = fontMetrics.measureLineHeight(config.fonts.metadata, config.fonts.metadata.size)
heightMm += metaLineHeight * 1.4f * 2 // two rows (headers + numbers)
heightMm += metaLineHeight * 0.5f // separator line gap
}
val pageCount = if (heightMm <= contentHeightMm) 1 else 2 val pageCount = if (heightMm <= contentHeightMm) 1 else 2
return MeasuredSong(song, heightMm, pageCount) return MeasuredSong(song, heightMm, pageCount)
} }

View File

@@ -258,4 +258,70 @@ class MeasurementEngineTest {
labeledHeight shouldBeGreaterThan unlabeledHeight labeledHeight shouldBeGreaterThan unlabeledHeight
} }
@Test
fun `references add footer height when reference books configured`() {
val configWithRefs = BookConfig(
referenceBooks = listOf(
ReferenceBook(id = "mo", name = "Mundorgel", abbreviation = "MO"),
ReferenceBook(id = "pl", name = "Pfadfinderlied", abbreviation = "PL")
)
)
val engineWithRefs = MeasurementEngine(fontMetrics, configWithRefs)
val songWithRefs = Song(
title = "With Refs",
references = mapOf("mo" to 42, "pl" to 17),
sections = listOf(
SongSection(
type = SectionType.VERSE,
lines = listOf(SongLine(listOf(LineSegment(text = "Line"))))
)
)
)
val songWithoutRefs = Song(
title = "No Refs",
sections = listOf(
SongSection(
type = SectionType.VERSE,
lines = listOf(SongLine(listOf(LineSegment(text = "Line"))))
)
)
)
val heightWith = engineWithRefs.measure(songWithRefs).totalHeightMm
val heightWithout = engineWithRefs.measure(songWithoutRefs).totalHeightMm
heightWith shouldBeGreaterThan heightWithout
}
@Test
fun `references do not add height when no reference books configured`() {
val songWithRefs = Song(
title = "With Refs",
references = mapOf("mo" to 42),
sections = listOf(
SongSection(
type = SectionType.VERSE,
lines = listOf(SongLine(listOf(LineSegment(text = "Line"))))
)
)
)
val songWithoutRefs = Song(
title = "No Refs",
sections = listOf(
SongSection(
type = SectionType.VERSE,
lines = listOf(SongLine(listOf(LineSegment(text = "Line"))))
)
)
)
// Default config has no reference books
val heightWith = engine.measure(songWithRefs).totalHeightMm
val heightWithout = engine.measure(songWithoutRefs).totalHeightMm
// Should be the same since no reference books are configured
heightWith shouldBe heightWithout
}
} }

View File

@@ -7,7 +7,17 @@ data class BookConfig(
val layout: LayoutConfig = LayoutConfig(), val layout: LayoutConfig = LayoutConfig(),
val images: ImagesConfig = ImagesConfig(), val images: ImagesConfig = ImagesConfig(),
val referenceBooks: List<ReferenceBook> = emptyList(), val referenceBooks: List<ReferenceBook> = emptyList(),
val output: OutputConfig = OutputConfig() val output: OutputConfig = OutputConfig(),
val foreword: ForewordConfig? = null,
val toc: TocConfig = TocConfig()
)
data class TocConfig(
val highlightColumn: String? = null // abbreviation of the column to highlight (e.g. "CL")
)
data class ForewordConfig(
val file: String = "./foreword.txt"
) )
data class BookMeta( data class BookMeta(
@@ -41,7 +51,9 @@ data class LayoutConfig(
val margins: Margins = Margins(), val margins: Margins = Margins(),
val chordLineSpacing: Float = 3f, // mm val chordLineSpacing: Float = 3f, // mm
val verseSpacing: Float = 4f, // mm val verseSpacing: Float = 4f, // mm
val pageNumberPosition: String = "bottom-outer" val pageNumberPosition: String = "bottom-outer",
val metadataLabels: String = "abbreviated", // "abbreviated" (M:/T:) or "german" (Worte:/Weise:)
val metadataPosition: String = "top" // "top" (after title) or "bottom" (bottom of last page)
) )
data class Margins( data class Margins(

View File

@@ -0,0 +1,7 @@
package de.pfadfinder.songbook.model
data class Foreword(
val quote: String? = null,
val paragraphs: List<String> = emptyList(),
val signatures: List<String> = emptyList()
)

View File

@@ -10,6 +10,7 @@ sealed class PageContent {
data class SongPage(val song: Song, val pageIndex: Int) : PageContent() // pageIndex 0 or 1 for 2-page songs data class SongPage(val song: Song, val pageIndex: Int) : PageContent() // pageIndex 0 or 1 for 2-page songs
data class FillerImage(val imagePath: String) : PageContent() data class FillerImage(val imagePath: String) : PageContent()
data object BlankPage : PageContent() data object BlankPage : PageContent()
data class ForewordPage(val foreword: Foreword, val pageIndex: Int) : PageContent() // pageIndex 0 or 1 for multi-page forewords
} }
data class LayoutResult( data class LayoutResult(

View File

@@ -0,0 +1,96 @@
package de.pfadfinder.songbook.parser
import de.pfadfinder.songbook.model.Foreword
import java.io.File
object ForewordParser {
/**
* Parses a foreword text file into a [Foreword] object.
*
* Format:
* - Lines starting with `> ` are collected as the quote (multiple lines joined)
* - `---` is a horizontal rule separator (marks end of quote section)
* - Lines starting with `-- ` are signatures
* - Other non-blank lines are body text; blank lines separate paragraphs
*/
fun parse(input: String): Foreword {
val lines = input.lines()
val quoteLines = mutableListOf<String>()
val signatures = mutableListOf<String>()
val paragraphs = mutableListOf<String>()
var currentParagraph = StringBuilder()
var inQuote = true // Start assuming we might be in the quote section
var foundSeparator = false
for (rawLine in lines) {
val line = rawLine.trimEnd()
// Quote lines (before separator)
if (!foundSeparator && line.trimStart().startsWith("> ")) {
quoteLines.add(line.trimStart().removePrefix("> "))
continue
}
// If we had quote lines but now see non-quote content before separator,
// the quote section is done
if (!foundSeparator && quoteLines.isNotEmpty() && line.trimStart().isNotEmpty() && !line.trimStart().startsWith("> ")) {
if (line.trim() == "---") {
foundSeparator = true
inQuote = false
continue
}
}
// Separator line
if (line.trim() == "---") {
foundSeparator = true
inQuote = false
continue
}
// Signature lines
if (line.trimStart().startsWith("-- ")) {
signatures.add(line.trimStart().removePrefix("-- "))
continue
}
// Skip quote processing after we established there are no quotes
if (inQuote && quoteLines.isEmpty() && line.isBlank()) {
continue
}
inQuote = false
// Body paragraphs
if (line.isBlank()) {
if (currentParagraph.isNotEmpty()) {
paragraphs.add(currentParagraph.toString().trim())
currentParagraph = StringBuilder()
}
} else {
if (currentParagraph.isNotEmpty()) {
currentParagraph.append(" ")
}
currentParagraph.append(line.trim())
}
}
// Flush remaining paragraph
if (currentParagraph.isNotEmpty()) {
paragraphs.add(currentParagraph.toString().trim())
}
val quote = if (quoteLines.isNotEmpty()) quoteLines.joinToString(" ") else null
return Foreword(
quote = quote,
paragraphs = paragraphs,
signatures = signatures
)
}
fun parseFile(file: File): Foreword = parse(file.readText())
}

View File

@@ -1,6 +1,8 @@
package de.pfadfinder.songbook.parser package de.pfadfinder.songbook.parser
import io.kotest.matchers.collections.shouldHaveSize import io.kotest.matchers.collections.shouldHaveSize
import io.kotest.matchers.nulls.shouldBeNull
import io.kotest.matchers.nulls.shouldNotBeNull
import io.kotest.matchers.shouldBe import io.kotest.matchers.shouldBe
import kotlin.test.Test import kotlin.test.Test
@@ -167,6 +169,76 @@ class ConfigParserTest {
config.layout.verseSpacing shouldBe 6f config.layout.verseSpacing shouldBe 6f
} }
@Test
fun `parse config with foreword section`() {
val yaml = """
book:
title: "Test"
foreword:
file: "./vorwort.txt"
""".trimIndent()
val config = ConfigParser.parse(yaml)
config.foreword.shouldNotBeNull()
config.foreword!!.file shouldBe "./vorwort.txt"
}
@Test
fun `parse config without foreword section has null foreword`() {
val yaml = """
book:
title: "Test"
""".trimIndent()
val config = ConfigParser.parse(yaml)
config.foreword.shouldBeNull()
}
@Test
fun `parse config with toc highlight column`() {
val yaml = """
book:
title: "Test"
toc:
highlight_column: "CL"
""".trimIndent()
val config = ConfigParser.parse(yaml)
config.toc.highlightColumn shouldBe "CL"
}
@Test
fun `parse config without toc section uses defaults`() {
val yaml = """
book:
title: "Test"
""".trimIndent()
val config = ConfigParser.parse(yaml)
config.toc.highlightColumn.shouldBeNull()
}
@Test
fun `parse config with german metadata labels`() {
val yaml = """
book:
title: "Test"
layout:
metadata_labels: german
metadata_position: bottom
""".trimIndent()
val config = ConfigParser.parse(yaml)
config.layout.metadataLabels shouldBe "german"
config.layout.metadataPosition shouldBe "bottom"
}
@Test
fun `parse config with default metadata settings`() {
val yaml = """
book:
title: "Test"
""".trimIndent()
val config = ConfigParser.parse(yaml)
config.layout.metadataLabels shouldBe "abbreviated"
config.layout.metadataPosition shouldBe "top"
}
@Test @Test
fun `parse config ignores unknown properties`() { fun `parse config ignores unknown properties`() {
val yaml = """ val yaml = """

View File

@@ -0,0 +1,150 @@
package de.pfadfinder.songbook.parser
import io.kotest.matchers.collections.shouldBeEmpty
import io.kotest.matchers.collections.shouldHaveSize
import io.kotest.matchers.nulls.shouldBeNull
import io.kotest.matchers.nulls.shouldNotBeNull
import io.kotest.matchers.shouldBe
import kotlin.test.Test
class ForewordParserTest {
@Test
fun `parse foreword with quote, paragraphs and signatures`() {
val input = """
> This is a quote line one
> and quote line two
---
This is the first paragraph of the foreword body.
It continues on the next line.
This is the second paragraph.
-- Max Mustermann
-- Erika Mustermann
""".trimIndent()
val foreword = ForewordParser.parse(input)
foreword.quote.shouldNotBeNull()
foreword.quote shouldBe "This is a quote line one and quote line two"
foreword.paragraphs shouldHaveSize 2
foreword.paragraphs[0] shouldBe "This is the first paragraph of the foreword body. It continues on the next line."
foreword.paragraphs[1] shouldBe "This is the second paragraph."
foreword.signatures shouldHaveSize 2
foreword.signatures[0] shouldBe "Max Mustermann"
foreword.signatures[1] shouldBe "Erika Mustermann"
}
@Test
fun `parse foreword without quote`() {
val input = """
This is just a paragraph.
And another one.
-- Author Name
""".trimIndent()
val foreword = ForewordParser.parse(input)
foreword.quote.shouldBeNull()
foreword.paragraphs shouldHaveSize 2
foreword.paragraphs[0] shouldBe "This is just a paragraph."
foreword.paragraphs[1] shouldBe "And another one."
foreword.signatures shouldHaveSize 1
foreword.signatures[0] shouldBe "Author Name"
}
@Test
fun `parse foreword without signatures`() {
val input = """
> A beautiful quote
---
The foreword body text goes here.
""".trimIndent()
val foreword = ForewordParser.parse(input)
foreword.quote shouldBe "A beautiful quote"
foreword.paragraphs shouldHaveSize 1
foreword.paragraphs[0] shouldBe "The foreword body text goes here."
foreword.signatures.shouldBeEmpty()
}
@Test
fun `parse empty foreword`() {
val foreword = ForewordParser.parse("")
foreword.quote.shouldBeNull()
foreword.paragraphs.shouldBeEmpty()
foreword.signatures.shouldBeEmpty()
}
@Test
fun `parse foreword with only paragraphs`() {
val input = """
First paragraph.
Second paragraph.
Third paragraph.
""".trimIndent()
val foreword = ForewordParser.parse(input)
foreword.quote.shouldBeNull()
foreword.paragraphs shouldHaveSize 3
foreword.paragraphs[0] shouldBe "First paragraph."
foreword.paragraphs[1] shouldBe "Second paragraph."
foreword.paragraphs[2] shouldBe "Third paragraph."
foreword.signatures.shouldBeEmpty()
}
@Test
fun `parse foreword with multi-line paragraph`() {
val input = """
This is a long paragraph that
spans multiple lines and should
be joined into a single paragraph.
""".trimIndent()
val foreword = ForewordParser.parse(input)
foreword.paragraphs shouldHaveSize 1
foreword.paragraphs[0] shouldBe "This is a long paragraph that spans multiple lines and should be joined into a single paragraph."
}
@Test
fun `parse foreword with only a quote`() {
val input = """
> Just a quote
---
""".trimIndent()
val foreword = ForewordParser.parse(input)
foreword.quote shouldBe "Just a quote"
foreword.paragraphs.shouldBeEmpty()
foreword.signatures.shouldBeEmpty()
}
@Test
fun `parse foreword with multiple signatures`() {
val input = """
Some text here.
-- Person One
-- Person Two
-- Person Three
""".trimIndent()
val foreword = ForewordParser.parse(input)
foreword.paragraphs shouldHaveSize 1
foreword.signatures shouldHaveSize 3
foreword.signatures[0] shouldBe "Person One"
foreword.signatures[1] shouldBe "Person Two"
foreword.signatures[2] shouldBe "Person Three"
}
}

View File

@@ -74,6 +74,14 @@ class PdfBookRenderer : BookRenderer {
cb.beginText() cb.beginText()
cb.endText() cb.endText()
} }
is PageContent.ForewordPage -> {
val leftMargin = if (isRightPage) marginInner else marginOuter
renderForewordPage(
cb, fontMetrics, config,
pageContent.foreword, pageContent.pageIndex,
contentTop, leftMargin, contentWidth
)
}
} }
pageDecorator.addPageNumber(cb, currentPageNum, pageSize.width, pageSize.height) pageDecorator.addPageNumber(cb, currentPageNum, pageSize.width, pageSize.height)
@@ -96,6 +104,8 @@ class PdfBookRenderer : BookRenderer {
) { ) {
var y = contentTop var y = contentTop
val renderMetaAtBottom = config.layout.metadataPosition == "bottom"
if (pageIndex == 0) { if (pageIndex == 0) {
// Render title // Render title
val titleFont = fontMetrics.getBaseFont(config.fonts.title) val titleFont = fontMetrics.getBaseFont(config.fonts.title)
@@ -108,21 +118,23 @@ class PdfBookRenderer : BookRenderer {
cb.endText() cb.endText()
y -= titleSize * 1.5f y -= titleSize * 1.5f
// Render metadata line (composer/lyricist) // Render metadata line (composer/lyricist) - at top position only
val metaParts = mutableListOf<String>() if (!renderMetaAtBottom) {
song.composer?.let { metaParts.add("M: $it") } val metaParts = buildMetadataLines(song, config)
song.lyricist?.let { metaParts.add("T: $it") }
if (metaParts.isNotEmpty()) { if (metaParts.isNotEmpty()) {
val metaFont = fontMetrics.getBaseFont(config.fonts.metadata) val metaFont = fontMetrics.getBaseFont(config.fonts.metadata)
val metaSize = config.fonts.metadata.size val metaSize = config.fonts.metadata.size
for (metaLine in metaParts) {
cb.beginText() cb.beginText()
cb.setFontAndSize(metaFont, metaSize) cb.setFontAndSize(metaFont, metaSize)
cb.setColorFill(Color.GRAY) cb.setColorFill(Color.GRAY)
cb.setTextMatrix(leftMargin, y - metaSize) cb.setTextMatrix(leftMargin, y - metaSize)
cb.showText(metaParts.joinToString(" / ")) cb.showText(metaLine)
cb.endText() cb.endText()
y -= metaSize * 1.8f y -= metaSize * 1.8f
} }
}
}
// Render key and capo // Render key and capo
val infoParts = mutableListOf<String>() val infoParts = mutableListOf<String>()
@@ -233,6 +245,251 @@ class PdfBookRenderer : BookRenderer {
y -= metaSize * 1.5f y -= metaSize * 1.5f
} }
} }
// Render metadata at bottom of song page (if configured)
if (renderMetaAtBottom && pageIndex == 0) {
val metaParts = buildMetadataLines(song, config)
if (metaParts.isNotEmpty()) {
y -= 4f
val metaFont = fontMetrics.getBaseFont(config.fonts.metadata)
val metaSize = config.fonts.metadata.size
for (metaLine in metaParts) {
val wrappedLines = wrapText(metaLine, metaFont, metaSize, contentWidth)
for (wrappedLine in wrappedLines) {
cb.beginText()
cb.setFontAndSize(metaFont, metaSize)
cb.setColorFill(Color.GRAY)
cb.setTextMatrix(leftMargin, y - metaSize)
cb.showText(wrappedLine)
cb.endText()
y -= metaSize * 1.5f
}
}
}
}
// Render reference book footer on the last page of the song
if (config.referenceBooks.isNotEmpty() && song.references.isNotEmpty()) {
val isLastPage = (pageIndex == 0) // For now, all content renders on page 0
if (isLastPage) {
renderReferenceFooter(
cb, fontMetrics, config, song,
leftMargin, contentWidth,
config.layout.margins.bottom / 0.3528f
)
}
}
}
/**
* Build metadata lines based on configured label style.
* Returns a list of lines to render (may be empty).
*/
private fun buildMetadataLines(song: Song, config: BookConfig): List<String> {
val useGerman = config.layout.metadataLabels == "german"
val lines = mutableListOf<String>()
if (useGerman) {
// German labels: "Worte und Weise:" when same person, otherwise separate
if (song.lyricist != null && song.composer != null && song.lyricist == song.composer) {
lines.add("Worte und Weise: ${song.lyricist}")
} else {
song.lyricist?.let { lines.add("Worte: $it") }
song.composer?.let { lines.add("Weise: $it") }
}
} else {
// Abbreviated labels on a single line
val parts = mutableListOf<String>()
song.composer?.let { parts.add("M: $it") }
song.lyricist?.let { parts.add("T: $it") }
if (parts.isNotEmpty()) {
lines.add(parts.joinToString(" / "))
}
}
return lines
}
/**
* Renders reference book abbreviations and page numbers as a footer row
* at the bottom of the song page, above the page number.
*/
private fun renderReferenceFooter(
cb: PdfContentByte,
fontMetrics: PdfFontMetrics,
config: BookConfig,
song: Song,
leftMargin: Float,
contentWidth: Float,
bottomMargin: Float
) {
val metaFont = fontMetrics.getBaseFont(config.fonts.metadata)
val metaSize = config.fonts.metadata.size
val lineHeight = metaSize * 1.4f
// Position: just above the page number area
val footerY = bottomMargin + lineHeight * 0.5f
// Map book IDs to abbreviations
val refAbbreviations = config.referenceBooks.associate { it.id to it.abbreviation }
val books = config.referenceBooks
// Calculate column widths: evenly distribute across content width
val colWidth = contentWidth / books.size
// Row 1: Abbreviation headers
for ((i, book) in books.withIndex()) {
val x = leftMargin + i * colWidth
val abbr = book.abbreviation
val textWidth = metaFont.getWidthPoint(abbr, metaSize)
// Center text in column
val textX = x + (colWidth - textWidth) / 2
cb.beginText()
cb.setFontAndSize(metaFont, metaSize)
cb.setColorFill(Color.DARK_GRAY)
cb.setTextMatrix(textX, footerY + lineHeight)
cb.showText(abbr)
cb.endText()
}
// Row 2: Page numbers
for ((i, book) in books.withIndex()) {
val x = leftMargin + i * colWidth
val pageNum = song.references[book.id]
if (pageNum != null) {
val pageText = pageNum.toString()
val textWidth = metaFont.getWidthPoint(pageText, metaSize)
val textX = x + (colWidth - textWidth) / 2
cb.beginText()
cb.setFontAndSize(metaFont, metaSize)
cb.setColorFill(Color.DARK_GRAY)
cb.setTextMatrix(textX, footerY)
cb.showText(pageText)
cb.endText()
}
}
// Draw a thin line above the footer
cb.setLineWidth(0.3f)
cb.setColorStroke(Color.LIGHT_GRAY)
cb.moveTo(leftMargin, footerY + lineHeight * 1.5f)
cb.lineTo(leftMargin + contentWidth, footerY + lineHeight * 1.5f)
cb.stroke()
}
private fun renderForewordPage(
cb: PdfContentByte,
fontMetrics: PdfFontMetrics,
config: BookConfig,
foreword: Foreword,
pageIndex: Int,
contentTop: Float,
leftMargin: Float,
contentWidth: Float
) {
var y = contentTop
val bodyFontSpec = config.fonts.lyrics
val bodyFont = fontMetrics.getBaseFont(bodyFontSpec)
val bodySize = bodyFontSpec.size
val lineHeight = bodySize * 1.5f
if (pageIndex == 0) {
// Page 1: Quote + separator + first paragraphs
// Render quote in italic (bold)
val quoteText = foreword.quote
if (quoteText != null) {
val quoteFont = fontMetrics.getBaseFontBold(bodyFontSpec)
val quoteSize = bodySize * 1.1f
// Word-wrap the quote text
val quoteLines = wrapText(quoteText, quoteFont, quoteSize, contentWidth)
for (quoteLine in quoteLines) {
cb.beginText()
cb.setFontAndSize(quoteFont, quoteSize)
cb.setColorFill(Color.DARK_GRAY)
cb.setTextMatrix(leftMargin, y - quoteSize)
cb.showText(quoteLine)
cb.endText()
y -= quoteSize * 1.5f
}
y -= 6f // gap before separator
// Horizontal rule
cb.setLineWidth(0.5f)
cb.setColorStroke(Color.GRAY)
cb.moveTo(leftMargin, y)
cb.lineTo(leftMargin + contentWidth, y)
cb.stroke()
y -= 10f // gap after separator
}
// Render body paragraphs
for (paragraph in foreword.paragraphs) {
val wrappedLines = wrapText(paragraph, bodyFont, bodySize, contentWidth)
for (wrappedLine in wrappedLines) {
cb.beginText()
cb.setFontAndSize(bodyFont, bodySize)
cb.setColorFill(Color.BLACK)
cb.setTextMatrix(leftMargin, y - bodySize)
cb.showText(wrappedLine)
cb.endText()
y -= lineHeight
}
y -= lineHeight * 0.5f // paragraph spacing
}
// Render signatures (right-aligned)
if (foreword.signatures.isNotEmpty()) {
y -= lineHeight // extra gap before signatures
val metaFont = fontMetrics.getBaseFont(config.fonts.metadata)
val metaSize = config.fonts.metadata.size
for (signature in foreword.signatures) {
val sigWidth = metaFont.getWidthPoint(signature, metaSize)
cb.beginText()
cb.setFontAndSize(metaFont, metaSize)
cb.setColorFill(Color.DARK_GRAY)
cb.setTextMatrix(leftMargin + contentWidth - sigWidth, y - metaSize)
cb.showText(signature)
cb.endText()
y -= metaSize * 1.8f
}
}
} else {
// Page 2: blank (or overflow content if needed in the future)
cb.beginText()
cb.endText()
}
}
/**
* Simple word-wrap: splits text into lines that fit within maxWidth (in points).
*/
private fun wrapText(text: String, font: BaseFont, fontSize: Float, maxWidth: Float): List<String> {
val words = text.split(" ")
val lines = mutableListOf<String>()
var currentLine = StringBuilder()
for (word in words) {
val testLine = if (currentLine.isEmpty()) word else "$currentLine $word"
val testWidth = font.getWidthPoint(testLine, fontSize)
if (testWidth <= maxWidth) {
currentLine = StringBuilder(testLine)
} else {
if (currentLine.isNotEmpty()) {
lines.add(currentLine.toString())
}
currentLine = StringBuilder(word)
}
}
if (currentLine.isNotEmpty()) {
lines.add(currentLine.toString())
}
return lines
} }
private fun renderFillerImage(document: Document, imagePath: String, pageSize: Rectangle) { private fun renderFillerImage(document: Document, imagePath: String, pageSize: Rectangle) {

View File

@@ -3,11 +3,15 @@ package de.pfadfinder.songbook.renderer.pdf
import com.lowagie.text.* import com.lowagie.text.*
import com.lowagie.text.pdf.* import com.lowagie.text.pdf.*
import de.pfadfinder.songbook.model.* import de.pfadfinder.songbook.model.*
import java.awt.Color
class TocRenderer( class TocRenderer(
private val fontMetrics: PdfFontMetrics, private val fontMetrics: PdfFontMetrics,
private val config: BookConfig private val config: BookConfig
) { ) {
// Light gray background for the highlighted column
private val highlightColor = Color(220, 220, 220)
fun render(document: Document, writer: PdfWriter, tocEntries: List<TocEntry>) { fun render(document: Document, writer: PdfWriter, tocEntries: List<TocEntry>) {
val tocFont = fontMetrics.getBaseFont(config.fonts.toc) val tocFont = fontMetrics.getBaseFont(config.fonts.toc)
val tocBoldFont = fontMetrics.getBaseFontBold(config.fonts.toc) val tocBoldFont = fontMetrics.getBaseFontBold(config.fonts.toc)
@@ -35,12 +39,25 @@ class TocRenderer(
} }
table.setWidths(widths) table.setWidths(widths)
// Determine which column index should be highlighted
val highlightAbbrev = config.toc.highlightColumn
val highlightColumnIndex: Int? = if (highlightAbbrev != null) {
// Check "Seite" (page) column first - the current book's page number column
if (highlightAbbrev == "Seite") {
1
} else {
val refIndex = refBooks.indexOfFirst { it.abbreviation == highlightAbbrev }
if (refIndex >= 0) 2 + refIndex else null
}
} else null
// Header row // Header row
val headerFont = Font(tocBoldFont, fontSize, Font.BOLD) val headerFont = Font(tocBoldFont, fontSize, Font.BOLD)
table.addCell(headerCell("Titel", headerFont)) table.addCell(headerCell("Titel", headerFont, isHighlighted = false))
table.addCell(headerCell("Seite", headerFont)) table.addCell(headerCell("Seite", headerFont, isHighlighted = highlightColumnIndex == 1))
for (book in refBooks) { for ((i, book) in refBooks.withIndex()) {
table.addCell(headerCell(book.abbreviation, headerFont)) val isHighlighted = highlightColumnIndex == 2 + i
table.addCell(headerCell(book.abbreviation, headerFont, isHighlighted = isHighlighted))
} }
table.headerRows = 1 table.headerRows = 1
@@ -49,31 +66,43 @@ class TocRenderer(
val aliasFont = Font(tocFont, fontSize, Font.ITALIC) val aliasFont = Font(tocFont, fontSize, Font.ITALIC)
for (entry in tocEntries.sortedBy { it.title.lowercase() }) { for (entry in tocEntries.sortedBy { it.title.lowercase() }) {
val font = if (entry.isAlias) aliasFont else entryFont val font = if (entry.isAlias) aliasFont else entryFont
table.addCell(entryCell(entry.title, font)) table.addCell(entryCell(entry.title, font, isHighlighted = false))
table.addCell(entryCell(entry.pageNumber.toString(), entryFont, Element.ALIGN_RIGHT)) table.addCell(entryCell(entry.pageNumber.toString(), entryFont, Element.ALIGN_RIGHT, isHighlighted = highlightColumnIndex == 1))
for (book in refBooks) { for ((i, book) in refBooks.withIndex()) {
val ref = entry.references[book.abbreviation] val ref = entry.references[book.abbreviation]
table.addCell(entryCell(ref?.toString() ?: "", entryFont, Element.ALIGN_RIGHT)) val isHighlighted = highlightColumnIndex == 2 + i
table.addCell(entryCell(ref?.toString() ?: "", entryFont, Element.ALIGN_RIGHT, isHighlighted = isHighlighted))
} }
} }
document.add(table) document.add(table)
} }
private fun headerCell(text: String, font: Font): PdfPCell { private fun headerCell(text: String, font: Font, isHighlighted: Boolean): PdfPCell {
val cell = PdfPCell(Phrase(text, font)) val cell = PdfPCell(Phrase(text, font))
cell.borderWidth = 0f cell.borderWidth = 0f
cell.borderWidthBottom = 0.5f cell.borderWidthBottom = 0.5f
cell.paddingBottom = 4f cell.paddingBottom = 4f
if (isHighlighted) {
cell.backgroundColor = highlightColor
}
return cell return cell
} }
private fun entryCell(text: String, font: Font, alignment: Int = Element.ALIGN_LEFT): PdfPCell { private fun entryCell(
text: String,
font: Font,
alignment: Int = Element.ALIGN_LEFT,
isHighlighted: Boolean = false
): PdfPCell {
val cell = PdfPCell(Phrase(text, font)) val cell = PdfPCell(Phrase(text, font))
cell.borderWidth = 0f cell.borderWidth = 0f
cell.horizontalAlignment = alignment cell.horizontalAlignment = alignment
cell.paddingTop = 1f cell.paddingTop = 1f
cell.paddingBottom = 1f cell.paddingBottom = 1f
if (isHighlighted) {
cell.backgroundColor = highlightColor
}
return cell return cell
} }
} }