Skip to content

[SymbolGraph] Show get/set on property/subscript full declarations #31903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 26, 2020
+355 −6
Merged

[SymbolGraph] Show get/set on property/subscript full declarations #31903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions lib/SymbolGraphGen/SymbolGraph.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ PrintOptions SymbolGraph::getDeclarationFragmentsPrintOptions() const {
Opts.FunctionDefinitions = false;
Opts.ArgAndParamPrinting =
PrintOptions::ArgAndParamPrintingMode::MatchSource;
Opts.PrintGetSetOnRWProperties = false;
Opts.PrintPropertyAccessors = false;
Opts.PrintSubscriptAccessors = false;
Opts.PrintGetSetOnRWProperties = true;
Opts.PrintPropertyAccessors = true;
Opts.PrintSubscriptAccessors = true;
Opts.SkipUnderscoredKeywords = true;
Opts.SkipAttributes = true;
Opts.PrintOverrideKeyword = true;
Expand All @@ -76,6 +76,16 @@ SymbolGraph::getSubHeadingDeclarationFragmentsPrintOptions() const {
auto Options = getDeclarationFragmentsPrintOptions();
Options.ArgAndParamPrinting =
PrintOptions::ArgAndParamPrintingMode::ArgumentOnly;

//--------------------------------------------------------------------------//
// Although we want these in the full declaration presentation,
// particularly for protocol requirements,
// we don't want to show these in subheadings.
Options.PrintGetSetOnRWProperties = false;
Options.PrintPropertyAccessors = false;
Options.PrintSubscriptAccessors = false;
//--------------------------------------------------------------------------//

Options.VarInitializers = false;
Options.PrintDefaultArgumentValue = false;
Options.PrintEmptyArgumentNames = false;
Expand Down
6 changes: 3 additions & 3 deletions ...ationFragments/DeclarationFragments.swift → ...s/Mixins/DeclarationFragments/Basic.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// RUN: %empty-directory(%t)
// RUN: %target-build-swift %s -module-name DeclarationFragments -emit-module -emit-module-path %t/
// RUN: %target-swift-symbolgraph-extract -module-name DeclarationFragments -I %t -pretty-print -output-dir %t
// RUN: %FileCheck %s --input-file %t/DeclarationFragments.symbols.json
// RUN: %target-build-swift %s -module-name Basic -emit-module -emit-module-path %t/
// RUN: %target-swift-symbolgraph-extract -module-name Basic -I %t -pretty-print -output-dir %t
// RUN: %FileCheck %s --input-file %t/Basic.symbols.json

public func foo<S>(f: @escaping () -> (), ext int: Int = 2, s: S) {}

Expand Down
162 changes: 162 additions & 0 deletions test/SymbolGraph/Symbols/Mixins/DeclarationFragments/Properties/ComputedProperties.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
// RUN: %empty-directory(%t)
// RUN: %target-build-swift %s -module-name ComputedProperties -emit-module -emit-module-path %t/
// RUN: %target-swift-symbolgraph-extract -module-name ComputedProperties -I %t -pretty-print -output-dir %t
// RUN: %FileCheck %s --input-file %t/ComputedProperties.symbols.json --check-prefix=XFULL
// RUN: %FileCheck %s --input-file %t/ComputedProperties.symbols.json --check-prefix=XSUBHEADING
// RUN: %FileCheck %s --input-file %t/ComputedProperties.symbols.json --check-prefix=YFULL
// RUN: %FileCheck %s --input-file %t/ComputedProperties.symbols.json --check-prefix=YSUBHEADING

public struct S {
// We should show { get set } here for the
// full declaration, but not for subheadings.
public var x: Int {
get { return 7 }
set {}
}
public private(set) var y: Int {
get { return 7 }
set {}
}
}

// XFULL-LABEL: "precise": "s:18ComputedProperties1SV1xSivp"
// XFULL: "declarationFragments": [
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "keyword",
// XFULL-NEXT: "spelling": "var"
// XFULL-NEXT: },
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "text",
// XFULL-NEXT: "spelling": " "
// XFULL-NEXT: },
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "identifier",
// XFULL-NEXT: "spelling": "x"
// XFULL-NEXT: },
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "text",
// XFULL-NEXT: "spelling": ": "
// XFULL-NEXT: },
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "typeIdentifier",
// XFULL-NEXT: "spelling": "Int",
// XFULL-NEXT: "preciseIdentifier": "s:Si"
// XFULL-NEXT: },
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "text",
// XFULL-NEXT: "spelling": " { "
// XFULL-NEXT: },
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "keyword",
// XFULL-NEXT: "spelling": "get"
// XFULL-NEXT: },
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "text",
// XFULL-NEXT: "spelling": " "
// XFULL-NEXT: },
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "keyword",
// XFULL-NEXT: "spelling": "set"
// XFULL-NEXT: },
// XFULL-NEXT: {
// XFULL-NEXT: "kind": "text",
// XFULL-NEXT: "spelling": " }"
// XFULL-NEXT: }
// XFULL-NEXT: ],

// XSUBHEADING-LABEL: "precise": "s:18ComputedProperties1SV1xSivp"
// XSUBHEADING: names
// XSUBHEADING: "subHeading": [
// XSUBHEADING-NEXT: {
// XSUBHEADING-NEXT: "kind": "keyword",
// XSUBHEADING-NEXT: "spelling": "var"
// XSUBHEADING-NEXT: },
// XSUBHEADING-NEXT: {
// XSUBHEADING-NEXT: "kind": "text",
// XSUBHEADING-NEXT: "spelling": " "
// XSUBHEADING-NEXT: },
// XSUBHEADING-NEXT: {
// XSUBHEADING-NEXT: "kind": "identifier",
// XSUBHEADING-NEXT: "spelling": "x"
// XSUBHEADING-NEXT: },
// XSUBHEADING-NEXT: {
// XSUBHEADING-NEXT: "kind": "text",
// XSUBHEADING-NEXT: "spelling": ": "
// XSUBHEADING-NEXT: },
// XSUBHEADING-NEXT: {
// XSUBHEADING-NEXT: "kind": "typeIdentifier",
// XSUBHEADING-NEXT: "spelling": "Int",
// XSUBHEADING-NEXT: "preciseIdentifier": "s:Si"
// XSUBHEADING-NEXT: }
// XSUBHEADING-NEXT: ]

// YFULL-LABEL: "precise": "s:18ComputedProperties1SV1ySivp"
// YFULL: "declarationFragments": [
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "keyword",
// YFULL-NEXT: "spelling": "var"
// YFULL-NEXT: },
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "text",
// YFULL-NEXT: "spelling": " "
// YFULL-NEXT: },
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "identifier",
// YFULL-NEXT: "spelling": "y"
// YFULL-NEXT: },
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "text",
// YFULL-NEXT: "spelling": ": "
// YFULL-NEXT: },
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "typeIdentifier",
// YFULL-NEXT: "spelling": "Int",
// YFULL-NEXT: "preciseIdentifier": "s:Si"
// YFULL-NEXT: },
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "text",
// YFULL-NEXT: "spelling": " { "
// YFULL-NEXT: },
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "keyword",
// YFULL-NEXT: "spelling": "get"
// YFULL-NEXT: },
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "text",
// YFULL-NEXT: "spelling": " "
// YFULL-NEXT: },
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "keyword",
// YFULL-NEXT: "spelling": "set"
// YFULL-NEXT: },
// YFULL-NEXT: {
// YFULL-NEXT: "kind": "text",
// YFULL-NEXT: "spelling": " }"
// YFULL-NEXT: }
// YFULL-NEXT: ]

// YSUBHEADING-LABEL: "precise": "s:18ComputedProperties1SV1ySivp"
// YSUBHEADING: names
// YSUBHEADING: "subHeading": [
// YSUBHEADING-NEXT: {
// YSUBHEADING-NEXT: "kind": "keyword",
// YSUBHEADING-NEXT: "spelling": "var"
// YSUBHEADING-NEXT: },
// YSUBHEADING-NEXT: {
// YSUBHEADING-NEXT: "kind": "text",
// YSUBHEADING-NEXT: "spelling": " "
// YSUBHEADING-NEXT: },
// YSUBHEADING-NEXT: {
// YSUBHEADING-NEXT: "kind": "identifier",
// YSUBHEADING-NEXT: "spelling": "y"
// YSUBHEADING-NEXT: },
// YSUBHEADING-NEXT: {
// YSUBHEADING-NEXT: "kind": "text",
// YSUBHEADING-NEXT: "spelling": ": "
// YSUBHEADING-NEXT: },
// YSUBHEADING-NEXT: {
// YSUBHEADING-NEXT: "kind": "typeIdentifier",
// YSUBHEADING-NEXT: "spelling": "Int",
// YSUBHEADING-NEXT: "preciseIdentifier": "s:Si"
// YSUBHEADING-NEXT: }
// YSUBHEADING-NEXT: ]
82 changes: 82 additions & 0 deletions test/SymbolGraph/Symbols/Mixins/DeclarationFragments/Properties/ProtocolRequirements.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
// RUN: %empty-directory(%t)
// RUN: %target-build-swift %s -module-name ProtocolRequirements -emit-module -emit-module-path %t/
// RUN: %target-swift-symbolgraph-extract -module-name ProtocolRequirements -I %t -pretty-print -output-dir %t
// RUN: %FileCheck %s --input-file %t/ProtocolRequirements.symbols.json --check-prefix=FULL
// RUN: %FileCheck %s --input-file %t/ProtocolRequirements.symbols.json --check-prefix=SUBHEADING

public protocol P {
// We should show { get set } here for the
// full declaration, but not for subheadings.
var x: Int { get set }
}

// FULL-LABEL: "precise": "s:20ProtocolRequirements1PP1xSivp"
// FULL: "declarationFragments": [
// FULL-NEXT: {
// FULL-NEXT: "kind": "keyword",
// FULL-NEXT: "spelling": "var"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": " "
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "identifier",
// FULL-NEXT: "spelling": "x"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": ": "
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "typeIdentifier",
// FULL-NEXT: "spelling": "Int",
// FULL-NEXT: "preciseIdentifier": "s:Si"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": " { "
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "keyword",
// FULL-NEXT: "spelling": "get"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": " "
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "keyword",
// FULL-NEXT: "spelling": "set"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": " }"
// FULL-NEXT: }
// FULL-NEXT: ]

// SUBHEADING-LABEL: "precise": "s:20ProtocolRequirements1PP1xSivp"
// SUBHEADING: names
// SUBHEADING: "subHeading": [
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "keyword",
// SUBHEADING-NEXT: "spelling": "var"
// SUBHEADING-NEXT: },
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "text",
// SUBHEADING-NEXT: "spelling": " "
// SUBHEADING-NEXT: },
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "identifier",
// SUBHEADING-NEXT: "spelling": "x"
// SUBHEADING-NEXT: },
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "text",
// SUBHEADING-NEXT: "spelling": ": "
// SUBHEADING-NEXT: },
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "typeIdentifier",
// SUBHEADING-NEXT: "spelling": "Int",
// SUBHEADING-NEXT: "preciseIdentifier": "s:Si"
// SUBHEADING-NEXT: }
// SUBHEADING-NEXT: ]
95 changes: 95 additions & 0 deletions test/SymbolGraph/Symbols/Mixins/DeclarationFragments/Properties/Subscripts.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
// RUN: %empty-directory(%t)
// RUN: %target-build-swift %s -module-name Subscripts -emit-module -emit-module-path %t/
// RUN: %target-swift-symbolgraph-extract -module-name Subscripts -I %t -pretty-print -output-dir %t
// RUN: %FileCheck %s --input-file %t/Subscripts.symbols.json --check-prefix=FULL
// RUN: %FileCheck %s --input-file %t/Subscripts.symbols.json --check-prefix=SUBHEADING

public struct S {
public subscript(i: Int) -> Int {
get {
return 7
}
set {}
}
}

// FULL-LABEL: "precise": "s:10Subscripts1SVyS2icip"
// FULL: "declarationFragments": [
// FULL-NEXT: {
// FULL-NEXT: "kind": "keyword",
// FULL-NEXT: "spelling": "subscript"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": "("
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "internalParam",
// FULL-NEXT: "spelling": "i"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": ": "
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "typeIdentifier",
// FULL-NEXT: "spelling": "Int",
// FULL-NEXT: "preciseIdentifier": "s:Si"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": ") -> "
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "typeIdentifier",
// FULL-NEXT: "spelling": "Int",
// FULL-NEXT: "preciseIdentifier": "s:Si"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": " { "
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "keyword",
// FULL-NEXT: "spelling": "get"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": " "
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "keyword",
// FULL-NEXT: "spelling": "set"
// FULL-NEXT: },
// FULL-NEXT: {
// FULL-NEXT: "kind": "text",
// FULL-NEXT: "spelling": " }"
// FULL-NEXT: }
// FULL-NEXT: ]

// SUBHEADING-LABEL: "precise": "s:10Subscripts1SVyS2icip"
// SUBHEADING: names
// SUBHEADING: "subHeading": [
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "keyword",
// SUBHEADING-NEXT: "spelling": "subscript"
// SUBHEADING-NEXT: },
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "text",
// SUBHEADING-NEXT: "spelling": "("
// SUBHEADING-NEXT: },
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "typeIdentifier",
// SUBHEADING-NEXT: "spelling": "Int",
// SUBHEADING-NEXT: "preciseIdentifier": "s:Si"
// SUBHEADING-NEXT: },
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "text",
// SUBHEADING-NEXT: "spelling": ") -> "
// SUBHEADING-NEXT: },
// SUBHEADING-NEXT: {
// SUBHEADING-NEXT: "kind": "typeIdentifier",
// SUBHEADING-NEXT: "spelling": "Int",
// SUBHEADING-NEXT: "preciseIdentifier": "s:Si"
// SUBHEADING-NEXT: }
// SUBHEADING-NEXT: ]