Skip to content

Commit

Permalink
Make Markdown Styles overridable
Browse files Browse the repository at this point in the history
  • Loading branch information
@janseeger
janseeger committed May 6, 2024
1 parent 2967cdd commit e9126af
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 25 deletions.
63 changes: 39 additions & 24 deletions dachlatten-compose/src/main/kotlin/de/sipgate/dachlatten/compose/markdown/ParseMarkdown.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,24 @@ internal val H5SPanStyle = SpanStyle(fontSize = 0.83.em, fontWeight = FontWeight
internal val H6SPanStyle = SpanStyle(fontSize = 0.75.em, fontWeight = FontWeight.Bold)
internal val LinkSpanStyle = SpanStyle(color = Color.Blue, textDecoration = TextDecoration.Underline)

data class MarkdownStyles(
val boldSpanStyle: SpanStyle = BoldSpanStyle,
val italicSpanStyle: SpanStyle = ItalicSpanStyle,
val monospaceSpanStyle: SpanStyle = MonospaceSpanStyle,
val strikethroughSpanStyle: SpanStyle = StrikethroughSpanStyle,
val h1SpanStyle: SpanStyle = H1SPanStyle,
val h2SpanStyle: SpanStyle = H2SPanStyle,
val h3SpanStyle: SpanStyle = H3SPanStyle,
val h4SpanStyle: SpanStyle = H4SPanStyle,
val h5SpanStyle: SpanStyle = H5SPanStyle,
val h6SpanStyle: SpanStyle = H6SPanStyle,
val linkSpanStyle: SpanStyle = LinkSpanStyle,
)

private fun AnnotatedString.removeRange(start: Int, end: Int) =
subSequence(0, start) + subSequence(end, length)

fun parseMarkdown(markdown: String): AnnotatedString {
fun parseMarkdown(markdown: String, styles: MarkdownStyles = MarkdownStyles()): AnnotatedString {
val tempNodesToRemoveAfter = mutableListOf<ASTNode>()
var tempString = buildAnnotatedString {
/*
Expand All @@ -49,7 +63,7 @@ fun parseMarkdown(markdown: String): AnnotatedString {
MarkdownParser(GFMFlavourDescriptor())
.buildMarkdownTreeFromString(markdown)
.children
.fastForEach { processNode(it, markdown, tempNodesToRemoveAfter::add) }
.fastForEach { processNode(it, markdown, styles, tempNodesToRemoveAfter::add) }
}

tempNodesToRemoveAfter.reversed().fastForEach {
Expand All @@ -63,19 +77,20 @@ fun parseMarkdown(markdown: String): AnnotatedString {
private fun AnnotatedString.Builder.processNode(
node: ASTNode,
markdown: String,
colors: MarkdownStyles,
tempNodesToRemoveAfter: (ASTNode) -> Unit
) {
fun ASTNode.processOneCharMarkdown(spanStyle: SpanStyle) {
tempNodesToRemoveAfter(children[0])
children.fastForEach { processNode(it, markdown, tempNodesToRemoveAfter) }
children.fastForEach { processNode(it, markdown, colors, tempNodesToRemoveAfter) }
tempNodesToRemoveAfter(children[children.lastIndex])
addStyle(spanStyle, startOffset + 1, endOffset - 1)
}

fun ASTNode.processTwoCharMarkdown(spanStyle: SpanStyle) {
tempNodesToRemoveAfter(children[0])
tempNodesToRemoveAfter(children[1])
children.fastForEach { processNode(it, markdown, tempNodesToRemoveAfter) }
children.fastForEach { processNode(it, markdown, colors, tempNodesToRemoveAfter) }
tempNodesToRemoveAfter(children[children.lastIndex - 1])
tempNodesToRemoveAfter(children[children.lastIndex])
addStyle(spanStyle, startOffset + 2, endOffset - 2)
Expand All @@ -94,15 +109,15 @@ private fun AnnotatedString.Builder.processNode(
tempNodesToRemoveAfter(headlineContent.children[0])

// process nodes and render headline text
children.fastForEach { processNode(it, markdown, tempNodesToRemoveAfter) }
children.fastForEach { processNode(it, markdown, colors, tempNodesToRemoveAfter) }

addStyle(spanStyle, startOffset + childOffset + whitespaceOffset, endOffset)
}

fun ASTNode.processInlineLink() {
// process link text node
val linkTextNode = children[0]
processNode(linkTextNode, markdown, tempNodesToRemoveAfter)
processNode(linkTextNode, markdown, colors, tempNodesToRemoveAfter)

// [
tempNodesToRemoveAfter(linkTextNode.children[0])
Expand All @@ -114,25 +129,25 @@ private fun AnnotatedString.Builder.processNode(
tempNodesToRemoveAfter(linkTextNode.children[2])

// (
processNode(children[1], markdown, tempNodesToRemoveAfter)
processNode(children[1], markdown, colors, tempNodesToRemoveAfter)
tempNodesToRemoveAfter(children[1])

// process destination
val linkDestinationNode = children[2]
processNode(linkDestinationNode, markdown, tempNodesToRemoveAfter)
processNode(linkDestinationNode, markdown, colors, tempNodesToRemoveAfter)
val linkDestination = linkDestinationNode.getTextInNode(markdown)
tempNodesToRemoveAfter(children[2])

// )
processNode(children[3], markdown, tempNodesToRemoveAfter)
processNode(children[3], markdown, colors, tempNodesToRemoveAfter)
tempNodesToRemoveAfter(children[3])

addUrlAnnotation(
UrlAnnotation(linkDestination.toString()),
linkTextNode.startOffset,
linkTextNode.endOffset
)
addStyle(LinkSpanStyle, linkTextNode.startOffset, linkTextNode.endOffset)
addStyle(colors.linkSpanStyle, linkTextNode.startOffset, linkTextNode.endOffset)
}

when (node.type) {
Expand All @@ -154,34 +169,34 @@ private fun AnnotatedString.Builder.processNode(
MarkdownTokenTypes.EOL -> append("\n")
MarkdownTokenTypes.BACKTICK -> append("`")
MarkdownTokenTypes.ATX_HEADER -> append("#".repeat(node.length))
MarkdownElementTypes.ATX_1 -> node.processHeadline(H1SPanStyle)
MarkdownElementTypes.ATX_2 -> node.processHeadline(H2SPanStyle)
MarkdownElementTypes.ATX_3 -> node.processHeadline(H3SPanStyle)
MarkdownElementTypes.ATX_4 -> node.processHeadline(H4SPanStyle)
MarkdownElementTypes.ATX_5 -> node.processHeadline(H5SPanStyle)
MarkdownElementTypes.ATX_6 -> node.processHeadline(H6SPanStyle)
MarkdownElementTypes.ATX_1 -> node.processHeadline(colors.h1SpanStyle)
MarkdownElementTypes.ATX_2 -> node.processHeadline(colors.h2SpanStyle)
MarkdownElementTypes.ATX_3 -> node.processHeadline(colors.h3SpanStyle)
MarkdownElementTypes.ATX_4 -> node.processHeadline(colors.h4SpanStyle)
MarkdownElementTypes.ATX_5 -> node.processHeadline(colors.h5SpanStyle)
MarkdownElementTypes.ATX_6 -> node.processHeadline(colors.h6SpanStyle)
MarkdownElementTypes.LINK_DESTINATION -> append(node.getTextInNode(markdown).toString())
else -> {
val nodeType = node.type
if (nodeType is MarkdownElementType && !nodeType.isToken) {
when (nodeType) {
MarkdownElementTypes.STRONG -> node.processTwoCharMarkdown(BoldSpanStyle)
MarkdownElementTypes.EMPH -> node.processOneCharMarkdown(ItalicSpanStyle)
GFMElementTypes.STRIKETHROUGH -> node.processTwoCharMarkdown(StrikethroughSpanStyle)
MarkdownElementTypes.STRONG -> node.processTwoCharMarkdown(colors.boldSpanStyle)
MarkdownElementTypes.EMPH -> node.processOneCharMarkdown(colors.italicSpanStyle)
GFMElementTypes.STRIKETHROUGH -> node.processTwoCharMarkdown(colors.strikethroughSpanStyle)
}
} else {
node.children.fastForEach { child ->
when (child.type) {
MarkdownElementTypes.STRONG -> child.processTwoCharMarkdown(BoldSpanStyle)
MarkdownElementTypes.STRONG -> child.processTwoCharMarkdown(colors.boldSpanStyle)
GFMElementTypes.STRIKETHROUGH ->
child.processTwoCharMarkdown(StrikethroughSpanStyle)
child.processTwoCharMarkdown(colors.strikethroughSpanStyle)

MarkdownElementTypes.EMPH -> child.processOneCharMarkdown(ItalicSpanStyle)
MarkdownElementTypes.EMPH -> child.processOneCharMarkdown(colors.italicSpanStyle)
MarkdownElementTypes.INLINE_LINK -> child.processInlineLink()
MarkdownElementTypes.CODE_SPAN ->
child.processOneCharMarkdown(MonospaceSpanStyle)
child.processOneCharMarkdown(colors.monospaceSpanStyle)

else -> processNode(child, markdown, tempNodesToRemoveAfter)
else -> processNode(child, markdown, colors, tempNodesToRemoveAfter)
}
}
}
Expand Down
11 changes: 10 additions & 1 deletion ...n-compose/src/test/kotlin/de/sipgate/dachlatten/compose/markdown/MarkdownConverterTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,17 @@ class MarkdownConverterTest {

parseMarkdown(markdown)
}
}

@Test
fun checkOverridingStylesWorks() {
val markdown = "Es ist eine `monospaced` Welt"

val parsedText = parseMarkdown(markdown, styles = MarkdownStyles(monospaceSpanStyle = SpanStyle(fontStyle = FontStyle.Italic)))
val overriddenSpan = parsedText.spanStyles.first { it.item.fontStyle == FontStyle.Italic }

assertEquals("monospaced", parsedText.slice(overriddenSpan))
}
}

private fun AnnotatedString.slice(span: AnnotatedString.Range<SpanStyle>): String =
text.substring(span.start, span.end)
Expand Down

0 comments on commit e9126af

Please sign in to comment.