FreSwift

Example Xcode projects showing how to create AIR Native Extensions for iOS, tvOS & OSX using Swift.
It supports iOS 9.0+, tvOS 9.2+, OSX 10.10+

Xcode 9.3 (9E145) must be used with Apple Swift version 4.1 (swiftlang-902.0.48 clang-902.0.37.1)

It is not possible to mix Swift versions in the same app. Therefore all Swift based ANEs must use the same exact version. ABI stability is planned for Swift 5 in late 2018

This project is used as the basis for the following ANEs
Google Maps ANE
AdMob ANE
WebViewANE
AR-ANE
ML-ANE

---

Getting Started

A basic Hello World starter project is included for each target

An iOS based walkthrough video is available on Youtube

How to use

Full documentation is provided

The following table shows the primitive as3 types which can easily be converted to/from Swift types

AS3 type	Swift type	AS3 param->Swift	return Swift->AS3
String	String	let str = String(argv[0])	return str.toFREObject()
int	Int	let i = Int(argv[0])	return i.toFREObject()
Boolean	Bool	let b = Bool(argv[0])	return b.toFREObject()
Number	Double	let dbl = Double(argv[0])	return dbl.toFREObject()
Number	CGFloat	let cfl = CGFloat(argv[0])	return cfl.toFREObject()
Date	Date	let date = Date(argv[0])	return date.toFREObject()
Rectangle	CGRect	let rect = CGRect(argv[0])	return rect.toFREObject()
Point	CGPoint	let pnt = CGPoint(argv[0])	return pnt.toFREObject()
Vector int	Array<Int>	let a = Array<Int>(argv[0])	return a.toFREObject()
Vector Boolean	Array<Bool>	let a = Array<Bool>(argv[0])	return a.toFREObject()
Vector Number	Array<Double>	let a = Array<Double>(argv[0])	return a.toFREObject()
Vector String	Array<String>	let a = Array<String>(argv[0])	return a.toFREObject()
Object	Dictionary<String, Any>?	let dct = Dictionary.init(argv[0])	N/A

Example

let airString = String(argv[0])
trace("String passed from AIR:", airString)
let swiftString: String = "I am a string from Swift"
return swiftString.toFREObject()

FreSwift is fully extensible. New conversion types can be added in your own project. For example, Rectangle and Point are built as Extensions.

---

Example - Call a method on an FREObject

let person = argv[0]
if let addition = try person.call(method: "add", args: 100, 31) {
    if let result = Int(addition) {
        trace("addition result:", result)
    }
}

Example - Get a property of a FREObject, convert to Int

let person = argv[0]
if let age = Int(person["age"]) {
    trace(age)
}

Example - Create a new FREObject, set property of FREObject

let person = try FREObject(className: "com.tuarua.Person")
try person.setProp(name: "age", value: 30)

Example - Sending events back to AIR (replaces dispatchStatusEventAsync)

sendEvent(name: "MY_EVENT", value: "My message")

Example - Reading items in array

let airArray: FREArray = FREArray.init(argv[0])
do {
    if let itemZero = Int(airArray[0]) {
        trace("AIR Array elem at 0 type:", "value:", itemZero)
        try airArray.set(index: 0, value: 56)
        return airArray.rawValue
    }
} catch {}

Example - Convert BitmapData to a UIImage and add to native view (iOS tvOS)

if let img = UIImage.init(freObject: argv[0]) {
    if let rootViewController = UIApplication.shared.keyWindow?.rootViewController {
        let imgView: UIImageView = UIImageView.init(image: img)
        imgView.frame = CGRect.init(x: 0, y: 0, width: img.size.width, height: img.size.height)
        rootViewController.view.addSubview(imgView)
    }
}

Example - Error handling

do {
    _ = try person.getProp(name: "doNotExist") //calling a property that doesn't exist
} catch let e as FreError {
    if let aneError = e.getError(#file, #line, #column) {
        return aneError //return the error as an actionscript error
    }
} catch {}

---

applicationDidFinishLaunching

The static library contains a predefined +(void)load method in FreMacros.h. This method can safely be declared in different ANEs. It is also called once for each ANE and very early in the launch cycle. In here the SwiftController is inited and onLoad() called. This makes an ideal place to add observers for applicationDidFinishLaunching and any other calls which would normally be added as app delegates, thus removing the restriction of one ANE declaring itself as the "owner".
Note: We have no FREContext yet so calls such as trace, sendEvent will not work.

@objc func applicationDidFinishLaunching(_ notification: Notification) {
   appDidFinishLaunchingNotif = notification //save the notification for later
}
func onLoad() {
NotificationCenter.default.addObserver(self, 
            selector: #selector(applicationDidFinishLaunching),
            name: NSNotification.Name.UIApplicationDidFinishLaunching, 
            object: nil)      
}

---

Required AS3 classes

com.tuarua.fre.ANEUtils.as and com.tuarua.fre.ANEError.as are required by FreSwift and should be included in the AS3 library of your ANE

Prerequisites

You will need

• Xcode 9.3
• Xcode 9.1 for iOS Simulator
• IntelliJ IDEA
• AIR 29
• wget