message_pump_android.cc revision f2477e01787aa58f445919b809d89e252beef54f
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.
24f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)static void DoRunLoopOnce(JNIEnv* env, jobject obj, jlong 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.
347dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  bool did_work = 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;
387dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  did_work |= delegate->DoDelayedWork(&delayed_work_time);
397dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch
407dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  // Always call this if there is a delayed message waiting in the queue
417dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  // since is at most one delayed message in the Java message handler, and this
427dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  // function call may be the result of that message being handled.
437dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  if (!delayed_work_time.is_null()) {
447dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch    Java_SystemMessageHandler_setDelayedTimer(env, obj,
457dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch        (delayed_work_time - base::TimeTicks::Now()).InMillisecondsRoundedUp());
467dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  }
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // This is a major difference between android and other platforms: since we
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // can't inspect it and process just one single message, instead we'll yeld
507dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  // the callstack.
517dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  if (did_work)
527dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch    return;
537dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch
547dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  delegate->DoIdleWork();
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base {
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)MessagePumpForUI::MessagePumpForUI()
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    : run_loop_(NULL) {
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)MessagePumpForUI::~MessagePumpForUI() {
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::Run(Delegate* delegate) {
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  NOTREACHED() << "UnitTests should rely on MessagePumpForUIStub in"
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      " test_stub_android.h";
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::Start(Delegate* delegate) {
727d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)  run_loop_ = new RunLoop();
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Since the RunLoop was just created above, BeforeRun should be guaranteed to
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // return true (it only returns false if the RunLoop has been Quit already).
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!run_loop_->BeforeRun())
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    NOTREACHED();
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
78eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  DCHECK(system_message_handler_obj_.is_null());
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  JNIEnv* env = base::android::AttachCurrentThread();
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(env);
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
83eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  system_message_handler_obj_.Reset(
84f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)      Java_SystemMessageHandler_create(
85f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)          env, reinterpret_cast<intptr_t>(delegate)));
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::Quit() {
89eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  if (!system_message_handler_obj_.is_null()) {
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    JNIEnv* env = base::android::AttachCurrentThread();
915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    DCHECK(env);
925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    Java_SystemMessageHandler_removeTimer(env,
94eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch        system_message_handler_obj_.obj());
95eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    system_message_handler_obj_.Reset();
965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (run_loop_) {
995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    run_loop_->AfterRun();
1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    delete run_loop_;
1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    run_loop_ = NULL;
1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::ScheduleWork() {
106eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  DCHECK(!system_message_handler_obj_.is_null());
1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  JNIEnv* env = base::android::AttachCurrentThread();
1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(env);
1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Java_SystemMessageHandler_setTimer(env,
112eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch      system_message_handler_obj_.obj());
1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void MessagePumpForUI::ScheduleDelayedWork(const TimeTicks& delayed_work_time) {
116eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  DCHECK(!system_message_handler_obj_.is_null());
1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  JNIEnv* env = base::android::AttachCurrentThread();
1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(env);
1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  jlong millis =
1227d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)      (delayed_work_time - TimeTicks::Now()).InMillisecondsRoundedUp();
1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Note that we're truncating to milliseconds as required by the java side,
1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // even though delayed_work_time is microseconds resolution.
1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Java_SystemMessageHandler_setDelayedTimer(env,
126eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch      system_message_handler_obj_.obj(), millis);
1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static
1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool MessagePumpForUI::RegisterBindings(JNIEnv* env) {
1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return RegisterNativesImpl(env);
1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace base
135