message_pump_android.cc revision eb525c5499e34cc9c4b825d6d9e75bb07cc06ace
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file.
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
57d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)#include "base/message_loop/message_pump_android.h"
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <jni.h>
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/android/jni_android.h"
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/android/scoped_java_ref.h"
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/lazy_instance.h"
125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h"
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/run_loop.h"
14eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/time/time.h"
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "jni/SystemMessageHandler_jni.h"
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)using base::android::ScopedJavaLocalRef;
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ----------------------------------------------------------------------------
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Native JNI methods called by Java.
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ----------------------------------------------------------------------------
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This method can not move to anonymous namespace as it has been declared as
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 'static' in system_message_handler_jni.h.
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static jboolean DoRunLoopOnce(JNIEnv* env, jobject obj, jint native_delegate) {
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  base::MessagePump::Delegate* delegate =
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      reinterpret_cast<base::MessagePump::Delegate*>(native_delegate);
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(delegate);
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // This is based on MessagePumpForUI::DoRunLoop() from desktop.
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Note however that our system queue is handled in the java side.
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // In desktop we inspect and process a single system message and then
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // we call DoWork() / DoDelayedWork().
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // On Android, the java message queue may contain messages for other handlers
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // that will be processed before calling here again.
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  bool more_work_is_plausible = delegate->DoWork();
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // This is the time when we need to do delayed work.
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  base::TimeTicks delayed_work_time;
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  more_work_is_plausible |= delegate->DoDelayedWork(&delayed_work_time);
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // This is a major difference between android and other platforms: since we
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // can't inspect it and process just one single message, instead we'll yeld
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // the callstack, and post a message to call us back soon.
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (more_work_is_plausible)
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return true;
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  more_work_is_plausible = delegate->DoIdleWork();
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!more_work_is_plausible && !delayed_work_time.is_null()) {
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // We only set the timer here as returning true would post a message.
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    jlong millis =
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)        (delayed_work_time - base::TimeTicks::Now()).InMillisecondsRoundedUp();
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    Java_SystemMessageHandler_setDelayedTimer(env, obj, millis);
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return more_work_is_plausible;
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base {
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)MessagePumpForUI::MessagePumpForUI()
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    : run_loop_(NULL) {
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)MessagePumpForUI::~MessagePumpForUI() {
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::Run(Delegate* delegate) {
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  NOTREACHED() << "UnitTests should rely on MessagePumpForUIStub in"
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      " test_stub_android.h";
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::Start(Delegate* delegate) {
717d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)  run_loop_ = new RunLoop();
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Since the RunLoop was just created above, BeforeRun should be guaranteed to
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // return true (it only returns false if the RunLoop has been Quit already).
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!run_loop_->BeforeRun())
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    NOTREACHED();
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
77eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  DCHECK(system_message_handler_obj_.is_null());
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  JNIEnv* env = base::android::AttachCurrentThread();
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(env);
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
82eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  system_message_handler_obj_.Reset(
835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      Java_SystemMessageHandler_create(env, reinterpret_cast<jint>(delegate)));
845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::Quit() {
87eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  if (!system_message_handler_obj_.is_null()) {
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    JNIEnv* env = base::android::AttachCurrentThread();
895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    DCHECK(env);
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    Java_SystemMessageHandler_removeTimer(env,
92eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch        system_message_handler_obj_.obj());
93eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    system_message_handler_obj_.Reset();
945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (run_loop_) {
975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    run_loop_->AfterRun();
985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    delete run_loop_;
995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    run_loop_ = NULL;
1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::ScheduleWork() {
104eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  DCHECK(!system_message_handler_obj_.is_null());
1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  JNIEnv* env = base::android::AttachCurrentThread();
1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(env);
1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Java_SystemMessageHandler_setTimer(env,
110eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch      system_message_handler_obj_.obj());
1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::ScheduleDelayedWork(const TimeTicks& delayed_work_time) {
114eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  DCHECK(!system_message_handler_obj_.is_null());
1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  JNIEnv* env = base::android::AttachCurrentThread();
1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(env);
1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  jlong millis =
1207d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)      (delayed_work_time - TimeTicks::Now()).InMillisecondsRoundedUp();
1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Note that we're truncating to milliseconds as required by the java side,
1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // even though delayed_work_time is microseconds resolution.
1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Java_SystemMessageHandler_setDelayedTimer(env,
124eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch      system_message_handler_obj_.obj(), millis);
1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static
1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool MessagePumpForUI::RegisterBindings(JNIEnv* env) {
1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return RegisterNativesImpl(env);
1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace base
133