blob: 0f853ac59f8e228f32367f4cf656ca9cce50fb1e [file] [log] [blame]
Dees_Troya13d74f2013-03-24 08:54:55 -05001/*
2 Copyright 2013 bigbiff/Dees_Troy TeamWin
3 This file is part of TWRP/TeamWin Recovery Project.
4
5 TWRP is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 TWRP is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with TWRP. If not, see <http://www.gnu.org/licenses/>.
17*/
Dees Troy3be70a82013-10-22 14:25:12 +000018
19// objects.hpp - Base classes for object manager of GUI
Dees_Troy51a0e822012-09-05 15:24:24 -040020
21#ifndef _OBJECTS_HEADER
22#define _OBJECTS_HEADER
23
24#include "rapidxml.hpp"
25#include <vector>
26#include <string>
27#include <map>
Vojtech Bocek0b7fe502014-03-13 17:36:52 +010028#include <set>
Samer Diab (S.a.M.e.R_d)71e9b042014-01-07 20:18:47 +000029#include <time.h>
Dees_Troy51a0e822012-09-05 15:24:24 -040030
Dees_Troy51a0e822012-09-05 15:24:24 -040031using namespace rapidxml;
32
33#include "../data.hpp"
34#include "resources.hpp"
35#include "pages.hpp"
Dees_Troya13d74f2013-03-24 08:54:55 -050036#include "../partitions.hpp"
Dees_Troy51a0e822012-09-05 15:24:24 -040037
Ethan Yonker751a85e2014-12-12 16:59:10 -060038#ifndef TW_X_OFFSET
39#define TW_X_OFFSET 0
40#endif
41#ifndef TW_Y_OFFSET
42#define TW_Y_OFFSET 0
43#endif
44
Dees_Troy51a0e822012-09-05 15:24:24 -040045class RenderObject
46{
47public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020048 enum Placement {
49 TOP_LEFT = 0,
50 TOP_RIGHT = 1,
51 BOTTOM_LEFT = 2,
52 BOTTOM_RIGHT = 3,
53 CENTER = 4,
Dees_Troy51a0e822012-09-05 15:24:24 -040054 CENTER_X_ONLY = 5,
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020055 };
Dees_Troy51a0e822012-09-05 15:24:24 -040056
57public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020058 RenderObject() { mRenderX = 0; mRenderY = 0; mRenderW = 0; mRenderH = 0; mPlacement = TOP_LEFT; }
59 virtual ~RenderObject() {}
Dees_Troy51a0e822012-09-05 15:24:24 -040060
61public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020062 // Render - Render the full object to the GL surface
63 // Return 0 on success, <0 on error
64 virtual int Render(void) = 0;
Dees_Troy51a0e822012-09-05 15:24:24 -040065
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020066 // Update - Update any UI component animations (called <= 30 FPS)
67 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
68 virtual int Update(void) { return 0; }
Dees_Troy51a0e822012-09-05 15:24:24 -040069
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020070 // GetRenderPos - Returns the current position of the object
71 virtual int GetRenderPos(int& x, int& y, int& w, int& h) { x = mRenderX; y = mRenderY; w = mRenderW; h = mRenderH; return 0; }
Dees_Troy51a0e822012-09-05 15:24:24 -040072
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020073 // SetRenderPos - Update the position of the object
74 // Return 0 on success, <0 on error
75 virtual int SetRenderPos(int x, int y, int w = 0, int h = 0) { mRenderX = x; mRenderY = y; if (w || h) { mRenderW = w; mRenderH = h; } return 0; }
Dees_Troy51a0e822012-09-05 15:24:24 -040076
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020077 // GetPlacement - Returns the current placement
78 virtual int GetPlacement(Placement& placement) { placement = mPlacement; return 0; }
Dees_Troy51a0e822012-09-05 15:24:24 -040079
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020080 // SetPlacement - Update the current placement
81 virtual int SetPlacement(Placement placement) { mPlacement = placement; return 0; }
Dees_Troy51a0e822012-09-05 15:24:24 -040082
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020083 // SetPageFocus - Notify when a page gains or loses focus
84 virtual void SetPageFocus(int inFocus) { return; }
Dees_Troy51a0e822012-09-05 15:24:24 -040085
86protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020087 int mRenderX, mRenderY, mRenderW, mRenderH;
88 Placement mPlacement;
Dees_Troy51a0e822012-09-05 15:24:24 -040089};
90
91class ActionObject
92{
93public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020094 ActionObject() { mActionX = 0; mActionY = 0; mActionW = 0; mActionH = 0; }
95 virtual ~ActionObject() {}
Dees_Troy51a0e822012-09-05 15:24:24 -040096
97public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020098 // NotifyTouch - Notify of a touch event
99 // Return 0 on success, >0 to ignore remainder of touch, and <0 on error
100 virtual int NotifyTouch(TOUCH_STATE state, int x, int y) { return 0; }
Dees_Troy51a0e822012-09-05 15:24:24 -0400101
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200102 // NotifyKey - Notify of a key press
103 // Return 0 on success (and consume key), >0 to pass key to next handler, and <0 on error
Vojtech Bocek0b7fe502014-03-13 17:36:52 +0100104 virtual int NotifyKey(int key, bool down) { return 1; }
Dees_Troy51a0e822012-09-05 15:24:24 -0400105
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200106 // GetRenderPos - Returns the current position of the object
107 virtual int GetActionPos(int& x, int& y, int& w, int& h) { x = mActionX; y = mActionY; w = mActionW; h = mActionH; return 0; }
Dees_Troy51a0e822012-09-05 15:24:24 -0400108
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200109 // SetRenderPos - Update the position of the object
110 // Return 0 on success, <0 on error
111 virtual int SetActionPos(int x, int y, int w = 0, int h = 0);
Dees_Troy51a0e822012-09-05 15:24:24 -0400112
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200113 // IsInRegion - Checks if the request is handled by this object
thatf8194e22015-01-29 01:05:01 +0100114 // Return 1 if this object handles the request, 0 if not
115 virtual int IsInRegion(int x, int y) { return ((x < mActionX || x >= mActionX + mActionW || y < mActionY || y >= mActionY + mActionH) ? 0 : 1); }
Dees_Troy51a0e822012-09-05 15:24:24 -0400116
Dees_Troy51a0e822012-09-05 15:24:24 -0400117protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200118 int mActionX, mActionY, mActionW, mActionH;
Dees_Troy51a0e822012-09-05 15:24:24 -0400119};
120
Vojtech Bocekede51c52014-02-07 23:58:09 +0100121class GUIObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400122{
123public:
Vojtech Bocekede51c52014-02-07 23:58:09 +0100124 GUIObject(xml_node<>* node);
125 virtual ~GUIObject();
Dees_Troy51a0e822012-09-05 15:24:24 -0400126
127public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200128 bool IsConditionVariable(std::string var);
129 bool isConditionTrue();
130 bool isConditionValid();
Vojtech Bocek07220562014-02-08 02:05:33 +0100131
132 // NotifyVarChange - Notify of a variable change
133 // Returns 0 on success, <0 on error
134 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
Dees_Troy51a0e822012-09-05 15:24:24 -0400135
136protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200137 class Condition
138 {
139 public:
Vojtech Bocek07220562014-02-08 02:05:33 +0100140 Condition() {
141 mLastResult = true;
142 }
143
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200144 std::string mVar1;
145 std::string mVar2;
146 std::string mCompareOp;
147 std::string mLastVal;
Vojtech Bocek07220562014-02-08 02:05:33 +0100148 bool mLastResult;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200149 };
Dees_Troy51a0e822012-09-05 15:24:24 -0400150
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200151 std::vector<Condition> mConditions;
Dees_Troy51a0e822012-09-05 15:24:24 -0400152
153protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200154 bool isMounted(std::string vol);
155 bool isConditionTrue(Condition* condition);
Vojtech Bocek07220562014-02-08 02:05:33 +0100156
157 bool mConditionsResult;
Dees_Troy51a0e822012-09-05 15:24:24 -0400158};
159
160class InputObject
161{
162public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200163 InputObject() { HasInputFocus = 0; }
164 virtual ~InputObject() {}
Dees_Troy51a0e822012-09-05 15:24:24 -0400165
166public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200167 // NotifyKeyboard - Notify of keyboard input
168 // Return 0 on success (and consume key), >0 to pass key to next handler, and <0 on error
169 virtual int NotifyKeyboard(int key) { return 1; }
Dees_Troy51a0e822012-09-05 15:24:24 -0400170
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200171 virtual int SetInputFocus(int focus) { HasInputFocus = focus; return 1; }
Dees_Troy51a0e822012-09-05 15:24:24 -0400172
173protected:
174 int HasInputFocus;
175};
176
177// Derived Objects
178// GUIText - Used for static text
Vojtech Bocekede51c52014-02-07 23:58:09 +0100179class GUIText : public GUIObject, public RenderObject, public ActionObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400180{
181public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200182 // w and h may be ignored, in which case, no bounding box is applied
183 GUIText(xml_node<>* node);
Dees_Troy51a0e822012-09-05 15:24:24 -0400184
185public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200186 // Render - Render the full object to the GL surface
187 // Return 0 on success, <0 on error
188 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400189
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200190 // Update - Update any UI component animations (called <= 30 FPS)
191 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
192 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400193
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200194 // Retrieve the size of the current string (dynamic strings may change per call)
195 virtual int GetCurrentBounds(int& w, int& h);
Dees_Troy51a0e822012-09-05 15:24:24 -0400196
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200197 // Notify of a variable change
Vojtech Bocek07220562014-02-08 02:05:33 +0100198 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
Dees_Troy51a0e822012-09-05 15:24:24 -0400199
200 // Set maximum width in pixels
201 virtual int SetMaxWidth(unsigned width);
202
203 // Set number of characters to skip (for scrolling)
204 virtual int SkipCharCount(unsigned skip);
205
Dees_Troy4d12f962012-10-19 13:13:15 -0400206public:
207 bool isHighlighted;
208
Dees_Troy51a0e822012-09-05 15:24:24 -0400209protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200210 std::string mText;
211 std::string mLastValue;
212 COLOR mColor;
Dees_Troy4d12f962012-10-19 13:13:15 -0400213 COLOR mHighlightColor;
thatf6ed8fc2015-02-14 20:23:16 +0100214 FontResource* mFont;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200215 int mIsStatic;
216 int mVarChanged;
217 int mFontHeight;
Dees_Troy51a0e822012-09-05 15:24:24 -0400218 unsigned maxWidth;
219 unsigned charSkip;
220
221protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200222 std::string parseText(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400223};
224
225// GUIImage - Used for static image
Vojtech Bocekede51c52014-02-07 23:58:09 +0100226class GUIImage : public GUIObject, public RenderObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400227{
228public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200229 GUIImage(xml_node<>* node);
Dees_Troy51a0e822012-09-05 15:24:24 -0400230
231public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200232 // Render - Render the full object to the GL surface
233 // Return 0 on success, <0 on error
234 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400235
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200236 // SetRenderPos - Update the position of the object
237 // Return 0 on success, <0 on error
238 virtual int SetRenderPos(int x, int y, int w = 0, int h = 0);
Dees_Troy51a0e822012-09-05 15:24:24 -0400239
Dees_Troy4d12f962012-10-19 13:13:15 -0400240public:
241 bool isHighlighted;
242
Dees_Troy51a0e822012-09-05 15:24:24 -0400243protected:
thatf6ed8fc2015-02-14 20:23:16 +0100244 ImageResource* mImage;
245 ImageResource* mHighlightImage;
Dees_Troy51a0e822012-09-05 15:24:24 -0400246};
247
248// GUIFill - Used for fill colors
Vojtech Bocekede51c52014-02-07 23:58:09 +0100249class GUIFill : public GUIObject, public RenderObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400250{
251public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200252 GUIFill(xml_node<>* node);
Dees_Troy51a0e822012-09-05 15:24:24 -0400253
254public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200255 // Render - Render the full object to the GL surface
256 // Return 0 on success, <0 on error
257 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400258
259protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200260 COLOR mColor;
Dees_Troy51a0e822012-09-05 15:24:24 -0400261};
262
263// GUIAction - Used for standard actions
Vojtech Bocekede51c52014-02-07 23:58:09 +0100264class GUIAction : public GUIObject, public ActionObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400265{
thatc6085482015-01-09 22:12:43 +0100266 friend class ActionThread;
267
Dees_Troy51a0e822012-09-05 15:24:24 -0400268public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200269 GUIAction(xml_node<>* node);
Dees_Troy51a0e822012-09-05 15:24:24 -0400270
271public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200272 virtual int NotifyTouch(TOUCH_STATE state, int x, int y);
Vojtech Bocek0b7fe502014-03-13 17:36:52 +0100273 virtual int NotifyKey(int key, bool down);
Vojtech Bocek07220562014-02-08 02:05:33 +0100274 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
that3f7b1ac2014-12-30 11:30:13 +0100275
276 int doActions();
Dees_Troy51a0e822012-09-05 15:24:24 -0400277
278protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200279 class Action
280 {
281 public:
282 std::string mFunction;
283 std::string mArg;
284 };
Dees_Troy51a0e822012-09-05 15:24:24 -0400285
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200286 std::vector<Action> mActions;
Vojtech Bocek0b7fe502014-03-13 17:36:52 +0100287 std::map<int, bool> mKeys;
Dees_Troy51a0e822012-09-05 15:24:24 -0400288
289protected:
that73a52952015-01-28 23:07:34 +0100290 enum ThreadType { THREAD_NONE, THREAD_ACTION, THREAD_CANCEL };
291
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200292 int getKeyByName(std::string key);
that3f7b1ac2014-12-30 11:30:13 +0100293 int doAction(Action action);
that73a52952015-01-28 23:07:34 +0100294 ThreadType getThreadType(const Action& action);
Dees_Troy51a0e822012-09-05 15:24:24 -0400295 void simulate_progress_bar(void);
Ethan Yonker0d47eb52015-01-09 11:23:19 -0600296 int flash_zip(std::string filename, int* wipe_cache);
thatcc8ddca2015-01-03 01:59:36 +0100297 void reinject_after_flash();
Dees_Troy51a0e822012-09-05 15:24:24 -0400298 void operation_start(const string operation_name);
that3f7b1ac2014-12-30 11:30:13 +0100299 void operation_end(const int operation_status);
Samer Diab (S.a.M.e.R_d)71e9b042014-01-07 20:18:47 +0000300 time_t Start;
that3f7b1ac2014-12-30 11:30:13 +0100301
302 // map action name to function pointer
303 typedef int (GUIAction::*execFunction)(std::string);
304 typedef std::map<std::string, execFunction> mapFunc;
305 static mapFunc mf;
thatc6085482015-01-09 22:12:43 +0100306 static std::set<std::string> setActionsRunningInCallerThread;
that3f7b1ac2014-12-30 11:30:13 +0100307
308 // GUI actions
309 int reboot(std::string arg);
310 int home(std::string arg);
311 int key(std::string arg);
312 int page(std::string arg);
313 int reload(std::string arg);
314 int readBackup(std::string arg);
315 int set(std::string arg);
316 int clear(std::string arg);
317 int mount(std::string arg);
318 int unmount(std::string arg);
319 int restoredefaultsettings(std::string arg);
320 int copylog(std::string arg);
321 int compute(std::string arg);
322 int setguitimezone(std::string arg);
323 int overlay(std::string arg);
324 int queuezip(std::string arg);
325 int cancelzip(std::string arg);
326 int queueclear(std::string arg);
327 int sleep(std::string arg);
328 int appenddatetobackupname(std::string arg);
329 int generatebackupname(std::string arg);
330 int checkpartitionlist(std::string arg);
331 int getpartitiondetails(std::string arg);
332 int screenshot(std::string arg);
333 int setbrightness(std::string arg);
334
thatc6085482015-01-09 22:12:43 +0100335 // (originally) threaded actions
that3f7b1ac2014-12-30 11:30:13 +0100336 int fileexists(std::string arg);
337 int flash(std::string arg);
338 int wipe(std::string arg);
339 int refreshsizes(std::string arg);
340 int nandroid(std::string arg);
341 int fixpermissions(std::string arg);
342 int dd(std::string arg);
343 int partitionsd(std::string arg);
344 int installhtcdumlock(std::string arg);
345 int htcdumlockrestoreboot(std::string arg);
346 int htcdumlockreflashrecovery(std::string arg);
347 int cmd(std::string arg);
348 int terminalcommand(std::string arg);
349 int killterminal(std::string arg);
350 int reinjecttwrp(std::string arg);
351 int checkbackupname(std::string arg);
352 int decrypt(std::string arg);
353 int adbsideload(std::string arg);
354 int adbsideloadcancel(std::string arg);
355 int openrecoveryscript(std::string arg);
356 int installsu(std::string arg);
357 int fixsu(std::string arg);
358 int decrypt_backup(std::string arg);
359 int repair(std::string arg);
360 int changefilesystem(std::string arg);
361 int startmtp(std::string arg);
362 int stopmtp(std::string arg);
Ethan Yonker96af84a2015-01-05 14:58:36 -0600363 int flashimage(std::string arg);
bigbiff7abc5fe2015-01-17 16:53:12 -0500364 int cancelbackup(std::string arg);
that3f7b1ac2014-12-30 11:30:13 +0100365
366 int simulate;
Dees_Troy51a0e822012-09-05 15:24:24 -0400367};
368
Vojtech Bocekede51c52014-02-07 23:58:09 +0100369class GUIConsole : public GUIObject, public RenderObject, public ActionObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400370{
371public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200372 GUIConsole(xml_node<>* node);
Dees_Troy51a0e822012-09-05 15:24:24 -0400373
374public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200375 // Render - Render the full object to the GL surface
376 // Return 0 on success, <0 on error
377 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400378
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200379 // Update - Update any UI component animations (called <= 30 FPS)
380 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
381 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400382
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200383 // SetRenderPos - Update the position of the object
384 // Return 0 on success, <0 on error
385 virtual int SetRenderPos(int x, int y, int w = 0, int h = 0);
Dees_Troy51a0e822012-09-05 15:24:24 -0400386
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200387 // IsInRegion - Checks if the request is handled by this object
thatf8194e22015-01-29 01:05:01 +0100388 // Return 1 if this object handles the request, 0 if not
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200389 virtual int IsInRegion(int x, int y);
Dees_Troy51a0e822012-09-05 15:24:24 -0400390
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200391 // NotifyTouch - Notify of a touch event
392 // Return 0 on success, >0 to ignore remainder of touch, and <0 on error (Return error to allow other handlers)
393 virtual int NotifyTouch(TOUCH_STATE state, int x, int y);
Dees_Troy51a0e822012-09-05 15:24:24 -0400394
395protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200396 enum SlideoutState
397 {
398 hidden = 0,
399 visible,
400 request_hide,
401 request_show
402 };
403
thatf6ed8fc2015-02-14 20:23:16 +0100404 FontResource* mFont;
405 ImageResource* mSlideoutImage;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200406 COLOR mForegroundColor;
407 COLOR mBackgroundColor;
408 COLOR mScrollColor;
that05360ba2015-02-06 00:58:16 +0100409 int mFontHeight;
410 int mCurrentLine; // index of last line to show; -1 to keep tracking last line
411 size_t mLastCount; // lines from gConsole that are already split and copied into rConsole
412 size_t RenderCount; // total number of lines after wrapping
413 int mMaxRows; // height of console in text rows
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200414 int mStartY;
415 int mSlideoutX, mSlideoutY, mSlideoutW, mSlideoutH;
416 int mSlideinX, mSlideinY, mSlideinW, mSlideinH;
417 int mConsoleX, mConsoleY, mConsoleW, mConsoleH;
418 int mLastTouchX, mLastTouchY;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200419 int mSlideout;
420 SlideoutState mSlideoutState;
Dees Troy31218ec2014-02-25 20:35:56 +0000421 std::vector<std::string> rConsole;
Ethan Yonkerbf2cb1c2014-07-02 10:15:54 -0500422 std::vector<std::string> rConsoleColor;
Dees Troy31218ec2014-02-25 20:35:56 +0000423 bool mRender;
Dees_Troy51a0e822012-09-05 15:24:24 -0400424
425protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200426 virtual int RenderSlideout(void);
427 virtual int RenderConsole(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400428};
429
Vojtech Bocekede51c52014-02-07 23:58:09 +0100430class GUIButton : public GUIObject, public RenderObject, public ActionObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400431{
432public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200433 GUIButton(xml_node<>* node);
434 virtual ~GUIButton();
Dees_Troy51a0e822012-09-05 15:24:24 -0400435
436public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200437 // Render - Render the full object to the GL surface
438 // Return 0 on success, <0 on error
439 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400440
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200441 // Update - Update any UI component animations (called <= 30 FPS)
442 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
443 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400444
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200445 // SetPos - Update the position of the render object
446 // Return 0 on success, <0 on error
447 virtual int SetRenderPos(int x, int y, int w = 0, int h = 0);
Dees_Troy51a0e822012-09-05 15:24:24 -0400448
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200449 // NotifyTouch - Notify of a touch event
450 // Return 0 on success, >0 to ignore remainder of touch, and <0 on error
451 virtual int NotifyTouch(TOUCH_STATE state, int x, int y);
Dees_Troy51a0e822012-09-05 15:24:24 -0400452
453protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200454 GUIImage* mButtonImg;
thatf6ed8fc2015-02-14 20:23:16 +0100455 ImageResource* mButtonIcon;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200456 GUIText* mButtonLabel;
457 GUIAction* mAction;
458 int mTextX, mTextY, mTextW, mTextH;
459 int mIconX, mIconY, mIconW, mIconH;
460 bool mRendered;
Dees_Troy1a7a6672013-02-15 09:39:07 -0600461 bool hasHighlightColor;
462 bool renderHighlight;
Dees_Troya13d74f2013-03-24 08:54:55 -0500463 bool hasFill;
464 COLOR mFillColor;
Dees_Troy1a7a6672013-02-15 09:39:07 -0600465 COLOR mHighlightColor;
Dees Troyb21cc642013-09-10 17:36:41 +0000466 Placement TextPlacement;
Dees_Troy51a0e822012-09-05 15:24:24 -0400467};
468
Vojtech Bocekede51c52014-02-07 23:58:09 +0100469class GUICheckbox: public GUIObject, public RenderObject, public ActionObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400470{
471public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200472 GUICheckbox(xml_node<>* node);
473 virtual ~GUICheckbox();
Dees_Troy51a0e822012-09-05 15:24:24 -0400474
475public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200476 // Render - Render the full object to the GL surface
477 // Return 0 on success, <0 on error
478 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400479
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200480 // Update - Update any UI component animations (called <= 30 FPS)
481 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
482 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400483
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200484 // SetPos - Update the position of the render object
485 // Return 0 on success, <0 on error
486 virtual int SetRenderPos(int x, int y, int w = 0, int h = 0);
Dees_Troy51a0e822012-09-05 15:24:24 -0400487
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200488 // NotifyTouch - Notify of a touch event
489 // Return 0 on success, >0 to ignore remainder of touch, and <0 on error
490 virtual int NotifyTouch(TOUCH_STATE state, int x, int y);
Dees_Troy51a0e822012-09-05 15:24:24 -0400491
492protected:
thatf6ed8fc2015-02-14 20:23:16 +0100493 ImageResource* mChecked;
494 ImageResource* mUnchecked;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200495 GUIText* mLabel;
496 int mTextX, mTextY;
497 int mCheckX, mCheckY, mCheckW, mCheckH;
498 int mLastState;
499 bool mRendered;
500 std::string mVarName;
Dees_Troy51a0e822012-09-05 15:24:24 -0400501};
502
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100503class GUIScrollList : public GUIObject, public RenderObject, public ActionObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400504{
505public:
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100506 GUIScrollList(xml_node<>* node);
507 virtual ~GUIScrollList();
Dees_Troy51a0e822012-09-05 15:24:24 -0400508
509public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200510 // Render - Render the full object to the GL surface
511 // Return 0 on success, <0 on error
512 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400513
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200514 // Update - Update any UI component animations (called <= 30 FPS)
515 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
516 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400517
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200518 // NotifyTouch - Notify of a touch event
519 // Return 0 on success, >0 to ignore remainder of touch, and <0 on error
520 virtual int NotifyTouch(TOUCH_STATE state, int x, int y);
Dees_Troy51a0e822012-09-05 15:24:24 -0400521
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200522 // NotifyVarChange - Notify of a variable change
Vojtech Bocek07220562014-02-08 02:05:33 +0100523 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
Dees_Troy51a0e822012-09-05 15:24:24 -0400524
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200525 // SetPos - Update the position of the render object
526 // Return 0 on success, <0 on error
527 virtual int SetRenderPos(int x, int y, int w = 0, int h = 0);
Dees_Troy51a0e822012-09-05 15:24:24 -0400528
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200529 // SetPageFocus - Notify when a page gains or loses focus
530 virtual void SetPageFocus(int inFocus);
Dees_Troy51a0e822012-09-05 15:24:24 -0400531
532protected:
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100533 // derived classes need to implement these
534 // get number of items
535 virtual size_t GetItemCount() { return 0; }
536 // get data for one item
thatf6ed8fc2015-02-14 20:23:16 +0100537 virtual int GetListItem(size_t item_index, ImageResource*& icon, std::string &text)
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100538 { icon = NULL; text = ""; return -1; }
539 // an item was selected
540 virtual void NotifySelect(size_t item_selected) {}
541
542 enum { NO_ITEM = (size_t)-1 };
543 // returns item index at coordinates or NO_ITEM if there is no item there
544 size_t HitTestItem(int x, int y);
545
546 // Called by the derived class to set the max icon size so we can calculate the proper actualItemHeight and center smaller icons if the icon size varies
547 void SetMaxIconSize(int w, int h);
548
549 // This will make sure that the item indicated by list_index is visible on the screen
550 void SetVisibleListLocation(size_t list_index);
551
552 // Handle scrolling changes for drags and kinetic scrolling
553 void HandleScrolling();
554
that9876ac32015-02-15 21:40:59 +0100555 // Returns many full rows the list is capable of displaying
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100556 int GetDisplayItemCount();
557
558 // Returns the size in pixels of a partial item or row size
559 int GetDisplayRemainder();
560
561protected:
562 // Background
563 COLOR mBackgroundColor;
thatf6ed8fc2015-02-14 20:23:16 +0100564 ImageResource* mBackground; // background image, if any, automatically centered
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100565 int mBackgroundW, mBackgroundH; // background width and height if using an image for the background
566
567 // Header
568 COLOR mHeaderBackgroundColor;
569 COLOR mHeaderFontColor;
570 std::string mHeaderText; // Original header text without parsing any variables
571 std::string mLastHeaderValue; // Header text after parsing variables
that9876ac32015-02-15 21:40:59 +0100572 bool mHeaderIsStatic; // indicates if the header is static (no need to check for changes in NotifyVarChange)
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100573 int mHeaderH; // actual header height including font, icon, padding, and separator heights
thatf6ed8fc2015-02-14 20:23:16 +0100574 ImageResource* mHeaderIcon;
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100575 int mHeaderIconHeight, mHeaderIconWidth; // width and height of the header icon if present
576 int mHeaderSeparatorH; // Height of the separator between header and list items
577 COLOR mHeaderSeparatorColor; // color of the header separator
578
579 // Per-item layout
thatf6ed8fc2015-02-14 20:23:16 +0100580 FontResource* mFont;
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100581 COLOR mFontColor;
that9876ac32015-02-15 21:40:59 +0100582 bool hasHighlightColor; // indicates if a highlight color was set
583 COLOR mHighlightColor; // background row highlight color
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100584 COLOR mFontHighlightColor;
585 int mFontHeight;
586 int actualItemHeight; // Actual height of each item in pixels including max icon size, font size, and padding
587 int maxIconWidth, maxIconHeight; // max icon width and height for the list, set by derived class in SetMaxIconSize
588 int mItemSpacing; // stores the spacing or padding on the y axis, part of the actualItemHeight
589 int mSeparatorH; // Height of the separator between items
590 COLOR mSeparatorColor; // color of the separator that is between items
591
thata9998212015-02-19 22:51:24 +0100592 // Scrollbar
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100593 int mFastScrollW; // width of the fastscroll area
594 int mFastScrollLineW; // width of the line for fastscroll rendering
595 int mFastScrollRectW; // width of the rectangle for fastscroll
thata9998212015-02-19 22:51:24 +0100596 int mFastScrollRectH; // minimum height of the rectangle for fastscroll
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100597 COLOR mFastScrollLineColor;
598 COLOR mFastScrollRectColor;
thata9998212015-02-19 22:51:24 +0100599
600 // Scrolling and dynamic state
601 int mFastScrollRectCurrentY; // current top of fastscroll rect relative to list top
602 int mFastScrollRectCurrentH; // current height of fastscroll rect
603 int mFastScrollRectTouchY; // offset from top of fastscroll rect where the user initially touched
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100604 bool hasScroll; // indicates that we have enough items in the list to scroll
605 int firstDisplayedItem; // this item goes at the top of the display list - may only be partially visible
606 int scrollingSpeed; // on a touch release, this is set based on the difference in the y-axis between the last 2 touches and indicates how fast the kinetic scrolling will go
607 int y_offset; // this is how many pixels offset in the y axis for per pixel scrolling, is always <= 0 and should never be < -actualItemHeight
608 size_t selectedItem; // selected item index after the initial touch, set to -1 if we are scrolling
609 int touchDebounce; // debounce for touches, minimum of 6 pixels but may be larger calculated based actualItemHeight / 3
610 int lastY, last2Y; // last 2 touch locations, used for tracking kinetic scroll speed
611 int fastScroll; // indicates that the inital touch was inside the fastscroll region - makes for easier fast scrolling as the touches don't have to stay within the fast scroll region and you drag your finger
612 int mUpdate; // indicates that a change took place and we need to re-render
613};
614
615class GUIFileSelector : public GUIScrollList
616{
617public:
618 GUIFileSelector(xml_node<>* node);
619 virtual ~GUIFileSelector();
620
621public:
622 // Update - Update any UI component animations (called <= 30 FPS)
623 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
624 virtual int Update(void);
625
626 // NotifyVarChange - Notify of a variable change
627 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
628
629 // SetPageFocus - Notify when a page gains or loses focus
630 virtual void SetPageFocus(int inFocus);
631
632 virtual size_t GetItemCount();
thatf6ed8fc2015-02-14 20:23:16 +0100633 virtual int GetListItem(size_t item_index, ImageResource*& icon, std::string &text);
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100634 virtual void NotifySelect(size_t item_selected);
635
636protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200637 struct FileData {
638 std::string fileName;
639 unsigned char fileType; // Uses d_type format from struct dirent
640 mode_t protection; // Uses mode_t format from stat
641 uid_t userId;
642 gid_t groupId;
643 off_t fileSize;
644 time_t lastAccess; // Uses time_t format from stat
645 time_t lastModified; // Uses time_t format from stat
646 time_t lastStatChange; // Uses time_t format from stat
647 };
Dees_Troy51a0e822012-09-05 15:24:24 -0400648
649protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200650 virtual int GetFileList(const std::string folder);
651 static bool fileSort(FileData d1, FileData d2);
Dees_Troy51a0e822012-09-05 15:24:24 -0400652
653protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200654 std::vector<FileData> mFolderList;
655 std::vector<FileData> mFileList;
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100656 std::string mPathVar; // current path displayed, saved in the data manager
Ethan Yonker21ff02a2015-02-18 14:35:00 -0600657 std::string mPathDefault; // default value for the path if none is set in mPathVar
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100658 std::string mExtn; // used for filtering the file list, for example, *.zip
659 std::string mVariable; // set when the user selects an item, pull path like /path/to/foo
660 std::string mSortVariable; // data manager variable used to change the sorting of files
661 std::string mSelection; // set when the user selects an item without the full path like selecting /path/to/foo would just be set to foo
662 int mShowFolders, mShowFiles; // indicates if the list should show folders and/or files
663 int mShowNavFolders; // indicates if the list should include the "up a level" item and allow you to traverse folders (nav folders are disabled for the restore list, for instance)
664 static int mSortOrder; // must be static because it is used by the static function fileSort
thatf6ed8fc2015-02-14 20:23:16 +0100665 ImageResource* mFolderIcon;
666 ImageResource* mFileIcon;
Dees_Troyc0583f52013-02-28 11:19:57 -0600667 bool updateFileList;
Dees_Troy51a0e822012-09-05 15:24:24 -0400668};
669
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100670class GUIListBox : public GUIScrollList
Dees_Troy51a0e822012-09-05 15:24:24 -0400671{
672public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200673 GUIListBox(xml_node<>* node);
674 virtual ~GUIListBox();
Dees_Troy51a0e822012-09-05 15:24:24 -0400675
676public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200677 // Update - Update any UI component animations (called <= 30 FPS)
678 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
679 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400680
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200681 // NotifyVarChange - Notify of a variable change
Vojtech Bocek07220562014-02-08 02:05:33 +0100682 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
Dees_Troy51a0e822012-09-05 15:24:24 -0400683
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200684 // SetPageFocus - Notify when a page gains or loses focus
685 virtual void SetPageFocus(int inFocus);
Dees_Troy51a0e822012-09-05 15:24:24 -0400686
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100687 virtual size_t GetItemCount();
thatf6ed8fc2015-02-14 20:23:16 +0100688 virtual int GetListItem(size_t item_index, ImageResource*& icon, std::string &text);
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100689 virtual void NotifySelect(size_t item_selected);
690
Dees_Troy51a0e822012-09-05 15:24:24 -0400691protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200692 struct ListData {
693 std::string displayName;
Dees_Troy51a0e822012-09-05 15:24:24 -0400694 std::string variableValue;
695 unsigned int selected;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200696 };
Dees_Troy51a0e822012-09-05 15:24:24 -0400697
698protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200699 std::vector<ListData> mList;
700 std::string mVariable;
Dees_Troy51a0e822012-09-05 15:24:24 -0400701 std::string currentValue;
thatf6ed8fc2015-02-14 20:23:16 +0100702 ImageResource* mIconSelected;
703 ImageResource* mIconUnselected;
Dees_Troy51a0e822012-09-05 15:24:24 -0400704};
705
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100706class GUIPartitionList : public GUIScrollList
Dees_Troya13d74f2013-03-24 08:54:55 -0500707{
708public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200709 GUIPartitionList(xml_node<>* node);
710 virtual ~GUIPartitionList();
Dees_Troya13d74f2013-03-24 08:54:55 -0500711
712public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200713 // Update - Update any UI component animations (called <= 30 FPS)
714 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100715 virtual int Update();
Dees_Troya13d74f2013-03-24 08:54:55 -0500716
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200717 // NotifyVarChange - Notify of a variable change
Vojtech Bocek07220562014-02-08 02:05:33 +0100718 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
Dees_Troya13d74f2013-03-24 08:54:55 -0500719
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200720 // SetPageFocus - Notify when a page gains or loses focus
721 virtual void SetPageFocus(int inFocus);
Dees_Troya13d74f2013-03-24 08:54:55 -0500722
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100723 virtual size_t GetItemCount();
thatf6ed8fc2015-02-14 20:23:16 +0100724 virtual int GetListItem(size_t item_index, ImageResource*& icon, std::string &text);
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100725 virtual void NotifySelect(size_t item_selected);
726
Dees_Troya13d74f2013-03-24 08:54:55 -0500727protected:
Ethan Yonker0a3a98f2015-02-05 00:48:28 +0100728 void MatchList();
Ethan Yonkercfd65092015-02-14 10:39:21 -0600729 void SetPosition();
Dees_Troya13d74f2013-03-24 08:54:55 -0500730
731protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200732 std::vector<PartitionList> mList;
Dees_Troya13d74f2013-03-24 08:54:55 -0500733 std::string ListType;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200734 std::string mVariable;
Dees_Troya13d74f2013-03-24 08:54:55 -0500735 std::string selectedList;
736 std::string currentValue;
Dees_Troya13d74f2013-03-24 08:54:55 -0500737 std::string mLastValue;
thatf6ed8fc2015-02-14 20:23:16 +0100738 ImageResource* mIconSelected;
739 ImageResource* mIconUnselected;
Dees_Troya13d74f2013-03-24 08:54:55 -0500740 bool updateList;
741};
742
Dees_Troy51a0e822012-09-05 15:24:24 -0400743// GUIAnimation - Used for animations
Vojtech Bocekede51c52014-02-07 23:58:09 +0100744class GUIAnimation : public GUIObject, public RenderObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400745{
746public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200747 GUIAnimation(xml_node<>* node);
Dees_Troy51a0e822012-09-05 15:24:24 -0400748
749public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200750 // Render - Render the full object to the GL surface
751 // Return 0 on success, <0 on error
752 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400753
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200754 // Update - Update any UI component animations (called <= 30 FPS)
755 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
756 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400757
758protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200759 AnimationResource* mAnimation;
760 int mFrame;
761 int mFPS;
762 int mLoop;
763 int mRender;
764 int mUpdateCount;
Dees_Troy51a0e822012-09-05 15:24:24 -0400765};
766
Vojtech Bocekede51c52014-02-07 23:58:09 +0100767class GUIProgressBar : public GUIObject, public RenderObject, public ActionObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400768{
769public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200770 GUIProgressBar(xml_node<>* node);
Dees_Troy51a0e822012-09-05 15:24:24 -0400771
772public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200773 // Render - Render the full object to the GL surface
774 // Return 0 on success, <0 on error
775 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400776
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200777 // Update - Update any UI component animations (called <= 30 FPS)
778 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
779 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400780
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200781 // NotifyVarChange - Notify of a variable change
782 // Returns 0 on success, <0 on error
Vojtech Bocek07220562014-02-08 02:05:33 +0100783 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
Dees_Troy51a0e822012-09-05 15:24:24 -0400784
785protected:
thatf6ed8fc2015-02-14 20:23:16 +0100786 ImageResource* mEmptyBar;
787 ImageResource* mFullBar;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200788 std::string mMinValVar;
789 std::string mMaxValVar;
790 std::string mCurValVar;
791 float mSlide;
792 float mSlideInc;
793 int mSlideFrames;
794 int mLastPos;
Dees_Troy51a0e822012-09-05 15:24:24 -0400795
796protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200797 virtual int RenderInternal(void); // Does the actual render
Dees_Troy51a0e822012-09-05 15:24:24 -0400798};
799
Vojtech Bocekede51c52014-02-07 23:58:09 +0100800class GUISlider : public GUIObject, public RenderObject, public ActionObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400801{
802public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200803 GUISlider(xml_node<>* node);
804 virtual ~GUISlider();
Dees_Troy51a0e822012-09-05 15:24:24 -0400805
806public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200807 // Render - Render the full object to the GL surface
808 // Return 0 on success, <0 on error
809 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400810
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200811 // Update - Update any UI component animations (called <= 30 FPS)
812 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
813 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400814
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200815 // NotifyTouch - Notify of a touch event
816 // Return 0 on success, >0 to ignore remainder of touch, and <0 on error
817 virtual int NotifyTouch(TOUCH_STATE state, int x, int y);
Dees_Troy51a0e822012-09-05 15:24:24 -0400818
819protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200820 GUIAction* sAction;
Ethan Yonker21ff02a2015-02-18 14:35:00 -0600821 GUIText* sSliderLabel;
thatf6ed8fc2015-02-14 20:23:16 +0100822 ImageResource* sSlider;
823 ImageResource* sSliderUsed;
824 ImageResource* sTouch;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200825 int sTouchW, sTouchH;
826 int sCurTouchX;
827 int sUpdate;
Dees_Troy51a0e822012-09-05 15:24:24 -0400828};
829
830#define MAX_KEYBOARD_LAYOUTS 5
831#define MAX_KEYBOARD_ROWS 9
832#define MAX_KEYBOARD_KEYS 20
833#define KEYBOARD_ACTION 253
834#define KEYBOARD_LAYOUT 254
835#define KEYBOARD_SWIPE_LEFT 252
836#define KEYBOARD_SWIPE_RIGHT 251
837#define KEYBOARD_ARROW_LEFT 250
838#define KEYBOARD_ARROW_RIGHT 249
839#define KEYBOARD_HOME 248
840#define KEYBOARD_END 247
841#define KEYBOARD_ARROW_UP 246
842#define KEYBOARD_ARROW_DOWN 245
843#define KEYBOARD_SPECIAL_KEYS 245
844#define KEYBOARD_BACKSPACE 8
845
Vojtech Bocekede51c52014-02-07 23:58:09 +0100846class GUIKeyboard : public GUIObject, public RenderObject, public ActionObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400847{
848public:
849 GUIKeyboard(xml_node<>* node);
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200850 virtual ~GUIKeyboard();
Dees_Troy51a0e822012-09-05 15:24:24 -0400851
852public:
853 virtual int Render(void);
854 virtual int Update(void);
855 virtual int NotifyTouch(TOUCH_STATE state, int x, int y);
856 virtual int SetRenderPos(int x, int y, int w = 0, int h = 0);
857
858protected:
859 virtual int GetSelection(int x, int y);
860
861protected:
862 struct keyboard_key_class
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200863 {
864 unsigned char key;
Dees_Troy51a0e822012-09-05 15:24:24 -0400865 unsigned char longpresskey;
that1a7ba972015-02-01 19:48:19 +0100866 int end_x;
867 int layout;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200868 };
that1a7ba972015-02-01 19:48:19 +0100869 int ParseKey(const char* keyinfo, keyboard_key_class& key, int& Xindex, int keyWidth, bool longpress);
Ethan Yonkerc3120d42014-02-17 07:55:00 -0600870 struct capslock_tracking_struct
871 {
872 int capslock;
873 int set_capslock;
874 int revert_layout;
875 };
Dees_Troy51a0e822012-09-05 15:24:24 -0400876
thatf6ed8fc2015-02-14 20:23:16 +0100877 ImageResource* keyboardImg[MAX_KEYBOARD_LAYOUTS];
Dees_Troy51a0e822012-09-05 15:24:24 -0400878 struct keyboard_key_class keyboard_keys[MAX_KEYBOARD_LAYOUTS][MAX_KEYBOARD_ROWS][MAX_KEYBOARD_KEYS];
Ethan Yonkerc3120d42014-02-17 07:55:00 -0600879 struct capslock_tracking_struct caps_tracking[MAX_KEYBOARD_LAYOUTS];
Dees_Troy51a0e822012-09-05 15:24:24 -0400880 bool mRendered;
881 std::string mVariable;
that1a7ba972015-02-01 19:48:19 +0100882 int currentLayout;
883 int row_heights[MAX_KEYBOARD_LAYOUTS][MAX_KEYBOARD_ROWS];
Dees_Troy51a0e822012-09-05 15:24:24 -0400884 unsigned int KeyboardWidth, KeyboardHeight;
Ethan Yonker21ff02a2015-02-18 14:35:00 -0600885 int rowY, colX, highlightRenderCount;
886 bool hasHighlight, hasCapsHighlight;
Dees_Troy51a0e822012-09-05 15:24:24 -0400887 GUIAction* mAction;
Dees_Troy30b962e2012-10-19 20:48:59 -0400888 COLOR mHighlightColor;
Ethan Yonkerc3120d42014-02-17 07:55:00 -0600889 COLOR mCapsHighlightColor;
Dees_Troy51a0e822012-09-05 15:24:24 -0400890};
891
892// GUIInput - Used for keyboard input
Vojtech Bocekede51c52014-02-07 23:58:09 +0100893class GUIInput : public GUIObject, public RenderObject, public ActionObject, public InputObject
Dees_Troy51a0e822012-09-05 15:24:24 -0400894{
895public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200896 GUIInput(xml_node<>* node);
Dees_Troy51a0e822012-09-05 15:24:24 -0400897 virtual ~GUIInput();
898
899public:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200900 // Render - Render the full object to the GL surface
901 // Return 0 on success, <0 on error
902 virtual int Render(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400903
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200904 // Update - Update any UI component animations (called <= 30 FPS)
905 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
906 virtual int Update(void);
Dees_Troy51a0e822012-09-05 15:24:24 -0400907
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200908 // Notify of a variable change
Vojtech Bocek07220562014-02-08 02:05:33 +0100909 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
Dees_Troy51a0e822012-09-05 15:24:24 -0400910
911 // NotifyTouch - Notify of a touch event
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200912 // Return 0 on success, >0 to ignore remainder of touch, and <0 on error
913 virtual int NotifyTouch(TOUCH_STATE state, int x, int y);
Dees_Troy51a0e822012-09-05 15:24:24 -0400914
915 virtual int NotifyKeyboard(int key);
916
917protected:
918 virtual int GetSelection(int x, int y);
919
920 // Handles displaying the text properly when chars are added, deleted, or for scrolling
921 virtual int HandleTextLocation(int x);
922
923protected:
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200924 GUIText* mInputText;
Dees_Troy51a0e822012-09-05 15:24:24 -0400925 GUIAction* mAction;
thatf6ed8fc2015-02-14 20:23:16 +0100926 ImageResource* mBackground;
927 ImageResource* mCursor;
928 FontResource* mFont;
Dees_Troy51a0e822012-09-05 15:24:24 -0400929 std::string mText;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200930 std::string mLastValue;
Dees_Troy51a0e822012-09-05 15:24:24 -0400931 std::string mVariable;
932 std::string mMask;
933 std::string mMaskVariable;
Vojtech Bocekfafb0c52013-07-25 22:53:02 +0200934 COLOR mBackgroundColor;
Dees_Troy51a0e822012-09-05 15:24:24 -0400935 COLOR mCursorColor;
936 int scrollingX;
937 int lastX;
938 int mCursorLocation;
939 int mBackgroundX, mBackgroundY, mBackgroundW, mBackgroundH;
940 int mFontY;
941 unsigned skipChars;
942 unsigned mFontHeight;
943 unsigned CursorWidth;
944 bool mRendered;
945 bool HasMask;
946 bool DrawCursor;
947 bool isLocalChange;
948 bool HasAllowed;
949 bool HasDisabled;
950 std::string AllowedList;
951 std::string DisabledList;
952 unsigned MinLen;
953 unsigned MaxLen;
954};
955
956class HardwareKeyboard
957{
958public:
thatf37aec22015-02-01 13:38:35 +0100959 HardwareKeyboard();
Dees_Troy51a0e822012-09-05 15:24:24 -0400960 virtual ~HardwareKeyboard();
961
962public:
thatf37aec22015-02-01 13:38:35 +0100963 // called by the input handler for key events
964 int KeyDown(int key_code);
965 int KeyUp(int key_code);
Vojtech Bocek0b7fe502014-03-13 17:36:52 +0100966
thatf37aec22015-02-01 13:38:35 +0100967 // called by the input handler when holding a key down
968 int KeyRepeat();
969
970 // called by multi-key actions to suppress key-release notifications
Vojtech Bocek0b7fe502014-03-13 17:36:52 +0100971 void ConsumeKeyRelease(int key);
972
973private:
thatf37aec22015-02-01 13:38:35 +0100974 int mLastKeyChar;
Vojtech Bocek0b7fe502014-03-13 17:36:52 +0100975 std::set<int> mPressedKeys;
Dees_Troy51a0e822012-09-05 15:24:24 -0400976};
977
Vojtech Bocekede51c52014-02-07 23:58:09 +0100978class GUISliderValue: public GUIObject, public RenderObject, public ActionObject
Vojtech Bocek85932342013-04-01 22:11:33 +0200979{
980public:
981 GUISliderValue(xml_node<>* node);
982 virtual ~GUISliderValue();
983
984public:
985 // Render - Render the full object to the GL surface
986 // Return 0 on success, <0 on error
987 virtual int Render(void);
988
989 // Update - Update any UI component animations (called <= 30 FPS)
990 // Return 0 if nothing to update, 1 on success and contiue, >1 if full render required, and <0 on error
991 virtual int Update(void);
992
993 // SetPos - Update the position of the render object
994 // Return 0 on success, <0 on error
995 virtual int SetRenderPos(int x, int y, int w = 0, int h = 0);
996
997 // NotifyTouch - Notify of a touch event
998 // Return 0 on success, >0 to ignore remainder of touch, and <0 on error
999 virtual int NotifyTouch(TOUCH_STATE state, int x, int y);
1000
1001 // Notify of a variable change
Vojtech Bocek07220562014-02-08 02:05:33 +01001002 virtual int NotifyVarChange(const std::string& varName, const std::string& value);
Vojtech Bocek85932342013-04-01 22:11:33 +02001003
1004 // SetPageFocus - Notify when a page gains or loses focus
1005 virtual void SetPageFocus(int inFocus);
1006
1007protected:
1008 int measureText(const std::string& str);
1009 int valueFromPct(float pct);
1010 float pctFromValue(int value);
1011 void loadValue(bool force = false);
1012
1013 std::string mVariable;
1014 int mMax;
1015 int mMin;
1016 int mValue;
1017 char *mValueStr;
1018 float mValuePct;
1019 std::string mMaxStr;
1020 std::string mMinStr;
thatf6ed8fc2015-02-14 20:23:16 +01001021 FontResource *mFont;
Vojtech Bocek85932342013-04-01 22:11:33 +02001022 GUIText* mLabel;
1023 int mLabelW;
1024 COLOR mTextColor;
1025 COLOR mLineColor;
1026 COLOR mSliderColor;
1027 bool mShowRange;
1028 bool mShowCurr;
1029 int mLineX;
1030 int mLineY;
1031 int mLineH;
1032 int mLinePadding;
1033 int mPadding;
1034 int mSliderY;
1035 int mSliderW;
1036 int mSliderH;
1037 bool mRendered;
1038 int mFontHeight;
1039 GUIAction *mAction;
1040 bool mChangeOnDrag;
Vojtech Bocek18d7c982014-08-04 17:19:28 +02001041 int mLineW;
1042 bool mDragging;
thatf6ed8fc2015-02-14 20:23:16 +01001043 ImageResource *mBackgroundImage;
1044 ImageResource *mHandleImage;
1045 ImageResource *mHandleHoverImage;
Vojtech Bocek85932342013-04-01 22:11:33 +02001046};
1047
Vojtech Bocek1fc30fc2014-01-29 18:37:19 +01001048class MouseCursor : public RenderObject
1049{
1050public:
1051 MouseCursor(int posX, int posY);
1052 virtual ~MouseCursor();
1053
1054 virtual int Render(void);
1055 virtual int Update(void);
1056 virtual int SetRenderPos(int x, int y, int w = 0, int h = 0);
1057
1058 void Move(int deltaX, int deltaY);
1059 void GetPos(int& x, int& y);
1060 void LoadData(xml_node<>* node);
1061 void ResetData(int resX, int resY);
1062
1063private:
1064 int m_resX;
1065 int m_resY;
1066 bool m_moved;
1067 float m_speedMultiplier;
1068 COLOR m_color;
thatf6ed8fc2015-02-14 20:23:16 +01001069 ImageResource *m_image;
Vojtech Bocek1fc30fc2014-01-29 18:37:19 +01001070 bool m_present;
1071};
1072
Dees_Troy51a0e822012-09-05 15:24:24 -04001073// Helper APIs
Ethan Yonker21ff02a2015-02-18 14:35:00 -06001074xml_node<>* FindNode(xml_node<>* parent, const char* nodename, int depth = 0);
thatf6ed8fc2015-02-14 20:23:16 +01001075std::string LoadAttrString(xml_node<>* element, const char* attrname, const char* defaultvalue = "");
1076int LoadAttrInt(xml_node<>* element, const char* attrname, int defaultvalue = 0);
1077int LoadAttrIntScaleX(xml_node<>* element, const char* attrname, int defaultvalue = 0);
1078int LoadAttrIntScaleY(xml_node<>* element, const char* attrname, int defaultvalue = 0);
Ethan Yonker21ff02a2015-02-18 14:35:00 -06001079COLOR LoadAttrColor(xml_node<>* element, const char* attrname, bool* found_color, COLOR defaultvalue = COLOR(0,0,0,0));
thatf6ed8fc2015-02-14 20:23:16 +01001080COLOR LoadAttrColor(xml_node<>* element, const char* attrname, COLOR defaultvalue = COLOR(0,0,0,0));
1081FontResource* LoadAttrFont(xml_node<>* element, const char* attrname);
1082ImageResource* LoadAttrImage(xml_node<>* element, const char* attrname);
1083AnimationResource* LoadAttrAnimation(xml_node<>* element, const char* attrname);
1084
Dees_Troy51a0e822012-09-05 15:24:24 -04001085bool LoadPlacement(xml_node<>* node, int* x, int* y, int* w = NULL, int* h = NULL, RenderObject::Placement* placement = NULL);
1086
1087#endif // _OBJECTS_HEADER
1088