recovery: Move a few int to bool.
Most of the changes are trivial.
Also update a dead reference to device_handle_key() in device.h comment,
and add some comments to get_menu_selection() function.
Test: `mmma bootable/recovery`
Change-Id: I59ef9213ec88ab35c0e7b8a7813ccf9c56dbd5c5
diff --git a/device.h b/device.h
index 08dfcdf..639e2bf 100644
--- a/device.h
+++ b/device.h
@@ -20,96 +20,90 @@
#include "ui.h"
class Device {
- public:
- explicit Device(RecoveryUI* ui) : ui_(ui) { }
- virtual ~Device() { }
+ public:
+ 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.
- virtual RecoveryUI* GetUI() { return ui_; }
+ // 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.
+ virtual RecoveryUI* GetUI() {
+ return ui_;
+ }
- // Called when recovery starts up (after the UI has been obtained
- // and initialized and after the arguments have been parsed, but
- // before anything else).
- virtual void StartRecovery() { };
+ // Called when recovery starts up (after the UI has been obtained and initialized and after the
+ // arguments have been parsed, but before anything else).
+ virtual void StartRecovery() {};
- // 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.)
- //
- // 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.)
- //
- // visible is true if the menu is visible.
- //
- // Return one of the defined constants below in order to:
- //
- // - move the menu highlight (kHighlight{Up,Down})
- // - invoke the highlighted item (kInvokeItem)
- // - do nothing (kNoAction)
- // - invoke a specific action (a menu position: any non-negative number)
- virtual int HandleMenuKey(int key, int visible);
+ // 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.)
+ //
+ // '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.)
+ //
+ // '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})
+ // - invoke the highlighted item (kInvokeItem)
+ // - do nothing (kNoAction)
+ // - invoke a specific action (a menu position: any non-negative number)
+ virtual int HandleMenuKey(int key, bool visible);
- enum BuiltinAction {
- NO_ACTION = 0,
- REBOOT = 1,
- APPLY_SDCARD = 2,
- // APPLY_CACHE was 3.
- APPLY_ADB_SIDELOAD = 4,
- WIPE_DATA = 5,
- WIPE_CACHE = 6,
- REBOOT_BOOTLOADER = 7,
- SHUTDOWN = 8,
- VIEW_RECOVERY_LOGS = 9,
- MOUNT_SYSTEM = 10,
- RUN_GRAPHICS_TEST = 11,
- };
+ enum BuiltinAction {
+ NO_ACTION = 0,
+ REBOOT = 1,
+ APPLY_SDCARD = 2,
+ // APPLY_CACHE was 3.
+ APPLY_ADB_SIDELOAD = 4,
+ WIPE_DATA = 5,
+ WIPE_CACHE = 6,
+ REBOOT_BOOTLOADER = 7,
+ SHUTDOWN = 8,
+ VIEW_RECOVERY_LOGS = 9,
+ MOUNT_SYSTEM = 10,
+ RUN_GRAPHICS_TEST = 11,
+ };
- // Return the list of menu items (an array of strings,
- // NULL-terminated). The menu_position passed to InvokeMenuItem
- // will correspond to the indexes into this array.
- virtual const char* const* GetMenuItems();
+ // Return the list of menu items (an array of strings, NULL-terminated). The menu_position passed
+ // to InvokeMenuItem will correspond to the indexes into this array.
+ virtual const char* const* GetMenuItems();
- // Perform a recovery action selected from the menu.
- // 'menu_position' will be the item number of the selected menu
- // item, or a non-negative number returned from
- // device_handle_key(). The menu will be hidden when this is
- // called; implementations can call ui_print() to print
- // information to the screen. If the menu position is one of the
- // builtin actions, you can just return the corresponding enum
- // value. If it is an action specific to your device, you
- // actually perform it here and return NO_ACTION.
- virtual BuiltinAction InvokeMenuItem(int menu_position);
+ // Perform a recovery action selected from the menu. 'menu_position' will be the item number of
+ // the selected menu item, or a non-negative number returned from HandleMenuKey(). The menu will
+ // be hidden when this is called; implementations can call ui_print() to print information to the
+ // screen. If the menu position is one of the builtin actions, you can just return the
+ // corresponding enum value. If it is an action specific to your device, you actually perform it
+ // here and return NO_ACTION.
+ virtual BuiltinAction InvokeMenuItem(int menu_position);
- static const int kNoAction = -1;
- static const int kHighlightUp = -2;
- static const int kHighlightDown = -3;
- static const int kInvokeItem = -4;
+ static const int kNoAction = -1;
+ static const int kHighlightUp = -2;
+ static const int kHighlightDown = -3;
+ static const int kInvokeItem = -4;
- // Called before and after we do a wipe data/factory reset operation,
- // either via a reboot from the main system with the --wipe_data flag,
- // or when the user boots into recovery image manually and selects the
- // option from the menu, to perform whatever device-specific wiping
- // actions are needed.
- // Return true on success; returning false from PreWipeData will prevent
- // the regular wipe, and returning false from PostWipeData will cause
- // the wipe to be considered a failure.
- virtual bool PreWipeData() { return true; }
- virtual bool PostWipeData() { return true; }
+ // Called before and after we do a wipe data/factory reset operation, either via a reboot from the
+ // main system with the --wipe_data flag, or when the user boots into recovery image manually and
+ // selects the option from the menu, to perform whatever device-specific wiping actions as needed.
+ // Returns true on success; returning false from PreWipeData will prevent the regular wipe, and
+ // returning false from PostWipeData will cause the wipe to be considered a failure.
+ virtual bool PreWipeData() {
+ return true;
+ }
- private:
- RecoveryUI* ui_;
+ virtual bool PostWipeData() {
+ return true;
+ }
+
+ private:
+ RecoveryUI* ui_;
};
-// The device-specific library must define this function (or the
-// default one will be used, if there is no device-specific library).
-// It returns the Device object that recovery should use.
+// The device-specific library must define this function (or the default one will be used, if there
+// is no device-specific library). It returns the Device object that recovery should use.
Device* make_device();
#endif // _DEVICE_H