Skip to content

[Docs] Update Swift Docs #3458

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
parrt merged 6 commits into from
Mar 4, 2022
+3 −11
Merged

[Docs] Update Swift Docs #3458

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3a7aca3
Add Swift Package Manager Support
100mango Mar 22, 2021
34c2866
Swift Package Dynamic
100mango Mar 26, 2021
f5776c0
Merge branch 'master' into master
parrt Oct 11, 2021
bcd7892
【fix】【test】Fix run process path
100mango Dec 31, 2021
fb8a23c
Merge branch 'antlr:master' into master
100mango Jan 4, 2022
47c0307
[Docs] [Swift] update link, remove expired descriptions
100mango Jan 4, 2022
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
14 changes: 3 additions & 11 deletions doc/swift-target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
# ANTLR4 Language Target, Runtime for Swift

## Requirements

ANTLR 4.7.2 requires Swift 4.2. It works on Swift 4.2.1 also.

ANTLR 4.7.1 requires Swift 4.0, and does not work on Swift 4.2. (The status of
Swift 4.1 support is unknown.)

## Performance Note

To use ANTLR4 Swift target in production environment, make sure to turn on compiler optimizations by following [these instructions](https://github.com/apple/swift-package-manager/blob/master/Documentation/Usage.md#build-configurations) if you use SwiftPM to build your project. If you are using Xcode to build your project, it's unlikely you will not use `release` build for production build.
To use ANTLR4 Swift target in production environment, make sure to turn on compiler optimizations by following [these instructions](https://github.com/apple/swift-package-manager/blob/main/Documentation/Usage.md#setting-the-build-configuration) if you use SwiftPM to build your project.

If you are using Xcode to build your project, it's unlikely you will not use `release` build for production build.

Conclusion is, you need to turn on `release` mode (which will have all the optimization pre configured for you) so the ANTLR4 Swift target can have reasonable parsing speed.

Expand Down Expand Up @@ -134,9 +129,6 @@ The runtime and generated grammar should now build correctly.

Add Antlr4 as a dependency to your `Package.swift` file. For more information, please see the [Swift Package Manager documentation](https://github.com/apple/swift-package-manager/tree/master/Documentation).

Since we cannot have a separate repository for Swift target (see issue [#1774](https://github.com/antlr/antlr4/issues/1774)),
and Swift is currently not ABI stable. We currently support SPM-based
projects by creating temporary local repository.

```swift
.package(name: "Antlr4", url: "https://github.com/antlr/antlr4", from: "4.9.3"
Expand Down