Symbol

Symbol

public final class Symbol

Nested Types

Contextual.Symbol.Extension.CompilationCondition.SourceFile

Nested Type Aliases

ID

public typealias ID = Identifier

Initializers

init(file:relativeTo:)

public init(file url: URL, relativeTo directory: URL) throws

init(from:)

public convenience init(from decoder: Decoder) throws

Properties

context

var context: [Contextual] = []

conditions

var conditions: [CompilationCondition] = context.compactMap { $0 as? CompilationCondition }

context

let context: [Contextual]

imports

let imports: [Import]

isDocumented

var isDocumented: Bool

visitedSymbols

var visitedSymbols: [Symbol] = []

path

let path: String

name

var name: String

documentation

let documentation: Documentation?

id

var id: ID = {
        Identifier(pathComponents: context.compactMap {
            ($0 as? Symbol)?.name ?? ($0 as? Extension)?.extendedType
        }, name: name)
    }()

visitedImports

var visitedImports: [Import] = []

sourceLocationConverter

let sourceLocationConverter: SourceLocationConverter

`extension`

var `extension`: Extension? = context.compactMap { $0 as? Extension }.first

sourceLocation

let sourceLocation: SourceLocation?

declaration

let declaration: API

isPublic

var isPublic: Bool

symbols

let symbols: [Symbol]

Methods

visit(_:)

override func visit(_ node: IfConfigClauseSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: IfConfigDeclSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: TypealiasDeclSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: PrecedenceGroupDeclSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: EnumCaseDeclSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: EnumDeclSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: InitializerDeclSyntax) -> SyntaxVisitorContinueKind

visitPost(_:)

override func visitPost(_ node: EnumDeclSyntax)

push(_:)

func push(_ extension: Extension)

pop()

func pop() -> Contextual?

visit(_:)

override func visit(_ node: AssociatedtypeDeclSyntax) -> SyntaxVisitorContinueKind

hash(into:)

public func hash(into hasher: inout Hasher)

symbol(_:_:)

func symbol<Node, Declaration>(_ type: Declaration.Type, _ node: Node) -> Symbol? where Declaration: API & ExpressibleBySyntax, Node == Declaration.Syntax

visit(_:)

override func visit(_ node: ProtocolDeclSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: ExtensionDeclSyntax) -> SyntaxVisitorContinueKind

encode(to:)

public func encode(to encoder: Encoder) throws

visit(_:)

override func visit(_ node: StructDeclSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: VariableDeclSyntax) -> SyntaxVisitorContinueKind

visitPost(_:)

override func visitPost(_ node: ExtensionDeclSyntax)

visitPost(_:)

override func visitPost(_ node: ProtocolDeclSyntax)

visitPost(_:)

override func visitPost(_ node: IfConfigClauseSyntax)

push(_:)

func push(_ symbol: Symbol?)

visit(_:)

override func visit(_ node: FunctionDeclSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: SubscriptDeclSyntax) -> SyntaxVisitorContinueKind

visit(_:)

override func visit(_ node: ClassDeclSyntax) -> SyntaxVisitorContinueKind

symbol(_:declaration:)

func symbol<Node: SyntaxProtocol>(_ node: Node, declaration: API) -> Symbol?

<(lhs:rhs:)

public static func <(lhs: Symbol, rhs: Symbol) -> Bool

visit(_:)

override func visit(_ node: ImportDeclSyntax) -> SyntaxVisitorContinueKind

visitPost(_:)

override func visitPost(_ node: StructDeclSyntax)

push(_:)

func push(_ import: Import)

push(_:)

func push(_ condition: CompilationCondition)

==(lhs:rhs:)

public static func ==(lhs: Symbol, rhs: Symbol) -> Bool

visitPost(_:)

override func visitPost(_ node: ClassDeclSyntax)