1 # This file is part of NIT (http://www.nitlanguage.org).
3 # Copyright 2014 Frédéric Vachon <fredvac@gmail.com>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Services to save/load data using `android.content.SharedPreferences` for the android platform
18 module shared_preferences_api10
22 private import json_serialization
25 import android.content.SharedPreferences;
26 import android.content.Context;
27 import android.app.Activity;
29 import java.util.Iterator;
30 import java.lang.ClassCastException;
31 import java.lang.NullPointerException;
34 extern class NativeSharedPreferences in "Java" `{ android.content.SharedPreferences `}
37 fun contains(key: JavaString): Bool in "Java" `{ return recv.contains(key); `}
38 fun get_all
: HashMap[JavaString, JavaObject] import HashMap[JavaString, JavaObject],
39 HashMap[JavaString, JavaObject].[]= in "Java" `{
40 Map<String, ?> java_map = null;
41 int nit_hashmap = new_HashMap_of_JavaString_JavaObject();
43 java_map = recv.getAll();
44 } catch (NullPointerException e) {
48 for (Map.Entry<String, ?> entry: java_map.entrySet())
49 HashMap_of_JavaString_JavaObject__index_assign(nit_hashmap,
50 entry.getKey(), entry.getValue());
54 fun get_boolean
(key
: JavaString, def_value
: Bool): Bool in "Java" `{
57 return_value = recv.getBoolean(key, def_value);
58 } catch (ClassCastException e) {
64 fun get_float
(key
: JavaString, def_value
: Float): Float in "Java" `{
67 return_value = recv.getFloat(key, (float) def_value);
68 } catch (ClassCastException e) {
74 fun get_int
(key
: JavaString, def_value
: Int): Int in "Java" `{
77 return_value = recv.getInt(key, (int)def_value);
78 } catch (ClassCastException e) {
84 fun get_long
(key
: JavaString, def_value
: Int): Int in "Java" `{
87 return_value = recv.getLong(key, def_value);
88 } catch (ClassCastException e) {
92 return (int) return_value;
94 fun get_string
(key
: JavaString, def_value
: JavaString): JavaString in "Java" `{
95 String return_value = null;
97 return_value = recv.getString(key, def_value);
98 } catch (ClassCastException e) {
106 redef fun new_global_ref
import sys
, Sys.jni_env
`{
107 Sys sys = NativeSharedPreferences_sys(recv);
108 JNIEnv *env = Sys_jni_env(sys);
109 return (*env)->NewGlobalRef(env, recv);
113 extern class NativeSharedPreferencesEditor in "Java" `{ android.content.SharedPreferences$Editor `}
116 fun clear: NativeSharedPreferencesEditor in "Java" `{ return recv.clear(); `}
117 fun commit
: Bool in "Java" `{ return recv.commit(); `}
118 fun put_boolean(key: JavaString, value: Bool ): NativeSharedPreferencesEditor in "Java" `{
119 return recv
.putBoolean
(key
, value
);
121 fun put_float(key: JavaString, value: Float): NativeSharedPreferencesEditor in "Java" `{
122 return recv
.putFloat
(key
, (float
) value
);
124 fun put_int(key: JavaString, value: Int): NativeSharedPreferencesEditor in "Java" `{
125 return recv
.putInt
(key
, (int
)value
);
127 fun put_long(key: JavaString, value: Int): NativeSharedPreferencesEditor in "Java" `{
128 return recv
.putLong
(key
, value
);
130 fun put_string(key: JavaString, value: JavaString): NativeSharedPreferencesEditor in "Java" `{
131 return recv
.putString
(key
, value
);
133 fun remove(key: JavaString): NativeSharedPreferencesEditor in "Java" `{
134 return recv
.remove
(key
);
138 redef fun new_global_ref import sys, Sys.jni_env `{
139 Sys sys
= NativeSharedPreferencesEditor_sys(recv
);
140 JNIEnv *env
= Sys_jni_env(sys
);
141 return (*env
)->NewGlobalRef(env
, recv
);
145 # Provides services to save and load data for the android platform
146 class SharedPreferences
147 protected var context: NativeActivity
148 protected var shared_preferences: NativeSharedPreferences
149 protected var editor: NativeSharedPreferencesEditor
151 # Automatically commits every saving/removing instructions (`true` by default)
152 var auto_commit = true
154 protected init(app: App, file_name: String, mode: Int)
156 self.context = app.native_activity
157 sys.jni_env.push_local_frame(1)
158 setup(file_name.to_java_string, mode)
159 sys.jni_env.pop_local_frame
162 # Restricts file access to the current application
163 init privately(app: App, file_name: String)
165 self.init(app, file_name, private_mode)
169 private fun private_mode: Int in "Java" `{ return Context.MODE_PRIVATE; `}
171 private fun set_vars
(shared_pref
: NativeSharedPreferences, editor
: NativeSharedPreferencesEditor)
173 self.shared_preferences
= shared_pref
.new_global_ref
174 self.editor
= editor
.new_global_ref
177 private fun setup
(file_name
: JavaString, mode
: Int) import context
, set_vars
in "Java" `{
178 Activity context = (Activity) SharedPreferences_context(recv);
179 SharedPreferences sp;
181 // Uses default SharedPreferences if file_name is an empty String
182 if (file_name.equals("")) {
183 sp = context.getPreferences((int)mode);
185 sp = context.getSharedPreferences(file_name, (int)mode);
188 SharedPreferences.Editor editor = sp.edit();
190 SharedPreferences_set_vars(recv, sp, editor);
193 private fun commit_if_auto
do if auto_commit
then self.commit
195 # Returns true if there's an entry corresponding the given key
196 fun has
(key
: String): Bool
198 sys
.jni_env
.push_local_frame
(2)
199 var return_value
= shared_preferences
.contains
(key
.to_java_string
)
200 sys
.jni_env
.pop_local_frame
204 # Returns a `HashMap` containing all entries or `null` if there's no entries
206 # User has to manage local stack deallocation himself
209 # var foo = new HashMap[JavaString, JavaObject]
211 # for key, value in foo do
212 # key.delete_local_ref
213 # value.delete_local_ref
216 # *You should use Nit getters instead and get each value one by one*
217 fun all
: nullable HashMap[JavaString, JavaObject]
219 var hashmap
= shared_preferences
.get_all
220 if hashmap
.is_empty
then return null
224 # Returns the `Bool` value corresponding the given key or `def_value` if none
225 # or if the value isn't of correct type
226 fun bool
(key
: String, def_value
: Bool): Bool
228 sys
.jni_env
.push_local_frame
(2)
229 var return_value
= shared_preferences
.get_boolean
(key
.to_java_string
, def_value
)
230 sys
.jni_env
.pop_local_frame
234 # Returns the `Float` value corresponding the given key or `def_value` if none
235 # or if the value isn't of correct type
236 fun float
(key
: String, def_value
: Float): Float
238 sys
.jni_env
.push_local_frame
(2)
239 var return_value
= shared_preferences
.get_float
(key
.to_java_string
, def_value
)
240 sys
.jni_env
.pop_local_frame
244 # Returns the `Int` value corresponding the given key or `def_value` if none
245 # or if the value isn't of correct type
246 # Be aware of possible `def_value` integer overflow as the Nit `Int` corresponds
248 fun int
(key
: String, def_value
: Int): Int
250 sys
.jni_env
.push_local_frame
(2)
251 var return_value
= shared_preferences
.get_int
(key
.to_java_string
, def_value
)
252 sys
.jni_env
.pop_local_frame
256 # Returns the `Int` value corresponding the given key or `def_value` if none
257 # or if the value isn't of correct type
258 # Calls `getLong(key, value)` java method
259 # Nit `Int` is equivalent to Java `long` so that no integer overflow will occur
260 fun long
(key
: String, def_value
: Int): Int
262 sys
.jni_env
.push_local_frame
(2)
263 var return_value
= shared_preferences
.get_long
(key
.to_java_string
, def_value
)
264 sys
.jni_env
.pop_local_frame
268 # Returns the `String` value corresponding the given key or `def_value` if none
269 # or if the value isn't of correct type
270 fun string
(key
: String, def_value
: String): String
272 sys
.jni_env
.push_local_frame
(3)
273 var java_return_value
= shared_preferences
.get_string
(key
.to_java_string
,
274 def_value
.to_java_string
)
275 var nit_return_value
= java_return_value
.to_s
276 sys
.jni_env
.pop_local_frame
277 return nit_return_value
280 # Clears all the dictionnary entries in the specified file or the default file
281 # if none specified at instanciation
282 # Returns `self` allowing fluent programming
283 fun clear
: SharedPreferences
290 # If auto_commit is `false`, has to be called to save the data to persistant memory
293 sys
.jni_env
.push_local_frame
(1)
294 var return_value
= editor
.commit
295 sys
.jni_env
.pop_local_frame
299 # Set a key-value pair using a `Bool` value
300 # Returns `self` allowing fluent programming
301 fun add_bool
(key
: String, value
: Bool ): SharedPreferences
303 sys
.jni_env
.push_local_frame
(1)
304 editor
.put_boolean
(key
.to_java_string
, value
)
305 sys
.jni_env
.pop_local_frame
310 # Set a key-value pair using a `Float` value
311 # Returns `self` allowing fluent programming
313 # Be aware of possible loss of precision as Nit `Float` corresponds to Java `double`
314 # and the methods stores a Java `float`
315 fun add_float
(key
: String, value
: Float): SharedPreferences
317 sys
.jni_env
.push_local_frame
(1)
318 editor
.put_float
(key
.to_java_string
, value
)
319 sys
.jni_env
.pop_local_frame
324 # Set a key-value pair using a `Int` type value
325 # Returns `self` allowing fluent programming
327 # Be aware of possible integer overflow as the Nit `Int` corresponds to Java `long`
328 # and the methods stores a Java `int`
329 # *You might want to use add_long instead*
330 fun add_int
(key
: String, value
: Int): SharedPreferences
332 sys
.jni_env
.push_local_frame
(1)
333 editor
.put_int
(key
.to_java_string
, value
)
334 sys
.jni_env
.pop_local_frame
339 # Set a key-value pair using a `Int` type value
340 # Returns `self` allowing fluent programming
341 fun add_long
(key
: String, value
: Int): SharedPreferences
343 sys
.jni_env
.push_local_frame
(1)
344 editor
.put_long
(key
.to_java_string
, value
)
345 sys
.jni_env
.pop_local_frame
350 # Set a key-value pair using a `String` type value
351 # Returns `self` allowing fluent programming
352 fun add_string
(key
: String, value
: String): SharedPreferences
354 sys
.jni_env
.push_local_frame
(2)
355 editor
.put_string
(key
.to_java_string
, value
.to_java_string
)
356 sys
.jni_env
.pop_local_frame
361 # Removes the corresponding entry in the file
362 # Returns `self` allowing fluent programming
363 fun remove
(key
: String): SharedPreferences
365 sys
.jni_env
.push_local_frame
(1)
366 editor
.remove
(key
.to_java_string
)
367 sys
.jni_env
.pop_local_frame
372 # Deallocate global references allocated by the SharedPreferences instance
375 self.shared_preferences
.delete_global_ref
376 self.editor
.delete_global_ref
379 # Store `value` as a serialized Json string
380 fun []=(key
: String, value
: nullable Serializable)
382 var serialized_string
= new StringWriter
383 var serializer
= new JsonSerializer(serialized_string
)
384 serializer
.serialize
(value
)
386 add_string
(key
, serialized_string
.to_s
)
390 # Retrieve an `Object` stored via `[]=` function
392 # Returns `null` if there's no serialized object corresponding to the given key
393 # Make sure that the serialized object is `auto_serializable` or that it redefines
394 # the appropriate methods. Refer to `Serializable` documentation for further details
395 fun [](key
: String): nullable Object
397 var serialized_string
= self.string
(key
, "")
399 if serialized_string
== "" then return null
401 var deserializer
= new JsonDeserializer(serialized_string
)
402 return deserializer
.deserialize
407 var shared_preferences
: SharedPreferences is lazy
do
408 return new SharedPreferences.privately
(self, "")