-
Notifications
You must be signed in to change notification settings - Fork 55
/
CommentStyle.scala
130 lines (99 loc) · 4.15 KB
/
CommentStyle.scala
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
* Copyright 2015 Heiko Seeberger
*
* 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
*
* http://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.
*/
package de.heikoseeberger.sbtheader
import de.heikoseeberger.sbtheader.HeaderPlugin.autoImport.HeaderPattern.{
commentBetween,
commentStartingWith
}
import scala.util.matching.Regex
/**
* Representation of the different comment styles supported by this plugin.
*/
final case class CommentStyle(commentCreator: CommentCreator, pattern: Regex) {
def apply(licenseText: String, existingHeader: Option[String]): String =
commentCreator(licenseText, existingHeader) + NewLine + NewLine
def apply(license: License, existingHeader: Option[String]): String =
apply(license.text, existingHeader)
def apply(licenseText: String): String =
apply(licenseText, None)
def apply(license: License): String =
apply(license.text)
}
trait CommentCreator {
def apply(text: String, existingText: Option[String] = None): String
def apply(text: String): String = apply(text, None)
}
object CommentStyle {
val cStyleBlockComment: CommentStyle =
CommentStyle(
new CommentBlockCreator("/*", " *", " */"),
commentBetween("""/\*+""", "*", """\*/""")
)
val cppStyleLineComment: CommentStyle =
CommentStyle(new LineCommentCreator("//"), commentStartingWith("//"))
val hashLineComment: CommentStyle =
CommentStyle(new LineCommentCreator("#"), commentStartingWith("#"))
val twirlStyleBlockComment: CommentStyle =
CommentStyle(
new CommentBlockCreator("@*", " *", " *@"),
commentBetween("""@\*""", "*", """\*@""")
)
val twirlStyleFramedBlockComment: CommentStyle =
CommentStyle(TwirlStyleFramedBlockCommentCreator, commentBetween("""@\*+""", "*", """\*@"""))
val xmlStyleBlockComment: CommentStyle =
CommentStyle(new CommentBlockCreator("<!--", " ", "-->"), commentBetween("<!--", " ", "-->"))
}
object TwirlStyleFramedBlockCommentCreator extends CommentCreator {
def apply(text: String, existingText: Option[String]): String = {
val maxLineLength = text.linesIterator.map(_.length).max
def fillLine(line: String) =
" * " + line + spaces(maxLineLength - line.length) + " *"
val commentBlock = text.linesIterator.map(fillLine).mkString(NewLine)
val firstLine = "@**" + stars(maxLineLength + 2)
val lastLine = " " + firstLine.reverse
s"$firstLine$NewLine$commentBlock$NewLine$lastLine"
}
private def spaces(count: Int) = " " * count
private def stars(count: Int) = "*" * count
}
final class LineCommentCreator(linePrefix: String, lineSuffix: String = "") extends CommentCreator {
override def apply(text: String, existingText: Option[String]): String = {
def prependWithLinePrefix(s: String) =
s match {
case "" => if (linePrefix.trim.nonEmpty) linePrefix else ""
case line => s"$linePrefix $line"
}
def appendLineSuffix(s: String) =
s match {
case "" => ""
case line => // Only add the suffix when a prefix was added before
if (linePrefix.trim.nonEmpty && lineSuffix.trim.nonEmpty) s"$line $lineSuffix" else line
}
text.linesIterator.map(prependWithLinePrefix).map(appendLineSuffix).mkString(NewLine)
}
}
final class CommentBlockCreator(blockPrefix: String, linePrefix: String, blockSuffix: String)
extends CommentCreator {
private val lineCommentCreator = new LineCommentCreator(linePrefix)
def apply(text: String, existingText: Option[String]): String = {
val lineComment = lineCommentCreator(text)
s"$blockPrefix$NewLine$lineComment$NewLine$blockSuffix"
}
}
object IdentityCommentCreator extends CommentCreator {
override def apply(text: String, existingText: Option[String]): String =
text
}