Split Symbol.swift to reduce complexity of the file

Author: Kyle-Ye

Sources/SymbolKit/Mixin.swift

@@ -0,0 +1,24 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See https://swift.org/LICENSE.txt for license information
+ See https://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import Foundation
+
+/**
+ A protocol that allows extracted symbols to have extra data
+ aside from the base ``SymbolGraph/Symbol``.
+ */
+public protocol Mixin: Codable {
+    /**
+     The key under which a mixin's data is filed.
+
+     > Important: With respect to deserialization, this framework assumes `mixinKey`s between instances of `SymbolMixin` are unique.
+     */
+    static var mixinKey: String { get }
+}

Sources/SymbolKit/SymbolGraph/Misc/LineList.swift renamed to Sources/SymbolKit/SymbolGraph/LineList/LineList.swift

@@ -202,37 +202,3 @@ extension SymbolGraph.LineList {
         }
     }
 }
-
-extension SymbolGraph.LineList {
-    /**
-     Represents a selection in text: a start and end position, a half-open range.
-     */
-    public struct SourceRange: Equatable, Codable {
-        /**
-         The range's start position.
-         */
-        public var start: Position
-
-        /**
-         The range's end position.
-         */
-        public var end: Position
-    }
-}
-
-extension SymbolGraph.LineList.SourceRange {
-    /**
-     Represents a cursor position in text.
-     */
-    public struct Position: Equatable, Codable {
-        /**
-         The zero-based line number of a document.
-         */
-        public var line: Int
-
-        /**
-         The zero-based *byte offset* into a line.
-         */
-        public var character: Int
-    }
-}

Sources/SymbolKit/SymbolGraph/LineList/SourceRange/SourceRange+Position.swift

@@ -0,0 +1,28 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See https://swift.org/LICENSE.txt for license information
+ See https://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import Foundation
+
+extension SymbolGraph.LineList.SourceRange {
+    /**
+     Represents a cursor position in text.
+     */
+    public struct Position: Equatable, Codable {
+        /**
+         The zero-based line number of a document.
+         */
+        public var line: Int
+
+        /**
+         The zero-based *byte offset* into a line.
+         */
+        public var character: Int
+    }
+}

Sources/SymbolKit/SymbolGraph/LineList/SourceRange/SourceRange.swift

@@ -0,0 +1,28 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See https://swift.org/LICENSE.txt for license information
+ See https://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import Foundation
+
+extension SymbolGraph.LineList {
+    /**
+     Represents a selection in text: a start and end position, a half-open range.
+     */
+    public struct SourceRange: Equatable, Codable {
+        /**
+         The range's start position.
+         */
+        public var start: Position
+
+        /**
+         The range's end position.
+         */
+        public var end: Position
+    }
+}

Sources/SymbolKit/SymbolGraph/Relationship.swift

@@ -43,7 +43,7 @@ extension SymbolGraph {
             static var mixinKeys: Set<CodingKeys> {
                 return [
                     .swiftConstraints,
-                    .sourceOrigin
+                    .sourceOrigin,
                 ]
             }
         }
@@ -106,164 +106,3 @@ extension SymbolGraph {
         }
     }
 }
-
-extension SymbolGraph.Relationship {
-    /// The kind of relationship.
-    public struct Kind: Codable, RawRepresentable, Equatable, Hashable {
-        public var rawValue: String
-        public init(rawValue: String) {
-            self.rawValue = rawValue
-        }
-
-        /**
-         A symbol `A` is a member of another symbol `B`.
-
-         For example, a method or field of a class would be
-         a member of that class.
-
-         The implied inverse of this relationship is that
-         symbol `B` is the owner of a member symbol `A`.
-         */
-        public static let memberOf = Kind(rawValue: "memberOf")
-
-        /**
-         A symbol `A` conforms to an interface/protocol symbol `B`.
-
-         For example, a class `C` that conforms to protocol `P` in Swift would
-         use this relationship.
-
-         The implied inverse of this relationship is that
-         a symbol `B` that has a conformer `A`.
-         */
-        public static let conformsTo = Kind(rawValue: "conformsTo")
-
-        /**
-         A symbol `A` inherits another symbol `B`.
-
-         For example, a derived class inherits from a base class,
-         or a protocol that refines another protocol would use this relationship.
-
-         The implied inverse of this relationship is that
-         a symbol `B` is a base of another symbol `A`.
-         */
-        public static let inheritsFrom = Kind(rawValue: "inheritsFrom")
-
-        /**
-         A symbol `A` serves as a default implementation of
-         an interface requirement `B`.
-
-         The implied inverse of this relationship is that
-         an interface requirement `B` has a default implementation of `A`.
-         */
-        public static let defaultImplementationOf = Kind(rawValue: "defaultImplementationOf")
-
-        /**
-         A symbol `A` overrides another symbol `B`, typically through inheritance.
-
-         The implied inverse of this relationship is that
-         a symbol `A` is the base of symbol `B`.
-         */
-        public static let overrides = Kind(rawValue: "overrides")
-
-        /**
-         A symbol `A` is a requirement of interface `B`.
-
-         The implied inverse of this relationship is that
-         an interface `B` has a requirement of `A`.
-         */
-        public static let requirementOf = Kind(rawValue: "requirementOf")
-
-        /**
-         A symbol `A` is an optional requirement of interface `B`.
-
-         The implied inverse of this relationship is that
-         an interface `B` has an optional requirement of `A`.
-         */
-        public static let optionalRequirementOf = Kind(rawValue: "optionalRequirementOf")
-    }
-}
-
-// MARK: - Mixins
-
-extension SymbolGraph.Relationship {
-    /// A mixin defining a source symbol's origin.
-    public struct SourceOrigin: Mixin, Codable, Hashable {
-        public static var mixinKey = "sourceOrigin"
-
-        /// Precise Identifier
-        public var identifier: String
-
-        /// Display Name
-        public var displayName: String
-        
-        public init(identifier: String, displayName: String) {
-            self.identifier = identifier
-            self.displayName = displayName
-        }
-
-        enum CodingKeys: String, CodingKey {
-            case identifier, displayName
-        }
-        
-        public init(from decoder: Decoder) throws {
-            let container = try decoder.container(keyedBy: CodingKeys.self)
-            self.identifier = try container.decode(String.self, forKey: .identifier)
-            self.displayName = try container.decode(String.self, forKey: .displayName)
-        }
-
-        public func encode(to encoder: Encoder) throws {
-            var container = encoder.container(keyedBy: CodingKeys.self)
-            try container.encode(identifier, forKey: .identifier)
-            try container.encode(displayName, forKey: .displayName)
-        }
-    }
-
-    /// A view of a relationship in terms of the Swift programming language.
-    public var swift: Swift {
-        return .init(relationship: self)
-    }
-
-    /// A view of a relationship in terms of the Swift programming language.
-    public struct Swift {
-        /// The relationship that may have Swift-specific information.
-        public var relationship: SymbolGraph.Relationship
-
-        public init(relationship: SymbolGraph.Relationship) {
-            self.relationship = relationship
-        }
-
-        /// The generic constraints on a relationship.
-        ///
-        /// > Note: `conformsTo` relationships may have constraints for *conditional conformance*.
-        public var genericConstraints: [SymbolGraph.Symbol.Swift.GenericConstraint] {
-            guard let genericConstraints = relationship.mixins[GenericConstraints.mixinKey] as? GenericConstraints else {
-                return []
-            }
-            return genericConstraints.constraints
-        }
-    }
-}
-
-extension SymbolGraph.Relationship.Swift {
-    /// A mixin collecting Swift generic constraints.
-    public struct GenericConstraints: Mixin, Codable, Hashable {
-        public static var mixinKey = "swiftConstraints"
-
-        /// Generic constraints.
-        public var constraints: [SymbolGraph.Symbol.Swift.GenericConstraint]
-
-        public init(constraints: [SymbolGraph.Symbol.Swift.GenericConstraint]) {
-            self.constraints = constraints
-        }
-
-        public init(from decoder: Decoder) throws {
-            let container = try decoder.singleValueContainer()
-            self.constraints = try container.decode([SymbolGraph.Symbol.Swift.GenericConstraint].self)
-        }
-
-        public func encode(to encoder: Encoder) throws {
-            var container = encoder.singleValueContainer()
-            try container.encode(constraints)
-        }
-    }
-}

Sources/SymbolKit/SymbolGraph/Relationship/Relationship+Kind.swift

@@ -0,0 +1,87 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See https://swift.org/LICENSE.txt for license information
+ See https://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import Foundation
+
+extension SymbolGraph.Relationship {
+    /// The kind of relationship.
+    public struct Kind: Codable, RawRepresentable, Equatable, Hashable {
+        public var rawValue: String
+        public init(rawValue: String) {
+            self.rawValue = rawValue
+        }
+
+        /**
+         A symbol `A` is a member of another symbol `B`.
+
+         For example, a method or field of a class would be
+         a member of that class.
+
+         The implied inverse of this relationship is that
+         symbol `B` is the owner of a member symbol `A`.
+         */
+        public static let memberOf = Kind(rawValue: "memberOf")
+
+        /**
+         A symbol `A` conforms to an interface/protocol symbol `B`.
+
+         For example, a class `C` that conforms to protocol `P` in Swift would
+         use this relationship.
+
+         The implied inverse of this relationship is that
+         a symbol `B` that has a conformer `A`.
+         */
+        public static let conformsTo = Kind(rawValue: "conformsTo")
+
+        /**
+         A symbol `A` inherits another symbol `B`.
+
+         For example, a derived class inherits from a base class,
+         or a protocol that refines another protocol would use this relationship.
+
+         The implied inverse of this relationship is that
+         a symbol `B` is a base of another symbol `A`.
+         */
+        public static let inheritsFrom = Kind(rawValue: "inheritsFrom")
+
+        /**
+         A symbol `A` serves as a default implementation of
+         an interface requirement `B`.
+
+         The implied inverse of this relationship is that
+         an interface requirement `B` has a default implementation of `A`.
+         */
+        public static let defaultImplementationOf = Kind(rawValue: "defaultImplementationOf")
+
+        /**
+         A symbol `A` overrides another symbol `B`, typically through inheritance.
+
+         The implied inverse of this relationship is that
+         a symbol `A` is the base of symbol `B`.
+         */
+        public static let overrides = Kind(rawValue: "overrides")
+
+        /**
+         A symbol `A` is a requirement of interface `B`.
+
+         The implied inverse of this relationship is that
+         an interface `B` has a requirement of `A`.
+         */
+        public static let requirementOf = Kind(rawValue: "requirementOf")
+
+        /**
+         A symbol `A` is an optional requirement of interface `B`.
+
+         The implied inverse of this relationship is that
+         an interface `B` has an optional requirement of `A`.
+         */
+        public static let optionalRequirementOf = Kind(rawValue: "optionalRequirementOf")
+    }
+}