Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capturecontext/swift-interception
Package for interception of objc selectors in Swift.
https://github.com/capturecontext/swift-interception
interception macros objc objc-runtime objective-c reflection runtime selector selectors swift swift-macro swift-macros swift-runtime
Last synced: 3 days ago
JSON representation
Package for interception of objc selectors in Swift.
- Host: GitHub
- URL: https://github.com/capturecontext/swift-interception
- Owner: CaptureContext
- License: mit
- Created: 2024-01-29T02:21:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-02-28T03:41:08.000Z (7 months ago)
- Last Synced: 2024-09-24T21:28:47.599Z (3 days ago)
- Topics: interception, macros, objc, objc-runtime, objective-c, reflection, runtime, selector, selectors, swift, swift-macro, swift-macros, swift-runtime
- Language: Swift
- Homepage: https://swiftpackageindex.com/CaptureContext/swift-interception/0.3.0/documentation/interception
- Size: 54.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# swift-interception
[](https://github.com/CaptureContext/swift-interception/actions/workflows/ci.yml) [](https://swift.org/download/)  [](https://twitter.com/capture_context)
Package for interception of objc selectors in Swift.
## Usage
### Basic
Observe selectors on NSObject instances
```swift
import Interception
navigationController.setInterceptionHandler(
for: _makeMethodSelector(
selector: UINavigationController.popViewController,
signature: navigationController.popViewController
)
) { result in
print(result.args) // `animated` flag
print(result.output) // popped `UIViewController?`
}
```
You can also simplify creating method selector with `InterceptionMacros` if you are open for macros
```swift
import InterceptionMacros
navigationController.setInterceptionHandler(
for: #methodSelector(UINavigationController.popViewController)
) { result in
print(result.args) // `animated` flag
print(result.output) // popped `UIViewController?`
}
```
> Macros require `swift-syntax` compilation, so it will affect cold compilation time
You can set up multiple interception handlers as well, just make sure that you use different keys for each handler
```swift
import Intercexption
object.setInterceptionHandler(
for: _makeMethodSelector(
selector: #selector(MyObject.someMethod(arg1:arg2)),
signature: MyObject.someMethod(arg1:arg2)
),
key: "argumentsPrinter"
) { result in
// In case of multiple arguments
// you can access them as a tuple
print(result.args.0)
print(result.args.1)
}
```
```swift
import InterceptionMacros
object.setInterceptionHandler(
for: #methodSelector(MyObject.someMethod(arg1:arg2)),
key: "argumentsPrinter"
) { result in
// In case of multiple arguments
// you can access them as a tuple
print(result.args.0)
print(result.args.1)
}
```
### Library development
If you use it to create a library it may be a good idea to export custom selectors implicitly
```swift
// Exports.swift
@_exported import _InterceptionCustomSelectors
```
Also you may find some `@_spi` methods and Utils helpful
```swift
@_spi(Internals) import Interception
import _InterceptionUtils // Is not shown in the autocomplete
```
See [`combine-interception`](https://github.com/capturecontext/combine-interception) for usage example.
## Installation
### Basic
You can add Interception to an Xcode project by adding it as a package dependency.
1. From the **File** menu, select **Swift Packages › Add Package Dependency…**
2. Enter [`"https://github.com/capturecontext/swift-interception.git"`](https://github.com/capturecontext/swift-interception.git) into the package repository URL text field
3. Choose products you need to link them to your project.
### Recommended
If you use SwiftPM for your project, you can add CombineInterception to your package file.
```swift
.package(
url: "https://github.com/capturecontext/swift-interception.git",
.upToNextMinor(from: "0.3.0")
)
```
Do not forget about target dependencies:
```swift
.product(
name: "Interception",
package: "swift-interception"
)
```
```swift
.product(
name: "InterceptionMacros",
package: "swift-interception"
)
```
## License
This library is released under the MIT license. See [LICENCE](LICENCE) for details.
See [ACKNOWLEDGMENTS](ACKNOWLEDGMENTS) for inspiration references and their licences.