update generator to clean up LDKStr and to not dangle NetGraphMsgHandler in BGProcessor initialization

Author: arik-so

.editorconfig

@@ -2,6 +2,7 @@
 indent_style = tab
 indent_size = 4
 insert_final_newline = true
+trim_trailing_whitespace = true
 
 [Makefile]
 

README.md

@@ -67,10 +67,10 @@ folder due to the previous `genbindings.sh` step. As Docker won't have access to
 replace those lines with the following:
 
 ```yaml
-lightning = { git = "https://github.com/thebluematt/rust-lightning", rev = "xxx", features = ["std"] }
-lightning-persister = { git = "https://github.com/thebluematt/rust-lightning", rev = "xxx" }
-lightning-invoice = { git = "https://github.com/thebluematt/rust-lightning", rev = "xxx" }
-lightning-background-processor = { git = "https://github.com/thebluematt/rust-lightning", rev = "xxx" }
+lightning = { git = "https://github.com/thebluematt/rust-lightning", branch = "2021-03-java-bindings-base", default-features = false }
+lightning-persister = { git = "https://github.com/thebluematt/rust-lightning", branch = "2021-03-java-bindings-base", default-features = false }
+lightning-invoice = { git = "https://github.com/thebluematt/rust-lightning", branch = "2021-03-java-bindings-base", default-features = false }
+lightning-background-processor = { git = "https://github.com/thebluematt/rust-lightning", branch = "2021-03-java-bindings-base", default-features = false }
 ```
 
 You will note that the revision is unspecified and is currently just placeholder `xxx`s. To obtain the revision, 

ci/docker_shell.sh

@@ -11,7 +11,8 @@ LDK_SUBDIRECTORY="$LDK_DIRECTORY/lightning-c-bindings"
 if [[ "${MOUNT_CI_FOLDER}" = "true" ]]; then
 	# use for direct ci folder access
 	cp -R bindings/batteries ci/LDKSwift/Sources/LDKSwift
-	docker run --name "swift-generator-shell" -e MOUNTED_CI_FOLDER=true -i -v $PROJECT_DIRECTORY/ci:/ci -v $LDK_DIRECTORY:/ldk-c-bindings --rm -t swift-generation-ci /bin/bash
+	# docker run --name "swift-generator-shell" -e MOUNTED_CI_FOLDER=true -i -v $PROJECT_DIRECTORY/ci:/ci -v $LDK_DIRECTORY:/ldk-c-bindings --rm -t swift-generation-ci /bin/bash
+	docker run --name "swift-generator-shell" -e MOUNTED_CI_FOLDER=true -i -v $PROJECT_DIRECTORY/ci:/ci -v $LDK_DIRECTORY:/ldk-c-bindings -v $PROJECT_DIRECTORY/src:/src --rm -t swift-generation-ci /bin/bash
 elif [ "${MOUNT_CI_FOLDER}" = "false" ]; then
 	docker run --name "swift-generator-shell" -e MOUNTED_CI_FOLDER=false -i -v $LDK_DIRECTORY:/ldk-c-bindings --rm -t swift-generation-ci /bin/bash
 else

ci/run_tests.sh

@@ -30,5 +30,6 @@ python3 ./fix_header_includes.py
 python3 ./fix_swift_imports.py
 
 pushd LDKSwift/
-swift test # -Xswiftc -suppress-warnings
-#swift test -Xswiftc -suppress-warnings
+#swift test
+swift test -Xswiftc -suppress-warnings
+#swift test --filter 'testInvoiceSerialization' -Xswiftc -suppress-warnings

src/conversion_helper.py

@@ -74,6 +74,17 @@ def is_instance_type(cls, swift_type: str, raw_rust_type: str, include_options_a
 	def is_array_type(cls, swift_type: str):
 		return swift_type.startswith('[')
 
+	@classmethod
+	def is_type_cloneable(cls, raw_rust_type: str):
+		cloneability_lookup = 'x-uncloneable'
+		individual_cloneability_lookup = None
+		if raw_rust_type is not None:
+			cloneability_lookup = raw_rust_type
+			if cloneability_lookup.startswith('LDK'):
+				cloneability_lookup = cloneability_lookup[len('LDK'):]
+		is_cloneable = cloneability_lookup in cloneable_types
+		return is_cloneable
+
 	@classmethod
 	def prepare_swift_to_native_arguments(cls, argument_types, is_trait_callback=False, force_pass_instance=False, is_free_method=False, is_returned_value_freeable=False, unwrap_complex_arrays = True, array_unwrapping_preparation_only = False, is_trait_default_redirect = False):
 		swift_arguments = []
@@ -309,7 +320,7 @@ def prepare_swift_to_native_arguments(cls, argument_types, is_trait_callback=Fal
 						force_unwrap_suffix = '!'
 					native_arguments.append(f'Bindings.string_to_unsafe_int8_pointer(string: {passed_argument_name}{force_unwrap_suffix})')
 				else:
-					native_arguments.append(f'Bindings.new_LDKStr(string: {passed_argument_name})')
+					native_arguments.append(f'Bindings.new_LDKStr(string: {passed_argument_name}, chars_is_owned: true)')
 			elif current_argument_details.rust_obj is None and current_argument_details.arr_len is not None and current_argument_details.arr_len.isnumeric():
 				if current_argument_details.is_const:
 					force_unwrap_suffix = ''
@@ -372,7 +383,16 @@ def prepare_native_to_swift_callback_arguments(cls, argument_types, array_unwrap
 					swift_local_conversion_suffix = ')'
 					# TODO: see if `current_argument_details.pass_by_ref` condition is necessary
 					if current_argument_details.passed_as_ptr and current_argument_details.pass_by_ref:
+						# this is useful for traits, but some types may not have cloneability support
 						swift_local_conversion_suffix = ').dangle()'
+						is_cloneable = ConversionHelper.is_type_cloneable(received_raw_type)
+						if is_cloneable:
+							swift_local_conversion_suffix += '.clone()'
+						else:
+							print(f"trait callback uncloneable type danger: {received_raw_type} / {published_swift_type}")
+					elif current_argument_details.passed_as_ptr or current_argument_details.pass_by_ref:
+						descriptor = 'passed_as_ptr' if current_argument_details.passed_as_ptr else 'pass_by_ref'
+						print(f'{descriptor}: {received_raw_type} / {published_swift_type}')
 				elif received_raw_type.startswith('LDKCOption_') and received_raw_type == 'LDKC' + published_swift_type:
 					swift_local_conversion_prefix = f'{published_swift_type}(pointer: '
 					swift_local_conversion_suffix = ')'

src/generators/opaque_struct_generator.py

@@ -69,7 +69,7 @@ def generate_opaque_struct(self, struct_name, struct_details, all_type_details={
 				''')
 
 				constructor_swift_arguments[4] = new_swift_argument
-				constructor_native_call_prep += '\nlet graphMessageHandler = net_graph_msg_handler?.dangle().cOpaqueStruct! ?? LDKNetGraphMsgHandler(inner: nil, is_owned: true)\n'
+				constructor_native_call_prep += '\nlet graphMessageHandler = net_graph_msg_handler?.cOpaqueStruct! ?? LDKNetGraphMsgHandler(inner: nil, is_owned: true)\n'
 				constructor_post_init_anchoring = constructor_post_init_anchoring.replace('try? self.addAnchor(anchor: net_graph_msg_handler)', '''
 					if let handler = net_graph_msg_handler {
 						try? self.addAnchor(anchor: handler)

templates/BindingsTemplate.swift

@@ -338,7 +338,7 @@ public class Bindings {
 	}
 	/* RUST_TO_SWIFT_END */
 
-    public class func LDKStr_to_string(nativeType: LDKStr) -> String {
+    public class func LDKStr_to_string(nativeType: LDKStr, deallocate: Bool = true) -> String {
 		var array = [UInt8]()
 		for index in 0..<Int(nativeType.len) {
 			let currentEntry = nativeType.chars[index]
@@ -347,6 +347,9 @@ public class Bindings {
 		}
 		let data = Data(bytes: array)
 		let string = String(data: data, encoding: .utf8)!
+		if deallocate && nativeType.len > 0{
+			Str_free(nativeType)
+		}
 		return string
 	}
 
@@ -380,7 +383,7 @@ public class Bindings {
 		let nativeKeysManager = keysManager.cOpaqueStruct!
 		let amount = Option_u64Z(value: amountMsat)
 		let nativeAmount = amount.cOpaqueStruct!
-		let nativeDescription = Self.new_LDKStr(string: description)
+		let nativeDescription = Self.new_LDKStr(string: description, chars_is_owned: true)
 		return withUnsafePointer(to: channelManager.cOpaqueStruct!) { (pointer: UnsafePointer<LDKChannelManager>) -> Result_InvoiceSignOrCreationErrorZ in
 			let nativeResult = create_invoice_from_channelmanager(pointer, nativeKeysManager, network, nativeAmount, nativeDescription)
 			return Result_InvoiceSignOrCreationErrorZ(pointer: nativeResult)