Allow '1-infinity' in ranges, and tighten the schema's validation of …

…ranges Fixes #4253. The schema's validation of ranges now rejects negative numbers, because the C++ code doesn't support them (both before and after this commit): * utils::parse_range("-7") will return {0,0}, because std::stoi("") throws invalid_argument. * src/map/location.cpp will parse it as -7, but that will never match an on-map coordinate
wesnoth · Aug 29, 2019 · 1c123fb · 1c123fb
1 parent ba4f3a7
commit 1c123fb
Show file tree

Hide file tree

Showing 23 changed files with 106 additions and 115 deletions.
diff --git a/changelog.md b/changelog.md
@@ -8,6 +8,8 @@
    * Set up for translating the Wings of Victory campaign (PR#4265)
    * Changed the :help command's output to split over multiple lines
    * Added translatable explanations of :droid, :help and :idle's arguments
+ ### WML engine
+   * Ranges can now have upper limit "infinity" instead using a big number like "99" or "99999"
 
 ## Version 1.15.1
  ### Editor

diff --git a/data/ai/micro_ais/scenarios/recruiting.cfg b/data/ai/micro_ais/scenarios/recruiting.cfg
@@ -115,7 +115,7 @@ A Micro AI can be added and adapted to the need of a scenario easily using only
         [if]
             [not]
                 [have_unit]
-                    count=1-9999
+                    count=1-infinity
                     side=$unit.side
                 [/have_unit]
             [/not]

diff --git a/data/ai/micro_ais/scenarios/wolves.cfg b/data/ai/micro_ais/scenarios/wolves.cfg
@@ -262,7 +262,7 @@ Also note that the wolves AI is coded as a Micro AI. A Micro AI can be added and
         [if]
             [not]
                 [have_unit]
-                    count=1-9999
+                    count=1-infinity
                     side=$unit.side
                 [/have_unit]
             [/not]

diff --git a/data/campaigns/An_Orcish_Incursion/scenarios/01_Defend_the_Forest.cfg b/data/campaigns/An_Orcish_Incursion/scenarios/01_Defend_the_Forest.cfg
@@ -195,7 +195,7 @@
             [have_unit]
                 # if they have less than 5 surviving units, then it's the wrong time to hint about healers
                 side=1
-                count=5-99999
+                count=5-infinity
             [/have_unit]
         [/filter_condition]
 

diff --git a/data/campaigns/Descent_Into_Darkness/scenarios/02_Peaceful_Valley.cfg b/data/campaigns/Descent_Into_Darkness/scenarios/02_Peaceful_Valley.cfg
@@ -230,7 +230,7 @@
             [/variable]
             [have_location]
                 owner_side=1
-                count=4-99
+                count=4-infinity
             [/have_location]
 
             # Make sure the guards actually exist, in case there was no space for them

diff --git a/data/campaigns/Eastern_Invasion/scenarios/11_Captured.cfg b/data/campaigns/Eastern_Invasion/scenarios/11_Captured.cfg
@@ -238,7 +238,7 @@
             [filter]
                 side=1
                 [not]
-                    x,y=1-999,1-999
+                    {EVERYWHERE}
                 [/not]
                 level=4
             [/filter]
@@ -251,7 +251,7 @@
             [filter]
                 side=1
                 [not]
-                    x,y=1-999,1-999
+                    {EVERYWHERE}
                 [/not]
                 level=3
             [/filter]
@@ -265,7 +265,7 @@
             [filter]
                 side=1
                 [not]
-                    x,y=1-999,1-999
+                    {EVERYWHERE}
                 [/not]
                 level=2
             [/filter]
@@ -279,7 +279,7 @@
             [filter]
                 side=1
                 [not]
-                    x,y=1-999,1-999
+                    {EVERYWHERE}
                 [/not]
                 level=1
             [/filter]
@@ -677,7 +677,7 @@
         [if]
             [have_unit]
                 side=1
-                count=2-99
+                count=2-infinity
             [/have_unit]
 
             [then]

diff --git a/data/campaigns/Legend_of_Wesmere/scenarios/chapter1/03_Kalian_under_Attack.cfg b/data/campaigns/Legend_of_Wesmere/scenarios/chapter1/03_Kalian_under_Attack.cfg
@@ -230,7 +230,7 @@
         [capture_village]
             side=4
             x=1-26
-            y=1-999
+            y=1-infinity
         [/capture_village]
     [/event]
 #endif

diff --git a/data/campaigns/Legend_of_Wesmere/scenarios/chapter2/07_Elves_Last_Stand.cfg b/data/campaigns/Legend_of_Wesmere/scenarios/chapter2/07_Elves_Last_Stand.cfg
@@ -364,7 +364,7 @@
             [/have_unit]
             [have_unit]
                 side=1,2,3,4
-                count=25-999
+                count=25-infinity
             [/have_unit]
             [then]
                 [message]

diff --git a/data/campaigns/Legend_of_Wesmere/utils/map-utils.cfg b/data/campaigns/Legend_of_Wesmere/utils/map-utils.cfg
@@ -7,8 +7,7 @@
 #define LOAD_SUBMAP X_SPAN Y_SPAN OFFSET_X OFFSET_Y MAP
     [store_unit]
         [filter]
-            x=1-999
-            y=1-999
+            {EVERYWHERE}
         [/filter]
         variable=MOVE_UNIT_store
         kill=yes

diff --git a/data/campaigns/Liberty/scenarios/08_Glory.cfg b/data/campaigns/Liberty/scenarios/08_Glory.cfg
@@ -123,7 +123,7 @@
             [/avoid]
         [/ai]
         [ai]
-            turns=7-99999
+            turns=7-infinity
 
             # Now just avoid Sir Gwydion
             [avoid]
@@ -195,7 +195,7 @@
             [/avoid]
         [/ai]
         [ai]
-            turns=7-99999
+            turns=7-infinity
 
             # Now just avoid the orc leader
             [avoid]

diff --git a/data/campaigns/Secrets_of_the_Ancients/scenarios/04_Becalmed.cfg b/data/campaigns/Secrets_of_the_Ancients/scenarios/04_Becalmed.cfg
@@ -81,8 +81,8 @@ The journey started well enough, but on the dawn following our departure, the wi
             green=-30
             blue=-25
         [/time]
-        x=14, 0-99
-        y=12, 13-99
+        x=14, 0-infinity
+        y=12, 13-infinity
     [/time_area]
 
     {DEFAULT_MUSIC_PLAYLIST}
@@ -297,7 +297,7 @@ The journey started well enough, but on the dawn following our departure, the wi
                         # will stick to the script. She's fair game on the
                         # third barrel though.
                         x=1-10
-                        y=11-99
+                        y=11-infinity
                     [/or]
                     [or]
                         # She also doesn't get *immediately* attacked if she
@@ -345,11 +345,11 @@ The journey started well enough, but on the dawn following our departure, the wi
                 y=6
             [/filter]
             [filter_location]
-                x=0-99
+                x=0-infinity
                 y=0-12
             [/filter_location]
             [filter_location_enemy]
-                x=0-99
+                x=0-infinity
                 y=13-99
             [/filter_location_enemy]
         [/micro_ai]

diff --git a/data/campaigns/Secrets_of_the_Ancients/scenarios/06_Following_the_Shadow.cfg b/data/campaigns/Secrets_of_the_Ancients/scenarios/06_Following_the_Shadow.cfg
@@ -371,7 +371,7 @@ I was so sure I had the answer! I was wrong. I wanted to believe that I was imag
                 [not]
                     variation=bat  # undead bat
                 [/not]
-                count=6-99  # six or more
+                count=6-infinity  # six or more
             [/have_unit]
             [then]
                 [fire_event]

diff --git a/data/campaigns/Secrets_of_the_Ancients/scenarios/08_Carcyn.cfg b/data/campaigns/Secrets_of_the_Ancients/scenarios/08_Carcyn.cfg
@@ -385,8 +385,7 @@ After several days of travel, he approached the frontier town of Carcyn."
             [then]
                 [capture_village]
                     side=1
-                    x=1-99
-                    y=1-99
+                    {EVERYWHERE}
                 [/capture_village]
                 [delay]
                     time=800

diff --git a/data/campaigns/Secrets_of_the_Ancients/scenarios/10_Merfolk_Revenge.cfg b/data/campaigns/Secrets_of_the_Ancients/scenarios/10_Merfolk_Revenge.cfg
@@ -144,7 +144,7 @@
         [store_unit]
             [filter]
                 race=human
-                x=1-99
+                {EVERYWHERE}
                 [not]
                     id=Ras-Tabahn
                 [/not]

diff --git a/data/campaigns/Under_the_Burning_Suns/scenarios/06a_In_the_Tunnels_of_Trolls.cfg b/data/campaigns/Under_the_Burning_Suns/scenarios/06a_In_the_Tunnels_of_Trolls.cfg
@@ -1404,7 +1404,7 @@ _ "These undead trolls fight again in death as they did in life, except this tim
     # Event 24: Troll Undead Uprising
 
     # count number of elves that have entered the trolls cave. Once 3 elves
-    # are in the cave, then active the troll undead uprising
+    # are in the cave, then activate the troll undead uprising
 
     [event]
         name=new turn
@@ -1414,7 +1414,7 @@ _ "These undead trolls fight again in death as they did in life, except this tim
                 x=35-50
                 y=23-29
                 side=1
-                count=3-99999
+                count=3-infinity
             [/have_unit]
         [/filter_condition]
 

diff --git a/data/core/macros/scenario-utils.cfg b/data/core/macros/scenario-utils.cfg
@@ -15,7 +15,7 @@
 
 # Everywhere on the map.  For filters that would otherwise touch recall lists.
 #define EVERYWHERE
-x,y=1-999,1-999 #enddef
+x,y=1-infinity,1-infinity #enddef
 
 #define NO_MAP_DATA
     # The display code in the game becomes confused if you give it a

diff --git a/data/core/macros/side-utils.cfg b/data/core/macros/side-utils.cfg
@@ -38,7 +38,7 @@
             [have_unit]
                 side=$side_number
                 type={TYPE}
-                count="{LIMIT_NUMBER}-99999"
+                count="{LIMIT_NUMBER}-infinity"
             [/have_unit]
 
             [then]
@@ -68,7 +68,7 @@
             [have_unit]
                 side=$side_number
                 type={TYPE}
-                count="{LIMIT_NUMBER}-99999"
+                count="{LIMIT_NUMBER}-infinity"
             [/have_unit]
         [/filter_condition]
 

diff --git a/data/schema/game_config.cfg b/data/schema/game_config.cfg
@@ -72,16 +72,16 @@
             [/type]
         [/union]
     [/type]
+    # definition of range_list and s_range_list, before macros are expanded
     {LIST_TYPE_COMPLEX range (
         [element]
-            [list]
-                split="-"
-                min=1
-                max=2
-                [element]
-                    link=unsigned
-                [/element]
-            [/list]
+            value="\d+"
+        [/element]
+        [element]
+            value="\d+-\d+"
+        [/element]
+        [element]
+            value="\d+-infinity"
         [/element]
     )}
     [type]

diff --git a/data/test/scenarios/store_locations.cfg b/data/test/scenarios/store_locations.cfg
@@ -8,3 +8,28 @@
         {RETURN ({VARIABLE_CONDITIONAL tmp.terrain equals "Gg^Kov"})}
     [/event]
 )}
+
+# This doubles as a test of the "1-infinity" range
+{GENERIC_UNIT_TEST "store_locations_range" (
+    [event]
+        name = start
+
+        # Including the borders, the map is 18 x 10
+        # Doubles as a test that whitespace is allowed within ranges.
+        [store_locations]
+            x,y=10 - infinity,5-infinity
+            variable=tmp
+        [/store_locations]
+        {ASSERT ({VARIABLE_CONDITIONAL tmp.length equals 40})}
+
+        # The definition of EVERYWHERE excludes x=0 and y=0, and the include_borders=no also excludes those columns
+        [store_locations]
+            {EVERYWHERE}
+            include_borders=no
+            variable=tmp
+        [/store_locations]
+        {ASSERT ({VARIABLE_CONDITIONAL tmp.length equals 128})}
+
+        {SUCCEED}
+    [/event]
+)}
diff --git a/src/game_events/conditional_wml.cpp b/src/game_events/conditional_wml.cpp
@@ -42,7 +42,7 @@ static lg::log_domain log_engine("engine");
 namespace game_events {
 
 namespace builtin_conditions {
-	std::vector<std::pair<int,int>> default_counts = utils::parse_ranges("1-99999");
+	std::vector<std::pair<int,int>> default_counts = utils::parse_ranges("1-infinity");
 
 	bool have_unit(const vconfig& cfg)
 	{