Attraction Support

forge-core/src/main/java/forge/card/CardDb.java

@@ -37,6 +37,7 @@
 
 import java.util.*;
 import java.util.Map.Entry;
+import java.util.stream.Collectors;
 
 public final class CardDb implements ICardDatabase, IDeckGenPool {
     public final static String foilSuffix = "+";
@@ -272,7 +273,22 @@ private void addSetCard(CardEdition e, CardInSet cis, CardRules cr) {
         }
 
         artIds.put(key, artIdx);
-        addCard(new PaperCard(cr, e.getCode(), cis.rarity, artIdx, false, cis.collectorNumber, cis.artistName));
+        addCard(new PaperCard(cr, e.getCode(), cis.rarity, artIdx, false, cis.collectorNumber, cis.artistName, cis.functionalVariantName));
+    }
+
+    private boolean addFromSetByName(String cardName, CardEdition ed, CardRules cr) {
+        List<CardInSet> cardsInSet = ed.getCardInSet(cardName);  // empty collection if not present
+        if (cr.hasFunctionalVariants()) {
+            cardsInSet = cardsInSet.stream().filter(c -> StringUtils.isEmpty(c.functionalVariantName)
+                    || cr.getSupportedFunctionalVariants().contains(c.functionalVariantName)
+            ).collect(Collectors.toList());
+        }
+        if (cardsInSet.isEmpty())
+            return false;
+        for (CardInSet cis : cardsInSet) {
+            addSetCard(ed, cis, cr);
+        }
+        return true;
     }
 
     public void loadCard(String cardName, String setCode, CardRules cr) {
@@ -285,18 +301,10 @@ public void loadCard(String cardName, String setCode, CardRules cr) {
         if (ed == null || ed.equals(CardEdition.UNKNOWN)) {
             // look for all possible editions
             for (CardEdition e : editions) {
-                List<CardInSet> cardsInSet = e.getCardInSet(cardName);  // empty collection if not present
-                for (CardInSet cis : cardsInSet) {
-                    addSetCard(e, cis, cr);
-                    reIndexNecessary = true;
-                }
+                reIndexNecessary |= addFromSetByName(cardName, e, cr);
             }
         } else {
-            List<CardInSet> cardsInSet = ed.getCardInSet(cardName);  // empty collection if not present
-            for (CardInSet cis : cardsInSet) {
-                addSetCard(ed, cis, cr);
-                reIndexNecessary = true;
-            }
+            reIndexNecessary |= addFromSetByName(cardName, ed, cr);
         }
 
         if (reIndexNecessary)
@@ -324,11 +332,20 @@ public void initialize(boolean logMissingPerEdition, boolean logMissingSummary,
 
             for (CardEdition.CardInSet cis : e.getAllCardsInSet()) {
                 CardRules cr = rulesByName.get(cis.name);
-                if (cr != null) {
-                    addSetCard(e, cis, cr);
-                } else {
+                if (cr == null) {
                     missingCards.add(cis.name);
+                    continue;
                 }
+                if (cr.hasFunctionalVariants()) {
+                    if (StringUtils.isNotEmpty(cis.functionalVariantName)
+                        && !cr.getSupportedFunctionalVariants().contains(cis.functionalVariantName)) {
+                        //Supported card, unsupported variant.
+                        //Could note the card as missing but since these are often un-cards,
+                        //it's likely absent because it does something out of scope.
+                        continue;
+                    }
+                }
+                addSetCard(e, cis, cr);
             }
             if (isCoreExpSet && logMissingPerEdition) {
                 if (missingCards.isEmpty()) {
@@ -871,14 +888,16 @@ public int getMaxArtIndex(String cardName) {
 
     @Override
     public int getArtCount(String cardName, String setCode) {
+        return getArtCount(cardName, setCode, null);
+    }
+    public int getArtCount(String cardName, String setCode, String functionalVariantName) {
         if (cardName == null || setCode == null)
             return 0;
-        Collection<PaperCard> cardsInSet = getAllCards(cardName, new Predicate<PaperCard>() {
-            @Override
-            public boolean apply(PaperCard card) {
-                return card.getEdition().equalsIgnoreCase(setCode);
-            }
-        });
+        Predicate<PaperCard> predicate = card -> card.getEdition().equalsIgnoreCase(setCode);
+        if(functionalVariantName != null && !functionalVariantName.equals(IPaperCard.NO_FUNCTIONAL_VARIANT)) {
+            predicate = Predicates.and(predicate, card -> functionalVariantName.equals(card.getFunctionalVariant()));
+        }
+        Collection<PaperCard> cardsInSet = getAllCards(cardName, predicate);
         return cardsInSet.size();
     }
 
@@ -1142,7 +1161,7 @@ public StringBuilder appendCardToStringBuilder(PaperCard card, StringBuilder sb)
         }
 
         if (!hasBadSetInfo) {
-            int artCount = getArtCount(card.getName(), card.getEdition());
+            int artCount = getArtCount(card.getName(), card.getEdition(), card.getFunctionalVariant());
             sb.append(CardDb.NameSetSeparator).append(card.getEdition());
             if (artCount >= IPaperCard.DEFAULT_ART_INDEX) {
                 sb.append(CardDb.NameSetSeparator).append(card.getArtIndex()); // indexes start at 1 to match image file name conventions
@@ -1229,7 +1248,7 @@ public CardRules putCard(CardRules rules, List<Pair<String, CardRarity>> whenItW
                     int artIdx = IPaperCard.DEFAULT_ART_INDEX;
                     for (CardInSet cis : e.getCardInSet(cardName))
                         paperCards.add(new PaperCard(rules, e.getCode(), cis.rarity, artIdx++, false,
-                                                     cis.collectorNumber, cis.artistName));
+                                                     cis.collectorNumber, cis.artistName, cis.functionalVariantName));
                 }
             } else {
                 String lastEdition = null;
@@ -1249,7 +1268,7 @@ public CardRules putCard(CardRules rules, List<Pair<String, CardRarity>> whenItW
                     int cardInSetIndex = Math.max(artIdx-1, 0); // make sure doesn't go below zero
                     CardInSet cds = cardsInSet.get(cardInSetIndex);  // use ArtIndex to get the right Coll. Number
                     paperCards.add(new PaperCard(rules, lastEdition, tuple.getValue(), artIdx++, false,
-                                                 cds.collectorNumber, cds.artistName));
+                                                 cds.collectorNumber, cds.artistName, cds.functionalVariantName));
                 }
             }
             if (paperCards.isEmpty()) {

forge-core/src/main/java/forge/card/CardEdition.java

@@ -166,12 +166,14 @@ public static class CardInSet implements Comparable<CardInSet> {
         public final String collectorNumber;
         public final String name;
         public final String artistName;
+        public final String functionalVariantName;
 
-        public CardInSet(final String name, final String collectorNumber, final CardRarity rarity, final String artistName) {
+        public CardInSet(final String name, final String collectorNumber, final CardRarity rarity, final String artistName, final String functionalVariantName) {
             this.name = name;
             this.collectorNumber = collectorNumber;
             this.rarity = rarity;
             this.artistName = artistName;
+            this.functionalVariantName = functionalVariantName;
         }
 
         public String toString() {
@@ -189,6 +191,10 @@ public String toString() {
                 sb.append(" @");
                 sb.append(artistName);
             }
+            if (functionalVariantName != null) {
+                sb.append(" $");
+                sb.append(functionalVariantName);
+            }
             return sb.toString();
         }
 
@@ -567,9 +573,11 @@ protected CardEdition read(File file) {
                     * cnum - grouping #2
                     * rarity - grouping #4
                     * name - grouping #5
+                    * artist name - grouping #7
+                    * functional variant name - grouping #9
              */
 //                "(^(.?[0-9A-Z]+.?))?(([SCURML]) )?(.*)$"
-                "(^(.?[0-9A-Z]+\\S?[A-Z]*)\\s)?(([SCURML])\\s)?([^@]*)( @(.*))?$"
+                    "(^(.?[0-9A-Z]+\\S?[A-Z]*)\\s)?(([SCURML])\\s)?([^@\\$]*)( @([^\\$]*))?( \\$(.+))?$"
             );
 
             ListMultimap<String, CardInSet> cardMap = ArrayListMultimap.create();
@@ -595,7 +603,8 @@ protected CardEdition read(File file) {
                         CardRarity r = CardRarity.smartValueOf(matcher.group(4));
                         String cardName = matcher.group(5);
                         String artistName = matcher.group(7);
-                        CardInSet cis = new CardInSet(cardName, collectorNumber, r, artistName);
+                        String functionalVariantName = matcher.group(9);
+                        CardInSet cis = new CardInSet(cardName, collectorNumber, r, artistName, functionalVariantName);
 
                         cardMap.put(sectionName, cis);
                     }

forge-core/src/main/java/forge/card/CardFace.java

@@ -1,10 +1,12 @@
 package forge.card;
 
-import forge.card.mana.ManaCost;
-import org.apache.commons.lang3.StringUtils;
-
 import java.util.*;
 import java.util.Map.Entry;
+import java.util.stream.Collectors;
+
+import org.apache.commons.lang3.StringUtils;
+
+import forge.card.mana.ManaCost;
 
 //
 // DO NOT AUTOFORMAT / CHECKSTYLE THIS FILE
@@ -40,6 +42,7 @@ public enum FaceSelectionMethod { //
     private String toughness = null;
     private String initialLoyalty = "";
     private String defense = "";
+    private Set<Integer> attractionLights = null;
 
     private String nonAbilityText = null;
     private List<String> keywords = null;
@@ -50,6 +53,8 @@ public enum FaceSelectionMethod { //
     private List<String> replacements = null;
     private Map<String, String> variables = null;
 
+    private Map<String, CardFace> functionalVariants = null;
+
 
 
     // these implement ICardCharacteristics 
@@ -60,6 +65,7 @@ public enum FaceSelectionMethod { //
     @Override public String getToughness()          { return toughness; }
     @Override public String getInitialLoyalty()              { return initialLoyalty; }
     @Override public String getDefense()              { return defense; }
+    @Override public Set<Integer> getAttractionLights()   { return attractionLights; }
     @Override public String getName()               { return this.name; }
     @Override public CardType getType()             { return this.type; }
     @Override public ManaCost getManaCost()         { return this.manaCost; }
@@ -73,24 +79,35 @@ public enum FaceSelectionMethod { //
     @Override public Iterable<String> getDraftActions()   { return draftActions; }
     @Override public Iterable<String> getReplacements() { return replacements; }
     @Override public String getNonAbilityText()       { return nonAbilityText; }
-    @Override public Iterable<Entry<String, String>> getVariables() { return variables.entrySet(); }
+    @Override public Iterable<Entry<String, String>> getVariables() {
+        if (variables == null)
+            return null;
+        return variables.entrySet();
+    }
 
     @Override public String getAltName()              { return this.altName; }
-    
-    public CardFace(String name0) { 
+
+    public CardFace(String name0) {
         this.name = name0; 
         if ( StringUtils.isBlank(name0) )
             throw new RuntimeException("Card name is empty");
     }
     // Here come setters to allow parser supply values
-    void setName(String name)             { this.name = name; }
+    void setName(String name)                { this.name = name; }
     void setAltName(String name)             { this.altName = name; }
     void setType(CardType type0)             { this.type = type0; }
     void setManaCost(ManaCost manaCost0)     { this.manaCost = manaCost0; }
     void setColor(ColorSet color0)           { this.color = color0; }
     void setOracleText(String text)          { this.oracleText = text; }
-    void setInitialLoyalty(String value)        { this.initialLoyalty = value; }
-    void setDefense(String value)        { this.defense = value; }
+    void setInitialLoyalty(String value)     { this.initialLoyalty = value; }
+    void setDefense(String value)            { this.defense = value; }
+    void setAttractionLights(String value) {
+        if (value == null) {
+            this.attractionLights = null;
+            return;
+        }
+        this.attractionLights = Arrays.stream(value.split(" ")).map(Integer::parseInt).collect(Collectors.toSet());
+    }
 
     void setPtText(String value) {
         final String[] k = value.split("/");
@@ -127,6 +144,27 @@ static int parsePT(String val) {
     void addReplacementEffect(String value)  { if (null == this.replacements) { this.replacements = new ArrayList<>(); } this.replacements.add(value);}
     void addSVar(String key, String value)   { if (null == this.variables) { this.variables = new TreeMap<>(String.CASE_INSENSITIVE_ORDER); } this.variables.put(key, value); }
 
+
+    //Functional variant methods. Used for Attractions and some Un-cards,
+    //when cards with the same name can have different logic.
+    public boolean hasFunctionalVariants() {
+        return this.functionalVariants != null;
+    }
+    @Override public ICardFace getFunctionalVariant(String variant) {
+        if(this.functionalVariants == null)
+            return null;
+        return this.functionalVariants.get(variant);
+    }
+    CardFace getOrCreateFunctionalVariant(String variant) {
+        if (this.functionalVariants == null) {
+            this.functionalVariants = new HashMap<>();
+        }
+        if (!this.functionalVariants.containsKey(variant)) {
+            this.functionalVariants.put(variant, new CardFace(this.name));
+        }
+        return this.functionalVariants.get(variant);
+    }
+
 
     void assignMissingFields() { // Most scripts do not specify color explicitly
         if ( null == oracleText ) { System.err.println(name + " has no Oracle text."); oracleText = ""; }
@@ -140,6 +178,7 @@ void assignMissingFields() { // Most scripts do not specify color explicitly
         if ( replacements == null ) replacements = emptyList;
         if ( variables == null ) variables = emptyMap;
         if ( null == nonAbilityText ) nonAbilityText = "";
+        //Not assigning attractionLightVariants here. Too rarely used. Will test for it downstream.
     }