|
| 1 | +//===----------------------------------------------------------------------===// |
| 2 | +// |
| 3 | +// This source file is part of the Swift.org open source project |
| 4 | +// |
| 5 | +// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors |
| 6 | +// Licensed under Apache License v2.0 with Runtime Library Exception |
| 7 | +// |
| 8 | +// See https://swift.org/LICENSE.txt for license information |
| 9 | +// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors |
| 10 | +// |
| 11 | +//===----------------------------------------------------------------------===// |
| 12 | + |
| 13 | +import Foundation |
| 14 | +@_spi(Rules) import SwiftFormat |
| 15 | +import SwiftParser |
| 16 | +import SwiftSyntax |
| 17 | + |
| 18 | +/// Collects information about rules in the formatter code base. |
| 19 | +final class PrettyPrintCollector { |
| 20 | + |
| 21 | + /// A list of all the format-only pretty-print categories found in the code base. |
| 22 | + var allPrettyPrinterCategories = Set<String>() |
| 23 | + |
| 24 | + /// Populates the internal collections with rules in the given directory. |
| 25 | + /// |
| 26 | + /// - Parameter url: The file system URL that should be scanned for rules. |
| 27 | + func collect(from url: URL) throws { |
| 28 | + // For each file in the Rules directory, find types that either conform to SyntaxLintRule or |
| 29 | + // inherit from SyntaxFormatRule. |
| 30 | + let fm = FileManager.default |
| 31 | + guard let rulesEnumerator = fm.enumerator(atPath: url.path) else { |
| 32 | + fatalError("Could not list the directory \(url.path)") |
| 33 | + } |
| 34 | + |
| 35 | + for baseName in rulesEnumerator { |
| 36 | + // Ignore files that aren't Swift source files. |
| 37 | + guard let baseName = baseName as? String, baseName.hasSuffix(".swift") else { continue } |
| 38 | + |
| 39 | + let fileURL = url.appendingPathComponent(baseName) |
| 40 | + let fileInput = try String(contentsOf: fileURL) |
| 41 | + let sourceFile = Parser.parse(source: fileInput) |
| 42 | + |
| 43 | + for statement in sourceFile.statements { |
| 44 | + let pp = self.detectPrettyPrintCategories(at: statement) |
| 45 | + allPrettyPrinterCategories.formUnion(pp) |
| 46 | + } |
| 47 | + } |
| 48 | + } |
| 49 | + |
| 50 | + private func detectPrettyPrintCategories(at statement: CodeBlockItemSyntax) -> [String] { |
| 51 | + guard let enumDecl = statement.item.as(EnumDeclSyntax.self) else { |
| 52 | + return [] |
| 53 | + } |
| 54 | + |
| 55 | + // Make sure it has an inheritance clause. |
| 56 | + guard let inheritanceClause = enumDecl.inheritanceClause else { |
| 57 | + return [] |
| 58 | + } |
| 59 | + |
| 60 | + // Scan through the inheritance clause to find one of the protocols/types we're interested in. |
| 61 | + for inheritance in inheritanceClause.inheritedTypes { |
| 62 | + guard let identifier = inheritance.type.as(IdentifierTypeSyntax.self) else { |
| 63 | + continue |
| 64 | + } |
| 65 | + |
| 66 | + if identifier.name.text != "FindingCategorizing" { |
| 67 | + // Keep looking at the other inheritances. |
| 68 | + continue |
| 69 | + } |
| 70 | + |
| 71 | + // Now that we know it's a pretty printing category, collect the `description` method and extract the name. |
| 72 | + for member in enumDecl.memberBlock.members { |
| 73 | + guard let varDecl = member.decl.as(VariableDeclSyntax.self) else { continue } |
| 74 | + guard |
| 75 | + let descriptionDecl = varDecl.bindings |
| 76 | + .first(where: { |
| 77 | + $0.pattern.as(IdentifierPatternSyntax.self)?.identifier.text == "description" |
| 78 | + }) |
| 79 | + else { continue } |
| 80 | + let pp = PrettyPrintCategoryVisitor(viewMode: .sourceAccurate) |
| 81 | + _ = pp.walk(descriptionDecl) |
| 82 | + return pp.prettyPrintCategories |
| 83 | + } |
| 84 | + } |
| 85 | + |
| 86 | + return [] |
| 87 | + } |
| 88 | +} |
| 89 | + |
| 90 | +final class PrettyPrintCategoryVisitor: SyntaxVisitor { |
| 91 | + |
| 92 | + var prettyPrintCategories: [String] = [] |
| 93 | + |
| 94 | + override func visit(_ node: StringSegmentSyntax) -> SyntaxVisitorContinueKind { |
| 95 | + prettyPrintCategories.append(node.content.text) |
| 96 | + return .skipChildren |
| 97 | + } |
| 98 | +} |
0 commit comments