Add CMake logic for defining a future library for playbilling

Adds a cmake script that allows the definition of a version of the future library that uses the namespace playbillingclient instead of firebase. Adds logic to the source files that if playbilling is being used, it includes the generated public header for it instead.
Because of the source libraries needing to include the generated header, it will currently only work for playbilling, but could potentially be generalized in the future.

PiperOrigin-RevId: 251918893

Author: a-maurice

app/CMakeLists.txt

@@ -86,6 +86,7 @@ set(log_common_SRCS
     src/log.cc)
 set(log_android_SRCS
     src/log_android.cc
+    src/log_android_callback.cc
     src/util_android.cc)
 set(log_ios_SRCS
     src/log_ios.mm)

app/src/future_manager.h

@@ -19,14 +19,19 @@
 
 #include <map>
 #include <set>
-#include "app/src/include/firebase/future.h"
 #include "app/src/mutex.h"
 #include "app/src/reference_counted_future_impl.h"
 
 #if !defined(FIREBASE_NAMESPACE)
 #define FIREBASE_NAMESPACE firebase
 #endif
 
+#ifdef USE_PLAYBILLING_FUTURE
+#include "playbillingclient/future.h"
+#else
+#include "app/src/include/firebase/future.h"
+#endif
+
 namespace FIREBASE_NAMESPACE {
 
 // Class for handling Future APIs. These all work directly with

app/src/include/firebase/internal/future_impl.h

@@ -22,7 +22,11 @@
 // You shouldn't include future_impl.h directly, since its just the inline
 // implementation of the functions in future.h. Include future.h instead.
 // This is here to ensure that presubmit tests pass.
+#ifdef USE_PLAYBILLING_FUTURE
+#include "playbillingclient/future.h"
+#else
 #include "firebase/future.h"
+#endif
 
 #if defined(FIREBASE_USE_MOVE_OPERATORS)
 #include <utility>

app/src/include/firebase/util.h

@@ -18,12 +18,17 @@
 #define FIREBASE_APP_CLIENT_CPP_SRC_INCLUDE_FIREBASE_UTIL_H_
 
 #include "firebase/app.h"
-#include "firebase/future.h"
 
 #if !defined(FIREBASE_NAMESPACE)
 #define FIREBASE_NAMESPACE firebase
 #endif
 
+#ifdef USE_PLAYBILLING_FUTURE
+#include "playbillingclient/future.h"
+#else
+#include "firebase/future.h"
+#endif
+
 namespace FIREBASE_NAMESPACE {
 
 struct ModuleInitializerData;

app/src/log_android.cc

@@ -27,12 +27,7 @@
 #define STR_EXPAND(x) #x
 #define STR(x) STR_EXPAND(x)
 
-#include <assert.h>
-#include <jni.h>
 #include <stdarg.h>
-#include <stdio.h>
-
-#include "app/src/util_android.h"
 
 namespace FIREBASE_NAMESPACE {
 
@@ -75,28 +70,5 @@ void LogMessageV(LogLevel log_level, const char* format, va_list args) {
 }
 #endif  // defined(FIREBASE_ANDROID_FOR_DESKTOP)
 
-// Called from com.google.firebase.app.internal.cpp.Log.
-extern "C" JNIEXPORT void JNICALL
-Java_com_google_firebase_app_internal_cpp_Log_nativeLog(
-    JNIEnv* env, jobject instance, jint priority, jstring tag, jstring msg) {
-  std::string ctag = util::JStringToString(env, tag);
-  std::string cmsg = util::JStringToString(env, msg);
-  static const LogLevel kLogPriorityToLogLevel[] = {
-      kLogLevelDebug,    // 0 = undocumented
-      kLogLevelDebug,    // 1 = undocumented
-      kLogLevelVerbose,  // 2 = android.util.Log.VERBOSE
-      kLogLevelDebug,    // 3 = android.util.Log.DEBUG
-      kLogLevelInfo,     // 4 = android.util.Log.INFO
-      kLogLevelWarning,  // 5 = android.util.Log.WARN
-      kLogLevelError,    // 6 = android.util.Log.ERROR
-      kLogLevelAssert,   // 7 = android.util.Log.ASSERT
-  };
-  assert(priority <
-         sizeof(kLogPriorityToLogLevel) / sizeof(kLogPriorityToLogLevel[0]));
-  assert(priority >= 0);
-  LogMessage(kLogPriorityToLogLevel[priority], "(%s) %s", ctag.c_str(),
-             cmsg.c_str());
-}
-
 // NOLINTNEXTLINE - allow namespace overridden
 }  // namespace FIREBASE_NAMESPACE

app/src/log_android_callback.cc

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <assert.h>
+#include <jni.h>
+
+#include <string>
+
+#include "app/src/log.h"
+#include "app/src/util_android.h"
+
+namespace firebase {
+
+// Called from com.google.firebase.app.internal.cpp.Log.
+extern "C" JNIEXPORT void JNICALL
+Java_com_google_firebase_app_internal_cpp_Log_nativeLog(
+    JNIEnv* env, jobject instance, jint priority, jstring tag, jstring msg) {
+  std::string ctag = util::JStringToString(env, tag);
+  std::string cmsg = util::JStringToString(env, msg);
+  static const LogLevel kLogPriorityToLogLevel[] = {
+      kLogLevelDebug,    // 0 = undocumented
+      kLogLevelDebug,    // 1 = undocumented
+      kLogLevelVerbose,  // 2 = android.util.Log.VERBOSE
+      kLogLevelDebug,    // 3 = android.util.Log.DEBUG
+      kLogLevelInfo,     // 4 = android.util.Log.INFO
+      kLogLevelWarning,  // 5 = android.util.Log.WARN
+      kLogLevelError,    // 6 = android.util.Log.ERROR
+      kLogLevelAssert,   // 7 = android.util.Log.ASSERT
+  };
+  assert(priority <
+         sizeof(kLogPriorityToLogLevel) / sizeof(kLogPriorityToLogLevel[0]));
+  assert(priority >= 0);
+  LogMessage(kLogPriorityToLogLevel[priority], "(%s) %s", ctag.c_str(),
+             cmsg.c_str());
+}
+
+}  // namespace firebase

app/src/reference_counted_future_impl.h

@@ -22,14 +22,19 @@
 #include <vector>
 
 #include "app/src/cleanup_notifier.h"
-#include "app/src/include/firebase/future.h"
 #include "app/src/include/firebase/internal/common.h"
 #include "app/src/mutex.h"
 
 #if !defined(FIREBASE_NAMESPACE)
 #define FIREBASE_NAMESPACE firebase
 #endif
 
+#ifdef USE_PLAYBILLING_FUTURE
+#include "playbillingclient/future.h"
+#else
+#include "app/src/include/firebase/future.h"
+#endif
+
 namespace FIREBASE_NAMESPACE {
 
 // Predeclarations.

cmake/future_lib.cmake

@@ -0,0 +1,84 @@
+# Copyright 2019 Google
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set(FUTURE_LIB_SRC_DIR ${CMAKE_CURRENT_LIST_DIR} CACHE INTERNAL "")
+
+# Defines a Future library for the given namespace
+function(define_future_lib CPP_NAMESPACE)
+  set(library_name "${CPP_NAMESPACE}_future")
+
+  # Modify the public Future header with the new namespace
+  file(READ
+       ${FUTURE_LIB_SRC_DIR}/../app/src/include/firebase/future.h
+       old_future_header)
+  string(TOUPPER ${CPP_NAMESPACE} upper_namespace)
+  set(new_header_guard "FUTURE_INCLUDE_${upper_namespace}_FUTURE_H_")
+  string(REPLACE
+         FIREBASE_APP_CLIENT_CPP_SRC_INCLUDE_FIREBASE_FUTURE_H_
+         ${new_header_guard}
+         future_header_guard_changed
+         "${old_future_header}")
+  string(REPLACE
+         "namespace FIREBASE_NAMESPACE {"
+         "namespace ${CPP_NAMESPACE} {"
+         future_header_namespace_changed
+         "${future_header_guard_changed}")
+  file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/future_include/${CPP_NAMESPACE})
+  set(generated_future_header_path
+      "${PROJECT_BINARY_DIR}/future_include/${CPP_NAMESPACE}/future.h")
+  #TODO Change to use a configure_file, will need to change future.h, and the
+  # Firebase library to use it as well.
+  file(WRITE
+       ${generated_future_header_path}
+       "${future_header_namespace_changed}")
+
+  if(ANDROID OR DEFINED ANDROID_NDK)
+    set(log_SRCS
+        ${FUTURE_LIB_SRC_DIR}/../app/src/log.cc
+        ${FUTURE_LIB_SRC_DIR}/../app/src/log_android.cc)
+  elseif(IOS OR "${CMAKE_OSX_SYSROOT}" MATCHES "iphoneos")
+    set(log_SRCS
+        ${FUTURE_LIB_SRC_DIR}/../app/src/log.cc
+        ${FUTURE_LIB_SRC_DIR}/../app/src/log_ios.mm)
+  else()
+    set(log_SRCS
+        ${FUTURE_LIB_SRC_DIR}/../app/src/log.cc
+        ${FUTURE_LIB_SRC_DIR}/../app/src/log_stdio.cc)
+  endif()
+
+  add_library("${library_name}" STATIC
+      ${FUTURE_LIB_SRC_DIR}/../app/src/cleanup_notifier.cc
+      ${FUTURE_LIB_SRC_DIR}/../app/src/future_manager.cc
+      ${FUTURE_LIB_SRC_DIR}/../app/src/reference_counted_future_impl.cc
+      ${generated_future_header_path}
+      ${log_SRCS})
+
+  target_compile_definitions("${library_name}"
+    PRIVATE
+      -DFIREBASE_NAMESPACE=${CPP_NAMESPACE}
+  )
+  if("${CPP_NAMESPACE}" STREQUAL "playbillingclient")
+    target_compile_definitions("${library_name}"
+      PRIVATE
+        -DUSE_PLAYBILLING_FUTURE=1
+    )
+  endif()
+  target_include_directories("${library_name}"
+    PUBLIC
+      ${PROJECT_BINARY_DIR}/future_include
+    PRIVATE
+      ${FUTURE_LIB_SRC_DIR}/..
+      ${FUTURE_LIB_SRC_DIR}/../app/src/include
+  )
+endfunction()