1 # This file is part of NIT (http://www.nitlanguage.org).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Some documentation of this module has been adapted from the
16 # Android Open Source Project.
18 # Core implementation of `app.nit` on Android using a custom Java entry point
20 # This module is implemented in 3 languages:
22 # * The Java code, in `NitActivity.java` acts as the entry point registered
23 # to the Android OS. It relays most of the Android callbacks to C.
24 # In theory, there may be more than one instance of `NitActivity` alive at
25 # a given time. They hold a reference to the corresponding Nit `Activity`
26 # in the attribute `nitActivity`.
28 # * The C code is defined in the top part of this source file. It acts as a
29 # glue between Java and Nit by relaying calls between both languages.
30 # It keeps a global variables reference to the Java VM and the Nit `App`.
32 # * The Nit code defines the `Activity` class with the callbacks from Android.
33 # The callback methods should be redefined by user modules.
35 # The main is invoked when the native library is dynamically linked by
36 # the Java virtual machine. For this reason, the main _must_ execute quickly,
37 # on the main UI thread at least.
38 module nit_activity
is
39 extra_java_files
"NitActivity.java"
40 android_activity
"nit.app.NitActivity"
53 #include <android/log.h>
55 // Nit's App running instance
58 // Java VM that launched this program
61 // JNI callback on loading this program
62 jint JNI_OnLoad(JavaVM *vm, void *reserved) {
63 // Set aside the Java VM
66 // Invoke Nit system and main
69 return JNI_VERSION_1_2;
73 * Implementations of NitActivity.java native methods
76 JNIEXPORT jint JNICALL Java_nit_app_NitActivity_nitRegisterActivity
77 (JNIEnv *env, jobject java_activity)
79 Activity nit_activity = App_register_activity(global_app, java_activity);
80 Activity_incr_ref(nit_activity);
81 return (jint)(void*)nit_activity;
84 JNIEXPORT void JNICALL Java_nit_app_NitActivity_nitOnCreate
85 (JNIEnv *env, jobject java_activity, jint nit_activity, jobject saved_state)
87 Activity_on_create((Activity)nit_activity, saved_state);
90 JNIEXPORT void JNICALL Java_nit_app_NitActivity_nitOnStart
91 (JNIEnv *env, jobject java_activity, jint nit_activity)
93 Activity_on_start((Activity)nit_activity);
96 JNIEXPORT void JNICALL Java_nit_app_NitActivity_nitOnRestart
97 (JNIEnv *env, jobject java_activity, jint nit_activity)
99 Activity_on_restart((Activity)nit_activity);
102 JNIEXPORT void JNICALL Java_nit_app_NitActivity_nitOnResume
103 (JNIEnv *env, jobject java_activity, jint nit_activity)
105 Activity_on_resume((Activity)nit_activity);
108 JNIEXPORT void JNICALL Java_nit_app_NitActivity_nitOnPause
109 (JNIEnv *env, jobject java_activity, jint nit_activity)
111 Activity_on_pause((Activity)nit_activity);
114 JNIEXPORT void JNICALL Java_nit_app_NitActivity_nitOnStop
115 (JNIEnv *env, jobject java_activity, jint nit_activity)
117 Activity_on_stop((Activity)nit_activity);
120 JNIEXPORT void JNICALL Java_nit_app_NitActivity_nitOnDestroy
121 (JNIEnv *env, jobject java_activity, jint nit_activity)
123 Activity_on_destroy((Activity)nit_activity);
126 JNIEXPORT void JNICALL Java_nit_app_NitActivity_nitOnSaveInstanceState
127 (JNIEnv *env, jobject java_activity, jint nit_activity, jobject saved_state)
129 Activity_on_save_instance_state((Activity)nit_activity, saved_state);
132 JNIEXPORT void JNICALL Java_nit_app_NitActivity_nitOnRestoreInstanceState
133 (JNIEnv *env, jobject java_activity, jint nit_activity, jobject saved_state)
135 Activity_on_restore_instance_state((Activity)nit_activity, saved_state);
138 JNIEXPORT jboolean JNICALL Java_nit_app_NitActivity_nitOnBackPressed
139 (JNIEnv *env, jobject java_activity, jint nit_activity)
141 return (jboolean)Activity_on_back_pressed((Activity)nit_activity);
144 JNIEXPORT jboolean JNICALL Java_nit_app_NitActivity_nitOnKeyDown
145 (JNIEnv *env, jobject java_activity, jint nit_activity, jint keyCode, jobject event)
147 return (jboolean)Activity_on_key_down((Activity)nit_activity, keyCode, event);
150 JNIEXPORT jboolean JNICALL Java_nit_app_NitActivity_nitOnKeyLongPress
151 (JNIEnv *env, jobject java_activity, jint nit_activity, jint keyCode, jobject event)
153 return (jboolean)Activity_on_key_long_press((Activity)nit_activity, keyCode, event);
156 JNIEXPORT jboolean JNICALL Java_nit_app_NitActivity_nitOnKeyMultiple
157 (JNIEnv *env, jobject java_activity, jint nit_activity, jint keyCode, jint count, jobject event)
159 return (jboolean)Activity_on_key_multiple((Activity)nit_activity, keyCode, count, event);
162 JNIEXPORT jboolean JNICALL Java_nit_app_NitActivity_nitOnKeyUp
163 (JNIEnv *env, jobject java_activity, jint nit_activity, jint keyCode, jobject event)
165 return (jboolean)Activity_on_key_up((Activity)nit_activity, keyCode, event);
169 # Wrapper to our Java `NitActivity`
170 extern class NativeNitActivity in "Java" `{ nit.app.NitActivity `}
175 redef fun jvm `{ return global_jvm; `}
180 var activities
= new Array[Activity]
182 # The main Java Activity of this application
183 redef fun native_activity
do return activities
.first
.native
185 redef fun setup
do set_global_app
188 private fun set_global_app
import register_activity
,
189 Activity.on_create
, Activity.on_destroy
,
190 Activity.on_start
, Activity.on_restart
, Activity.on_stop
,
191 Activity.on_pause
, Activity.on_resume
,
192 Activity.on_save_instance_state
, Activity.on_restore_instance_state
,
193 Activity.on_back_pressed
,
194 Activity.on_key_down
, Activity.on_key_long_press
,
195 Activity.on_key_multiple
, Activity.on_key_up
`{
200 # Create the Nit side to this new `native` Java activity, and return it to Java
201 private fun register_activity
(native
: NativeNitActivity): Activity
203 native
= native
.new_global_ref
204 var activity
= new Activity(native
)
205 activities
.add activity
210 # An Android activity
212 # You must implement the callbacks (prefixed with `on_`) to follow the
213 # standard Android life-cycle.
215 # Native Java activity
216 var native
: NativeActivity
218 # Notification from Android, the activity is created
220 # Do your normal static set up here.
222 # If available, `save_state` contains the activity's previous state
223 # as registered by `on_save_instance_state`.
225 # Followed by `on_start`.
226 fun on_create
(save_state
: NativeBundle)
232 # Notification from Android, the activity has been restarted
234 # Followed by `on_start`.
235 fun on_restart
do end
237 # Notification from Android, the activity has been started
239 # Followed by `on_resume` or `on_stop`.
240 fun on_start
do app
.on_start
242 # Notification from Android, the activity has been resumed
244 # Followed by `on_pause`
245 fun on_resume
do app
.on_resume
247 # Notification from Android, the activity has been paused
249 # Followed by `on_resume` or `on_stop`.
250 fun on_pause
do app
.on_pause
252 # Notification from Android, the activity has been stopped
254 # Followed by `on_restart` or `on_destroy`.
255 fun on_stop
do app
.on_stop
257 # Notification from Android, the activity is being destroyed
264 native
.delete_global_ref
265 app
.activities
.remove
self
268 # Notification from Android, the activity is being re-initialized from a `save_state`
270 # Occurs after `on_start`.
271 fun on_restore_instance_state
(save_state
: NativeBundle) do end
273 # Notification from Android, the activity may be stopped, save state
275 # Occurs before `on_stop` and, without guarantee, before or after `on_pause`.
276 fun on_save_instance_state
(save_state
: NativeBundle) do app
.on_save_state
278 # Notification from Android, the system is running low on memory
280 # Try to reduce your memory use.
281 fun on_low_memory
do end
283 # Notification from Android, the current window of the activity has lost or gained focus
284 fun on_window_focus_changed
(has_focus
: Bool) do end
286 # Notification from Android, the current device configuration has changed
287 fun on_configuration_changed
do end
289 # The back key has been pressed
291 # Return `true` if the event has been handled.
292 fun on_back_pressed
: Bool do return false
294 # A key has been pressed
296 # Return `true` if the event has been handled.
297 fun on_key_down
(key_code
: Int, event
: NativeKeyEvent): Bool do return false
299 # A key has been long pressed
301 # Return `true` if the event has been handled.
302 fun on_key_long_press
(key_code
: Int, event
: NativeKeyEvent): Bool do return false
304 # Multiple down/up pairs of the same key have occurred in a row
306 # Return `true` if the event has been handled.
307 fun on_key_multiple
(key_code
, count
: Int, event
: NativeKeyEvent): Bool do return false
309 # A key has been released
311 # Return `true` if the event has been handled.
312 fun on_key_up
(key_code
: Int, event
: NativeKeyEvent): Bool do return false
315 # Set up global data in C and leave it to Android to callback Java, which we relay to Nit