Add symbolName property for some syntax nodes by Matejkob · Pull Request #2583 · swiftlang/swift-syntax

Matejkob · 2024-04-02T07:54:35Z

FunctionDecl, InitializerDecl, SubscriptDecl, EnumCaseElement, and MacroDecl gained a new computed property: symbolName

The symbolName property provides a string representation of the declaration's name along with its parameter labels. For example, a function func greet(name: String) will have the symbol name greet(name:).

Resolves #2488

Tests/SwiftSyntaxTest/SymbolNameTests.swift

Matejkob

Which other nodes should have a symbolName property?

enum, protocol, struct, class, actor?
typealias?
property - this one for sure.
deinit ?
macro ?
operator ?

ahoppen · 2024-04-03T21:28:47Z

I think it only makes sense to offer it for nodes that have a FunctionParameterClauseSyntax or EnumCaseParameterClauseSyntax and thus need handling of argument labels. That is

FunctionDeclSyntax
InitializerDeclSyntax
MacroDeclSyntax
SubscriptDeclSyntax
EnumCaseDeclSyntax

Matejkob · 2024-04-08T19:44:36Z

Depending on: #2593

ahoppen

Thank you. Looks great, I’m just being nitpicky again.

Sources/SwiftSyntax/SymbolName.swift

Tests/SwiftSyntaxTest/SymbolNameTests.swift

Matejkob · 2024-04-09T07:42:04Z

Thanks for the review Alex 🫶

`FunctionDecl`, `InitializerDecl`, `SubscriptDecl`, `EnumCaseElement`, and `MacroDecl` gained a new computed property: `symbolName` The `symbolName` property provides a string representation of the declaration's name along with its parameter labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`.

ktoso · 2024-04-16T00:04:31Z

@swift-ci please smoke test

hamishknight

A small nit over the naming in the documentation, but otherwise this LGTM

hamishknight · 2024-04-16T20:00:20Z

Release Notes/601.md

 ## New APIs

+- `FunctionDecl`, `InitializerDecl`, `SubscriptDecl`, `EnumCaseElement`, and `MacroDecl` gained a new computed property: `symbolName`
+  - Description: The `symbolName` property provides a string representation of the declaration's name along with its parameter labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`.


Nit: These are called argument labels in TSPL, and we have e.g SyntaxClassification.argumentLabel, I think we probably ought to be consistent.

Suggested change

- Description: The `symbolName` property provides a string representation of the declaration's name along with its parameter labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`.

- Description: The `symbolName` property provides a string representation of the declaration's name along with its argument labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`.

hamishknight · 2024-04-16T20:00:38Z

Sources/SwiftSyntax/SymbolName.swift

+extension FunctionDeclSyntax {
+  /// The symbol name of the function declaration.
+  ///
+  /// The symbol name is a string representation of the function name along with its parameter labels.


Suggested change

/// The symbol name is a string representation of the function name along with its parameter labels.

/// The symbol name is a string representation of the function name along with its argument labels.

hamishknight · 2024-04-16T20:00:57Z

Sources/SwiftSyntax/SymbolName.swift

+extension InitializerDeclSyntax {
+  /// The symbol name of the initializer declaration.
+  ///
+  /// The symbol name is a string representation of the initializer along with its parameter labels.


Suggested change

/// The symbol name is a string representation of the initializer along with its parameter labels.

/// The symbol name is a string representation of the initializer along with its argument labels.

hamishknight · 2024-04-16T20:03:55Z

Sources/SwiftSyntax/SymbolName.swift

+extension SubscriptDeclSyntax {
+  /// The symbol name of the subscript declaration.
+  ///
+  /// The symbol name is a string representation of the subscript along with its parameter labels.


Suggested change

/// The symbol name is a string representation of the subscript along with its parameter labels.

/// The symbol name is a string representation of the subscript along with its argument labels.

hamishknight · 2024-04-16T20:08:23Z

Sources/SwiftSyntax/SymbolName.swift

+extension MacroDeclSyntax {
+  /// The symbol name of the macro declaration.
+  ///
+  /// The symbol name is a string representation of the macro name along with its parameter labels.


Suggested change

/// The symbol name is a string representation of the macro name along with its parameter labels.

/// The symbol name is a string representation of the macro name along with its argument labels.

hamishknight · 2024-04-16T20:09:05Z

Sources/SwiftSyntax/SymbolName.swift

+  }
+}
+
+/// Generates the symbol name by combining the base name and parameter labels.


Suggested change

/// Generates the symbol name by combining the base name and parameter labels.

/// Generates the symbol name by combining the base name and argument labels.

rintaro · 2024-04-16T20:38:46Z

This resembles DeclName in C++ compiler.
I think we should also make it a struct, like:

struct SymbolBaseName {
  enum Kind { case normal, subscript, initializer, deinitializer }
  var asString: String {get}
  var kind: Kind {get}
  var isOperator: Bool {get}
}
struct SymbolName {  
  var asString: String {get}
  var baseName: SymbolBaseName {get}
  var argumentLabels: some Collection<String> {get}
}

WDYT?

ahoppen · 2024-04-17T20:41:03Z

That is a great idea, @rintaro.

Matejkob force-pushed the symbol-name branch from 97ea3f3 to 462b618 Compare April 2, 2024 08:35

Matejkob commented Apr 2, 2024

View reviewed changes

Tests/SwiftSyntaxTest/SymbolNameTests.swift Show resolved Hide resolved

Matejkob commented Apr 2, 2024

View reviewed changes

Tests/SwiftSyntaxTest/SymbolNameTests.swift Show resolved Hide resolved

Matejkob force-pushed the symbol-name branch from 462b618 to e216d52 Compare April 2, 2024 19:59

Matejkob commented Apr 3, 2024

View reviewed changes

Matejkob force-pushed the symbol-name branch from e216d52 to 616978f Compare April 8, 2024 19:42

Matejkob changed the title ~~[WIP] Symbol name~~ Add symbolName property for some syntax nodes Apr 8, 2024

Matejkob marked this pull request as ready for review April 8, 2024 19:43

Matejkob requested a review from bnbarham as a code owner April 8, 2024 19:43

ahoppen reviewed Apr 8, 2024

View reviewed changes

Matejkob force-pushed the symbol-name branch from 616978f to b5c83f3 Compare April 9, 2024 07:35

Matejkob force-pushed the symbol-name branch from b5c83f3 to 7d61a8d Compare April 9, 2024 07:43

ahoppen approved these changes Apr 10, 2024

View reviewed changes

Matejkob force-pushed the symbol-name branch from 7d61a8d to 9a4f045 Compare April 10, 2024 20:12

Matejkob added 2 commits April 10, 2024 22:13

Add symbol name unit tests

d1e1a4d

Matejkob force-pushed the symbol-name branch from 9a4f045 to 9be1cf4 Compare April 10, 2024 20:13

bnbarham approved these changes Apr 11, 2024

View reviewed changes

hamishknight approved these changes Apr 16, 2024

View reviewed changes

	- Description: The `symbolName` property provides a string representation of the declaration's name along with its parameter labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`.
	- Description: The `symbolName` property provides a string representation of the declaration's name along with its argument labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`.

	/// The symbol name is a string representation of the function name along with its parameter labels.
	/// The symbol name is a string representation of the function name along with its argument labels.

	/// Generates the symbol name by combining the base name and parameter labels.
	/// Generates the symbol name by combining the base name and argument labels.

Conversation

Matejkob commented Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Matejkob left a comment

Choose a reason for hiding this comment

Uh oh!

ahoppen commented Apr 3, 2024

Uh oh!

Matejkob commented Apr 8, 2024

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Matejkob commented Apr 9, 2024

Uh oh!

ktoso commented Apr 16, 2024

Uh oh!

hamishknight left a comment

Choose a reason for hiding this comment

Uh oh!

hamishknight Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

hamishknight Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

hamishknight Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

hamishknight Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

hamishknight Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

hamishknight Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

rintaro commented Apr 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ahoppen commented Apr 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Matejkob commented Apr 2, 2024 •

edited

Loading

rintaro commented Apr 16, 2024 •

edited

Loading