aboutsummaryrefslogtreecommitdiff
path: root/doc-tool/src/dotty/tools/dottydoc/model/comment/MarkdownShortener.scala
blob: f7d97095928a72c93076e32e86b59b656533bead (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
package dotty.tools
package dottydoc
package model
package comment

/** The `MarkdownShortener` takes a node and *mutates* it and all children so
  * that the displayed length of the generated HTML doesn't exceeed `maxLen`.
  * This number defaults to 150 characters.
  *
  * @note calling `shorten` **will** mutate the Markdown AST node.
  */
class MarkdownShortener {
  import com.vladsch.flexmark.ast._

  def shorten(node: Node, maxLen: Int = 150): Node = {
    var len = 0
    var didUnlinkListItem = false

    def count(node: Node, length: => Int, shortenOrUnlink: Int => Unit) = {
      val remaining = math.max(maxLen - len, 0)
      if (remaining == 0) node.unlink()
      else {
        if (length <= remaining) len += length
        else {
          shortenOrUnlink(remaining)
          len = maxLen
        }
      }
    }

    val nodeVisitor = new NodeVisitor(
      new VisitHandler(classOf[Text], new Visitor[Text] {
        override def visit(node: Text) = count(
          node,
          node.getChars.length,
          remaining => node.setChars(
            node.getChars.subSequence(0, remaining).trimEnd.append("...")
          )
        )
      }),
      new VisitHandler(classOf[Code], new Visitor[Code] {
        override def visit(node: Code) = count(
          node,
          node.getText.length,
          remaining => node.setText(
            node.getText.subSequence(0, remaining).trimEnd.append("...")
          )
        )
      }),
      new VisitHandler(classOf[Image], new Visitor[Image] {
        override def visit(node: Image) = count(node, maxLen, _ => node.unlink())
      }),
      new VisitHandler(classOf[BulletListItem], new Visitor[BulletListItem] {
        override def visit(node: BulletListItem) = count(
          node,
          if (didUnlinkListItem) maxLen
          else node.getSegments.map(_.length).reduceLeft(_ + _),
          _ => {
            node.unlink()
            didUnlinkListItem = true // unlink all following bullets
          }
        )
      }),
      new VisitHandler(classOf[OrderedListItem], new Visitor[OrderedListItem] {
        override def visit(node: OrderedListItem) = count(
          node,
          if (didUnlinkListItem) maxLen
          else node.getSegments.map(_.length).reduceLeft(_ + _),
          _ => {
            node.unlink()
            didUnlinkListItem = true // unlink all following bullets
          }
        )
      })
    )

    nodeVisitor.visit(node)
    node
  }
}