summaryrefslogtreecommitdiff
path: root/base/src/main/java/com/smartdevicelink/managers/screen/menu/BaseMenuManager.java
blob: 053f90c8cd58bf7997a6f5dd5fa0a1a624282bc2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
/*
 * Copyright (c) 2019 Livio, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Livio Inc. nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package com.smartdevicelink.managers.screen.menu;

import androidx.annotation.NonNull;

import com.smartdevicelink.managers.BaseSubManager;
import com.smartdevicelink.managers.CompletionListener;
import com.smartdevicelink.managers.ManagerUtility;
import com.smartdevicelink.managers.file.FileManager;
import com.smartdevicelink.managers.file.MultipleFileCompletionListener;
import com.smartdevicelink.managers.file.filetypes.SdlArtwork;
import com.smartdevicelink.managers.lifecycle.OnSystemCapabilityListener;
import com.smartdevicelink.managers.lifecycle.SystemCapabilityManager;
import com.smartdevicelink.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCNotification;
import com.smartdevicelink.proxy.RPCRequest;
import com.smartdevicelink.proxy.RPCResponse;
import com.smartdevicelink.proxy.interfaces.ISdl;
import com.smartdevicelink.proxy.rpc.AddCommand;
import com.smartdevicelink.proxy.rpc.AddSubMenu;
import com.smartdevicelink.proxy.rpc.DeleteCommand;
import com.smartdevicelink.proxy.rpc.DeleteSubMenu;
import com.smartdevicelink.proxy.rpc.DisplayCapability;
import com.smartdevicelink.proxy.rpc.MenuParams;
import com.smartdevicelink.proxy.rpc.OnCommand;
import com.smartdevicelink.proxy.rpc.OnHMIStatus;
import com.smartdevicelink.proxy.rpc.SdlMsgVersion;
import com.smartdevicelink.proxy.rpc.SetGlobalProperties;
import com.smartdevicelink.proxy.rpc.ShowAppMenu;
import com.smartdevicelink.proxy.rpc.WindowCapability;
import com.smartdevicelink.proxy.rpc.enums.DisplayType;
import com.smartdevicelink.proxy.rpc.enums.HMILevel;
import com.smartdevicelink.proxy.rpc.enums.ImageFieldName;
import com.smartdevicelink.proxy.rpc.enums.PredefinedWindows;
import com.smartdevicelink.proxy.rpc.enums.SystemCapabilityType;
import com.smartdevicelink.proxy.rpc.enums.SystemContext;
import com.smartdevicelink.proxy.rpc.listeners.OnMultipleRequestListener;
import com.smartdevicelink.proxy.rpc.listeners.OnRPCNotificationListener;
import com.smartdevicelink.proxy.rpc.listeners.OnRPCResponseListener;
import com.smartdevicelink.util.DebugTool;

import org.json.JSONException;

import java.lang.ref.WeakReference;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;

abstract class BaseMenuManager extends BaseSubManager {
	private static final String TAG = "BaseMenuManager";
	private static final int KEEP = 0;
	private static final int MARKED_FOR_ADDITION = 1;
	private static final int MARKED_FOR_DELETION = 2;

	private final WeakReference<FileManager> fileManager;

	List<MenuCell> menuCells, waitingUpdateMenuCells, oldMenuCells, keepsNew, keepsOld;
	List<RPCRequest> inProgressUpdate;
	DynamicMenuUpdatesMode dynamicMenuUpdatesMode;
	MenuConfiguration menuConfiguration;
	SdlMsgVersion sdlMsgVersion;
	private String displayType;

	boolean waitingOnHMIUpdate;
	private boolean hasQueuedUpdate;
	HMILevel currentHMILevel;

	OnRPCNotificationListener hmiListener, commandListener;
	OnSystemCapabilityListener onDisplaysCapabilityListener;
	WindowCapability defaultMainWindowCapability;

	private static final int MAX_ID = 2000000000;
	private static final int parentIdNotFound = MAX_ID;
	private static final int menuCellIdMin = 1;
	int lastMenuId;

	SystemContext currentSystemContext;

	BaseMenuManager(@NonNull ISdl internalInterface, @NonNull FileManager fileManager) {

		super(internalInterface);

		// Set up some Vars
		this.fileManager = new WeakReference<>(fileManager);
		currentSystemContext = SystemContext.SYSCTXT_MAIN;
		currentHMILevel = HMILevel.HMI_NONE;
		lastMenuId = menuCellIdMin;
		dynamicMenuUpdatesMode = DynamicMenuUpdatesMode.ON_WITH_COMPAT_MODE;
		sdlMsgVersion = internalInterface.getSdlMsgVersion();

		addListeners();
	}

	@Override
	public void start(CompletionListener listener) {
		transitionToState(READY);
		super.start(listener);
	}

	@Override
	public void dispose(){

		lastMenuId = menuCellIdMin;
		menuCells = null;
		oldMenuCells = null;
		currentHMILevel = null;
		currentSystemContext = SystemContext.SYSCTXT_MAIN;
		dynamicMenuUpdatesMode = DynamicMenuUpdatesMode.ON_WITH_COMPAT_MODE;
		defaultMainWindowCapability = null;
		inProgressUpdate = null;
		hasQueuedUpdate = false;
		waitingOnHMIUpdate = false;
		waitingUpdateMenuCells = null;
		keepsNew = null;
		keepsOld = null;
		menuConfiguration = null;
		sdlMsgVersion = null;

		// remove listeners
		internalInterface.removeOnRPCNotificationListener(FunctionID.ON_HMI_STATUS, hmiListener);
		internalInterface.removeOnRPCNotificationListener(FunctionID.ON_COMMAND, commandListener);
		if (internalInterface.getSystemCapabilityManager() != null) {
			internalInterface.getSystemCapabilityManager().removeOnSystemCapabilityListener(SystemCapabilityType.DISPLAYS, onDisplaysCapabilityListener);
		}

		super.dispose();
	}

	// SETTERS

	public void setDynamicUpdatesMode(@NonNull DynamicMenuUpdatesMode value){
		this.dynamicMenuUpdatesMode = value;
	}

	/**
	 * Creates and sends all associated Menu RPCs
	 * @param cells - the menu cells that are to be sent to the head unit, including their sub-cells.
	 */
	public void setMenuCells(@NonNull List<MenuCell> cells){

		// Create a deep copy of the list so future changes by developers don't affect the algorithm logic
		List <MenuCell> clonedCells = cloneMenuCellsList(cells);

		if (currentHMILevel == null || currentHMILevel.equals(HMILevel.HMI_NONE) || currentSystemContext.equals(SystemContext.SYSCTXT_MENU)){
			// We are in NONE or the menu is in use, bail out of here
			waitingOnHMIUpdate = true;
			waitingUpdateMenuCells = new ArrayList<>();
			if (clonedCells != null && !clonedCells.isEmpty()) {
				waitingUpdateMenuCells.addAll(clonedCells);
			}
			return;
		}
		waitingOnHMIUpdate = false;

		// Update our Lists
		// set old list
		if (menuCells != null) {
			oldMenuCells = new ArrayList<>(menuCells);
		}
		// copy new list
		menuCells = new ArrayList<>();
		if (clonedCells != null && !clonedCells.isEmpty()) {
			menuCells.addAll(clonedCells);
		}

		// HashSet order doesnt matter / does not allow duplicates
		HashSet<String> titleCheckSet = new HashSet<>();
		HashSet<String> allMenuVoiceCommands = new HashSet<>();
		int voiceCommandCount = 0;

		for (MenuCell cell : menuCells){
			titleCheckSet.add(cell.getTitle());
			if (cell.getVoiceCommands() != null){
				allMenuVoiceCommands.addAll(cell.getVoiceCommands());
				voiceCommandCount += cell.getVoiceCommands().size();
			}
		}
		// Check for duplicate titles
		if (titleCheckSet.size() != menuCells.size()){
			DebugTool.logError(TAG, "Not all cell titles are unique. The menu will not be set");
			return;
		}

		// Check for duplicate voice commands
		if (allMenuVoiceCommands.size() != voiceCommandCount){
			DebugTool.logError(TAG, "Attempted to create a menu with duplicate voice commands. Voice commands must be unique. The menu will not be set");
			return;
		}

		// Upload the Artworks
		List<SdlArtwork> artworksToBeUploaded = findAllArtworksToBeUploadedFromCells(menuCells);
		if (artworksToBeUploaded.size() > 0 && fileManager.get() != null){
			fileManager.get().uploadArtworks(artworksToBeUploaded, new MultipleFileCompletionListener() {
				@Override
				public void onComplete(Map<String, String> errors) {

					if (errors != null && errors.size() > 0){
						DebugTool.logError(TAG, "Error uploading Menu Artworks: "+ errors.toString());
					}else{
						DebugTool.logInfo(TAG, "Menu Artworks Uploaded");
					}
					// proceed
					updateMenuAndDetermineBestUpdateMethod();
				}
			});
		}else{
			// No Artworks to be uploaded, send off
			updateMenuAndDetermineBestUpdateMethod();
		}
	}

	/**
	 * Returns current list of menu cells
	 * @return a List of Currently set menu cells
	 */
	public List<MenuCell> getMenuCells(){

		if (menuCells != null) {
			return menuCells;
		} else if (waitingOnHMIUpdate && waitingUpdateMenuCells != null) {
			// this will keep from returning null if the menu list is set and we are pending HMI FULL
			return  waitingUpdateMenuCells;
		} else {
			return null;
		}
	}

	/**
	 * @return The currently set DynamicMenuUpdatesMode. It defaults to ON_WITH_COMPAT_MODE
	 */
	public DynamicMenuUpdatesMode getDynamicMenuUpdatesMode() {
		return this.dynamicMenuUpdatesMode;
	}

    // OPEN MENU RPCs

    /**
     * Opens the Main Menu
     */
    public boolean openMenu(){

        if (sdlMsgVersion.getMajorVersion() < 6){
            DebugTool.logWarning(TAG, "Menu opening is only supported on head units with RPC spec version 6.0.0 or later. Currently connected head unit RPC spec version is: "+sdlMsgVersion.getMajorVersion() + "." + sdlMsgVersion.getMinorVersion()+ "." +sdlMsgVersion.getPatchVersion());
            return false;
        }
        
        ShowAppMenu showAppMenu = new ShowAppMenu();
        showAppMenu.setOnRPCResponseListener(new OnRPCResponseListener() {
            @Override
            public void onResponse(int correlationId, RPCResponse response) {
                if (response.getSuccess()){
                    DebugTool.logInfo(TAG, "Open Main Menu Request Successful");
                } else {
                    DebugTool.logError(TAG, "Open Main Menu Request Failed");
                }
            }
        });
        internalInterface.sendRPC(showAppMenu);
        return true;
    }

    /**
     * Opens a subMenu. The cell you pass in must be constructed with {@link MenuCell(String,SdlArtwork,List)}
     * @param cell - A <Strong>SubMenu</Strong> cell whose sub menu you wish to open
     */
    public boolean openSubMenu(@NonNull MenuCell cell){

        if (sdlMsgVersion.getMajorVersion() < 6){
            DebugTool.logWarning(TAG, "Sub menu opening is only supported on head units with RPC spec version 6.0.0 or later. Currently connected head unit RPC spec version is: "+sdlMsgVersion.getMajorVersion() + "." + sdlMsgVersion.getMinorVersion()+ "." +sdlMsgVersion.getPatchVersion());
            return false;
        }

        if (oldMenuCells == null){
            DebugTool.logError(TAG, "open sub menu called, but no Menu cells have been set");
            return false;
        }
        // We must see if we have a copy of this cell, since we clone the objects
        for (MenuCell clonedCell : oldMenuCells){
            if (clonedCell.equals(cell) && clonedCell.getCellId() != MAX_ID){
                // We've found the correct sub menu cell
				sendOpenSubMenu(clonedCell.getCellId());
				return true;
            }
        }
        return false;
    }

    private void sendOpenSubMenu(Integer id){

        ShowAppMenu showAppMenu = new ShowAppMenu();
        showAppMenu.setMenuID(id);
        showAppMenu.setOnRPCResponseListener(new OnRPCResponseListener() {
            @Override
            public void onResponse(int correlationId, RPCResponse response) {
                if (response.getSuccess()){
                    DebugTool.logInfo(TAG, "Open Sub Menu Request Successful");
                } else {
                    DebugTool.logError(TAG, "Open Sub Menu Request Failed");
                }
            }
        });

        internalInterface.sendRPC(showAppMenu);
    }

    // MENU CONFIG

        /**
     * This method is called via the screen manager to set the menuConfiguration.
     * This will be used when a menu item with sub-cells has a null value for menuConfiguration
     * @param menuConfiguration - The default menuConfiguration
     */
    public void setMenuConfiguration(@NonNull final MenuConfiguration menuConfiguration) {

        if (sdlMsgVersion == null) {
            DebugTool.logError(TAG, "SDL Message Version is null. Cannot set Menu Configuration");
            return;
        }

        if (sdlMsgVersion.getMajorVersion() < 6){
            DebugTool.logWarning(TAG, "Menu configurations is only supported on head units with RPC spec version 6.0.0 or later. Currently connected head unit RPC spec version is: "+sdlMsgVersion.getMajorVersion() + "." + sdlMsgVersion.getMinorVersion()+ "." +sdlMsgVersion.getPatchVersion());
            return;
        }

        if (currentHMILevel == null || currentHMILevel.equals(HMILevel.HMI_NONE) || currentSystemContext.equals(SystemContext.SYSCTXT_MENU)){
            // We are in NONE or the menu is in use, bail out of here
            DebugTool.logError(TAG, "Could not set main menu configuration, HMI level: "+currentHMILevel+", required: 'Not-NONE', system context: "+currentSystemContext+", required: 'Not MENU'");
            return;
        }

        // In the future, when the manager is switched to use queues, the menuConfiguration should be set when SetGlobalProperties response is received
        this.menuConfiguration = menuConfiguration;

        if (menuConfiguration.getMenuLayout() != null) {

			SetGlobalProperties setGlobalProperties = new SetGlobalProperties();
			setGlobalProperties.setMenuLayout(menuConfiguration.getMenuLayout());
			setGlobalProperties.setOnRPCResponseListener(new OnRPCResponseListener() {
				@Override
				public void onResponse(int correlationId, RPCResponse response) {
					if (response.getSuccess()) {
						DebugTool.logInfo(TAG, "Menu Configuration successfully set: " + menuConfiguration.toString());
					} else {
						DebugTool.logError(TAG, "onError: " + response.getResultCode() + " | Info: " + response.getInfo());
					}
				}
			});
			internalInterface.sendRPC(setGlobalProperties);
		} else {
			DebugTool.logInfo(TAG, "Menu Layout is null, not sending setGlobalProperties");
		}
    }

    public MenuConfiguration getMenuConfiguration(){
        return this.menuConfiguration;
    }
	// UPDATING SYSTEM

	// ROOT MENU

	private void updateMenuAndDetermineBestUpdateMethod(){

		if (currentHMILevel == null || currentHMILevel.equals(HMILevel.HMI_NONE) || currentSystemContext.equals(SystemContext.SYSCTXT_MENU)){
			// We are in NONE or the menu is in use, bail out of here
			DebugTool.logInfo(TAG, "HMI in None or System Context Menu, returning");
			waitingOnHMIUpdate = true;
			waitingUpdateMenuCells = menuCells;
			return;
		}

		if (inProgressUpdate != null && inProgressUpdate.size() > 0){
			// there's an in-progress update so this needs to wait
			DebugTool.logInfo(TAG, "There is an in progress Menu Update, returning");
			hasQueuedUpdate = true;
			return;
		}

		// Checks against what the developer set for update mode and against the display type
		// to determine how the menu will be updated. This has the ability to be changed during
		// a session.
		if (checkUpdateMode(dynamicMenuUpdatesMode, displayType)) {
			// run the lists through the new algorithm
			RunScore rootScore = runMenuCompareAlgorithm(oldMenuCells, menuCells);
			if (rootScore == null) {
				// send initial menu (score will return null)
				// make a copy of our current cells
				DebugTool.logInfo(TAG, "Creating initial Menu");
				// Set the IDs if needed
				lastMenuId = menuCellIdMin;
				updateIdsOnMenuCells(menuCells, parentIdNotFound);
				this.oldMenuCells = new ArrayList<>(menuCells);
				createAndSendEntireMenu();
			} else {
				DebugTool.logInfo(TAG, "Dynamically Updating Menu");
				if (menuCells.size() == 0 && (oldMenuCells != null && oldMenuCells.size() > 0)) {
					// the dev wants to clear the menu. We have old cells and an empty array of new ones.
					deleteMenuWhenNewCellsEmpty();
				} else {
					// lets dynamically update the root menu
					dynamicallyUpdateRootMenu(rootScore);
				}
			}
		} else {
			// we are in compatibility mode
			DebugTool.logInfo(TAG, "Updating menus in compatibility mode");
			lastMenuId = menuCellIdMin;
			updateIdsOnMenuCells(menuCells, parentIdNotFound);
			// if the old cell array is not null, we want to delete the entire thing, else copy the new array
			if (oldMenuCells == null) {
				this.oldMenuCells = new ArrayList<>(menuCells);
			}
			createAndSendEntireMenu();
		}
	}

	private boolean checkUpdateMode(DynamicMenuUpdatesMode updateMode, String displayType){

		if (updateMode.equals(DynamicMenuUpdatesMode.ON_WITH_COMPAT_MODE)){
			if (displayType == null){
				return true;
			}
			return (!displayType.equals(DisplayType.GEN3_8_INCH.toString()));

		} else if (updateMode.equals(DynamicMenuUpdatesMode.FORCE_OFF)){
			return false;
		} else if (updateMode.equals(DynamicMenuUpdatesMode.FORCE_ON)){
			return true;
		}

		return true;
	}

	private void deleteMenuWhenNewCellsEmpty(){
		sendDeleteRPCs(createDeleteRPCsForCells(oldMenuCells), new CompletionListener() {
			@Override
			public void onComplete(boolean success) {
				inProgressUpdate = null;

				if (!success){
					DebugTool.logError(TAG, "Error Sending Current Menu");
				}else{
					DebugTool.logInfo(TAG, "Successfully Cleared Menu");
				}
				oldMenuCells = null;
				if (hasQueuedUpdate){
					hasQueuedUpdate = false;
				}
			}
		});
	}

	private void dynamicallyUpdateRootMenu(RunScore bestRootScore){

		// we need to run through the keeps and see if they have subCells, as they also need to be run
		// through the compare function.
		List<Integer> newIntArray = bestRootScore.getCurrentMenu();
		List<Integer> oldIntArray = bestRootScore.getOldMenu();
		List<RPCRequest> deleteCommands;

		// Set up deletes
		List<MenuCell> deletes = new ArrayList<>();
		keepsOld = new ArrayList<>();
		for (int x = 0; x < oldIntArray.size(); x++) {
			Integer old = oldIntArray.get(x);
			if (old.equals(MARKED_FOR_DELETION)){
				// grab cell to send to function to create delete commands
				deletes.add(oldMenuCells.get(x));
			} else if (old.equals(KEEP)) {
				keepsOld.add(oldMenuCells.get(x));
			}
		}
		// create the delete commands
		deleteCommands = createDeleteRPCsForCells(deletes);

		// Set up the adds
		List<MenuCell> adds = new ArrayList<>();
		keepsNew = new ArrayList<>();
		for (int x = 0; x < newIntArray.size(); x++) {
			Integer newInt = newIntArray.get(x);
			if (newInt.equals(MARKED_FOR_ADDITION)){
				// grab cell to send to function to create add commands
				adds.add(menuCells.get(x));
			} else if (newInt.equals(KEEP)){
				keepsNew.add(menuCells.get(x));
			}
		}
		updateIdsOnDynamicCells(adds);
		// this is needed for the onCommands to still work
		transferIdsToKeptCells(keepsNew);

		if (adds.size() > 0){
			DebugTool.logInfo(TAG, "Sending root menu updates");
			sendDynamicRootMenuRPCs(deleteCommands, adds);
		}else{
			DebugTool.logInfo(TAG, "All root menu items are kept. Check the sub menus");
			runSubMenuCompareAlgorithm();
		}
	}

	// OTHER

	private void sendDynamicRootMenuRPCs(List<RPCRequest> deleteCommands,final List<MenuCell> updatedCells){
		sendDeleteRPCs(deleteCommands,new CompletionListener() {
			@Override
			public void onComplete(boolean success) {
				createAndSendMenuCellRPCs(updatedCells, new CompletionListener() {
					@Override
					public void onComplete(boolean success) {
						inProgressUpdate = null;

						if (!success){
							DebugTool.logError(TAG, "Error Sending Current Menu");
						}

						if (hasQueuedUpdate){
							//setMenuCells(waitingUpdateMenuCells);
							hasQueuedUpdate = false;
						}
					}
				});
			}
		});
	}

	// SUB MENUS

	// This is called in the listener in the sendMenu and sendSubMenuCommands Methods
	private void runSubMenuCompareAlgorithm(){
		// any cells that were re-added have their sub-cells added with them
		// at this point all we care about are the cells that were deemed equal and kept.
		if (keepsNew == null || keepsNew.size() == 0) {
			return;
		}

		List<SubCellCommandList> commandLists = new ArrayList<>();

		for (int i = 0; i < keepsNew.size(); i++) {

			MenuCell keptCell = keepsNew.get(i);
			MenuCell oldKeptCell = keepsOld.get(i);

			if (oldKeptCell.getSubCells() != null && oldKeptCell.getSubCells().size() > 0 && keptCell.getSubCells() != null && keptCell.getSubCells().size() > 0){
				// ACTUAL LOGIC
				RunScore subScore = compareOldAndNewLists(oldKeptCell.getSubCells(), keptCell.getSubCells());

				if (subScore != null){
					DebugTool.logInfo(TAG, "Sub menu Run Score: "+ oldKeptCell.getTitle()+ " Score: "+ subScore.getScore());
					SubCellCommandList commandList = new SubCellCommandList(oldKeptCell.getTitle(), oldKeptCell.getCellId(), subScore, oldKeptCell.getSubCells(), keptCell.getSubCells());
					commandLists.add(commandList);
				}
			}
		}
		createSubMenuDynamicCommands(commandLists);
	}

	private void createSubMenuDynamicCommands(final List<SubCellCommandList> commandLists){

		// break out
		if (commandLists.size() == 0){
			if (inProgressUpdate != null){
				inProgressUpdate = null;
			}

			if (hasQueuedUpdate) {
				DebugTool.logInfo(TAG, "Menu Manager has waiting updates, sending now");
				setMenuCells(waitingUpdateMenuCells);
				hasQueuedUpdate = false;
			}
			DebugTool.logInfo(TAG, "All menu updates, including sub menus - done.");
			return;
		}

		final SubCellCommandList commandList = commandLists.remove(0);

		DebugTool.logInfo(TAG, "Creating and Sending Dynamic Sub Commands For Root Menu Cell: "+ commandList.getMenuTitle());

		// grab the scores
		RunScore score = commandList.getListsScore();
		List<Integer> newIntArray = score.getCurrentMenu();
		List<Integer> oldIntArray = score.getOldMenu();

		// Grab the sub-menus from the parent cell
		final List<MenuCell> oldCells = commandList.getOldList();
		final List<MenuCell> newCells = commandList.getNewList();

		// Create the list for the adds
		List<MenuCell> subCellKeepsNew = new ArrayList<>();

		List<RPCRequest> deleteCommands;

		// Set up deletes
		List<MenuCell> deletes = new ArrayList<>();
		for (int x = 0; x < oldIntArray.size(); x++) {
			Integer old = oldIntArray.get(x);
			if (old.equals(MARKED_FOR_DELETION)){
				// grab cell to send to function to create delete commands
				deletes.add(oldCells.get(x));
			}
		}
		// create the delete commands
		deleteCommands = createDeleteRPCsForCells(deletes);

		// Set up the adds
		List<MenuCell> adds = new ArrayList<>();
		for (int x = 0; x < newIntArray.size(); x++) {
			Integer newInt = newIntArray.get(x);
			if (newInt.equals(MARKED_FOR_ADDITION)){
				// grab cell to send to function to create add commands
				adds.add(newCells.get(x));
			} else if (newInt.equals(KEEP)){
				subCellKeepsNew.add(newCells.get(x));
			}
		}
		final List<MenuCell> addsWithNewIds = updateIdsOnDynamicSubCells(oldCells, adds, commandList.getParentId());
		// this is needed for the onCommands to still work
		transferIdsToKeptSubCells(oldCells, subCellKeepsNew);

		sendDeleteRPCs(deleteCommands,new CompletionListener() {
			@Override
			public void onComplete(boolean success) {
				if (addsWithNewIds != null && addsWithNewIds.size() > 0) {
					createAndSendDynamicSubMenuRPCs(newCells, addsWithNewIds, new CompletionListener() {
						@Override
						public void onComplete(boolean success) {
							// recurse through next sub list
							DebugTool.logInfo(TAG, "Finished Sending Dynamic Sub Commands For Root Menu Cell: "+ commandList.getMenuTitle());
							createSubMenuDynamicCommands(commandLists);
						}
					});
				} else{
					// no add commands to send, recurse through next sub list
					DebugTool.logInfo(TAG, "Finished Sending Dynamic Sub Commands For Root Menu Cell: "+ commandList.getMenuTitle());
					createSubMenuDynamicCommands(commandLists);
				}
			}
		});
	}

	// OTHER HELPER METHODS:

	// COMPARISONS

	RunScore runMenuCompareAlgorithm(List<MenuCell> oldCells, List<MenuCell> newCells){

		if (oldCells == null || oldCells.size() == 0){
			return null;
		}

		RunScore bestScore = compareOldAndNewLists(oldCells, newCells);
		DebugTool.logInfo(TAG, "Best menu run score: "+ bestScore.getScore());

		return bestScore;
	}

	private RunScore compareOldAndNewLists(List<MenuCell> oldCells, List<MenuCell> newCells){

		RunScore bestRunScore = null;

		// This first loop is for each 'run'
		for (int run = 0; run < oldCells.size(); run++) {

			List<Integer> oldArray = new ArrayList<>(oldCells.size());
			List<Integer> newArray = new ArrayList<>(newCells.size());

			// Set the statuses
			setDeleteStatus(oldCells.size(), oldArray);
			setAddStatus(newCells.size(), newArray);

			int startIndex = 0;

			// Keep items that appear in both lists
			for (int oldItems = run; oldItems < oldCells.size(); oldItems++) {

				for (int newItems = startIndex; newItems < newCells.size(); newItems++) {

					if (oldCells.get(oldItems).equals(newCells.get(newItems))){
						oldArray.set(oldItems, KEEP);
						newArray.set(newItems, KEEP);
						// set the new start index
						startIndex = newItems + 1;
						break;
					}
				}
			}

			// Calculate number of adds, or the 'score' for this run
			int numberOfAdds = 0;

			for (int x = 0; x < newArray.size(); x++) {
				if (newArray.get(x).equals(MARKED_FOR_ADDITION)){
					numberOfAdds++;
				}
			}

			// see if we have a new best score and set it if we do
			if (bestRunScore == null || numberOfAdds < bestRunScore.getScore()){
				bestRunScore = new RunScore(numberOfAdds, oldArray, newArray);
			}

		}
		return bestRunScore;
	}

	private void setDeleteStatus(Integer size, List<Integer> oldArray){
		for (int i = 0; i < size; i++) {
			oldArray.add(MARKED_FOR_DELETION);
		}
	}

	private void setAddStatus(Integer size, List<Integer> newArray){
		for (int i = 0; i < size; i++) {
			newArray.add(MARKED_FOR_ADDITION);
		}
	}

	// ARTWORKS

	private List<SdlArtwork> findAllArtworksToBeUploadedFromCells(List<MenuCell> cells){
		// Make sure we can use images in the menus
		if (!supportsImages()){
			return new ArrayList<>();
		}

		List<SdlArtwork> artworks = new ArrayList<>();
		for (MenuCell cell : cells){
			if (artworkNeedsUpload(cell.getIcon())){
				artworks.add(cell.getIcon());
			}
			if (cell.getSubCells() != null && cell.getSubCells().size() > 0){
				artworks.addAll(findAllArtworksToBeUploadedFromCells(cell.getSubCells()));
			}
		}

		return artworks;
	}

	@SuppressWarnings("BooleanMethodIsAlwaysInverted")
	private boolean supportsImages(){
		return defaultMainWindowCapability == null || ManagerUtility.WindowCapabilityUtility.hasImageFieldOfName(defaultMainWindowCapability, ImageFieldName.cmdIcon);
	}

	private boolean artworkNeedsUpload(SdlArtwork artwork){
		if (fileManager.get() != null){
			return (artwork != null && !fileManager.get().hasUploadedFile(artwork) && !artwork.isStaticIcon());
		}
		return false;
	}

	// IDs

	private void updateIdsOnDynamicCells(List<MenuCell> dynamicCells){
		if (menuCells != null && menuCells.size() > 0 && dynamicCells != null && dynamicCells.size() > 0) {
			for (int z = 0; z < menuCells.size(); z++) {
				MenuCell mainCell = menuCells.get(z);
				for (int i = 0; i < dynamicCells.size(); i++) {
					MenuCell dynamicCell = dynamicCells.get(i);
					if (mainCell.equals(dynamicCell)) {
						int newId = ++lastMenuId;
						menuCells.get(z).setCellId(newId);
						dynamicCells.get(i).setCellId(newId);

						if (mainCell.getSubCells() != null && mainCell.getSubCells().size() > 0) {
							updateIdsOnMenuCells(mainCell.getSubCells(), mainCell.getCellId());
						}
						break;
					}
				}
			}
		}
	}

	private List<MenuCell> updateIdsOnDynamicSubCells(List<MenuCell> oldList, List<MenuCell> dynamicCells, Integer parentId){
		if (oldList != null && oldList.size() > 0 && dynamicCells != null && dynamicCells.size() > 0) {
			for (int z = 0; z < oldList.size(); z++) {
				MenuCell mainCell = oldList.get(z);
				for (int i = 0; i < dynamicCells.size(); i++) {
					MenuCell dynamicCell = dynamicCells.get(i);
					if (mainCell.equals(dynamicCell)) {
						int newId = ++lastMenuId;
						oldList.get(z).setCellId(newId);
						dynamicCells.get(i).setParentCellId(parentId);
						dynamicCells.get(i).setCellId(newId);
					}else{
						int newId = ++lastMenuId;
						dynamicCells.get(i).setParentCellId(parentId);
						dynamicCells.get(i).setCellId(newId);
					}
				}
			}
			return dynamicCells;
		}
		return null;
	}

	private void updateIdsOnMenuCells(List<MenuCell> cells, int parentId) {
		for (MenuCell cell : cells) {
			int newId = ++lastMenuId;
			cell.setCellId(newId);
			cell.setParentCellId(parentId);
			if (cell.getSubCells() != null && cell.getSubCells().size() > 0) {
				updateIdsOnMenuCells(cell.getSubCells(), cell.getCellId());
			}
		}
	}

	private void transferIdsToKeptCells(List<MenuCell> keeps) {
		for (int z = 0; z < oldMenuCells.size(); z++) {
			MenuCell oldCell = oldMenuCells.get(z);
			for (int i = 0; i < keeps.size(); i++) {
				MenuCell keptCell = keeps.get(i);
				if (oldCell.equals(keptCell)) {
					keptCell.setCellId(oldCell.getCellId());
					break;
				}
			}
		}
	}

	private void transferIdsToKeptSubCells(List<MenuCell> old, List<MenuCell> keeps) {
		for (int z = 0; z < old.size(); z++) {
			MenuCell oldCell = old.get(z);
			for (int i = 0; i < keeps.size(); i++) {
				MenuCell keptCell = keeps.get(i);
				if (oldCell.equals(keptCell)) {
					keptCell.setCellId(oldCell.getCellId());
					break;
				}
			}
		}
	}

	// DELETES

	private List<RPCRequest> createDeleteRPCsForCells(List<MenuCell> cells){
		List<RPCRequest> deletes = new ArrayList<>();
		for (MenuCell cell : cells){
			if (cell.getSubCells() == null){
				DeleteCommand delete = new DeleteCommand(cell.getCellId());
				deletes.add(delete);
			}else{
				DeleteSubMenu delete = new DeleteSubMenu(cell.getCellId());
				deletes.add(delete);
			}
		}
		return deletes;
	}

	// COMMANDS / SUBMENU RPCs

	private List<RPCRequest> mainMenuCommandsForCells(List<MenuCell> cellsToAdd, boolean shouldHaveArtwork) {
		List<RPCRequest> builtCommands = new ArrayList<>();

		// We need the index so we will use this type of loop
		for (int z = 0; z < menuCells.size(); z++) {
			MenuCell mainCell = menuCells.get(z);
			for (int i = 0; i < cellsToAdd.size(); i++) {
				MenuCell addCell = cellsToAdd.get(i);
				if (mainCell.equals(addCell)) {
					if (addCell.getSubCells() != null && addCell.getSubCells().size() > 0) {
						builtCommands.add(subMenuCommandForMenuCell(addCell, shouldHaveArtwork, z));
					} else {
						builtCommands.add(commandForMenuCell(addCell, shouldHaveArtwork, z));
					}
					break;
				}
			}
		}
		return builtCommands;
	}

	private List<RPCRequest> subMenuCommandsForCells(List<MenuCell> cells, boolean shouldHaveArtwork){
		List<RPCRequest> builtCommands = new ArrayList<>();
		for (MenuCell cell : cells){
			if (cell.getSubCells() != null && cell.getSubCells().size() > 0){
				builtCommands.addAll(allCommandsForCells(cell.getSubCells(), shouldHaveArtwork));
			}
		}
		return builtCommands;
	}

	List<RPCRequest> allCommandsForCells(List<MenuCell> cells, boolean shouldHaveArtwork){
		List<RPCRequest> builtCommands = new ArrayList<>();

		// We need the index so we will use this type of loop
		for (int i = 0; i < cells.size(); i++) {
			MenuCell cell = cells.get(i);
			if (cell.getSubCells() != null && cell.getSubCells().size() > 0){
				builtCommands.add(subMenuCommandForMenuCell(cell, shouldHaveArtwork, i));
				// recursively grab the commands for all the sub cells
				builtCommands.addAll(allCommandsForCells(cell.getSubCells(), shouldHaveArtwork));
			}else{
				builtCommands.add(commandForMenuCell(cell, shouldHaveArtwork, i));
			}
		}
		return builtCommands;
	}

	private List<RPCRequest> createCommandsForDynamicSubCells(List<MenuCell> oldMenuCells, List<MenuCell> cells, boolean shouldHaveArtwork) {
		List<RPCRequest> builtCommands = new ArrayList<>();
		for (int z = 0; z < oldMenuCells.size(); z++) {
			MenuCell oldCell = oldMenuCells.get(z);
			for (int i = 0; i < cells.size(); i++) {
				MenuCell cell = cells.get(i);
				if (cell.equals(oldCell)){
					builtCommands.add(commandForMenuCell(cell, shouldHaveArtwork, z));
					break;
				}
			}
		}
		return builtCommands;
	}

	private AddCommand commandForMenuCell(MenuCell cell, boolean shouldHaveArtwork, int position){

		MenuParams params = new MenuParams(cell.getTitle());
		params.setParentID(cell.getParentCellId() != MAX_ID ? cell.getParentCellId() : null);
		params.setPosition(position);

		AddCommand command = new AddCommand(cell.getCellId());
		command.setMenuParams(params);
		if (cell.getVoiceCommands() != null && !cell.getVoiceCommands().isEmpty()) {
			command.setVrCommands(cell.getVoiceCommands());
		} else {
			command.setVrCommands(null);
		}
		command.setCmdIcon((cell.getIcon() != null && shouldHaveArtwork) ? cell.getIcon().getImageRPC() : null);

		return command;
	}

	private AddSubMenu subMenuCommandForMenuCell(MenuCell cell, boolean shouldHaveArtwork, int position){
		AddSubMenu subMenu = new AddSubMenu(cell.getCellId(), cell.getTitle());
		subMenu.setPosition(position);
		if (cell.getSubMenuLayout() != null ) {
			subMenu.setMenuLayout(cell.getSubMenuLayout());
		} else if (menuConfiguration != null && menuConfiguration.getSubMenuLayout() != null) {
			subMenu.setMenuLayout(menuConfiguration.getSubMenuLayout());
		}
		subMenu.setMenuIcon((shouldHaveArtwork && (cell.getIcon()!= null && cell.getIcon().getImageRPC() != null)) ? cell.getIcon().getImageRPC() : null);
		return subMenu;
	}

	// CELL COMMAND HANDLING

	private boolean callListenerForCells(List<MenuCell> cells, OnCommand command){
		if (cells != null && cells.size() > 0 && command != null) {
			for (MenuCell cell : cells) {

				if (cell.getCellId() == command.getCmdID() && cell.getMenuSelectionListener() != null) {
					cell.getMenuSelectionListener().onTriggered(command.getTriggerSource());
					return true;
				}
				if (cell.getSubCells() != null && cell.getSubCells().size() > 0) {
					// for each cell, if it has sub cells, recursively loop through those as well
					if (callListenerForCells(cell.getSubCells(), command)) {
						return true;
					}
				}
			}
		}
		return false;
	}

	// LISTENERS

	private void addListeners(){
		// DISPLAY CAPABILITIES - via SCM
		onDisplaysCapabilityListener = new OnSystemCapabilityListener() {
			@Override
			public void onCapabilityRetrieved(Object capability) {
				// instead of using the parameter it's more safe to use the convenience method
				List<DisplayCapability> capabilities = SystemCapabilityManager.convertToList(capability, DisplayCapability.class);
				if (capabilities == null || capabilities.size() == 0) {
					DebugTool.logError(TAG, "SoftButton Manager - Capabilities sent here are null or empty");
				}else {
					DisplayCapability display = capabilities.get(0);
					displayType = display.getDisplayName();
					for (WindowCapability windowCapability : display.getWindowCapabilities()) {
						int currentWindowID = windowCapability.getWindowID() != null ? windowCapability.getWindowID() : PredefinedWindows.DEFAULT_WINDOW.getValue();
						if (currentWindowID == PredefinedWindows.DEFAULT_WINDOW.getValue()) {
							defaultMainWindowCapability = windowCapability;
						}
					}
				}
			}

			@Override
			public void onError(String info) {
				DebugTool.logError(TAG, "Display Capability cannot be retrieved");
				defaultMainWindowCapability = null;
			}
		};
		if (internalInterface.getSystemCapabilityManager() != null) {
			this.internalInterface.getSystemCapabilityManager().addOnSystemCapabilityListener(SystemCapabilityType.DISPLAYS, onDisplaysCapabilityListener);
		}

		// HMI UPDATES
		hmiListener = new OnRPCNotificationListener() {
			@Override
			public void onNotified(RPCNotification notification) {
				OnHMIStatus onHMIStatus = (OnHMIStatus)notification;
				if (onHMIStatus.getWindowID() != null && onHMIStatus.getWindowID() != PredefinedWindows.DEFAULT_WINDOW.getValue()) {
					return;
				}
				HMILevel oldHMILevel = currentHMILevel;
				currentHMILevel = onHMIStatus.getHmiLevel();

				// Auto-send an updated menu if we were in NONE and now we are not, and we need an update
				if (oldHMILevel == HMILevel.HMI_NONE && currentHMILevel != HMILevel.HMI_NONE && currentSystemContext != SystemContext.SYSCTXT_MENU){
					if (waitingOnHMIUpdate){
						DebugTool.logInfo(TAG, "We now have proper HMI, sending waiting update");
						setMenuCells(waitingUpdateMenuCells);
						waitingUpdateMenuCells.clear();
						return;
					}
				}

				// If we don't check for this and only update when not in the menu, there can be IN_USE errors, especially with submenus.
				// We also don't want to encourage changing out the menu while the user is using it for usability reasons.
				SystemContext oldContext = currentSystemContext;
				currentSystemContext = onHMIStatus.getSystemContext();

				if (oldContext == SystemContext.SYSCTXT_MENU && currentSystemContext != SystemContext.SYSCTXT_MENU && currentHMILevel != HMILevel.HMI_NONE){
					if (waitingOnHMIUpdate){
						DebugTool.logInfo(TAG, "We now have a proper system context, sending waiting update");
						setMenuCells(waitingUpdateMenuCells);
						waitingUpdateMenuCells.clear();
					}
				}
			}
		};
		internalInterface.addOnRPCNotificationListener(FunctionID.ON_HMI_STATUS, hmiListener);

		// COMMANDS
		commandListener = new OnRPCNotificationListener() {
			@Override
			public void onNotified(RPCNotification notification) {
				OnCommand onCommand = (OnCommand) notification;
				callListenerForCells(menuCells, onCommand);
			}
		};
		internalInterface.addOnRPCNotificationListener(FunctionID.ON_COMMAND, commandListener);
	}

	// SEND NEW MENU ITEMS

	private void createAndSendEntireMenu(){

		if (currentHMILevel == null || currentHMILevel.equals(HMILevel.HMI_NONE) || currentSystemContext.equals(SystemContext.SYSCTXT_MENU)){
			// We are in NONE or the menu is in use, bail out of here
			DebugTool.logInfo(TAG, "HMI in None or System Context Menu, returning");
			waitingOnHMIUpdate = true;
			waitingUpdateMenuCells = menuCells;
			return;
		}

		if (inProgressUpdate != null && inProgressUpdate.size() > 0){
			// there's an in-progress update so this needs to wait
			DebugTool.logInfo(TAG, "There is an in progress Menu Update, returning");
			hasQueuedUpdate = true;
			return;
		}

		deleteRootMenu(new CompletionListener() {
			@Override
			public void onComplete(boolean success) {
				createAndSendMenuCellRPCs(menuCells, new CompletionListener() {
					@Override
					public void onComplete(boolean success) {
						inProgressUpdate = null;

						if (!success) {
							DebugTool.logError(TAG, "Error Sending Current Menu");
						}

						if (hasQueuedUpdate) {
							setMenuCells(waitingUpdateMenuCells);
							hasQueuedUpdate = false;
						}
					}
				});
			}
		});
	}

	private void createAndSendMenuCellRPCs(final List<MenuCell> menu, final CompletionListener listener){

		if (menu.size() == 0){
			if (listener != null){
				// This can be considered a success if the user was clearing out their menu
				listener.onComplete(true);
			}
			return;
		}

		List<RPCRequest> mainMenuCommands;
		final List<RPCRequest> subMenuCommands;

		if (findAllArtworksToBeUploadedFromCells(menu).size() > 0 || !supportsImages()){
			// Send artwork-less menu
			mainMenuCommands = mainMenuCommandsForCells(menu, false);
			subMenuCommands = subMenuCommandsForCells(menu, false);
		} else {
			mainMenuCommands = mainMenuCommandsForCells(menu, true);
			subMenuCommands = subMenuCommandsForCells(menu, true);
		}

		// add all built commands to inProgressUpdate
		inProgressUpdate = new ArrayList<>(mainMenuCommands);
		inProgressUpdate.addAll(subMenuCommands);

		internalInterface.sendSequentialRPCs(mainMenuCommands, new OnMultipleRequestListener() {
			@Override
			public void onUpdate(int remainingRequests) {
				// nothing here
			}

			@Override
			public void onFinished() {

				if (subMenuCommands.size() > 0) {
					sendSubMenuCommandRPCs(subMenuCommands, listener);
					DebugTool.logInfo(TAG, "Finished sending main menu commands. Sending sub menu commands.");
				} else {

					if (keepsNew != null && keepsNew.size() > 0){
						runSubMenuCompareAlgorithm();
					}else {
						inProgressUpdate = null;
						DebugTool.logInfo(TAG, "Finished sending main menu commands.");
					}
				}
			}

			@Override
			public void onResponse(int correlationId, RPCResponse response) {
				if (response.getSuccess()) {
					try {
						DebugTool.logInfo(TAG, "Main Menu response: " + response.serializeJSON().toString());
					} catch (JSONException e) {
						e.printStackTrace();
					}
				} else {
					DebugTool.logError(TAG, "Result: " + response.getResultCode() + " Info: " + response.getInfo());
				}
			}
		});
	}

	private void sendSubMenuCommandRPCs(List<RPCRequest> commands, final CompletionListener listener){

		internalInterface.sendSequentialRPCs(commands, new OnMultipleRequestListener() {
			@Override
			public void onUpdate(int remainingRequests) {

			}

			@Override
			public void onFinished() {

				if (keepsNew != null && keepsNew.size() > 0){
					runSubMenuCompareAlgorithm();
				}else {
					DebugTool.logInfo(TAG, "Finished Updating Menu");
					inProgressUpdate = null;

					if (listener != null) {
						listener.onComplete(true);
					}
				}
			}

			@Override
			public void onResponse(int correlationId, RPCResponse response) {
				if (response.getSuccess()) {
					try {
						DebugTool.logInfo(TAG, "Sub Menu response: " + response.serializeJSON().toString());
					} catch (JSONException e) {
						e.printStackTrace();
					}
				} else {
					DebugTool.logError(TAG, "Failed to send sub menu commands: "+ response.getInfo());
					if (listener != null){
						listener.onComplete(false);
					}
				}
			}
		});
	}

	private void createAndSendDynamicSubMenuRPCs(List<MenuCell> newMenu, final List<MenuCell> adds, final CompletionListener listener){

		if (adds.size() == 0){
			if (listener != null){
				// This can be considered a success if the user was clearing out their menu
				DebugTool.logError(TAG, "Called createAndSendDynamicSubMenuRPCs with empty menu");
				listener.onComplete(true);
			}
			return;
		}

		List<RPCRequest> mainMenuCommands;

		if (findAllArtworksToBeUploadedFromCells(adds).size() > 0 || !supportsImages()){
			// Send artwork-less menu
			mainMenuCommands = createCommandsForDynamicSubCells(newMenu, adds, false);
		} else {
			mainMenuCommands = createCommandsForDynamicSubCells(newMenu, adds, true);
		}

		internalInterface.sendSequentialRPCs(mainMenuCommands, new OnMultipleRequestListener() {
			@Override
			public void onUpdate(int remainingRequests) {
				// nothing here
			}

			@Override
			public void onFinished() {

				if (listener != null){
					listener.onComplete(true);
				}
			}

			@Override
			public void onResponse(int correlationId, RPCResponse response) {
				if (response.getSuccess()) {
					try {
						DebugTool.logInfo(TAG, "Dynamic Sub Menu response: " + response.serializeJSON().toString());
					} catch (JSONException e) {
						e.printStackTrace();
					}
				} else {
					DebugTool.logError(TAG, "Result: " + response.getResultCode() + " Info: " + response.getInfo());
				}
			}
		});
	}

	// DELETE OLD MENU ITEMS

	private void deleteRootMenu(final CompletionListener listener){

		if (oldMenuCells == null || oldMenuCells.size() == 0) {
			if (listener != null){
				// technically this method is successful if there's nothing to delete
				DebugTool.logInfo(TAG, "No old cells to delete, returning");
				listener.onComplete(true);
			}
		} else {
			sendDeleteRPCs(createDeleteRPCsForCells(oldMenuCells), listener);
		}
	}

	private void sendDeleteRPCs(List<RPCRequest> deleteCommands, final CompletionListener listener){
		if (oldMenuCells != null && oldMenuCells.size() == 0) {
			if (listener != null){
				// technically this method is successful if there's nothing to delete
				DebugTool.logInfo(TAG, "No old cells to delete, returning");
				listener.onComplete(true);
			}
			return;
		}

		if (deleteCommands == null || deleteCommands.size() == 0){
			// no dynamic deletes required. return
			if (listener != null){
				// technically this method is successful if there's nothing to delete
				listener.onComplete(true);
			}
			return;
		}

		internalInterface.sendRPCs(deleteCommands, new OnMultipleRequestListener() {
			@Override
			public void onUpdate(int remainingRequests) {

			}

			@Override
			public void onFinished() {
				DebugTool.logInfo(TAG, "Successfully deleted cells");
				if (listener != null){
					listener.onComplete(true);
				}
			}

			@Override
			public void onResponse(int correlationId, RPCResponse response) {

			}
		});
	}

	private List<MenuCell> cloneMenuCellsList(List<MenuCell> originalList) {
		if (originalList == null) {
			return null;
		}

		List<MenuCell> clone = new ArrayList<>();
		for (MenuCell menuCell : originalList) {
			clone.add(menuCell.clone());
		}
		return clone;
	}
}