The Tor Browser: widget/android/AndroidBridge.h@b8a032363ba2 (annotated)

widget/android/AndroidBridge.h@b8a032363ba2 (annotated)

widget/android/AndroidBridge.h

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* -*- Mode: c++; c-basic-offset: 4; tab-width: 20; indent-tabs-mode: nil; -*-
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 #ifndef AndroidBridge_h__
 #define AndroidBridge_h__
 #include <jni.h>
 #include <android/log.h>
 #include <cstdlib>
 #include <pthread.h>
 #include "nsCOMPtr.h"
 #include "nsCOMArray.h"
 #include "GeneratedJNIWrappers.h"
 #include "nsIMutableArray.h"
 #include "nsIMIMEInfo.h"
 #include "nsColor.h"
 #include "gfxRect.h"
 #include "nsIAndroidBridge.h"
 #include "nsIMobileMessageCallback.h"
 #include "mozilla/Likely.h"
 #include "mozilla/StaticPtr.h"
 #include "mozilla/layers/GeckoContentController.h"
 #include "mozilla/TimeStamp.h"
 // Some debug #defines
 // #define DEBUG_ANDROID_EVENTS
 // #define DEBUG_ANDROID_WIDGET
 class nsWindow;
 class nsIDOMMozSmsMessage;
 class nsIObserver;
 /* See the comment in AndroidBridge about this function before using it */
 extern "C" JNIEnv * GetJNIForThread();
 extern bool mozilla_AndroidBridge_SetMainThread(pthread_t);
 namespace base {
 class Thread;
 } // end namespace base
 typedef void* EGLSurface;
 namespace mozilla {
 namespace hal {
 class BatteryInformation;
 class NetworkInformation;
 } // namespace hal
 namespace dom {
 namespace mobilemessage {
 struct SmsFilterData;
 struct SmsSegmentInfoData;
 } // namespace mobilemessage
 } // namespace dom
 namespace layers {
 class CompositorParent;
 } // namespace layers
 // The order and number of the members in this structure must correspond
 // to the attrsAppearance array in GeckoAppShell.getSystemColors()
 typedef struct AndroidSystemColors {
     nscolor textColorPrimary;
     nscolor textColorPrimaryInverse;
     nscolor textColorSecondary;
     nscolor textColorSecondaryInverse;
     nscolor textColorTertiary;
     nscolor textColorTertiaryInverse;
     nscolor textColorHighlight;
     nscolor colorForeground;
     nscolor colorBackground;
     nscolor panelColorForeground;
     nscolor panelColorBackground;
 } AndroidSystemColors;
 class nsFilePickerCallback : nsISupports {
 public:
     NS_DECL_THREADSAFE_ISUPPORTS
     virtual void handleResult(nsAString& filePath) = 0;
     nsFilePickerCallback() {}
 protected:
     virtual ~nsFilePickerCallback() {}
 };
 class DelayedTask {
 public:
     DelayedTask(Task* aTask, int aDelayMs) {
         mTask = aTask;
         mRunTime = TimeStamp::Now() + TimeDuration::FromMilliseconds(aDelayMs);
     }
     bool IsEarlierThan(DelayedTask *aOther) {
         return mRunTime < aOther->mRunTime;
     }
     int64_t MillisecondsToRunTime() {
         TimeDuration timeLeft = mRunTime - TimeStamp::Now();
         return (int64_t)timeLeft.ToMilliseconds();
     }
     Task* GetTask() {
         return mTask;
     }
 private:
     Task* mTask;
     TimeStamp mRunTime;
 };
 class AndroidBridge MOZ_FINAL : public mozilla::layers::GeckoContentController
 {
 public:
     enum {
         // Values for NotifyIME, in addition to values from the Gecko
         // IMEMessage enum; use negative values here to prevent conflict
         NOTIFY_IME_OPEN_VKB = -2,
         NOTIFY_IME_REPLY_EVENT = -1,
     };
     enum {
         LAYER_CLIENT_TYPE_NONE = 0,
         LAYER_CLIENT_TYPE_GL = 2            // AndroidGeckoGLLayerClient
     };
     static void ConstructBridge(JNIEnv *jEnv);
     static AndroidBridge *Bridge() {
         return sBridge.get();
     }
     static JavaVM *GetVM() {
         MOZ_ASSERT(sBridge);
         return sBridge->mJavaVM;
     }
     static JNIEnv *GetJNIEnv() {
         MOZ_ASSERT(sBridge);
         if (MOZ_UNLIKELY(!pthread_equal(pthread_self(), sBridge->mThread))) {
             MOZ_CRASH();
         }
         MOZ_ASSERT(sBridge->mJNIEnv);
         return sBridge->mJNIEnv;
     }
     static bool HasEnv() {
         return sBridge && sBridge->mJNIEnv;
     }
     static bool ThrowException(JNIEnv *aEnv, const char *aClass,
                                const char *aMessage) {
         MOZ_ASSERT(aEnv, "Invalid thread JNI env");
         jclass cls = aEnv->FindClass(aClass);
         MOZ_ASSERT(cls, "Cannot find exception class");
         bool ret = !aEnv->ThrowNew(cls, aMessage);
         aEnv->DeleteLocalRef(cls);
         return ret;
     }
     static bool ThrowException(JNIEnv *aEnv, const char *aMessage) {
         return ThrowException(aEnv, "java/lang/Exception", aMessage);
     }
     static void HandleUncaughtException(JNIEnv *aEnv) {
         MOZ_ASSERT(aEnv);
         if (!aEnv->ExceptionCheck()) {
             return;
         }
         jthrowable e = aEnv->ExceptionOccurred();
         MOZ_ASSERT(e);
         aEnv->ExceptionClear();
         mozilla::widget::android::GeckoAppShell::HandleUncaughtException(nullptr, e);
         // Should be dead by now...
         MOZ_CRASH("Failed to handle uncaught exception");
     }
     // The bridge needs to be constructed via ConstructBridge first,
     // and then once the Gecko main thread is spun up (Gecko side),
     // SetMainThread should be called which will create the JNIEnv for
     // us to use.  toolkit/xre/nsAndroidStartup.cpp calls
     // SetMainThread.
     bool SetMainThread(pthread_t thr);
     /* These are all implemented in Java */
     bool GetThreadNameJavaProfiling(uint32_t aThreadId, nsCString & aResult);
     bool GetFrameNameJavaProfiling(uint32_t aThreadId, uint32_t aSampleId, uint32_t aFrameId, nsCString & aResult);
     nsresult CaptureThumbnail(nsIDOMWindow *window, int32_t bufW, int32_t bufH, int32_t tabId, jobject buffer);
     void GetDisplayPort(bool aPageSizeUpdate, bool aIsBrowserContentDisplayed, int32_t tabId, nsIAndroidViewport* metrics, nsIAndroidDisplayport** displayPort);
     void ContentDocumentChanged();
     bool IsContentDocumentDisplayed();
     bool ProgressiveUpdateCallback(bool aHasPendingNewThebesContent, const LayerRect& aDisplayPort, float aDisplayResolution, bool aDrawingCritical, mozilla::ParentLayerRect& aCompositionBounds, mozilla::CSSToParentLayerScale& aZoom);
     void SetLayerClient(JNIEnv* env, jobject jobj);
     mozilla::widget::android::GeckoLayerClient* GetLayerClient() { return mLayerClient; }
     bool GetHandlersForURL(const nsAString& aURL,
                            nsIMutableArray* handlersArray = nullptr,
                            nsIHandlerApp **aDefaultApp = nullptr,
                            const nsAString& aAction = EmptyString());
     bool GetHandlersForMimeType(const nsAString& aMimeType,
                                 nsIMutableArray* handlersArray = nullptr,
                                 nsIHandlerApp **aDefaultApp = nullptr,
                                 const nsAString& aAction = EmptyString());
     void GetMimeTypeFromExtensions(const nsACString& aFileExt, nsCString& aMimeType);
     void GetExtensionFromMimeType(const nsACString& aMimeType, nsACString& aFileExt);
     bool GetClipboardText(nsAString& aText);
     void ShowAlertNotification(const nsAString& aImageUrl,
                                const nsAString& aAlertTitle,
                                const nsAString& aAlertText,
                                const nsAString& aAlertData,
                                nsIObserver *aAlertListener,
                                const nsAString& aAlertName);
     int GetDPI();
     int GetScreenDepth();
     void ShowFilePickerForExtensions(nsAString& aFilePath, const nsAString& aExtensions);
     void ShowFilePickerForMimeType(nsAString& aFilePath, const nsAString& aMimeType);
     void ShowFilePickerAsync(const nsAString& aMimeType, nsFilePickerCallback* callback);
     void Vibrate(const nsTArray<uint32_t>& aPattern);
     void GetSystemColors(AndroidSystemColors *aColors);
     void GetIconForExtension(const nsACString& aFileExt, uint32_t aIconSize, uint8_t * const aBuf);
     // Switch Java to composite with the Gecko Compositor thread
     void RegisterCompositor(JNIEnv* env = nullptr);
     EGLSurface CreateEGLSurfaceForCompositor();
     bool GetStaticStringField(const char *classID, const char *field, nsAString &result, JNIEnv* env = nullptr);
     bool GetStaticIntField(const char *className, const char *fieldName, int32_t* aInt, JNIEnv* env = nullptr);
     // These next four functions are for native Bitmap access in Android 2.2+
     bool HasNativeBitmapAccess();
     bool ValidateBitmap(jobject bitmap, int width, int height);
     void *LockBitmap(jobject bitmap);
     // Returns a global reference to the Context for Fennec's Activity. The
     // caller is responsible for ensuring this doesn't leak by calling
     // DeleteGlobalRef() when the context is no longer needed.
     jobject GetGlobalContextRef(void);
     void UnlockBitmap(jobject bitmap);
     /* Copied from Android's native_window.h in newer (platform 9) NDK */
     enum {
         WINDOW_FORMAT_RGBA_8888          = 1,
         WINDOW_FORMAT_RGBX_8888          = 2,
         WINDOW_FORMAT_RGB_565            = 4
     };
     bool HasNativeWindowAccess();
     void *AcquireNativeWindow(JNIEnv* aEnv, jobject aSurface);
     void ReleaseNativeWindow(void *window);
     void *AcquireNativeWindowFromSurfaceTexture(JNIEnv* aEnv, jobject aSurface);
     void ReleaseNativeWindowForSurfaceTexture(void *window);
     bool LockWindow(void *window, unsigned char **bits, int *width, int *height, int *format, int *stride);
     bool UnlockWindow(void *window);
     void HandleGeckoMessage(JSContext* cx, JS::HandleObject message);
     bool InitCamera(const nsCString& contentType, uint32_t camera, uint32_t *width, uint32_t *height, uint32_t *fps);
     void GetCurrentBatteryInformation(hal::BatteryInformation* aBatteryInfo);
     nsresult GetSegmentInfoForText(const nsAString& aText,
                                    nsIMobileMessageCallback* aRequest);
     void SendMessage(const nsAString& aNumber, const nsAString& aText,
                      nsIMobileMessageCallback* aRequest);
     void GetMessage(int32_t aMessageId, nsIMobileMessageCallback* aRequest);
     void DeleteMessage(int32_t aMessageId, nsIMobileMessageCallback* aRequest);
     void CreateMessageList(const dom::mobilemessage::SmsFilterData& aFilter,
                            bool aReverse, nsIMobileMessageCallback* aRequest);
     void GetNextMessageInList(int32_t aListId, nsIMobileMessageCallback* aRequest);
     already_AddRefed<nsIMobileMessageCallback> DequeueSmsRequest(uint32_t aRequestId);
     void GetCurrentNetworkInformation(hal::NetworkInformation* aNetworkInfo);
     void SetFirstPaintViewport(const LayerIntPoint& aOffset, const CSSToLayerScale& aZoom, const CSSRect& aCssPageRect);
     void SetPageRect(const CSSRect& aCssPageRect);
     void SyncViewportInfo(const LayerIntRect& aDisplayPort, const CSSToLayerScale& aDisplayResolution,
                           bool aLayersUpdated, ScreenPoint& aScrollOffset, CSSToScreenScale& aScale,
                           LayerMargin& aFixedLayerMargins, ScreenPoint& aOffset);
     void SyncFrameMetrics(const ScreenPoint& aScrollOffset, float aZoom, const CSSRect& aCssPageRect,
                           bool aLayersUpdated, const CSSRect& aDisplayPort, const CSSToLayerScale& aDisplayResolution,
                           bool aIsFirstPaint, LayerMargin& aFixedLayerMargins, ScreenPoint& aOffset);
     void AddPluginView(jobject view, const LayoutDeviceRect& rect, bool isFullScreen);
     // These methods don't use a ScreenOrientation because it's an
     // enum and that would require including the header which requires
     // include IPC headers which requires including basictypes.h which
     // requires a lot of changes...
     uint32_t GetScreenOrientation();
     int GetAPIVersion() { return mAPIVersion; }
     bool IsHoneycomb() { return mAPIVersion >= 11 && mAPIVersion <= 13; }
     void ScheduleComposite();
     nsresult GetProxyForURI(const nsACString & aSpec,
                             const nsACString & aScheme,
                             const nsACString & aHost,
                             const int32_t      aPort,
                             nsACString & aResult);
     // Utility methods.
     static jstring NewJavaString(JNIEnv* env, const char16_t* string, uint32_t len);
     static jstring NewJavaString(JNIEnv* env, const nsAString& string);
     static jstring NewJavaString(JNIEnv* env, const char* string);
     static jstring NewJavaString(JNIEnv* env, const nsACString& string);
     static jstring NewJavaString(AutoLocalJNIFrame* frame, const char16_t* string, uint32_t len);
     static jstring NewJavaString(AutoLocalJNIFrame* frame, const nsAString& string);
     static jstring NewJavaString(AutoLocalJNIFrame* frame, const char* string);
     static jstring NewJavaString(AutoLocalJNIFrame* frame, const nsACString& string);
     static jclass GetClassGlobalRef(JNIEnv* env, const char* className);
     static jfieldID GetFieldID(JNIEnv* env, jclass jClass, const char* fieldName, const char* fieldType);
     static jfieldID GetStaticFieldID(JNIEnv* env, jclass jClass, const char* fieldName, const char* fieldType);
     static jmethodID GetMethodID(JNIEnv* env, jclass jClass, const char* methodName, const char* methodType);
     static jmethodID GetStaticMethodID(JNIEnv* env, jclass jClass, const char* methodName, const char* methodType);
 protected:
     static StaticRefPtr<AndroidBridge> sBridge;
     nsTArray<nsCOMPtr<nsIMobileMessageCallback> > mSmsRequests;
     // the global JavaVM
     JavaVM *mJavaVM;
     // the JNIEnv for the main thread
     JNIEnv *mJNIEnv;
     pthread_t mThread;
     mozilla::widget::android::GeckoLayerClient *mLayerClient;
     // the android.telephony.SmsMessage class
     jclass mAndroidSmsMessageClass;
     AndroidBridge();
     ~AndroidBridge();
     void InitStubs(JNIEnv *jEnv);
     bool Init(JNIEnv *jEnv);
     bool mOpenedGraphicsLibraries;
     void OpenGraphicsLibraries();
     void* GetNativeSurface(JNIEnv* env, jobject surface);
     bool mHasNativeBitmapAccess;
     bool mHasNativeWindowAccess;
     bool mHasNativeWindowFallback;
     int mAPIVersion;
     bool QueueSmsRequest(nsIMobileMessageCallback* aRequest, uint32_t* aRequestIdOut);
     // other things
     jmethodID jNotifyAppShellReady;
     jmethodID jGetOutstandingDrawEvents;
     jmethodID jPostToJavaThread;
     jmethodID jCreateSurface;
     jmethodID jShowSurface;
     jmethodID jHideSurface;
     jmethodID jDestroySurface;
     jmethodID jCalculateLength;
     // For native surface stuff
     jclass jSurfaceClass;
     jfieldID jSurfacePointerField;
     jclass jLayerView;
     jfieldID jEGLSurfacePointerField;
     mozilla::widget::android::GLController *mGLControllerObj;
     // some convinient types to have around
     jclass jStringClass;
     // calls we've dlopened from libjnigraphics.so
     int (* AndroidBitmap_getInfo)(JNIEnv *env, jobject bitmap, void *info);
     int (* AndroidBitmap_lockPixels)(JNIEnv *env, jobject bitmap, void **buffer);
     int (* AndroidBitmap_unlockPixels)(JNIEnv *env, jobject bitmap);
     void* (*ANativeWindow_fromSurface)(JNIEnv *env, jobject surface);
     void* (*ANativeWindow_fromSurfaceTexture)(JNIEnv *env, jobject surfaceTexture);
     void (*ANativeWindow_release)(void *window);
     int (*ANativeWindow_setBuffersGeometry)(void *window, int width, int height, int format);
     int (* ANativeWindow_lock)(void *window, void *outBuffer, void *inOutDirtyBounds);
     int (* ANativeWindow_unlockAndPost)(void *window);
     int (* Surface_lock)(void* surface, void* surfaceInfo, void* region, bool block);
     int (* Surface_unlockAndPost)(void* surface);
     void (* Region_constructor)(void* region);
     void (* Region_set)(void* region, void* rect);
 private:
     mozilla::widget::android::NativePanZoomController* mNativePanZoomController;
     // This will always be accessed from one thread (the APZC "controller"
     // thread, which is the Java UI thread), so we don't need to do locking
     // to touch it
     nsTArray<DelayedTask*> mDelayedTaskQueue;
 public:
     mozilla::widget::android::NativePanZoomController* SetNativePanZoomController(jobject obj);
     // GeckoContentController methods
     void RequestContentRepaint(const mozilla::layers::FrameMetrics& aFrameMetrics) MOZ_OVERRIDE;
     void AcknowledgeScrollUpdate(const mozilla::layers::FrameMetrics::ViewID& aScrollId,
                                  const uint32_t& aScrollGeneration) MOZ_OVERRIDE;
     void HandleDoubleTap(const CSSPoint& aPoint,
                          int32_t aModifiers,
                          const mozilla::layers::ScrollableLayerGuid& aGuid) MOZ_OVERRIDE;
     void HandleSingleTap(const CSSPoint& aPoint,
                          int32_t aModifiers,
                          const mozilla::layers::ScrollableLayerGuid& aGuid) MOZ_OVERRIDE;
     void HandleLongTap(const CSSPoint& aPoint,
                        int32_t aModifiers,
                        const mozilla::layers::ScrollableLayerGuid& aGuid) MOZ_OVERRIDE;
     void HandleLongTapUp(const CSSPoint& aPoint,
                          int32_t aModifiers,
                          const mozilla::layers::ScrollableLayerGuid& aGuid) MOZ_OVERRIDE;
     void SendAsyncScrollDOMEvent(bool aIsRoot,
                                  const CSSRect& aContentRect,
                                  const CSSSize& aScrollableSize) MOZ_OVERRIDE;
     void PostDelayedTask(Task* aTask, int aDelayMs) MOZ_OVERRIDE;
     int64_t RunDelayedTasks();
 };
 class AutoJObject {
 public:
     AutoJObject(JNIEnv* aJNIEnv = nullptr) : mObject(nullptr)
     {
         mJNIEnv = aJNIEnv ? aJNIEnv : AndroidBridge::GetJNIEnv();
     }
     AutoJObject(JNIEnv* aJNIEnv, jobject aObject)
     {
         mJNIEnv = aJNIEnv ? aJNIEnv : AndroidBridge::GetJNIEnv();
         mObject = aObject;
     }
     ~AutoJObject() {
         if (mObject)
             mJNIEnv->DeleteLocalRef(mObject);
     }
     jobject operator=(jobject aObject)
     {
         if (mObject) {
             mJNIEnv->DeleteLocalRef(mObject);
         }
         return mObject = aObject;
     }
     operator jobject() {
         return mObject;
     }
 private:
     JNIEnv* mJNIEnv;
     jobject mObject;
 };
 class AutoLocalJNIFrame {
 public:
     AutoLocalJNIFrame(int nEntries = 15)
         : mEntries(nEntries)
         , mJNIEnv(AndroidBridge::GetJNIEnv())
         , mHasFrameBeenPushed(false)
     {
         MOZ_ASSERT(mJNIEnv);
         Push();
     }
     AutoLocalJNIFrame(JNIEnv* aJNIEnv, int nEntries = 15)
         : mEntries(nEntries)
         , mJNIEnv(aJNIEnv ? aJNIEnv : AndroidBridge::GetJNIEnv())
         , mHasFrameBeenPushed(false)
     {
         MOZ_ASSERT(mJNIEnv);
         Push();
     }
     ~AutoLocalJNIFrame() {
         if (mHasFrameBeenPushed) {
             Pop();
         }
     }
     JNIEnv* GetEnv() {
         return mJNIEnv;
     }
     bool CheckForException() {
         if (mJNIEnv->ExceptionCheck()) {
             AndroidBridge::HandleUncaughtException(mJNIEnv);
             return true;
         }
         return false;
     }
     // Note! Calling Purge makes all previous local refs created in
     // the AutoLocalJNIFrame's scope INVALID; be sure that you locked down
     // any local refs that you need to keep around in global refs!
     void Purge() {
         Pop();
         Push();
     }
     template <typename ReturnType = jobject>
     ReturnType Pop(ReturnType aResult = nullptr) {
         MOZ_ASSERT(mHasFrameBeenPushed);
         mHasFrameBeenPushed = false;
         return static_cast<ReturnType>(
             mJNIEnv->PopLocalFrame(static_cast<jobject>(aResult)));
     }
 private:
     void Push() {
         MOZ_ASSERT(!mHasFrameBeenPushed);
         // Make sure there is enough space to store a local ref to the
         // exception.  I am not completely sure this is needed, but does
         // not hurt.
         if (mJNIEnv->PushLocalFrame(mEntries + 1) != 0) {
             CheckForException();
             return;
         }
         mHasFrameBeenPushed = true;
     }
     const int mEntries;
     JNIEnv* const mJNIEnv;
     bool mHasFrameBeenPushed;
 };
 }
 #define NS_ANDROIDBRIDGE_CID \
 { 0x0FE2321D, 0xEBD9, 0x467D, \
     { 0xA7, 0x43, 0x03, 0xA6, 0x8D, 0x40, 0x59, 0x9E } }
 class nsAndroidBridge MOZ_FINAL : public nsIAndroidBridge
 {
 public:
   NS_DECL_ISUPPORTS
   NS_DECL_NSIANDROIDBRIDGE
   nsAndroidBridge();
 private:
   ~nsAndroidBridge();
 protected:
 };
 #endif /* AndroidBridge_h__ */

The Tor Browser / annotate

widget/android/AndroidBridge.h@b8a032363ba2 (annotated)

widget/android/AndroidBridge.h