aboutsummaryrefslogtreecommitdiff
path: root/project/spark-style/src/main/scala/org/apache/spark/scalastyle/SparkSpaceAfterCommentStyleCheck.scala
blob: 2f3c1a182814d5e43a8d6c5349cc16447b7b4f40 (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
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.spark.scalastyle

import java.util.regex.Pattern

import org.scalastyle.{PositionError, ScalariformChecker, ScalastyleError}
import scalariform.lexer.{MultiLineComment, ScalaDocComment, SingleLineComment, Token}
import scalariform.parser.CompilationUnit

class SparkSpaceAfterCommentStartChecker extends ScalariformChecker {
  val errorKey: String = "insert.a.single.space.after.comment.start"

  private def multiLineCommentRegex(comment: Token) =
    Pattern.compile( """/\*\S+.*""", Pattern.DOTALL).matcher(comment.text.trim).matches()

  private def scalaDocPatternRegex(comment: Token) =
    Pattern.compile( """/\*\*\S+.*""", Pattern.DOTALL).matcher(comment.text.trim).matches()

  private def singleLineCommentRegex(comment: Token): Boolean =
    comment.text.trim.matches( """//\S+.*""") && !comment.text.trim.matches( """///+""")

  override def verify(ast: CompilationUnit): List[ScalastyleError] = {
    ast.tokens
      .filter(hasComment)
      .map {
      _.associatedWhitespaceAndComments.comments.map {
        case x: SingleLineComment if singleLineCommentRegex(x.token) => Some(x.token.offset)
        case x: MultiLineComment if multiLineCommentRegex(x.token) => Some(x.token.offset)
        case x: ScalaDocComment if scalaDocPatternRegex(x.token) => Some(x.token.offset)
        case _ => None
      }.flatten
    }.flatten.map(PositionError(_))
  }


  private def hasComment(x: Token) =
    x.associatedWhitespaceAndComments != null && !x.associatedWhitespaceAndComments.comments.isEmpty

}