Merge "Document the clang-format usage."
diff --git a/device.h b/device.h
index 9510fbe..bf148f5 100644
--- a/device.h
+++ b/device.h
@@ -19,6 +19,7 @@
#include <stddef.h>
+#include <memory>
#include <string>
#include <vector>
@@ -51,17 +52,15 @@
explicit Device(RecoveryUI* ui) : ui_(ui) {}
virtual ~Device() {}
- // Called to obtain the UI object that should be used to display the recovery user interface for
- // this device. You should not have called Init() on the UI object already, the caller will do
- // that after this method returns.
+ // Returns a raw pointer to the RecoveryUI object.
virtual RecoveryUI* GetUI() {
- return ui_;
+ return ui_.get();
}
- // Sets the UI object to the given UI. Used to override the default UI in case initialization
- // failed, or we want a stub for some reason.
- virtual void SetUI(RecoveryUI* ui) {
- ui_ = ui;
+ // Resets the UI object to the given UI. Used to override the default UI in case initialization
+ // failed, or we want a different UI for some reason. The device object will take the ownership.
+ virtual void ResetUI(RecoveryUI* ui) {
+ ui_.reset(ui);
}
// Called when recovery starts up (after the UI has been obtained and initialized and after the
@@ -70,16 +69,15 @@
// Called from the main thread when recovery is at the main menu and waiting for input, and a key
// is pressed. (Note that "at" the main menu does not necessarily mean the menu is visible;
- // recovery will be at the main menu with it invisible after an unsuccessful operation [ie OTA
- // package failure], or if recovery is started with no command.)
+ // recovery will be at the main menu with it invisible after an unsuccessful operation, such as
+ // failed to install an OTA package, or if recovery is started with no command.)
//
// 'key' is the code of the key just pressed. (You can call IsKeyPressed() on the RecoveryUI
- // object you returned from GetUI if you want to find out if other keys are held down.)
+ // object you returned from GetUI() if you want to find out if other keys are held down.)
//
// 'visible' is true if the menu is visible.
//
// Returns one of the defined constants below in order to:
- //
// - move the menu highlight (kHighlight{Up,Down}: negative value)
// - invoke the highlighted item (kInvokeItem: negative value)
// - do nothing (kNoAction: negative value)
@@ -87,7 +85,7 @@
virtual int HandleMenuKey(int key, bool visible);
// Returns the list of menu items (a vector of strings). The menu_position passed to
- // InvokeMenuItem will correspond to the indexes into this array.
+ // InvokeMenuItem() will correspond to the indexes into this array.
virtual const std::vector<std::string>& GetMenuItems();
// Performs a recovery action selected from the menu. 'menu_position' will be the index of the
@@ -112,7 +110,8 @@
}
private:
- RecoveryUI* ui_;
+ // The RecoveryUI object that should be used to display the user interface for this device.
+ std::unique_ptr<RecoveryUI> ui_;
};
// The device-specific library must define this function (or the default one will be used, if there
diff --git a/recovery.cpp b/recovery.cpp
index 95118ff..b11298f 100644
--- a/recovery.cpp
+++ b/recovery.cpp
@@ -230,8 +230,8 @@
// Clear the recovery command and prepare to boot a (hopefully working) system,
// copy our log file to cache as well (for the system to read). This function is
// idempotent: call it as many times as you like.
-static void finish_recovery(Device* device) {
- std::string locale = device->GetUI()->GetLocale();
+static void finish_recovery() {
+ std::string locale = ui->GetLocale();
// Save the locale to cache, so if recovery is next started up without a '--locale' argument
// (e.g., directly from the bootloader) it will use the last-known locale.
if (!locale.empty() && has_cache) {
@@ -808,7 +808,7 @@
// which is to reboot or shutdown depending on if the --shutdown_after flag was passed to recovery.
static Device::BuiltinAction prompt_and_wait(Device* device, int status) {
for (;;) {
- finish_recovery(device);
+ finish_recovery();
switch (status) {
case INSTALL_SUCCESS:
case INSTALL_NONE:
@@ -1173,16 +1173,14 @@
Device* device = make_device();
if (android::base::GetBoolProperty("ro.boot.quiescent", false)) {
printf("Quiescent recovery mode.\n");
- ui = new StubRecoveryUI();
+ device->ResetUI(new StubRecoveryUI());
} else {
- ui = device->GetUI();
-
- if (!ui->Init(locale)) {
- printf("Failed to initialize UI, use stub UI instead.\n");
- ui = new StubRecoveryUI();
+ if (!device->GetUI()->Init(locale)) {
+ printf("Failed to initialize UI; using stub UI instead.\n");
+ device->ResetUI(new StubRecoveryUI());
}
}
- device->SetUI(ui);
+ ui = device->GetUI();
// Set background string to "installing security update" for security update,
// otherwise set it to "installing system update".
@@ -1349,7 +1347,7 @@
}
// Save logs and clean up before rebooting or shutting down.
- finish_recovery(device);
+ finish_recovery();
switch (after) {
case Device::SHUTDOWN:
diff --git a/screen_ui.cpp b/screen_ui.cpp
index c0fb2cf..f5dadf7 100644
--- a/screen_ui.cpp
+++ b/screen_ui.cpp
@@ -751,7 +751,7 @@
return true;
}
-std::string ScreenRecoveryUI::GetLocale() {
+std::string ScreenRecoveryUI::GetLocale() const {
return locale_;
}
diff --git a/screen_ui.h b/screen_ui.h
index 293696d..2d6b621 100644
--- a/screen_ui.h
+++ b/screen_ui.h
@@ -114,7 +114,7 @@
explicit ScreenRecoveryUI(bool scrollable_menu);
bool Init(const std::string& locale) override;
- std::string GetLocale() override;
+ std::string GetLocale() const override;
// overall recovery state ("background image")
void SetBackground(Icon icon) override;
diff --git a/stub_ui.h b/stub_ui.h
index fddf4e7..67c338e 100644
--- a/stub_ui.h
+++ b/stub_ui.h
@@ -28,7 +28,7 @@
public:
StubRecoveryUI() = default;
- std::string GetLocale() override {
+ std::string GetLocale() const override {
return "";
}
void SetBackground(Icon /* icon */) override {}
diff --git a/ui.h b/ui.h
index f867790..3928426 100644
--- a/ui.h
+++ b/ui.h
@@ -57,7 +57,7 @@
// the given locale. Returns true on success.
virtual bool Init(const std::string& locale);
- virtual std::string GetLocale() = 0;
+ virtual std::string GetLocale() const = 0;
// Shows a stage indicator. Called immediately after Init().
virtual void SetStage(int current, int max) = 0;
diff --git a/updater_sample/res/raw/sample.json b/updater_sample/res/raw/sample.json
index 7ac8ffa..46fbfa3 100644
--- a/updater_sample/res/raw/sample.json
+++ b/updater_sample/res/raw/sample.json
@@ -1,7 +1,7 @@
{
"__name": "name will be visible on UI",
"__url": "https:// or file:// uri to update package (zip, xz, ...)",
- "__type": "NON_STREAMING (from a local file) OR STREAMING (on the fly)",
+ "__ab_install_type": "NON_STREAMING (from a local file) OR STREAMING (on the fly)",
"name": "SAMPLE-cake-release BUILD-12345",
"url": "http://foo.bar/builds/ota-001.zip",
"ab_install_type": "NON_STREAMING",
diff --git a/updater_sample/src/com/example/android/systemupdatersample/UpdateConfig.java b/updater_sample/src/com/example/android/systemupdatersample/UpdateConfig.java
index b08bfd0..9bdd8b9 100644
--- a/updater_sample/src/com/example/android/systemupdatersample/UpdateConfig.java
+++ b/updater_sample/src/com/example/android/systemupdatersample/UpdateConfig.java
@@ -79,9 +79,13 @@
p.getLong("offset"),
p.getLong("size"));
}
+ String authorization = null;
+ if (meta.has("authorization")) {
+ authorization = meta.getString("authorization");
+ }
c.mAbStreamingMetadata = new StreamingMetadata(
propertyFiles,
- meta.getString("authorization_token"));
+ authorization);
}
c.mRawJson = json;
return c;
@@ -196,7 +200,7 @@
}
public Optional<String> getAuthorization() {
- return Optional.of(mAuthorization);
+ return mAuthorization == null ? Optional.empty() : Optional.of(mAuthorization);
}
}
diff --git a/updater_sample/tests/src/com/example/android/systemupdatersample/util/FileDownloaderTest.java b/updater_sample/tests/src/com/example/android/systemupdatersample/util/FileDownloaderTest.java
index 009610e..a136ff0 100644
--- a/updater_sample/tests/src/com/example/android/systemupdatersample/util/FileDownloaderTest.java
+++ b/updater_sample/tests/src/com/example/android/systemupdatersample/util/FileDownloaderTest.java
@@ -16,7 +16,7 @@
package com.example.android.systemupdatersample.util;
-import static junit.framework.Assert.assertEquals;
+import static org.junit.Assert.assertEquals;
import android.content.Context;
import android.support.test.InstrumentationRegistry;