Add dockable Macro Window with readable replay diagnostics

forge-game/src/main/java/forge/game/player/actions/ActivateAbilityAction.java

@@ -15,7 +15,7 @@ public String getAbilityDescription() {
     }
 
     @Override
-    protected void appendDetails(final StringBuilder sb) {
-        sb.append(" ability=\"").append(abilityDescription).append("\"");
+    public String describe() {
+        return localize("lblMacroActionActivateAbility", describeEntity(), abilityDescription);
     }
 }

forge-game/src/main/java/forge/game/player/actions/CastSpellAction.java

@@ -6,4 +6,9 @@ public class CastSpellAction extends PlayerAction {
     public CastSpellAction(GameEntityView cardView) {
         super(cardView, "Cast spell");
     }
+
+    @Override
+    public String describe() {
+        return localize("lblMacroActionCastSpell", describeEntity());
+    }
 }

forge-game/src/main/java/forge/game/player/actions/ColorChoiceAction.java

@@ -15,7 +15,7 @@ public byte getColor() {
     }
 
     @Override
-    protected void appendDetails(final StringBuilder sb) {
-        sb.append(" color=").append(MagicColor.toShortString(color));
+    public String describe() {
+        return localize("lblMacroActionChooseColor", MagicColor.toLongString(color));
     }
 }

forge-game/src/main/java/forge/game/player/actions/ConfirmAction.java

@@ -15,7 +15,9 @@ public boolean isConfirmed() {
     }
 
     @Override
-    protected void appendDetails(final StringBuilder sb) {
-        sb.append(" confirmed=").append(confirmed);
+    public String describe() {
+        final String action = localize(confirmed ? "lblMacroActionConfirm" : "lblMacroActionDecline");
+        final String entity = describeEntity();
+        return entity.isEmpty() ? action : localize("lblMacroActionChoiceFor", action, entity);
     }
 }

forge-game/src/main/java/forge/game/player/actions/FinishTargetingAction.java

@@ -1,7 +1,12 @@
 package forge.game.player.actions;
 
-public class FinishTargetingAction extends PlayerAction{
+public class FinishTargetingAction extends PlayerAction {
     public FinishTargetingAction() {
         super(null, "Finish game entity");
     }
+
+    @Override
+    public String describe() {
+        return localize("lblMacroActionFinishSelecting");
+    }
 }

forge-game/src/main/java/forge/game/player/actions/ManaComboAction.java

@@ -1,5 +1,8 @@
 package forge.game.player.actions;
 
+import forge.card.MagicColor;
+
+import java.util.Collections;
 import java.util.LinkedHashMap;
 import java.util.Map;
 
@@ -8,15 +11,34 @@ public class ManaComboAction extends PlayerAction {
 
     public ManaComboAction(final Map<Byte, Integer> manaCombo) {
         super(null, "Choose mana combination");
-        this.manaCombo = new LinkedHashMap<>(manaCombo);
+        this.manaCombo = Collections.unmodifiableMap(new LinkedHashMap<>(manaCombo));
     }
 
     public Map<Byte, Integer> getManaCombo() {
         return manaCombo;
     }
 
     @Override
-    protected void appendDetails(final StringBuilder sb) {
-        sb.append(" manaCombo=").append(manaCombo);
+    public String describe() {
+        final StringBuilder sb = new StringBuilder();
+        boolean needComma = false;
+        for (final Map.Entry<Byte, Integer> entry : manaCombo.entrySet()) {
+            final int amount = entry.getValue() == null ? 0 : entry.getValue();
+            if (amount <= 0) {
+                continue;
+            }
+            if (needComma) {
+                sb.append(", ");
+            }
+            sb.append(describeColor(entry.getKey(), amount));
+            needComma = true;
+        }
+        return localize("lblMacroActionChooseManaCombination",
+                needComma ? sb.toString() : localize("lblMacroNone"));
+    }
+
+    private static String describeColor(final byte color, final int amount) {
+        final String colorName = MagicColor.toLongString(color);
+        return localize(amount == 1 ? "lblMacroManaAmount" : "lblMacroManaAmountPlural", amount, colorName);
     }
 }

forge-game/src/main/java/forge/game/player/actions/ModeChoiceAction.java

@@ -1,21 +1,24 @@
 package forge.game.player.actions;
 
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 
 public class ModeChoiceAction extends PlayerAction {
     private final List<String> modeDescriptions;
 
     public ModeChoiceAction(final List<String> modeDescriptions) {
         super(null, "Choose mode");
-        this.modeDescriptions = modeDescriptions;
+        this.modeDescriptions = Collections.unmodifiableList(new ArrayList<>(modeDescriptions));
     }
 
     public List<String> getModeDescriptions() {
         return modeDescriptions;
     }
 
     @Override
-    protected void appendDetails(final StringBuilder sb) {
-        sb.append(" modes=").append(modeDescriptions);
+    public String describe() {
+        return localize(modeDescriptions.size() == 1 ? "lblMacroActionChooseMode" : "lblMacroActionChooseModes",
+                describeList(modeDescriptions));
     }
 }

forge-game/src/main/java/forge/game/player/actions/PassPriorityAction.java

@@ -25,10 +25,9 @@ public PhaseType getPhase() {
     }
 
     @Override
-    protected void appendDetails(final StringBuilder sb) {
-        sb.append(" stackWasEmpty=").append(stackWasEmpty);
-        if (phase != null) {
-            sb.append(" phase=").append(phase);
-        }
+    public String describe() {
+        final String phaseText = phase == null ? "" : " " + localize("lblMacroActionDuringPhase", phase.nameForUi);
+        final String stackText = localize(stackWasEmpty ? "lblMacroStackEmpty" : "lblMacroStackNotEmpty");
+        return localize("lblMacroActionPassPriority", phaseText, stackText);
     }
 }

forge-game/src/main/java/forge/game/player/actions/PayCostAction.java

@@ -6,4 +6,9 @@ public class PayCostAction extends PlayerAction {
     public PayCostAction(GameEntityView cardView) {
         super(cardView, "Pay cost");
     }
+
+    @Override
+    public String describe() {
+        return localize("lblMacroActionPayCost", describeEntity());
+    }
 }

forge-game/src/main/java/forge/game/player/actions/PayManaFromPoolAction.java

@@ -1,8 +1,10 @@
 package forge.game.player.actions;
 
+import forge.card.MagicColor;
+
+public class PayManaFromPoolAction extends PlayerAction {
+    private final byte colorSelected;
 
-public class PayManaFromPoolAction extends PlayerAction{
-    private byte colorSelected;
     public PayManaFromPoolAction(byte colorCode) {
         super(null, "Pay mana");
         colorSelected = colorCode;
@@ -13,7 +15,7 @@ public byte getSelectedColor() {
     }
 
     @Override
-    protected void appendDetails(final StringBuilder sb) {
-        sb.append(" mana=").append(colorSelected);
+    public String describe() {
+        return localize("lblMacroActionPayManaFromPool", MagicColor.toSymbol(colorSelected));
     }
 }

forge-game/src/main/java/forge/game/player/actions/PlayerAction.java

@@ -2,17 +2,25 @@
 
 import forge.game.GameEntityView;
 import forge.game.player.PlayerController;
+import forge.util.Localizer;
+
+import java.util.List;
+import java.util.regex.Pattern;
 
 public abstract class PlayerAction {
-    protected String name;
-    protected GameEntityView gameEntityView = null;
+    private static final Pattern ENTITY_ID_SUFFIX = Pattern.compile(" \\((\\d+)\\)$");
+    private static final Localizer LOCALIZER = Localizer.getInstance();
+
+    private final String name;
+    private final GameEntityView gameEntityView;
 
     public PlayerAction(GameEntityView cardView) {
         gameEntityView = cardView;
+        name = null;
     }
 
     public PlayerAction(final GameEntityView cardView, final String actionName) {
-        this(cardView);
+        gameEntityView = cardView;
         name = actionName;
     }
 
@@ -26,14 +34,38 @@ public GameEntityView getGameEntityView() {
     }
 
     public String describe() {
-        final StringBuilder sb = new StringBuilder(getClass().getSimpleName());
-        if (gameEntityView != null) {
-            sb.append("(").append(gameEntityView).append(")");
+        final StringBuilder sb = new StringBuilder(name == null ? getClass().getSimpleName() : name);
+        final String entity = describeEntity();
+        if (!entity.isEmpty()) {
+            sb.append(": ").append(entity);
         }
         appendDetails(sb);
         return sb.toString();
     }
 
+    protected String describeEntity() {
+        return gameEntityView == null ? "" : describeEntity(gameEntityView);
+    }
+
+    protected static String describeEntity(final GameEntityView entity) {
+        return entity == null ? "" : ENTITY_ID_SUFFIX.matcher(String.valueOf(entity)).replaceAll(" $1");
+    }
+
+    protected static String describeList(final List<String> values) {
+        if (values == null || values.isEmpty()) {
+            return localize("lblMacroNone");
+        }
+        final StringBuilder sb = new StringBuilder();
+        for (final String value : values) {
+            sb.append('\n').append("- ").append(value);
+        }
+        return sb.toString();
+    }
+
+    protected static String localize(final String key, final Object... args) {
+        return LOCALIZER.getMessage(key, args);
+    }
+
     protected void appendDetails(final StringBuilder sb) {
     }
 

forge-game/src/main/java/forge/game/player/actions/ScryAction.java

@@ -25,7 +25,7 @@ private static List<String> namesOf(final CardCollectionView cards) {
         for (final Card card : cards) {
             names.add(card.getName());
         }
-        return names;
+        return Collections.unmodifiableList(names);
     }
 
     public List<String> getTopCardNames() {
@@ -37,8 +37,7 @@ public List<String> getBottomCardNames() {
     }
 
     @Override
-    protected void appendDetails(final StringBuilder sb) {
-        sb.append(" top=").append(topCardNames);
-        sb.append(" bottom=").append(bottomCardNames);
+    public String describe() {
+        return localize("lblMacroActionScry", describeList(topCardNames), describeList(bottomCardNames));
     }
 }

forge-game/src/main/java/forge/game/player/actions/SelectCardAction.java

@@ -2,10 +2,13 @@
 
 import forge.game.GameEntityView;
 
-public class SelectCardAction extends PlayerAction{
+public class SelectCardAction extends PlayerAction {
     public SelectCardAction(GameEntityView cardView) {
         super(cardView, "Select card");
     }
 
-
+    @Override
+    public String describe() {
+        return localize("lblMacroActionSelectCard", describeEntity());
+    }
 }

forge-game/src/main/java/forge/game/player/actions/SelectPlayerAction.java

@@ -7,4 +7,8 @@ public SelectPlayerAction(GameEntityView playerView) {
         super(playerView, "Select player");
     }
 
+    @Override
+    public String describe() {
+        return localize("lblMacroActionSelectPlayer", describeEntity());
+    }
 }

forge-game/src/main/java/forge/game/player/actions/StackOrderAction.java

@@ -1,21 +1,23 @@
 package forge.game.player.actions;
 
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 
 public class StackOrderAction extends PlayerAction {
     private final List<String> abilityDescriptions;
 
     public StackOrderAction(final List<String> abilityDescriptions) {
         super(null, "Order simultaneous abilities");
-        this.abilityDescriptions = abilityDescriptions;
+        this.abilityDescriptions = Collections.unmodifiableList(new ArrayList<>(abilityDescriptions));
     }
 
     public List<String> getAbilityDescriptions() {
         return abilityDescriptions;
     }
 
     @Override
-    protected void appendDetails(final StringBuilder sb) {
-        sb.append(" order=").append(abilityDescriptions);
+    public String describe() {
+        return localize("lblMacroActionOrderAbilities", describeList(abilityDescriptions));
     }
 }

forge-game/src/main/java/forge/game/player/actions/TargetEntityAction.java

@@ -7,4 +7,9 @@ public class TargetEntityAction extends PlayerAction {
     public TargetEntityAction(GameEntityView cardView) {
         super(cardView, "Target game entity");
     }
+
+    @Override
+    public String describe() {
+        return localize("lblMacroActionChooseTarget", describeEntity());
+    }
 }

forge-gui-desktop/src/main/java/forge/control/KeyboardShortcuts.java

@@ -193,11 +193,12 @@ public void actionPerformed(final ActionEvent e) {
             }
         };
 
-        final Action actMacroRecord = macroAction(matchUI, ui -> ui.getGameController().macros().setRememberedActions());
+        final Action actMacroRecord = macroAction(matchUI, ui -> ui.getCDock().toggleMacroRecording());
 
-        final Action actMacroNextAction = macroAction(matchUI, ui -> ui.getGameController().macros().nextRememberedAction());
+        final Action actMacroNextAction = macroActionAndRefreshControls(matchUI,
+                ui -> ui.getGameController().macros().nextRememberedAction());
 
-        final Action actMacroRepeatActions = macroAction(matchUI,
+        final Action actMacroRepeatActions = macroActionAndRefreshControls(matchUI,
                 ui -> ui.getGameController().macros().repeatRememberedActions());
 
         final Action actZoomCard = new AbstractAction() {
@@ -305,11 +306,18 @@ public void actionPerformed(final ActionEvent e) {
                     return;
                 }
                 command.accept(matchUI);
-                matchUI.getCDock().refreshMacroButtons();
             }
         };
     }
 
+    private static Action macroActionAndRefreshControls(final CMatchUI matchUI, final Consumer<CMatchUI> command) {
+        return macroAction(matchUI, ui -> {
+            command.accept(ui);
+            ui.getCDock().refreshMacroButtons();
+            ui.getCMacro().update();
+        });
+    }
+
     /**
      * 
      * Instantiates a shortcut key instance with various properties for use

forge-gui-desktop/src/main/java/forge/gui/framework/EDocID.java

@@ -95,6 +95,7 @@ public enum EDocID {
     REPORT_STACK (),
     REPORT_COMBAT (),
     REPORT_DEPENDENCIES (),
+    REPORT_MACRO (),
     REPORT_LOG (),
 
     DEV_MODE (),