JNIObject.swift

//
//  JNIObject.swift
//  SwiftJava
//
//  Created by John Holdsworth on 14/07/2016.
//  Copyright (c) 2016 John Holdsworth. All rights reserved.
//
//  Core protocols and implementation of JNIObject which represents
//  a Java oject by class or by interface inside a Swift program.
//  Basic conversion to/from these object types and containers.
//

import Foundation

public protocol JNIObjectProtocol {

    func localJavaObject( _ locals: UnsafeMutablePointer<[jobject]> ) -> jobject?

}

public protocol JNIObjectInit {

    init( javaObject: jobject? )

}

extension JNIObjectProtocol {

    public func withJavaObject<Result>( _ body: @escaping (jobject?) throws -> Result ) rethrows -> Result {
        var locals = [jobject]()
        let javaObject: jobject? = localJavaObject( &locals )
        defer {
            for local in locals {
                JNI.DeleteLocalRef( local )
            }
        }
        return try body( javaObject )
    }
}

public protocol JavaProtocol: JNIObjectProtocol {
}

public protocol UnavailableProtocol: JavaProtocol {
}

open class UnavailableProtocolForward: JNIObjectForward, UnavailableProtocol  {
}

open class UnavailableObject: JavaObject, Error {
}

open class UnavailableEnum: JavaEnum {
}

extension Throwable: Error {
}

#if swift(>=5.7)
extension Throwable: @unchecked Sendable {
}
extension UnavailableObject: @unchecked Sendable {
}
#endif

open class JNIObject: JNIObjectProtocol, JNIObjectInit {

    private var _javaObject: jobject?

    open var javaObject: jobject? {
        get {
            return _javaObject
        }
        set(newValue) {
            if newValue != _javaObject {
                let oldValue: jobject? = _javaObject
                if newValue != nil {
                    _javaObject = JNI.api.NewGlobalRef( JNI.env, newValue )
                }
                else {
                    _javaObject = nil
                }
                if oldValue != nil {
                    JNI.api.DeleteGlobalRef( JNI.env, oldValue )
                }
            }
        }
    }

    public required init( javaObject: jobject? ) {
        self.javaObject = javaObject
    }

    public convenience init() {
        self.init( javaObject: nil )
    }

    open var isNull: Bool {
        return _javaObject == nil || JNI.api.IsSameObject( JNI.env, _javaObject, nil ) == jboolean(JNI_TRUE)
    }

    open func localJavaObject( _ locals: UnsafeMutablePointer<[jobject]> ) -> jobject? {
        if let local: jobject = _javaObject != nil ? JNI.api.NewLocalRef( JNI.env, _javaObject ) : nil {
            locals.pointee.append( local )
            return local
        }
        return nil
    }

    open func clearLocal() {
    }

    deinit {
        javaObject = nil
    }
}

open class JNIObjectForward: JNIObject {
}

extension String: JNIObjectProtocol {

    public func localJavaObject( _ locals: UnsafeMutablePointer<[jobject]> ) -> jobject? {
        if let javaObject: jstring =  Array(utf16).withUnsafeBufferPointer( {
            JNI.env?.pointee?.pointee.NewString( JNI.env, $0.baseAddress, jsize($0.count) )
        } ) {
            locals.pointee.append( javaObject )
            return javaObject
        }
        return nil
    }
}

extension String: JNIObjectInit {

    public init( javaObject: jobject? ) {
        var isCopy: jboolean = 0
        if let javaObject: jobject = javaObject, let value: UnsafePointer<jchar> = JNI.api.GetStringChars( JNI.env, javaObject, &isCopy ) {
            self.init( utf16CodeUnits: value, count: Int(JNI.api.GetStringLength( JNI.env, javaObject )) )
            if isCopy != 0 || true {
                JNI.api.ReleaseStringChars( JNI.env, javaObject, value ) ////
            }
        }
        else {
            self.init()
        }
    }
}

extension jobject {

    public func arrayMap<T>( block: ( _ javaObject: jobject? ) -> T ) -> [T] {
        return (0 ..< JNI.api.GetArrayLength( JNI.env, self )).map {
            let element: jobject? = JNI.api.GetObjectArrayElement( JNI.env, self, $0 )
            defer { JNI.DeleteLocalRef( element ) }
            return block( element )
        }
    }
}

//// Passing arbitrary arrays and dictionaries of objects will have to wait for swift 4 I guess
//// https://github.com/apple/swift-evolution/blob/master/proposals/0143-conditional-conformances.md#extending-protocols-to-conform-to-protocols
//
//extension Array: JNIObjectProtocol where Element: JNIObjectProtocol {
//    public func localJavaObject( _ locals: UnsafeMutablePointer<[jobject]> ) -> jobject? {
//        return JNIType.toJavaArray( value: self, locals: locals ) { JNIType.toJava( value: $0, locals: $1 ) }.l
////        return JNIType.toJava( value: map { JNIType.toJava( value: $0, locals: locals ) }, locals: locals ).l
//    }
//}

extension JNIType {

    private static var java_lang_StringClass: jclass?

    public static func toJavaArray<T>( value: [T]?, locals: UnsafeMutablePointer<[jobject]> ,
                                       block: (_ value: T, _ locals: UnsafeMutablePointer<[jobject]> ) -> jvalue ) -> jvalue {
        var array: jarray?
        if let value: [T] = value {
            for i in 0 ..< value.count {
                var sublocals = [jobject]()
                let element: jobject? = block( value[i], &sublocals ).l
                if array == nil {
                    if element == nil {
                        break
                    }
                    let elementClass: jclass? = JNI.GetObjectClass( element, &sublocals )
                    array = JNI.api.NewObjectArray( JNI.env, jsize(value.count), elementClass, nil )
                }
                JNI.api.SetObjectArrayElement( JNI.env, array, jsize(i), element )
                for local in sublocals {
                    JNI.DeleteLocalRef( local )
                }
            }

            // zero length lists of Strings are allowed
            if value.count == 0 && T.self == String.self {
                JNI.CachedFindClass( "java/lang/String", &java_lang_StringClass )
                array = JNI.api.NewObjectArray( JNI.env, 0, java_lang_StringClass, nil )
            }
        }

        if ( array != nil ) {
            locals.pointee.append( array! )
        }
        return jvalue( l: array )
    }

    public static func toJava( value: JNIObjectProtocol?, locals: UnsafeMutablePointer<[jobject]> ) -> jvalue {
        return jvalue( l: value?.localJavaObject( locals ) )
    }

    public static func toJava( value: [JNIObjectProtocol]?, locals: UnsafeMutablePointer<[jobject]> ) -> jvalue {
        return toJavaArray( value: value, locals: locals ) { toJava( value: $0, locals: $1 ) }
    }

    public static func toJava( value: [[JNIObjectProtocol]]?, locals: UnsafeMutablePointer<[jobject]> ) -> jvalue {
        return toJavaArray( value: value, locals: locals ) { toJava( value: $0, locals: $1 ) }
    }

    public static func toSwift<T: JNIObjectInit>( type: T.Type, from: jobject?, consume: Bool = true ) -> T? {
        guard let from: jobject = from else { return nil }
        defer { if consume { JNI.DeleteLocalRef( from ) } }
        return T( javaObject: from )
    }

    public static func toSwift<T: JNIObjectInit>( type: [T].Type, from: jobject?, consume: Bool = true ) -> [T]? {
        guard let from: jobject = from else { return nil }
        defer { if consume { JNI.DeleteLocalRef( from ) } }
        return from.arrayMap { T( javaObject: $0 ) }
    }

    public static func toSwift<T: JNIObjectInit>( type: [[T]].Type, from: jobject?, consume: Bool = true ) -> [[T]]? {
        guard let from: jobject = from else { return nil }
        defer { if consume { JNI.DeleteLocalRef( from ) } }
        return from.arrayMap { toSwift( type: [T].self, from: $0, consume: false ) ?? [T]() }
    }

    public static func toJava( value: JNIObjectProtocol?, mapClass: String, locals: UnsafeMutablePointer<[jobject]> ) -> jvalue {
        return jvalue( l: value?.localJavaObject( locals ) )
    }

    public static func toJava( value: [String: JNIObjectProtocol]?, mapClass: String, locals: UnsafeMutablePointer<[jobject]> ) -> jvalue {
        guard let value: [String: JNIObjectProtocol] = value else { return jvalue( l: nil ) }

        var classCache: jclass?
        var methodID: jmethodID?
        var __locals = [jobject]()
        var __args = [jvalue]( repeating: jvalue(), count: 1 )
        guard let __object: jobject = JNIMethod.NewObject( className: mapClass, classCache: &classCache,
                  methodSig: "()V", methodCache: &methodID, args: &__args, locals: &__locals ) else {
            JNI.report( "Unable to create HashMap of class \(mapClass)" )
            return jvalue( l: nil )
        }

        JNI.api.DeleteGlobalRef( JNI.env, classCache )

        let map = HashMap( javaObject: __object )
        for (key, item) in value {
            var sublocals = [jobject]()
            let javaKey = JavaObject( javaObject: toJava( value: key, locals: &sublocals ).l )
            let javaItem = JavaObject( javaObject: toJava( value: item, locals: &sublocals ).l )
            _ = map.put( javaKey, javaItem )
            for local in sublocals {
                JNI.DeleteLocalRef( local )
            }
        }

        locals.pointee.append( __object )
        return jvalue( l: __object )
    }

    public static func toJava( value: [String: [JNIObjectProtocol]]?, mapClass: String, locals: UnsafeMutablePointer<[jobject]> ) -> jvalue {
        guard let value: [String: [JNIObjectProtocol]] = value else { return jvalue( l: nil ) }

        var classCache: jclass?
        var methodID: jmethodID?
        var __args = [jvalue]( repeating: jvalue(), count: 1 )
        var __locals = [jobject]()
        guard let __object: jobject = JNIMethod.NewObject( className: mapClass, classCache: &classCache,
                  methodSig: "()V", methodCache: &methodID, args: &__args, locals: &__locals ) else {
            JNI.report( "Unable to create HashMap of class \(mapClass)" )
            return jvalue( l: nil )
        }

        JNI.api.DeleteGlobalRef( JNI.env, classCache )

        let map: HashMap = HashMap( javaObject: __object )
        for (key, item) in value {
            var sublocals = [jobject]()
            let javaKey = JavaObject( javaObject: toJava( value: key, locals: &sublocals ).l )
            let javaItem = JavaObject( javaObject: toJava( value: item, locals: &sublocals ).l )
            _ = map.put( javaKey, javaItem )
            for local in sublocals {
                JNI.DeleteLocalRef( local )
            }
        }

        locals.pointee.append( __object )
        return jvalue( l: __object )
    }

    public static func toSwift<T: JNIObjectInit>( type: [String: T].Type, from: jobject?, consume: Bool = true ) -> [String: T]? {
        guard let from: jobject = from else { return nil }
        defer { if consume { JNI.DeleteLocalRef( from ) } }
        let map = HashMap( javaObject: from )
        var out = [String:T]()
        for key in map.keySet().toArray() {
            key.withJavaObject {
                keyObject in
                map.get(key).withJavaObject {
                    itemObject in
                    if let keystr: String = JNIType.toSwift( type: String.self, from: keyObject, consume: false ) {
                        out[keystr] = T( javaObject: itemObject )
                    }
                }
            }
        }
        return out
    }

    public static func toSwift<T: JNIObjectInit>( type: [String: [T]].Type, from: jobject?, consume: Bool = true ) -> [String: [T]]? {
        guard let from: jobject = from else { return nil }
        defer { if consume { JNI.DeleteLocalRef( from ) } }
        let map = HashMap( javaObject: from )
        var out = [String:[T]]()
        for key in map.keySet().toArray() {
            key.withJavaObject {
                keyObject in
                map.get(key).withJavaObject {
                    itemObject in
                    if let keystr: String = JNIType.toSwift( type: String.self, from: keyObject, consume: false ),
                        let value: [T] = JNIType.toSwift( type: [T].self, from: itemObject, consume: false ) {
                        out[keystr] = value
                    }
                }
            }
        }
        return out
    }
}