Use the SwiftIfConfig library for evaluating #if conditions #75688
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ | |
|
|
||
| import ASTBridging | ||
| import SwiftDiagnostics | ||
| @_spi(Compiler) import SwiftIfConfig | ||
| import SwiftParser | ||
| import SwiftSyntax | ||
|
|
||
|
|
@@ -109,6 +109,13 @@ struct CompilerBuildConfiguration: BuildConfiguration { | |
|
|
||
| func isActiveTargetRuntime(name: String) throws -> Bool { | ||
| var name = name | ||
|
|
||
| // Complain if the provided runtime isn't one of the known values. | ||
| switch name { | ||
| case "_Native", "_ObjC", "_multithreaded": break | ||
| default: throw IfConfigError.unexpectedRuntimeCondition | ||
| } | ||
|
|
||
| return name.withBridgedString { nameRef in | ||
| ctx.langOptsIsActiveTargetRuntime(nameRef) | ||
| } | ||
|
|
@@ -161,6 +168,18 @@ struct CompilerBuildConfiguration: BuildConfiguration { | |
| } | ||
| } | ||
|
|
||
| enum IfConfigError: Error, CustomStringConvertible { | ||
| case unexpectedRuntimeCondition | ||
|
|
||
| var description: String { | ||
| switch self { | ||
| case .unexpectedRuntimeCondition: | ||
| return "unexpected argument for the '_runtime' condition; expected '_Native' or '_ObjC'" | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| /// Extract the #if clause range information for the given source file. | ||
| @_cdecl("swift_ASTGen_configuredRegions") | ||
| public func configuredRegions( | ||
|
|
@@ -301,3 +320,53 @@ public func freeConfiguredRegions( | |
| ) { | ||
| UnsafeMutableBufferPointer(start: regions, count: numRegions).deallocate() | ||
| } | ||
|
|
||
| /// Evaluate the #if condition at ifClauseLocationPtr. | ||
| @_cdecl("swift_ASTGen_evaluatePoundIfCondition") | ||
| public func evaluatePoundIfCondition( | ||
| astContext: BridgedASTContext, | ||
| diagEnginePtr: UnsafeMutableRawPointer, | ||
| sourceFileBuffer: BridgedStringRef, | ||
| ifConditionText: BridgedStringRef, | ||
| shouldEvaluate: Bool | ||
| ) -> Int { | ||
| // Retrieve the #if condition that we're evaluating here. | ||
| // FIXME: Use 'ExportedSourceFile' when C++ parser is replaced. | ||
| let textBuffer = UnsafeBufferPointer<UInt8>(start: ifConditionText.data, count: ifConditionText.count) | ||
|
There was a problem hiding this comment. Don’t we have an There was a problem hiding this comment. I'm following the path @rintaro used for checking the definitions of macros, which avoids running the swift-syntax parser on the whole file (for performance reasons). This also avoids the somewhat brittle "go find this exact swift-syntax node at this source location" lookup we need to do with that approach, which can fail when the C++ parser and SwiftParser don't recover in exactly the same way. There was a problem hiding this comment. I see. I was still thinking we had the syntax tree for the entire file anyway and forgot that we no longer parse it completely. |
||
| var parser = Parser(textBuffer) | ||
| let conditionExpr = ExprSyntax.parse(from: &parser) | ||
|
|
||
| let isActive: Bool | ||
| let syntaxErrorsAllowed: Bool | ||
| let diagnostics: [Diagnostic] | ||
| if shouldEvaluate { | ||
| // Evaluate the condition against the compiler's build configuration. | ||
| let configuration = CompilerBuildConfiguration( | ||
| ctx: astContext, | ||
| sourceBuffer: textBuffer | ||
| ) | ||
|
|
||
| let state: IfConfigRegionState | ||
| (state, syntaxErrorsAllowed, diagnostics) = IfConfigRegionState.evaluating(conditionExpr, in: configuration) | ||
| isActive = (state == .active) | ||
| } else { | ||
| // Don't evaluate the condition, because we know it's inactive. Determine | ||
| // whether syntax errors are permitted within this region according to the | ||
| // condition. | ||
| isActive = false | ||
| (syntaxErrorsAllowed, diagnostics) = IfConfigClauseSyntax.syntaxErrorsAllowed(conditionExpr) | ||
| } | ||
|
|
||
| // Render the diagnostics. | ||
| for diagnostic in diagnostics { | ||
| emitDiagnostic( | ||
| diagnosticEngine: BridgedDiagnosticEngine(raw: diagEnginePtr), | ||
| sourceFileBuffer: UnsafeBufferPointer(start: sourceFileBuffer.data, count: sourceFileBuffer.count), | ||
| sourceFileBufferOffset: ifConditionText.data! - sourceFileBuffer.data!, | ||
| diagnostic: diagnostic, | ||
| diagnosticSeverity: diagnostic.diagMessage.severity | ||
| ) | ||
| } | ||
|
|
||
| return (isActive ? 0x1 : 0) | (syntaxErrorsAllowed ? 0x2 : 0) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn’t
_multithreadedalso allowed, based on the check above?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Heh, yes. I was originally following the actually-incorrect diagnostic text in the compiler itself to try to minimize the diffs in this PR. We can fix this now.