lib/app/README.md

   1 _app.nit_, a framework for portable applications
   2
   3 The framework provides services to manage common needs of modern mobile applications:
   4
   5 * Life-cycle
   6 * User interface
   7 * Persistence
   8 * Async HTTP requests
   9 * Package metadata
  10 * Compilation and packaging
  11
  12 The features offered by _app.nit_ are common to all platforms, but
  13 may not be available on all devices.
  14
  15 # Application Life-Cycle
  16
  17 The _app.nit_ application life-cycle is compatible with all target platforms.
  18 It relies on the following sequence of events, represented here by their callback method name:
  19
  20 1. `on_create`: The application is being created.
  21    You should build the UI at this time.
  22
  23 2. `on_start`: The app is starting or restarting, background activities may
  24
  25 3. `on_resume`: The app enters the active state, it is in the foreground.
  26
  27 4. `on_pause`: The app leaves the active state and the foreground.
  28    It may still be visible in the background.
  29    It may then go back to `on_resume` or `on_stop`.
  30
  31 5. `on_stop`: The app is completely hidden.
  32    It may then be destroyed (`on_destroy`) or go back to `on_start`.
  33
  34 6. `on_destroy`: The app is being destroyed.
  35
  36 Life-cycle events related to saving and restoring the application state are provided by two special callback methods:
  37
  38 * `on_save_state`: The app may be destroyed soon, save its state for a future `on_restore_state`.
  39   More on how it can be done in the `app::data_store` section.
  40
  41 * `on_restore_state`: The app is launching, restore its state from a previous `on_save_state`.
  42
  43 These events are synchronized to the native platforms applications
  44 The `App` instance is the first to be notified of these events.
  45 Other UI elements, from the `ui` submodule, are notified of the same events using a simple depth first visit.
  46 So all UI elements can react separately to live-cycle events.
  47
  48 # User Interface
  49
  50 The `app::ui` module defines an abstract API to build a portable graphical application.
  51 The API is composed of interactive `Control`s, visible `View`s and an active `Window`.
  52
  53 Here is a subset of the most useful controls and views:
  54
  55 * The classic pushable `Button` with text (usually rectangular).
  56
  57 * `TextInput` is a field for the user to enter text.
  58
  59 * `HorizontalLayout` and `VerticalLayout` organize other controls in order.
  60
  61 Each control is notified of input events by callbacks to `on_event`.
  62 All controls have observers that are also notified of the events.
  63 So there is two ways  to customize the behavior on a given event:
  64
  65 * Create a subclass of the wanted `Control`, let's say `Button`, and specialize `on_event`.
  66
  67 * Add an observer to a `Button` instance, and implement `on_event` in the observer.
  68
  69 ## Usage Example
  70
  71 The calculator example (at `../../examples/calculator/src/calculator.nit`) is a concrete,
  72 simple and complete use of the _app.nit_ portable UI.
  73
  74 ## Platform-specific UI
  75
  76 You can go beyond the portable UI API of _app.nit_ by using the natives services of a platform.
  77
  78 The suggested approach is to use platform specific modules to customize the application on a precise platform.
  79 See the calculator example for an adaptation of the UI on Android,
  80 the interesting module is in this repository at ../../examples/calculator/src/android_calculator.nit
  81
  82 # Persistent State with data\_store
  83
  84 _app.nit_ offers the submodule `app::data_store` to easily save the application state and user preferences.
  85 The service is accessible by the method `App::data_store`. The `DataStore` itself defines 2 methods:
  86
  87 * `DataStore::[]=` saves and associates any serializable instances to a `String` key.
  88 Pass `null` to clear the value associated to a key.
  89
  90 * `DataStore::[]` returns the object associated to a `String` key.
  91 It returns `null` if nothing is associated to the key.
  92
  93 ## Usage Example
  94
  95 ~~~
  96 import app::data_store
  97
  98 redef class App
  99         var user_name: String
 100
 101         redef fun on_save_state
 102         do
 103                 app.data_store["first run"] = false
 104                 app.data_store["user name"] = user_name
 105
 106                 super # call `on_save_state` on all attached instances of `AppComponent`
 107         end
 108
 109         redef fun on_restore_state
 110         do
 111                 var first_run = app.data_store["first run"]
 112                 if first_run != true then
 113                         print "It's the first run of this application"
 114                 end
 115
 116                 var user_name = app.data_store["user name"]
 117                 if user_name isa String then
 118                         self.user_name = user_name
 119                 else self.user_name = "Undefined"
 120
 121                 super
 122         end
 123 end
 124 ~~~
 125
 126 # Async HTTP request
 127
 128 The module `app::http_request` provides services to execute asynchronous HTTP request.
 129 The class `AsyncHttpRequest` hides the complex parallel logic and
 130 lets the user implement methods acting only on the UI thread.
 131 See the documentation of `AsyncHttpRequest` for more information.
 132
 133 # Metadata annotations
 134
 135 The _app.nit_ framework defines three annotations to customize the application package.
 136
 137 * `app_name` takes a single argument, the visible name of the application.
 138   This name is used for launchers and window title.
 139   By default, the name of the target module.
 140
 141 * `app_namespace` specifies the full namespace (or package name) of the application package.
 142   This value usually identify the application uniquely on application stores.
 143   It should not change once the application has benn published.
 144   By default, the namespace is `org.nitlanguage.{module_name}`.
 145
 146 * `app_version` specifies the version of the application package.
 147   This annotation expects at least one argument, usually we use three version numbers:
 148   the major, minor and revision.
 149   The special function `git_revision` will use the prefix of the hash of the latest git commit.
 150   By default, the version is 0.1.
 151
 152 ## Usage Example
 153
 154 ~~~
 155 module my_module is
 156     app_name "My App"
 157     app_namespace "org.example.my_app"
 158     app_version(1, 0, git_revision)
 159 end
 160 ~~~
 161
 162 # Compiling and Packaging an Application
 163
 164 The Nit compiler detects the target platform from the importations and generates the appropriate application format and package.
 165
 166 Applications using only the portable services of _app.nit_ require some special care at compilation.
 167 Such an application, let's say `calculator.nit`, does not depend on a specific platform and use the portable UI.
 168 The target platform must be specified to the compiler for it to produce the correct application package.
 169 There is two main ways to achieve this goal:
 170
 171 * The mixin option (`-m module`) imports an additional module before compiling.
 172   It can be used to load platform specific implementations of the _app.nit_ portable UI.
 173
 174   ~~~
 175   # GNU/Linux version, using GTK
 176   nitc calculator.nit -m linux
 177
 178   # Android version
 179   nitc calculator.nit -m android
 180
 181   # iOS version
 182   nitc calculator.nit -m ios
 183   ~~~
 184
 185 * A common alternative for larger projects is to use platform specific modules.
 186   Continuing with the calculator example, it is adapted for Android by the module `android_calculator.nit`.
 187   This module imports both `calculator` and `android`, it can then use Android specific code.
 188
 189   ~~~
 190   module android_calculator
 191
 192   import calculator
 193   import android
 194
 195   # ...
 196   ~~~