Skip to content

[Observation] Forward availability and defines to extensions #67412

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.

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 3 commits into from
Jul 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
120 changes: 120 additions & 0 deletions lib/Macros/Sources/ObservationMacros/Availability.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2023 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
//
//===----------------------------------------------------------------------===//

import SwiftSyntax
import SwiftSyntaxMacros
import SwiftDiagnostics
import SwiftOperators
import SwiftSyntaxBuilder


extension AttributeSyntax {
var availability: AttributeSyntax? {
if attributeName.identifier == "available" {
return self
} else {
return nil
}
}
}

extension IfConfigClauseSyntax.Elements {
var availability: IfConfigClauseSyntax.Elements? {
switch self {
case .attributes(let attributes):
if let availability = attributes.availability {
return .attributes(availability)
} else {
return nil
}
default:
return nil
}
}
}

extension IfConfigClauseSyntax {
var availability: IfConfigClauseSyntax? {
if let availability = elements?.availability {
return with(\.elements, availability)
} else {
return nil
}
}

var clonedAsIf: IfConfigClauseSyntax {
detached.with(\.poundKeyword, .poundIfKeyword())
}
}

extension IfConfigDeclSyntax {
var availability: IfConfigDeclSyntax? {
var elements = [IfConfigClauseListSyntax.Element]()
for clause in clauses {
if let availability = clause.availability {
if elements.isEmpty {
elements.append(availability.clonedAsIf)
} else {
elements.append(availability)
}
}
}
if elements.isEmpty {
return nil
} else {
return with(\.clauses, IfConfigClauseListSyntax(elements))
}

}
}

extension AttributeListSyntax.Element {
var availability: AttributeListSyntax.Element? {
switch self {
case .attribute(let attribute):
if let availability = attribute.availability {
return .attribute(availability)
}
case .ifConfigDecl(let ifConfig):
if let availability = ifConfig.availability {
return .ifConfigDecl(availability)
}
default:
break
}
return nil
}
}

extension AttributeListSyntax {
var availability: AttributeListSyntax? {
var elements = [AttributeListSyntax.Element]()
for element in self {
if let availability = element.availability {
elements.append(availability)
}
}
if elements.isEmpty {
return nil
}
return AttributeListSyntax(elements)
}
}

extension DeclGroupSyntax {
var availability: AttributeListSyntax? {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DougGregor this seems really complex to forward things - should this be included in SwiftSyntax/macros directly?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps. We'd need to clarify what exactly should be automatically transferred to the extensions and implement that in SwiftSyntax.

if let attributes {
return attributes.availability
} else {
return nil
}
}
}
3 changes: 2 additions & 1 deletion lib/Macros/Sources/ObservationMacros/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@
#===----------------------------------------------------------------------===#

add_swift_macro_library(ObservationMacros
ObservableMacro.swift
Availability.swift
Extensions.swift
ObservableMacro.swift
SWIFT_DEPENDENCIES
SwiftSyntax::SwiftDiagnostics
SwiftSyntax::SwiftOperators
Expand Down
7 changes: 3 additions & 4 deletions lib/Macros/Sources/ObservationMacros/Extensions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@

import SwiftSyntax
import SwiftSyntaxMacros

@_implementationOnly import SwiftDiagnostics
@_implementationOnly import SwiftOperators
@_implementationOnly import SwiftSyntaxBuilder
import SwiftDiagnostics
import SwiftOperators
import SwiftSyntaxBuilder

extension VariableDeclSyntax {
var identifierPattern: IdentifierPatternSyntax? {
Expand Down
20 changes: 11 additions & 9 deletions lib/Macros/Sources/ObservationMacros/ObservableMacro.swift
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@

import SwiftSyntax
import SwiftSyntaxMacros

@_implementationOnly import SwiftDiagnostics
@_implementationOnly import SwiftOperators
@_implementationOnly import SwiftSyntaxBuilder
import SwiftDiagnostics
import SwiftOperators
import SwiftSyntaxBuilder

public struct ObservableMacro {
static let moduleName = "Observation"
Expand Down Expand Up @@ -282,12 +281,15 @@ extension ObservableMacro: ExtensionMacro {
}

let decl: DeclSyntax = """
extension \(raw: type.trimmedDescription): \(raw: qualifiedConformanceName) {}
"""
extension \(raw: type.trimmedDescription): \(raw: qualifiedConformanceName) {}
"""
let ext = decl.cast(ExtensionDeclSyntax.self)

return [
decl.cast(ExtensionDeclSyntax.self)
]
if let availability = declaration.availability {
return [ext.with(\.attributes, availability)]
} else {
return [ext]
}
}
}

Expand Down
10 changes: 10 additions & 0 deletions test/stdlib/Observation/Observable.swift
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,16 @@ class RecursiveOuter {
}
}

@Observable
#if FOO
@available(SwiftStdlib 5.9, *)
#elseif BAR
@available(SwiftStdlib 5.9, *)
#else
#endif
class GuardedAvailability {
}

@main
struct Validator {
@MainActor
Expand Down