BNCLog functions for Swift (#614)

jdee · E-B-Smith · commit 1319a2095aa2 · 2017-04-24T14:15:04.000-07:00
* Added BNCLog functions for Swift. work in progress

* Another approach: Added BNCLogMessageInternalSwift

* Remove workaround for UIApplicationOpenURLOptionsKey problem (now fixed)
diff --git a/Branch-SDK/Branch-SDK/BNCLog.h b/Branch-SDK/Branch-SDK/BNCLog.h
@@ -131,6 +131,14 @@ extern void BNCLogMessageInternal(
     ...
 );
 
+/// Swift-friendly wrapper for BNCLogMessageInternal
+extern void BNCLogMessageInternalSwift(
+    BNCLogLevel logLevel,
+    NSString *_Nonnull sourceFileName,
+    NSUInteger sourceLineNumber,
+    NSString *_Nonnull message
+);
+
 /// This function synchronizes all outstanding log messages and writes them to the logging function
 /// set by BNCLogSetOutputFunction.
 extern void BNCLogFlushMessages();
diff --git a/Branch-SDK/Branch-SDK/BNCLog.m b/Branch-SDK/Branch-SDK/BNCLog.m
@@ -551,6 +551,15 @@ void BNCLogMessageInternal(
     }
 }
 
+void BNCLogMessageInternalSwift(
+                           BNCLogLevel logLevel,
+                           NSString *_Nonnull file,
+                           NSUInteger lineNumber,
+                           NSString *_Nonnull message
+                           ) {
+    BNCLogMessageInternal(logLevel, file.UTF8String, (int)lineNumber, @"%@", message);
+}
+
 void BNCLogFlushMessages() {
     if (BNCLogSynchronizeMessages()) {
         dispatch_sync(bnc_LogQueue, ^{
diff --git a/Examples/WebViewExample/WebViewExample.xcodeproj/project.pbxproj b/Examples/WebViewExample/WebViewExample.xcodeproj/project.pbxproj
@@ -8,6 +8,7 @@
 
 /* Begin PBXBuildFile section */
 		44B41F44A1783294F78E3DCC /* Pods_WebViewExample.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 8529F4248FBBE54B064721F2 /* Pods_WebViewExample.framework */; };
+		7B016F1F1E97F29000C34EBA /* BNCLog.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7B016F1E1E97F29000C34EBA /* BNCLog.swift */; };
 		7B132B5A1E8D7B43006FB28F /* BranchUniversalObject+PlanetData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7B132B591E8D7B43006FB28F /* BranchUniversalObject+PlanetData.swift */; };
 		7B132B5C1E8D878E006FB28F /* Style.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7B132B5B1E8D878E006FB28F /* Style.swift */; };
 		7B3B97841E8C1B650089C04B /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7B3B97831E8C1B650089C04B /* AppDelegate.swift */; };
@@ -25,6 +26,7 @@
 /* Begin PBXFileReference section */
 		6D6117909230007A384D2046 /* Pods-WebViewExample.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-WebViewExample.release.xcconfig"; path = "Pods/Target Support Files/Pods-WebViewExample/Pods-WebViewExample.release.xcconfig"; sourceTree = "<group>"; };
 		73F43B2C303E9BF5A6714F1B /* Pods-WebViewExample.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-WebViewExample.debug.xcconfig"; path = "Pods/Target Support Files/Pods-WebViewExample/Pods-WebViewExample.debug.xcconfig"; sourceTree = "<group>"; };
+		7B016F1E1E97F29000C34EBA /* BNCLog.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BNCLog.swift; sourceTree = "<group>"; };
 		7B132B591E8D7B43006FB28F /* BranchUniversalObject+PlanetData.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "BranchUniversalObject+PlanetData.swift"; sourceTree = "<group>"; };
 		7B132B5B1E8D878E006FB28F /* Style.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Style.swift; sourceTree = "<group>"; };
 		7B3B97801E8C1B650089C04B /* WebViewExample.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = WebViewExample.app; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -63,6 +65,14 @@
 			name = Frameworks;
 			sourceTree = "<group>";
 		};
+		7B016F191E97F1BE00C34EBA /* Utilities */ = {
+			isa = PBXGroup;
+			children = (
+				7B016F1E1E97F29000C34EBA /* BNCLog.swift */,
+			);
+			path = Utilities;
+			sourceTree = "<group>";
+		};
 		7B3B97771E8C1B640089C04B = {
 			isa = PBXGroup;
 			children = (
@@ -84,6 +94,7 @@
 		7B3B97821E8C1B650089C04B /* WebViewExample */ = {
 			isa = PBXGroup;
 			children = (
+				7B016F191E97F1BE00C34EBA /* Utilities */,
 				7B3B97AD1E8C40400089C04B /* WebViewExample.entitlements */,
 				7B3B97831E8C1B650089C04B /* AppDelegate.swift */,
 				7B3B97971E8C21F60089C04B /* ArticleListViewController.swift */,
@@ -146,6 +157,7 @@
 				TargetAttributes = {
 					7B3B977F1E8C1B650089C04B = {
 						CreatedOnToolsVersion = 8.3;
+						LastSwiftMigration = 0830;
 						ProvisioningStyle = Automatic;
 						SystemCapabilities = {
 							com.apple.SafariKeychain = {
@@ -246,6 +258,7 @@
 				7B3B979A1E8C23AA0089C04B /* PlanetData.swift in Sources */,
 				7B3B97961E8C21510089C04B /* NavigationController.swift in Sources */,
 				7B3B97AC1E8C32BD0089C04B /* ArticleView.swift in Sources */,
+				7B016F1F1E97F29000C34EBA /* BNCLog.swift in Sources */,
 				7B132B5C1E8D878E006FB28F /* Style.swift in Sources */,
 				7B3B97841E8C1B650089C04B /* AppDelegate.swift in Sources */,
 			);
@@ -373,12 +386,14 @@
 			baseConfigurationReference = 73F43B2C303E9BF5A6714F1B /* Pods-WebViewExample.debug.xcconfig */;
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
+				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_ENTITLEMENTS = WebViewExample/WebViewExample.entitlements;
 				DEVELOPMENT_TEAM = "";
 				INFOPLIST_FILE = WebViewExample/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = io.branch.WebViewExample;
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
 				SWIFT_VERSION = 3.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
@@ -389,6 +404,7 @@
 			baseConfigurationReference = 6D6117909230007A384D2046 /* Pods-WebViewExample.release.xcconfig */;
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
+				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_ENTITLEMENTS = WebViewExample/WebViewExample.entitlements;
 				DEVELOPMENT_TEAM = "";
 				INFOPLIST_FILE = WebViewExample/Info.plist;
diff --git a/Examples/WebViewExample/WebViewExample/AppDelegate.swift b/Examples/WebViewExample/WebViewExample/AppDelegate.swift
@@ -17,14 +17,16 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     // MARK: - UIApplicationDelegate methods
 
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
+        BNCLogSetOutputFunction(nil)
+
         // Store the NavigationController for later link routing.
         navigationController = window?.rootViewController as? NavigationController
 
         // Initialize Branch SDK
         Branch.getInstance().initSession(launchOptions: launchOptions) {
             (buo: BranchUniversalObject?, linkProperties: BranchLinkProperties?, error: Error?) in
             guard error == nil else {
-                print("Error from Branch: \(error!)")
+                BNCLogError("Error from Branch: \(error!)")
                 return
             }
 
diff --git a/Examples/WebViewExample/WebViewExample/ArticleView.swift b/Examples/WebViewExample/WebViewExample/ArticleView.swift
@@ -63,7 +63,7 @@ class ArticleView: UIView, WKNavigationDelegate {
 
     func webView(_ webView: WKWebView, didFail navigation: WKNavigation!, withError error: Error) {
         hud.hide(animated: true)
-        print("could not load \(planetData.url): \(error)")
+        BNCLogError("could not load \(planetData.url): \(error)")
     }
 
     func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {
diff --git a/Examples/WebViewExample/WebViewExample/ArticleViewController.swift b/Examples/WebViewExample/WebViewExample/ArticleViewController.swift
@@ -64,7 +64,7 @@ class ArticleViewController: UIViewController, ArticleViewDelegate {
 
         // Log a BNCRegisterViewEvent each time the user views the page.
         buo.userCompletedAction(BNCRegisterViewEvent)
-        print("Logged BNCRegisterViewEvent on BUO")
+        BNCLog("Logged BNCRegisterViewEvent on BUO")
     }
 
     // MARK: - ArticleViewDelegate
@@ -79,7 +79,7 @@ class ArticleViewController: UIViewController, ArticleViewDelegate {
 
         buo.showShareSheet(with: linkProperties, andShareText: "Read about the planet \(planetData.title).", from: self) {
             channel, success in
-            print("Share to channel \(channel ?? "(nil)") complete. success = \(success)")
+            BNCLog("Share to channel \(channel ?? "(nil)") complete. success = \(success)")
         }
     }
 
@@ -89,6 +89,6 @@ class ArticleViewController: UIViewController, ArticleViewDelegate {
         // Initialization and configuration.
         buo = BranchUniversalObject(planetData: planetData)
         
-        print("Created Branch Universal Object")
+        BNCLog("Created Branch Universal Object")
     }
 }
diff --git a/Examples/WebViewExample/WebViewExample/PlanetData.swift b/Examples/WebViewExample/WebViewExample/PlanetData.swift
@@ -47,7 +47,7 @@ struct PlanetData {
         guard let title = branchUniversalObject.title,
             let urlString = branchUniversalObject.canonicalUrl,
             let url = URL(string: urlString) else {
-            print("Could not get required data from BranchUniversalObject")
+            BNCLogWarning("Could not get required data from BranchUniversalObject")
             return nil
         }
 
diff --git a/Examples/WebViewExample/WebViewExample/Utilities/BNCLog.swift b/Examples/WebViewExample/WebViewExample/Utilities/BNCLog.swift
@@ -0,0 +1,53 @@
+//
+//  BNCLog.swift
+//  WebViewExample
+//
+//  Created by Jimmy Dee on 4/7/17.
+//  Copyright © 2017 Branch Metrics. All rights reserved.
+//
+
+import Branch
+
+/**
+ * Logs a message at BNCLogLevel.debug
+ * - Parameters:
+ *   - message: the message to log
+ *   - file: (unused) provides the Swift source file path
+ *   - line: (unused) provides the Swift line number
+ */
+func BNCLogDebug(_ message: String, _ file: String=#file, _ line: UInt=#line) {
+    BNCLogMessageInternalSwift(.debug, file, line, message)
+}
+
+/**
+ * Logs a message at BNCLogLevel.error
+ * - Parameters:
+ *   - message: the message to log
+ *   - file: (unused) provides the Swift source file path
+ *   - line: (unused) provides the Swift line number
+ */
+func BNCLogError(_ message: String, _ file: String=#file, _ line: UInt=#line) {
+    BNCLogMessageInternalSwift(.error, file, line, message)
+}
+
+/**
+ * Logs a message at BNCLogLevel.log
+ * - Parameters:
+ *   - message: the message to log
+ *   - file: (unused) provides the Swift source file path
+ *   - line: (unused) provides the Swift line number
+ */
+func BNCLog(_ message: String, _ file: String=#file, _ line: UInt=#line) {
+    BNCLogMessageInternalSwift(.log, file, line, message)
+}
+
+/**
+ * Logs a message at BNCLogLevel.warning
+ * - Parameters:
+ *   - message: the message to log
+ *   - file: (unused) provides the Swift source file path
+ *   - line: (unused) provides the Swift line number
+ */
+func BNCLogWarning(_ message: String, _ file: String=#file, _ line: UInt=#line) {
+    BNCLogMessageInternalSwift(.warning, file, line, message)
+}

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ class ArticleView: UIView, WKNavigationDelegate {`
`63`	`63`
`64`	`64`	`func webView(_ webView: WKWebView, didFail navigation: WKNavigation!, withError error: Error) {`
`65`	`65`	`hud.hide(animated: true)`
`66`		`- print("could not load \(planetData.url): \(error)")`
	`66`	`+ BNCLogError("could not load \(planetData.url): \(error)")`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ class ArticleViewController: UIViewController, ArticleViewDelegate {`
`64`	`64`
`65`	`65`	`// Log a BNCRegisterViewEvent each time the user views the page.`
`66`	`66`	`buo.userCompletedAction(BNCRegisterViewEvent)`
`67`		`- print("Logged BNCRegisterViewEvent on BUO")`
	`67`	`+ BNCLog("Logged BNCRegisterViewEvent on BUO")`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`// MARK: - ArticleViewDelegate`
`@@ -79,7 +79,7 @@ class ArticleViewController: UIViewController, ArticleViewDelegate {`
`79`	`79`
`80`	`80`	`buo.showShareSheet(with: linkProperties, andShareText: "Read about the planet \(planetData.title).", from: self) {`
`81`	`81`	`channel, success in`
`82`		`- print("Share to channel \(channel ?? "(nil)") complete. success = \(success)")`
	`82`	`+ BNCLog("Share to channel \(channel ?? "(nil)") complete. success = \(success)")`
`83`	`83`	`}`
`84`	`84`	`}`
`85`	`85`
`@@ -89,6 +89,6 @@ class ArticleViewController: UIViewController, ArticleViewDelegate {`
`89`	`89`	`// Initialization and configuration.`
`90`	`90`	`buo = BranchUniversalObject(planetData: planetData)`
`91`	`91`
`92`		`- print("Created Branch Universal Object")`
	`92`	`+ BNCLog("Created Branch Universal Object")`
`93`	`93`	`}`
`94`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ struct PlanetData {`
`47`	`47`	`guard let title = branchUniversalObject.title,`
`48`	`48`	`let urlString = branchUniversalObject.canonicalUrl,`
`49`	`49`	`let url = URL(string: urlString) else {`
`50`		`- print("Could not get required data from BranchUniversalObject")`
	`50`	`+ BNCLogWarning("Could not get required data from BranchUniversalObject")`
`51`	`51`	`return nil`
`52`	`52`	`}`
`53`	`53`