Update BNCLog Logging Names (#618)

* Better naming for logging functions. More intuitive defaults.

Author: E-B-Smith

Branch-SDK/Branch-SDK/BNCLog.h

@@ -119,20 +119,20 @@ extern void BNCLogSetFlushFunction(BNCLogFlushFunctionPtr _Nullable flushFunctio
 extern BNCLogFlushFunctionPtr _Nullable BNCLogFlushFunction();
 
 
-#pragma mark - BNCLogMessageInternal
+#pragma mark - BNCLogWriteMessage
 
 
-/// The main logging function used in the logging defines.
-extern void BNCLogMessageInternal(
+/// The main logging function used in the variadic logging defines.
+extern void BNCLogWriteMessageFormat(
     BNCLogLevel logLevel,
     const char *_Nullable sourceFileName,
     int sourceLineNumber,
     id _Nullable messageFormat,
     ...
 );
 
-/// Swift-friendly wrapper for BNCLogMessageInternal
-extern void BNCLogMessageInternalSwift(
+/// Swift-friendly wrapper for BNCLogWriteMessageFormat
+extern void BNCLogWriteMessage(
     BNCLogLevel logLevel,
     NSString *_Nonnull sourceFileName,
     NSUInteger sourceLineNumber,
@@ -149,25 +149,25 @@ extern void BNCLogFlushMessages();
 
 ///@param format Log a debug message with the specified formatting.
 #define BNCLogDebug(...) \
-    do  { BNCLogMessageInternal(BNCLogLevelDebug, __FILE__, __LINE__, __VA_ARGS__); } while (0)
+    do  { BNCLogWriteMessageFormat(BNCLogLevelDebug, __FILE__, __LINE__, __VA_ARGS__); } while (0)
 
 ///@param format Log a warning message with the specified formatting.
 #define BNCLogWarning(...) \
-    do  { BNCLogMessageInternal(BNCLogLevelWarning, __FILE__, __LINE__, __VA_ARGS__); } while (0)
+    do  { BNCLogWriteMessageFormat(BNCLogLevelWarning, __FILE__, __LINE__, __VA_ARGS__); } while (0)
 
 ///@param format Log an error message with the specified formatting.
 #define BNCLogError(...) \
-    do  { BNCLogMessageInternal(BNCLogLevelError, __FILE__, __LINE__, __VA_ARGS__); } while (0)
+    do  { BNCLogWriteMessageFormat(BNCLogLevelError, __FILE__, __LINE__, __VA_ARGS__); } while (0)
 
 ///@param format Log a message with the specified formatting.
 #define BNCLog(...) \
-    do  { BNCLogMessageInternal(BNCLogLevelLog, __FILE__, __LINE__, __VA_ARGS__); } while (0)
+    do  { BNCLogWriteMessageFormat(BNCLogLevelLog, __FILE__, __LINE__, __VA_ARGS__); } while (0)
 
 ///Cause a programmatic breakpoint if breakpoints are enabled.
 #define BNCLogBreakPoint() \
     do  { \
         if (BNCLogBreakPointsAreEnabled()) { \
-            BNCLogMessageInternal(BNCLogLevelBreakPoint, __FILE__, __LINE__, @"Programmatic breakpoint."); \
+            BNCLogWriteMessageFormat(BNCLogLevelBreakPoint, __FILE__, __LINE__, @"Programmatic breakpoint."); \
             if (BNCDebuggerIsAttached()) { \
                 BNCLogFlushMessages(); \
                 BNCDebugBreakpoint(); \
@@ -179,7 +179,7 @@ extern void BNCLogFlushMessages();
 #define BNCBreakPointWithMessage(...) \
     do  { \
         if (BNCLogBreakPointsAreEnabled() { \
-            BNCLogMessageInternal(BNCLogLevelBreakPoint, __FILE__, __LINE__, __VA_ARGS__); \
+            BNCLogWriteMessageFormat(BNCLogLevelBreakPoint, __FILE__, __LINE__, __VA_ARGS__); \
             if (BNCDebuggerIsAttached()) { \
                 BNCLogFlushMessages(); \
                 BNCDebugBreakpoint(); \
@@ -191,7 +191,7 @@ extern void BNCLogFlushMessages();
 #define BNCLogAssert(condition) \
     do  { \
         if (!(condition)) { \
-            BNCLogMessageInternal(BNCLogLevelAssert, __FILE__, __LINE__, @"(%s) !!!", #condition); \
+            BNCLogWriteMessageFormat(BNCLogLevelAssert, __FILE__, __LINE__, @"(%s) !!!", #condition); \
             if (BNCLogBreakPointsAreEnabled() && BNCDebuggerIsAttached()) { \
                 BNCLogFlushMessages(); \
                 BNCDebugBreakpoint(); \
@@ -205,7 +205,7 @@ extern void BNCLogFlushMessages();
     do  { \
         if (!(condition)) { \
             NSString *m = [NSString stringWithFormat:message, __VA_ARGS__]; \
-            BNCLogMessageInternal(BNCLogLevelAssert, __FILE__, __LINE__, @"(%s) !!! %@", #condition, m); \
+            BNCLogWriteMessageFormat(BNCLogLevelAssert, __FILE__, __LINE__, @"(%s) !!! %@", #condition, m); \
             if (BNCLogBreakPointsAreEnabled() && BNCDebuggerIsAttached()) { \
                 BNCLogFlushMessages(); \
                 BNCDebugBreakpoint(); \

Branch-SDK/Branch-SDK/BNCLog.m

@@ -463,7 +463,7 @@ void BNCLogSetBreakPointsEnabled(BOOL enabled) {
 
 #pragma mark - Log Functions
 
-static BNCLogOutputFunctionPtr bnc_LoggingFunction = BNCLogFunctionOutputToStdOut;
+static BNCLogOutputFunctionPtr bnc_LoggingFunction = nil; // Default to just NSLog output.
 static BNCLogFlushFunctionPtr bnc_LogFlushFunction = BNCLogFlushFileDescriptor;
 
 BNCLogOutputFunctionPtr _Nullable BNCLogOutputFunction() {
@@ -498,7 +498,7 @@ void BNCLogSetFlushFunction(BNCLogFlushFunctionPtr flushFunction) {
 
 static dispatch_queue_t bnc_LogQueue = nil;
 
-void BNCLogMessageInternal(
+void BNCLogWriteMessageFormat(
         BNCLogLevel logLevel,
         const char *_Nullable file,
         int lineNumber,
@@ -551,13 +551,13 @@ void BNCLogMessageInternal(
     }
 }
 
-void BNCLogMessageInternalSwift(
+void BNCLogWriteMessage(
                            BNCLogLevel logLevel,
                            NSString *_Nonnull file,
                            NSUInteger lineNumber,
                            NSString *_Nonnull message
                            ) {
-    BNCLogMessageInternal(logLevel, file.UTF8String, (int)lineNumber, @"%@", message);
+    BNCLogWriteMessageFormat(logLevel, file.UTF8String, (int)lineNumber, @"%@", message);
 }
 
 void BNCLogFlushMessages() {

Examples/WebViewExample/Podfile

@@ -1,4 +1,5 @@
 use_frameworks!
+platform :ios, '9.0'
 
 # ----- Branch pod
 #

Examples/WebViewExample/WebViewExample.xcodeproj/project.pbxproj

@@ -226,7 +226,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "diff \"${PODS_ROOT}/../Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n    # print error to STDERR\n    echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n    exit 1\nfi\n";
+			shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n    # print error to STDERR\n    echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n    exit 1\nfi\n";
 			showEnvVarsInLog = 0;
 		};
 		DF74DA356D0CBFBBC39E6377 /* [CP] Copy Pods Resources */ = {

Examples/WebViewExample/WebViewExample/AppDelegate.swift

@@ -17,7 +17,6 @@ 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
@@ -33,7 +32,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             guard let buo = buo else { return }
             self.routeURLFromBranch(buo)
         }
-        
+
         return true
     }
 

Examples/WebViewExample/WebViewExample/Utilities/BNCLog.swift

@@ -16,7 +16,7 @@ import Branch
  *   - line: (unused) provides the Swift line number
  */
 func BNCLogDebug(_ message: String, _ file: String=#file, _ line: UInt=#line) {
-    BNCLogMessageInternalSwift(.debug, file, line, message)
+    BNCLogWriteMessage(.debug, file, line, message)
 }
 
 /**
@@ -27,7 +27,7 @@ func BNCLogDebug(_ message: String, _ file: String=#file, _ line: UInt=#line) {
  *   - line: (unused) provides the Swift line number
  */
 func BNCLogError(_ message: String, _ file: String=#file, _ line: UInt=#line) {
-    BNCLogMessageInternalSwift(.error, file, line, message)
+    BNCLogWriteMessage(.error, file, line, message)
 }
 
 /**
@@ -38,7 +38,7 @@ func BNCLogError(_ message: String, _ file: String=#file, _ line: UInt=#line) {
  *   - line: (unused) provides the Swift line number
  */
 func BNCLog(_ message: String, _ file: String=#file, _ line: UInt=#line) {
-    BNCLogMessageInternalSwift(.log, file, line, message)
+    BNCLogWriteMessage(.log, file, line, message)
 }
 
 /**
@@ -49,5 +49,5 @@ func BNCLog(_ message: String, _ file: String=#file, _ line: UInt=#line) {
  *   - line: (unused) provides the Swift line number
  */
 func BNCLogWarning(_ message: String, _ file: String=#file, _ line: UInt=#line) {
-    BNCLogMessageInternalSwift(.warning, file, line, message)
+    BNCLogWriteMessage(.warning, file, line, message)
 }