SDL 0180 - Fix to support broaden choice cell uniqueness

SmartDeviceLink/private/NSArray+NSObject.h

@@ -0,0 +1,19 @@
+//
+//  NSArray+NSObject.h
+//  SmartDeviceLink
+//
+//  Created by Frank Elias on 2/18/21.
+//  Copyright © 2021 smartdevicelink. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface NSArray (NSObject)
+
+-(NSUInteger)dynamicHash;
+
+@end
+
+NS_ASSUME_NONNULL_END

SmartDeviceLink/private/NSArray+NSObject.m

@@ -0,0 +1,27 @@
+//
+//  NSArray+NSObject.m
+//  SmartDeviceLink
+//
+//  Created by Frank Elias on 2/18/21.
+//  Copyright © 2021 smartdevicelink. All rights reserved.
+//
+
+#import "NSArray+NSObject.h"
+
+@implementation NSArray (NSObject)
+
+NSUInteger const NSUIntBitCellDynamicHash = (CHAR_BIT * sizeof(NSUInteger));
+NSUInteger NSUIntRotateCellDynamicHash(NSUInteger val, NSUInteger howMuch) {
+    return ((((NSUInteger)val) << howMuch) | (((NSUInteger)val) >> (NSUIntBitCellDynamicHash - howMuch)));
+}
+
+- (NSUInteger)dynamicHash {
+    NSUInteger returnValue = 0;
+    for (NSObject *object in self) {
+        returnValue += NSUIntRotateCellDynamicHash(object.hash, NSUIntBitCellDynamicHash/2);
+    }
+    return returnValue;
+}
+
+
+@end

SmartDeviceLink/private/SDLChoiceSetManager.m

@@ -39,6 +39,7 @@
 #import "SDLSystemCapability.h"
 #import "SDLSystemCapabilityManager.h"
 #import "SDLWindowCapability.h"
+#import "SDLVersion.h"
 #import "SDLWindowCapability+ScreenManagerExtensions.h"
 
 NS_ASSUME_NONNULL_BEGIN
@@ -53,6 +54,7 @@
 @interface SDLChoiceCell()
 
 @property (assign, nonatomic) UInt16 choiceId;
+@property (strong, nonatomic, readwrite) NSString *uniqueText;
 
 @end
 
@@ -446,11 +448,38 @@ - (void)dismissKeyboardWithCancelID:(NSNumber<SDLInt> *)cancelID {
 /// @return The choices that have not yet been uploaded to the module
 - (NSSet<SDLChoiceCell *> *)sdl_choicesToBeUploadedWithArray:(NSArray<SDLChoiceCell *> *)choices {
     NSMutableSet<SDLChoiceCell *> *choicesSet = [NSMutableSet setWithArray:choices];
+
+    // If we're running on a connection < RPC 7.1, we need to de-duplicate cells because presenting them will fail if we have the same cell primary text.
+    SDLVersion *choiceUniquenessSupportedVersion = [[SDLVersion alloc] initWithMajor:7 minor:1 patch:0];
+    if ([[SDLGlobals sharedGlobals].rpcVersion isLessThanVersion:choiceUniquenessSupportedVersion]) {
+        [self sdl_addUniqueNamesToCells:choicesSet];
+    }
     [choicesSet minusSet:self.preloadedChoices];
 
     return [choicesSet copy];
 }
 
+/// Checks if 2 or more cells have the same text/title. In case this condition is true, this function will handle the presented issue by adding "(count)".
+/// E.g. Choices param contains 2 cells with text/title "Address" will be handled by updating the uniqueText/uniqueTitle of the second cell to "Address (2)".
+/// @param choices The choices to be uploaded.
+- (void)sdl_addUniqueNamesToCells:(NSMutableSet<SDLChoiceCell *> *)choices {
+    // Tracks how many of each cell primary text there are so that we can append numbers to make each unique as necessary
+    NSMutableDictionary<NSString *, NSNumber *> *dictCounter = [[NSMutableDictionary alloc] init];
+    for (SDLChoiceCell *cell in choices) {
+        NSString *cellName = cell.text;
+        NSNumber *counter = dictCounter[cellName];
+        if (counter != nil) {
+            counter = @(counter.intValue + 1);
+            dictCounter[cellName] = counter;
+        } else {
+            dictCounter[cellName] = @1;
+        }
+        if (counter.intValue > 1) {
+            cell.uniqueText = [NSString stringWithFormat: @"%@ (%d)", cell.text, counter.intValue];
+        }
+    }
+}
+
 /// Checks the passed list of choices to be deleted and returns the items that have been uploaded to the module.
 /// @param choices The choices to be deleted
 /// @return The choices that have been uploaded to the module

SmartDeviceLink/private/SDLMenuManager.m

@@ -48,6 +48,7 @@ @interface SDLMenuCell()
 
 @property (assign, nonatomic) UInt32 parentCellId;
 @property (assign, nonatomic) UInt32 cellId;
+@property (strong, nonatomic, readwrite) NSString *uniqueTitle;
 
 @end
 
@@ -74,6 +75,8 @@ @interface SDLMenuManager()
 
 UInt32 const ParentIdNotFound = UINT32_MAX;
 UInt32 const MenuCellIdMin = 1;
+NSMutableSet<NSString *> *identicalVoiceCommandsCheckSet;
+NSUInteger voiceCommandCount;
 
 @implementation SDLMenuManager
 
@@ -90,6 +93,9 @@ - (instancetype)init {
     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_hmiStatusNotification:) name:SDLDidChangeHMIStatusNotification object:nil];
     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(sdl_commandNotification:) name:SDLDidReceiveCommandNotification object:nil];
 
+    identicalVoiceCommandsCheckSet = [NSMutableSet set];
+    voiceCommandCount = 0;
+
     return self;
 }
 
@@ -160,6 +166,21 @@ - (void)setMenuConfiguration:(SDLMenuConfiguration *)menuConfiguration {
 }
 
 - (void)setMenuCells:(NSArray<SDLMenuCell *> *)menuCells {
+///Check for cell lists with completely duplicate information, or any duplicate voiceCommands
+    if (![self sdl_menuCellsAreUnique:menuCells]) {
+        return;
+    } else if (identicalVoiceCommandsCheckSet.count != voiceCommandCount) {
+        SDLLogE(@"Attempted to create a menu with duplicate voice commands. Voice commands must be unique. The menu will not be set.");
+        identicalVoiceCommandsCheckSet = [NSMutableSet set];
+        voiceCommandCount = 0;
+        return;
+    }
+
+    SDLVersion *menuUniquenessSupportedVersion = [[SDLVersion alloc] initWithMajor:7 minor:1 patch:0];
+    if ([[SDLGlobals sharedGlobals].rpcVersion isLessThanVersion:menuUniquenessSupportedVersion]) {
+        [self sdl_addUniqueNamesToCells:menuCells];
+    }
+
     if (self.currentHMILevel == nil
         || [self.currentHMILevel isEqualToEnum:SDLHMILevelNone]
         || [self.currentSystemContext isEqualToEnum:SDLSystemContextMenu]) {
@@ -171,28 +192,6 @@ - (void)setMenuCells:(NSArray<SDLMenuCell *> *)menuCells {
 
     self.waitingOnHMIUpdate = NO;
 
-    NSMutableSet *titleCheckSet = [NSMutableSet set];
-    NSMutableSet<NSString *> *allMenuVoiceCommands = [NSMutableSet set];
-    NSUInteger voiceCommandCount = 0;
-    for (SDLMenuCell *cell in menuCells) {
-        [titleCheckSet addObject:cell.title];
-        if (cell.voiceCommands == nil) { continue; }
-        [allMenuVoiceCommands addObjectsFromArray:cell.voiceCommands];
-        voiceCommandCount += cell.voiceCommands.count;
-    }
-
-    // Check for duplicate titles
-    if (titleCheckSet.count != menuCells.count) {
-        SDLLogE(@"Not all cell titles are unique. The menu will not be set.");
-        return;
-    }
-
-    // Check for duplicate voice recognition commands
-    if (allMenuVoiceCommands.count != voiceCommandCount) {
-        SDLLogE(@"Attempted to create a menu with duplicate voice commands. Voice commands must be unique. The menu will not be set.");
-        return;
-    }
-
     _oldMenuCells = _menuCells;
     _menuCells = menuCells;
 
@@ -530,6 +529,62 @@ - (BOOL)sdl_isDynamicMenuUpdateActive:(SDLDynamicMenuUpdatesMode)dynamicMenuUpda
     }
 }
 
+/// Checks if 2 or more cells have the same text/title. In case this condition is true, this function will handle the presented issue by adding "(count)".
+/// E.g. Choices param contains 2 cells with text/title "Address" will be handled by updating the uniqueText/uniqueTitle of the second cell to "Address (2)".
+/// @param choices The choices to be uploaded.
+- (void)sdl_addUniqueNamesToCells:(nullable NSArray<SDLMenuCell *> *)choices {
+    // Tracks how many of each cell primary text there are so that we can append numbers to make each unique as necessary
+    NSMutableDictionary<NSString *, NSNumber *> *dictCounter = [[NSMutableDictionary alloc] init];
+    for (SDLMenuCell *cell in choices) {
+        NSString *cellName = cell.title;
+        NSNumber *counter = dictCounter[cellName];
+        if (counter != nil) {
+            counter = @(counter.intValue + 1);
+            dictCounter[cellName] = counter;
+        } else {
+            dictCounter[cellName] = @1;
+        }
+
+        counter = dictCounter[cellName];
+        if (counter.intValue > 1) {
+            cell.uniqueTitle = [NSString stringWithFormat: @"%@ (%d)", cell.title, counter.intValue];
+        }
+
+        if (cell.subCells.count > 0) {
+            [self sdl_addUniqueNamesToCells:cell.subCells];
+        }
+    }
+}
+
+/**
+ Check for cell lists with completely duplicate information, or any duplicate voiceCommands
+
+ @param cells The cells you will be adding
+ @return Boolean that indicates whether menuCells are unique or not
+ */
+-(BOOL)sdl_menuCellsAreUnique:(NSArray<SDLMenuCell *> *)cells {
+    ///Check all voice commands for identical items and check each list of cells for identical cells
+    NSMutableSet *identicalCellsCheckSet = [NSMutableSet set];
+    for (SDLMenuCell *cell in cells) {
+        [identicalCellsCheckSet addObject:cell];
+        if (cell.subCells.count > 0 && ![self sdl_menuCellsAreUnique:cell.subCells]) {
+            return NO;
+        }
+
+        if (cell.voiceCommands == nil) { continue; }
+        [identicalVoiceCommandsCheckSet addObjectsFromArray:cell.voiceCommands];
+        voiceCommandCount += cell.voiceCommands.count;
+    }
+
+    // Check for duplicate cells
+    if (identicalCellsCheckSet.count != cells.count) {
+        SDLLogE(@"Not all cells are unique. The menu will not be set.");
+        return NO;
+    }
+
+    return YES;
+}
+
 #pragma mark Artworks
 
 - (NSArray<SDLArtwork *> *)sdl_findAllArtworksToBeUploadedFromCells:(NSArray<SDLMenuCell *> *)cells {
@@ -670,7 +725,7 @@ - (SDLAddCommand *)sdl_commandForMenuCell:(SDLMenuCell *)cell withArtwork:(BOOL)
     SDLAddCommand *command = [[SDLAddCommand alloc] init];
 
     SDLMenuParams *params = [[SDLMenuParams alloc] init];
-    params.menuName = cell.title;
+    params.menuName = cell.uniqueTitle;
     params.parentID = cell.parentCellId != UINT32_MAX ? @(cell.parentCellId) : nil;
     params.position = @(position);
     params.tertiaryText = cell.tertiaryText;
@@ -695,7 +750,7 @@ - (SDLAddSubMenu *)sdl_subMenuCommandForMenuCell:(SDLMenuCell *)cell withArtwork
     } else {
         submenuLayout = self.menuConfiguration.defaultSubmenuLayout;
     }
-    return [[SDLAddSubMenu alloc] initWithMenuID:cell.cellId menuName:cell.title position:@(position) menuIcon:icon menuLayout:submenuLayout parentID:nil secondaryText:cell.secondaryText tertiaryText:cell.tertiaryText secondaryImage:secondaryImage];
+    return [[SDLAddSubMenu alloc] initWithMenuID:cell.cellId menuName:cell.uniqueTitle position:@(position) menuIcon:icon menuLayout:submenuLayout parentID:nil secondaryText:cell.secondaryText tertiaryText:cell.tertiaryText secondaryImage:secondaryImage];
 }
 
 #pragma mark - Calling handlers
@@ -744,6 +799,8 @@ - (void)sdl_hmiStatusNotification:(SDLRPCNotificationNotification *)notification
         ![self.currentSystemContext isEqualToEnum:SDLSystemContextMenu]) {
         if (self.waitingOnHMIUpdate) {
             [self setMenuCells:self.waitingUpdateMenuCells];
+            identicalVoiceCommandsCheckSet = [NSMutableSet set];
+            voiceCommandCount = 0;
             self.waitingUpdateMenuCells = @[];
             return;
         }
@@ -758,6 +815,8 @@ - (void)sdl_hmiStatusNotification:(SDLRPCNotificationNotification *)notification
         && ![self.currentHMILevel isEqualToEnum:SDLHMILevelNone]) {
         if (self.waitingOnHMIUpdate) {
             [self setMenuCells:self.waitingUpdateMenuCells];
+            identicalVoiceCommandsCheckSet = [NSMutableSet set];
+            voiceCommandCount = 0;
             self.waitingUpdateMenuCells = @[];
         }
     }

SmartDeviceLink/private/SDLPreloadChoicesOperation.m

@@ -160,7 +160,7 @@ - (nullable SDLCreateInteractionChoiceSet *)sdl_choiceFromCell:(SDLChoiceCell *)
 
     NSString *menuName = nil;
     if ([self sdl_shouldSendChoiceText]) {
-        menuName = cell.text;
+        menuName = cell.uniqueText;
     }
 
     if(!menuName) {

SmartDeviceLink/public/SDLChoiceCell.h

@@ -45,6 +45,10 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (strong, nonatomic, readonly, nullable) SDLArtwork *secondaryArtwork;
 
+/**
+ Primary text of the cell to be displayed on the module. Used to distinguish cells with the same `text` but other fields are different. This is autogenerated by the screen manager. Attempting to use cells that are exactly the same (all text and artwork fields are the same) will not cause this to be used. This will not be used when connected to modules supporting RPC 7.1+.
+ */
+@property (strong, nonatomic, readonly) NSString *uniqueText;
 /**
  Initialize the cell with nothing. This is unavailable
 

SmartDeviceLink/public/SDLChoiceCell.m

@@ -9,12 +9,14 @@
 #import "SDLChoiceCell.h"
 
 #import "SDLArtwork.h"
+#import "NSArray+NSObject.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
 @interface SDLChoiceCell()
 
 @property (assign, nonatomic) UInt16 choiceId;
+@property (nonatomic, readwrite) NSString *uniqueText;
 
 @end
 
@@ -40,6 +42,7 @@ - (instancetype)initWithText:(NSString *)text secondaryText:(nullable NSString *
     _voiceCommands = voiceCommands;
     _artwork = artwork;
     _secondaryArtwork = secondaryArtwork;
+    _uniqueText = text;
 
     _choiceId = UINT16_MAX;
 
@@ -65,7 +68,7 @@ - (NSUInteger)hash {
     ^ NSUIntRotate(self.tertiaryText.hash, NSUIntBit / 4)
     ^ NSUIntRotate(self.artwork.name.hash, NSUIntBit / 5)
     ^ NSUIntRotate(self.secondaryArtwork.name.hash, NSUIntBit / 6)
-    ^ NSUIntRotate(self.voiceCommands.hash, NSUIntBit / 7);
+    ^ NSUIntRotate([self.voiceCommands dynamicHash], NSUIntBit / 7);
 }
 
 - (BOOL)isEqual:(id)object {
@@ -84,7 +87,7 @@ - (BOOL)isEqualToChoice:(SDLChoiceCell *)choice {
 #pragma mark - Etc.
 
 - (NSString *)description {
-    return [NSString stringWithFormat:@"SDLChoiceCell: %u-\"%@ - %@ - %@\", artworkNames: %@ - %@, voice commands: %lu", _choiceId, _text, _secondaryText, _tertiaryText, _artwork.name, _secondaryArtwork.name, (unsigned long)_voiceCommands.count];
+    return [NSString stringWithFormat:@"SDLChoiceCell: %u-\"%@ - %@ - %@\", artworkNames: %@ - %@, voice commands: %lu, uniqueText: %@", _choiceId, _text, _secondaryText, _tertiaryText, _artwork.name, _secondaryArtwork.name, (unsigned long)_voiceCommands.count, ([_text isEqualToString:_uniqueText] ? @"NO" : _uniqueText)];
 }
 
 @end