Merge branch '1.7.1' into develop

Author: herzbube

Little Go.xcodeproj/project.pbxproj

@@ -666,6 +666,8 @@
 		CDD48FB01413E95500188B6A /* CommandBase.m in Sources */ = {isa = PBXBuildFile; fileRef = CDD48FAF1413E95500188B6A /* CommandBase.m */; };
 		CDD48FC01414038000188B6A /* CommandProcessor.m in Sources */ = {isa = PBXBuildFile; fileRef = CDD48FBF1414038000188B6A /* CommandProcessor.m */; };
 		CDD4901B14141BCF00188B6A /* CommandProcessor.m in Sources */ = {isa = PBXBuildFile; fileRef = CDD48FBF1414038000188B6A /* CommandProcessor.m */; };
+		CDD67B6C28DDEC4F00F5196A /* NSObjectAddtions.m in Sources */ = {isa = PBXBuildFile; fileRef = CDD67B6A28DDEC4F00F5196A /* NSObjectAddtions.m */; };
+		CDD67B6D28DDEC4F00F5196A /* NSObjectAddtions.m in Sources */ = {isa = PBXBuildFile; fileRef = CDD67B6A28DDEC4F00F5196A /* NSObjectAddtions.m */; };
 		CDD7D7E5175257850068CBBA /* ResetPlayersAndProfilesCommand.m in Sources */ = {isa = PBXBuildFile; fileRef = CDD7D7E4175257850068CBBA /* ResetPlayersAndProfilesCommand.m */; };
 		CDD86B4A2827E91500AA0A6B /* StaticTableView.m in Sources */ = {isa = PBXBuildFile; fileRef = CDD86B482827E91400AA0A6B /* StaticTableView.m */; };
 		CDD86B4B2827E91500AA0A6B /* StaticTableView.m in Sources */ = {isa = PBXBuildFile; fileRef = CDD86B482827E91400AA0A6B /* StaticTableView.m */; };
@@ -1546,6 +1548,8 @@
 		CDD48FAF1413E95500188B6A /* CommandBase.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CommandBase.m; sourceTree = "<group>"; };
 		CDD48FBE1414038000188B6A /* CommandProcessor.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CommandProcessor.h; sourceTree = "<group>"; };
 		CDD48FBF1414038000188B6A /* CommandProcessor.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CommandProcessor.m; sourceTree = "<group>"; };
+		CDD67B6A28DDEC4F00F5196A /* NSObjectAddtions.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = NSObjectAddtions.m; sourceTree = "<group>"; };
+		CDD67B6B28DDEC4F00F5196A /* NSObjectAddtions.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = NSObjectAddtions.h; sourceTree = "<group>"; };
 		CDD7D7E3175257850068CBBA /* ResetPlayersAndProfilesCommand.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ResetPlayersAndProfilesCommand.h; sourceTree = "<group>"; };
 		CDD7D7E4175257850068CBBA /* ResetPlayersAndProfilesCommand.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ResetPlayersAndProfilesCommand.m; sourceTree = "<group>"; };
 		CDD7D7E61753F3FD0068CBBA /* NOTES.Build.3rdparty */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = NOTES.Build.3rdparty; sourceTree = "<group>"; };
@@ -3194,6 +3198,8 @@
 				CD2230B225E661E600187C57 /* LogFormatter.m */,
 				CD1E6EA92860F0BC00785E23 /* MarkupUtilities.h */,
 				CD1E6EA82860F0BC00785E23 /* MarkupUtilities.mm */,
+				CDD67B6B28DDEC4F00F5196A /* NSObjectAddtions.h */,
+				CDD67B6A28DDEC4F00F5196A /* NSObjectAddtions.m */,
 				CDFA4AD013F71859001A2A94 /* NSStringAdditions.h */,
 				CDFA4AD113F71859001A2A94 /* NSStringAdditions.m */,
 				CDFA32A615A0A3E400439B4E /* PathUtilities.h */,
@@ -3971,6 +3977,7 @@
 				CD1E6EAF2865F9BD00785E23 /* PanGestureHandler.m in Sources */,
 				CDEE19F919433EAC00DF2389 /* BoardViewLayerDelegateBase.m in Sources */,
 				CD1F503F25B7A5C20098037A /* ViewLoadResultMessageController.m in Sources */,
+				CDD67B6C28DDEC4F00F5196A /* NSObjectAddtions.m in Sources */,
 				CDE302891360BDA4005235F2 /* Player.m in Sources */,
 				CDE3028A1360BDA4005235F2 /* PlayerModel.m in Sources */,
 				CDE3028B1360BDA4005235F2 /* PlayerStatistics.m in Sources */,
@@ -4255,6 +4262,7 @@
 				CDFABF5C141D343B0065C93B /* CommandBase.m in Sources */,
 				CDEE19FC19433EAC00DF2389 /* GridLayerDelegate.m in Sources */,
 				CD05A9E81422B01600214BBE /* ComputerPlayMoveCommand.m in Sources */,
+				CDD67B6D28DDEC4F00F5196A /* NSObjectAddtions.m in Sources */,
 				CDEE1A0419438AE000DF2389 /* StonesLayerDelegate.m in Sources */,
 				CD7C6A161AB49631009EC5AD /* BoardPositionCollectionViewController.m in Sources */,
 				CD05AB97142516A400214BBE /* GoUtilities.m in Sources */,
@@ -4465,13 +4473,13 @@
 				CODE_SIGN_ENTITLEMENTS = resource/plist/Entitlements.plist;
 				CODE_SIGN_IDENTITY = "iPhone Developer";
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 24;
+				CURRENT_PROJECT_VERSION = 26;
 				DEVELOPMENT_TEAM = "";
 				EXCLUDED_SOURCE_FILE_NAMES = "GoogleService-Info.plist";
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = src/main/Prefix.pch;
 				INFOPLIST_FILE = resource/plist/Info.plist;
-				MARKETING_VERSION = 1.7.0;
+				MARKETING_VERSION = 1.7.1;
 				PRODUCT_BUNDLE_IDENTIFIER = ch.herzbube.littlego;
 				PRODUCT_NAME = "Little Go";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -4487,12 +4495,12 @@
 				CODE_SIGN_ENTITLEMENTS = resource/plist/Entitlements.plist;
 				CODE_SIGN_IDENTITY = "iPhone Developer";
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 24;
+				CURRENT_PROJECT_VERSION = 26;
 				DEVELOPMENT_TEAM = "";
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = src/main/Prefix.pch;
 				INFOPLIST_FILE = resource/plist/Info.plist;
-				MARKETING_VERSION = 1.7.0;
+				MARKETING_VERSION = 1.7.1;
 				PRODUCT_BUNDLE_IDENTIFIER = ch.herzbube.littlego;
 				PRODUCT_NAME = "Little Go";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -4695,12 +4703,12 @@
 				CODE_SIGN_ENTITLEMENTS = resource/plist/Entitlements.plist;
 				CODE_SIGN_IDENTITY = "iPhone Developer";
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 24;
+				CURRENT_PROJECT_VERSION = 26;
 				DEVELOPMENT_TEAM = "";
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = src/main/Prefix.pch;
 				INFOPLIST_FILE = resource/plist/Info.plist;
-				MARKETING_VERSION = 1.7.0;
+				MARKETING_VERSION = 1.7.1;
 				PRODUCT_BUNDLE_IDENTIFIER = ch.herzbube.littlego;
 				PRODUCT_NAME = "Little Go";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -5019,12 +5027,12 @@
 				CODE_SIGN_ENTITLEMENTS = resource/plist/Entitlements.plist;
 				CODE_SIGN_IDENTITY = "iPhone Developer";
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 24;
+				CURRENT_PROJECT_VERSION = 26;
 				DEVELOPMENT_TEAM = "";
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = src/main/Prefix.pch;
 				INFOPLIST_FILE = resource/plist/Info.plist;
-				MARKETING_VERSION = 1.7.0;
+				MARKETING_VERSION = 1.7.1;
 				PRODUCT_BUNDLE_IDENTIFIER = ch.herzbube.littlego;
 				PRODUCT_NAME = "Little Go";
 				PROVISIONING_PROFILE_SPECIFIER = "";

README.md

@@ -9,7 +9,9 @@ Little Go is released under the [Apache License](http://www.apache.org/licenses/
 
 ## Changes in this release
 
-This is the Little Go feature release 1.7.0. A selection of the most important changes are:
+This is the Little Go bugfix release 1.7.1. It contains two fixes for bugs that caused the app to crash (#397 and #398).
+
+The previous release was the Little Go feature release 1.7.0. A selection of the most important changes are:
 
 - The app now supports reading and writing of all SGF node annotation and move annotation properties (#339). The app also displays these properties' values and lets you edit them. This means that you can now add a valuation to a move (e.g. good/bad move) and/or to the entire board position (e.g. good position for black/white), designate a board position to be a "hotspot" (e.g. it contains a game-deciding move), annotate a board position with an estimated score, and finally you can add textual notes to a board position. Annotation data is displayed by, and can be edited via, an all-new annotation view.
 - The app now supports reading and writing of all SGF markup properties (#349). Except for the DD property (dim parts of the board), the app also displays these properties' values and lets you edit them. This means that you can now mark intersections on the board with 5 different symbols (circle, square, triangle, "X" mark, "selected" symbol), place single-character letter markers or single-digit number markers, place a free-form label text, and finally you can draw arrows or plain lines on the board. The app has an all-new markup editing mode for this (accessible via menu icon) that includes drag & drop support to move around existing markup.

doc/ChangeLog

@@ -1,3 +1,37 @@
+--------------------------------------------------------------------------------
+Version 1.7.1 (September 23 2022)
+--------------------------------------------------------------------------------
+========
+Features
+========
+- None
+
+========
+Bugfixes
+========
+- Fixed app crash when board position cells are reused after a new game is
+  started or loaded from the archive (#397).
+- The app no longer crashes when the user performs a board setup operation (e.g.
+  places a setup stone) and the game has ended without any move because a player
+  immediately resigned without playing a move (#398).
+
+===========
+Regressions
+===========
+- None
+
+=================
+Technical changes
+=================
+- None
+
+=================
+GitHub issue list
+=================
+A list of all issues closed for this release is available on GitHub:
+https://github.com/herzbube/littlego/milestone/22?closed=1
+
+
 --------------------------------------------------------------------------------
 Version 1.7.0 (September 16 2022)
 --------------------------------------------------------------------------------

src/command/boardposition/ChangeAndDiscardCommand.h

@@ -24,6 +24,8 @@
 /// current board position, possibly the position that precedes it, and all
 /// positions that follow afterwards. As a side effect, the current board
 /// position changes to the one preceding the ones that were just discarded.
+/// The second responsibility of ChangeAndDiscardCommand is to revert the game
+/// state to "in progress" if the game is currently ended.
 ///
 /// If the user preference DiscardMyLastMove is turned on (the default) and the
 /// current board position was created by a computer player's move, then all
@@ -34,10 +36,14 @@
 /// player moves.
 ///
 /// If there is only one board position (i.e. no moves have been made yet and
-/// no other nodes have been created yet), ChangeAndDiscardCommand does nothing.
+/// no other nodes have been created yet), ChangeAndDiscardCommand reverts the
+/// game state to "in progress" if the game is currently ended (e.g. if a player
+/// resigned immediately without playing a move). If the game is not currently
+/// ended, ChangeAndDiscardCommand does nothing.
 ///
-/// After it has made the discard, ChangeAndDiscardCommand performs a backup
-/// of the current game.
+/// After it has made the discard and/or reverted the game state to
+/// "in progress", ChangeAndDiscardCommand performs a backup of the current
+/// game.
 ///
 /// @note The first board position represents the start of the game and cannot
 /// be discarded. Therefore, if ChangeAndDiscardCommand is executed when the

src/command/boardposition/ChangeAndDiscardCommand.m

@@ -40,40 +40,56 @@ @implementation ChangeAndDiscardCommand
 - (bool) doIt
 {
   bool shouldDiscardBoardPositions = [self shouldDiscardBoardPositions];
-  if (! shouldDiscardBoardPositions)
+  bool shouldRevertGameStateToInProgress = [self shouldRevertGameStateToInProgress];
+  if (! shouldDiscardBoardPositions && ! shouldRevertGameStateToInProgress)
     return true;
 
   @try
   {
     [[ApplicationStateManager sharedManager] beginSavePoint];
     [[LongRunningActionCounter sharedCounter] increment];
 
+    bool success;
+
     // Before we discard, first change to a board position that will be valid
     // even after the discard.
-    bool success = [self changeBoardPosition];
-    if (! success)
+    if (shouldDiscardBoardPositions)
     {
-      DDLogError(@"%@: Aborting because changeBoardPosition failed", [self shortDescription]);
-      return false;
+      success = [self changeBoardPositionIfNecessary];
+      if (! success)
+      {
+        DDLogError(@"%@: Aborting because changeBoardPositionIfNecessary failed", [self shortDescription]);
+        return false;
+      }
     }
-    success = [self revertGameStateIfNecessary];
-    if (! success)
+
+    if (shouldRevertGameStateToInProgress)
     {
-      DDLogError(@"%@: Aborting because revertGameStateIfNecessary failed", [self shortDescription]);
-      return false;
+      success = [self revertGameStateIfNecessary];
+      if (! success)
+      {
+        DDLogError(@"%@: Aborting because revertGameStateIfNecessary failed", [self shortDescription]);
+        return false;
+      }
     }
-    success = [self discardNodes];
-    if (! success)
+
+    if (shouldDiscardBoardPositions)
     {
-      DDLogError(@"%@: Aborting because discardNodes failed", [self shortDescription]);
-      return false;
+      success = [self discardNodesIfNecessary];
+      if (! success)
+      {
+        DDLogError(@"%@: Aborting because discardNodesIfNecessary failed", [self shortDescription]);
+        return false;
+      }
     }
+
     success = [self backupGame];
     if (! success)
     {
       DDLogError(@"%@: Aborting because backupGame failed", [self shortDescription]);
       return false;
     }
+
     return success;
   }
   @finally
@@ -98,10 +114,20 @@ - (bool) shouldDiscardBoardPositions
     return true;
 }
 
+// -----------------------------------------------------------------------------
+/// @brief Private helper for doIt(). Returns true if the game state needs to
+/// be reverted to "in progress", false otherwise.
+// -----------------------------------------------------------------------------
+- (bool) shouldRevertGameStateToInProgress
+{
+  GoGame* game = [GoGame sharedGame];
+  return (game.state == GoGameStateGameHasEnded);
+}
+
 // -----------------------------------------------------------------------------
 /// @brief Private helper for doIt(). Returns true on success, false on failure.
 // -----------------------------------------------------------------------------
-- (bool) changeBoardPosition
+- (bool) changeBoardPositionIfNecessary
 {
   GoBoardPosition* boardPosition = [GoGame sharedGame].boardPosition;
   if (boardPosition.currentBoardPosition == 0)
@@ -175,14 +201,20 @@ - (bool) revertGameStateIfNecessary
 // -----------------------------------------------------------------------------
 /// @brief Private helper for doIt(). Returns true on success, false on failure.
 // -----------------------------------------------------------------------------
-- (bool) discardNodes
+- (bool) discardNodesIfNecessary
 {
   GoGame* game = [GoGame sharedGame];
   GoBoardPosition* boardPosition = game.boardPosition;
-  int indexOfFirstNodeToDiscard = boardPosition.currentBoardPosition + 1;
-  DDLogInfo(@"%@: Index position of first node to discard = %d", [self shortDescription], indexOfFirstNodeToDiscard);
   GoNodeModel* nodeModel = game.nodeModel;
+
+  int indexOfFirstNodeToDiscard = boardPosition.currentBoardPosition + 1;
+  int numberOfNodes = nodeModel.numberOfNodes;
+  if (indexOfFirstNodeToDiscard >= numberOfNodes)
+    return true;
+
+  DDLogInfo(@"%@: Index position of first node to discard = %d, number of nodes = %d", [self shortDescription], indexOfFirstNodeToDiscard, numberOfNodes);
   [nodeModel discardNodesFromIndex:indexOfFirstNodeToDiscard];
+
   return true;
 }
 

src/command/boardsetup/DiscardAllSetupStonesCommand.m

@@ -114,7 +114,7 @@ - (void) didDismissAlertWithButton:(enum AlertButtonType)alertButtonType
     [[ApplicationStateManager sharedManager] beginSavePoint];
     [[LongRunningActionCounter sharedCounter] increment];
 
-    if (game.boardPosition.numberOfBoardPositions > 0)
+    if (game.boardPosition.numberOfBoardPositions > 0 || game.state == GoGameStateGameHasEnded)
     {
       // Whoever invoked DiscardAllSetupStonesCommand must have previously
       // made sure that it's OK to discard future moves. We can therefore safely

src/command/boardsetup/HandleBoardSetupInteractionCommand.m

@@ -173,7 +173,7 @@ - (void) handleBoardSetupInteraction
     [[ApplicationStateManager sharedManager] beginSavePoint];
     [[LongRunningActionCounter sharedCounter] increment];
 
-    if (game.boardPosition.numberOfBoardPositions > 0)
+    if (game.boardPosition.numberOfBoardPositions > 0 || game.state == GoGameStateGameHasEnded)
     {
       // Whoever invoked HandleBoardSetupInteractionCommand must have previously
       // made sure that it's OK to discard future moves. We can therefore safely

src/command/boardsetup/SetupFirstMoveColorCommand.m

@@ -91,7 +91,7 @@ - (bool) doIt
     [[ApplicationStateManager sharedManager] beginSavePoint];
     [[LongRunningActionCounter sharedCounter] increment];
 
-    if (game.boardPosition.numberOfBoardPositions > 0)
+    if (game.boardPosition.numberOfBoardPositions > 0 || game.state == GoGameStateGameHasEnded)
     {
       // Whoever invoked SetupFirstMoveColorCommand must have previously
       // made sure that it's OK to discard future moves. We can therefore safely