|
| 1 | +// |
| 2 | +// TreeNodeProtocol+Extensions.swift |
| 3 | +// SyntaxKit |
| 4 | +// |
| 5 | +// Created by Leo Dion. |
| 6 | +// Copyright © 2025 BrightDigit. |
| 7 | +// |
| 8 | +// Permission is hereby granted, free of charge, to any person |
| 9 | +// obtaining a copy of this software and associated documentation |
| 10 | +// files (the “Software”), to deal in the Software without |
| 11 | +// restriction, including without limitation the rights to use, |
| 12 | +// copy, modify, merge, publish, distribute, sublicense, and/or |
| 13 | +// sell copies of the Software, and to permit persons to whom the |
| 14 | +// Software is furnished to do so, subject to the following |
| 15 | +// conditions: |
| 16 | +// |
| 17 | +// The above copyright notice and this permission notice shall be |
| 18 | +// included in all copies or substantial portions of the Software. |
| 19 | +// |
| 20 | +// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, |
| 21 | +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES |
| 22 | +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
| 23 | +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
| 24 | +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
| 25 | +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| 26 | +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 27 | +// OTHER DEALINGS IN THE SOFTWARE. |
| 28 | +// |
| 29 | + |
| 30 | +package import SwiftSyntax |
| 31 | + |
| 32 | +extension TreeNodeProtocol { |
| 33 | + package static func parseTree( |
| 34 | + from sourceFile: SourceFileSyntax, |
| 35 | + withFileName fileName: String = .defaultFileName, |
| 36 | + showingMissingTokens: Bool = false |
| 37 | + ) -> [Self] { |
| 38 | + // Use raw syntax tree without precedence folding for simplicity |
| 39 | + let syntax = Syntax(sourceFile) |
| 40 | + |
| 41 | + // Create visitor to traverse AST and extract structured information |
| 42 | + let visitor = TokenVisitor<Self>( |
| 43 | + locationConverter: SourceLocationConverter( |
| 44 | + fileName: fileName, |
| 45 | + tree: sourceFile |
| 46 | + ), |
| 47 | + showMissingTokens: false |
| 48 | + ) |
| 49 | + |
| 50 | + // Traverse the syntax tree and build our simplified representation |
| 51 | + _ = visitor.rewrite(syntax) |
| 52 | + |
| 53 | + // Return the tree nodes directly |
| 54 | + return visitor.tree |
| 55 | + } |
| 56 | +} |
| 57 | + |
| 58 | +// MARK: - Structure Extraction Extensions |
| 59 | + |
| 60 | +extension TreeNodeProtocol { |
| 61 | + /// Appends structural information from a SwiftSyntax node to the structure array. |
| 62 | + /// |
| 63 | + /// This method analyzes the node's internal structure and converts it into |
| 64 | + /// a simplified format with named properties and values, appending them to |
| 65 | + /// the structure array. It handles different structure types (layout, collection, |
| 66 | + /// choices) and processes their properties according to their specific requirements. |
| 67 | + /// |
| 68 | + /// - Parameters: |
| 69 | + /// - node: The SwiftSyntax node to analyze |
| 70 | + /// - allChildren: All child nodes of the syntax node |
| 71 | + internal func appendStructure( |
| 72 | + from node: Syntax, |
| 73 | + allChildren: SyntaxChildren |
| 74 | + ) { |
| 75 | + switch node.syntaxNodeType.structure { |
| 76 | + case .layout(let keyPaths): |
| 77 | + // Handle nodes with fixed structure (most syntax nodes) |
| 78 | + appendLayoutStructure( |
| 79 | + node: node, |
| 80 | + keyPaths: keyPaths, |
| 81 | + allChildren: allChildren |
| 82 | + ) |
| 83 | + case .collection(let syntax): |
| 84 | + // Handle collection nodes (lists, arrays, etc.) |
| 85 | + appendCollectionStructure( |
| 86 | + elementType: syntax, |
| 87 | + allChildren: allChildren |
| 88 | + ) |
| 89 | + case .choices: |
| 90 | + // Handle choice nodes (union types) - no special processing needed |
| 91 | + break |
| 92 | + } |
| 93 | + } |
| 94 | + |
| 95 | + private func appendLayoutStructure( |
| 96 | + node: Syntax, |
| 97 | + keyPaths: [AnyKeyPath], |
| 98 | + allChildren: SyntaxChildren |
| 99 | + ) { |
| 100 | + guard let syntaxNode = node.as(node.syntaxNodeType) else { |
| 101 | + return |
| 102 | + } |
| 103 | + |
| 104 | + for keyPath in keyPaths { |
| 105 | + appendKeyPathProperty( |
| 106 | + keyPath: keyPath, |
| 107 | + syntaxNode: syntaxNode, |
| 108 | + allChildren: allChildren |
| 109 | + ) |
| 110 | + } |
| 111 | + } |
| 112 | + |
| 113 | + private func appendKeyPathValue(_ anyValue: Any?, withName name: String) { |
| 114 | + switch anyValue { |
| 115 | + case let value as TokenSyntax: |
| 116 | + // Handle token nodes (keywords, identifiers, operators, etc.) |
| 117 | + structure.append( |
| 118 | + StructureProperty( |
| 119 | + token: name, |
| 120 | + tokenSyntax: value |
| 121 | + ) |
| 122 | + ) |
| 123 | + case let value as any SyntaxProtocol: |
| 124 | + // Handle nested syntax nodes - store type reference |
| 125 | + structure.append( |
| 126 | + StructureProperty(reference: name, type: value.syntaxNodeType) |
| 127 | + ) |
| 128 | + case let value?: |
| 129 | + // Handle primitive values |
| 130 | + structure.append( |
| 131 | + StructureProperty(primitive: name, value: value) |
| 132 | + ) |
| 133 | + case .none: |
| 134 | + // Property exists but is nil |
| 135 | + structure.append(StructureProperty(name: name)) |
| 136 | + } |
| 137 | + } |
| 138 | + |
| 139 | + private func appendKeyPathProperty( |
| 140 | + keyPath: AnyKeyPath, |
| 141 | + syntaxNode: any SyntaxProtocol, |
| 142 | + allChildren: SyntaxChildren |
| 143 | + ) { |
| 144 | + guard let name = String(keyPath) else { |
| 145 | + return |
| 146 | + } |
| 147 | + |
| 148 | + // Check if this property has an actual child node |
| 149 | + guard allChildren.contains(where: { child in child.keyPathInParent == keyPath }) else { |
| 150 | + // Property exists but has no value - mark as nil |
| 151 | + structure.append( |
| 152 | + StructureProperty(nilValueWithName: name) |
| 153 | + ) |
| 154 | + return |
| 155 | + } |
| 156 | + |
| 157 | + // Extract the actual property value |
| 158 | + let keyPath = keyPath as AnyKeyPath |
| 159 | + appendKeyPathValue(syntaxNode[keyPath: keyPath], withName: name) |
| 160 | + } |
| 161 | + |
| 162 | + private func appendCollectionStructure( |
| 163 | + elementType: Any.Type, |
| 164 | + allChildren: SyntaxChildren |
| 165 | + ) { |
| 166 | + // Mark as collection type |
| 167 | + type = .collection |
| 168 | + |
| 169 | + // Add element type information |
| 170 | + structure.append( |
| 171 | + StructureProperty(elementWithType: elementType) |
| 172 | + ) |
| 173 | + |
| 174 | + // Add count information |
| 175 | + structure.append( |
| 176 | + StructureProperty(collectionWithCount: allChildren.count) |
| 177 | + ) |
| 178 | + } |
| 179 | +} |
| 180 | + |
| 181 | +extension String { |
| 182 | + fileprivate static let defaultFileName = "" |
| 183 | + |
| 184 | + fileprivate init?(_ keyPath: AnyKeyPath) { |
| 185 | + let keyPathString = String(describing: keyPath) |
| 186 | + |
| 187 | + // Extract the last component after the last dot |
| 188 | + if let lastDotIndex = keyPathString.lastIndex(of: ".") { |
| 189 | + let afterDot = keyPathString[keyPathString.index(after: lastDotIndex)...] |
| 190 | + self = String(afterDot) |
| 191 | + } else { |
| 192 | + // If no dots found, use the whole string |
| 193 | + guard !keyPathString.isEmpty else { |
| 194 | + return nil |
| 195 | + } |
| 196 | + self = keyPathString |
| 197 | + } |
| 198 | + } |
| 199 | +} |
0 commit comments