std::variant ter_furn_id (#82802)

adds ter_furn_id::deserialize

Author: ShnitzelX2

src/mapdata.cpp

@@ -149,6 +149,37 @@ int_id<furn_t>::int_id( const string_id<furn_t> &id ) : _id( id.id() )
 {
 }
 
+ter_furn_id::ter_furn_id()
+{
+    ter_furn = ter_str_id::NULL_ID().id();
+}
+
+ter_furn_id::ter_furn_id( const std::string &name )
+{
+    resolve( name );
+}
+
+bool ter_furn_id::resolve( const std::string &name )
+{
+    ter_str_id temp_ter( name );
+    furn_str_id temp_furn( name );
+    bool resolved = false;
+    if( temp_ter.is_valid() && !temp_ter.is_null() ) {
+        ter_furn = ter_id( name );
+        resolved = true;
+    } else if( temp_furn.is_valid() && !temp_furn.is_null() ) {
+        ter_furn = furn_id( name );
+        resolved = true;
+    }
+    return resolved;
+}
+
+void ter_furn_id::deserialize( const JsonValue &jo )
+{
+    std::string name = jo.get_string();
+    resolve( name );
+}
+
 namespace io
 {
 

src/mapdata.h

@@ -10,6 +10,7 @@
 #include <string>
 #include <string_view>
 #include <utility>
+#include <variant>
 #include <vector>
 
 #include "calendar.h"
@@ -27,6 +28,7 @@
 
 class Character;
 class JsonObject;
+class JsonValue;
 struct connect_group;
 struct furn_t;
 struct itype;
@@ -769,6 +771,18 @@ struct furn_t : map_data_common_t {
     void check() const override;
 };
 
+//holds either a ter_id OR furn_id (not both!), for loading JSON
+struct ter_furn_id {
+    std::variant<ter_id, furn_id> ter_furn;
+    void deserialize( const JsonValue &jo );
+    ter_furn_id();
+    explicit ter_furn_id( const std::string &name );
+    bool operator==( const ter_furn_id &rhs ) const {
+        return ter_furn == rhs.ter_furn;
+    }
+    bool resolve( const std::string &name );
+};
+
 void load_furniture( const JsonObject &jo, const std::string &src );
 void finalize_furniture();
 void load_terrain( const JsonObject &jo, const std::string &src );

src/mapgen_functions.cpp

@@ -11,6 +11,7 @@
 #include <string>
 #include <unordered_set>
 #include <utility>
+#include <variant>
 #include <vector>
 
 #include "calendar.h"
@@ -1038,7 +1039,7 @@ void mapgen_forest( mapgendata &dat )
     * @param p the point to check to place a feature at.
     */
     const auto get_feathered_feature = [&no_ter_furn, &max_factor, &factor, &self_biome,
-                                                      &adjacent_biomes, &nesw_weights, &get_feathered_groundcover, &unify_all_borders,
+                                                      &adjacent_biomes, &nesw_weights, &unify_all_borders,
                   &dat]( const point & p ) {
         std::array<float, 4> adj_weights;
         float net_weight = nesw_weights( p, factor, adj_weights );
@@ -1079,9 +1080,6 @@ void mapgen_forest( mapgendata &dat )
                 }
                 break;
         }
-        if( feature.ter == no_ter_furn.ter ) {
-            feature.ter = get_feathered_groundcover( p );
-        }
         return feature;
     };
 
@@ -1118,10 +1116,24 @@ void mapgen_forest( mapgendata &dat )
     // Lay groundcover, place a feature, and place terrain dependent furniture.
     for( int x = 0; x < SEEX * 2; x++ ) {
         for( int y = 0; y < SEEY * 2; y++ ) {
-            const ter_furn_id feature = get_feathered_feature( point( x, y ) );
-            m->ter_set( point_bub_ms( x, y ), feature.ter );
-            m->furn_set( point_bub_ms( x, y ), feature.furn );
-            set_terrain_dependent_furniture( feature.ter, point_bub_ms( x, y ) );
+            const point pos_raw = point( x, y );
+            const point_bub_ms pos = point_bub_ms( x, y );
+
+            ter_furn_id feature = get_feathered_feature( pos_raw );
+            ter_id groundcover = get_feathered_groundcover( pos_raw );
+
+            const ter_id *is_ter = std::get_if<ter_id>( &feature.ter_furn );
+            const furn_id *is_furniture = std::get_if<furn_id>( &feature.ter_furn );
+            ter_id resolved_ter = is_ter == nullptr ? groundcover : *is_ter;
+            const furn_id resolved_furn = is_furniture == nullptr ? furn_str_id::NULL_ID().id() : *is_furniture;
+
+            if( resolved_ter == ter_str_id::NULL_ID().id() ) {
+                resolved_ter = groundcover;
+            }
+
+            m->ter_set( pos, resolved_ter );
+            m->furn_set( pos, resolved_furn );
+            set_terrain_dependent_furniture( resolved_ter, pos );
         }
     }
 

src/regional_settings.cpp

@@ -8,11 +8,13 @@
 #include <string>
 #include <string_view>
 #include <utility>
+#include <variant>
 
 #include "debug.h"
 #include "enum_conversions.h"
 #include "flexbuffer_json.h"
 #include "generic_factory.h"
+#include "mapdata.h"
 #include "map_extras.h"
 #include "options.h"
 #include "output.h"
@@ -22,8 +24,6 @@
 
 class mapgendata;
 
-ter_furn_id::ter_furn_id() : ter( ter_str_id::NULL_ID().id() ),
-    furn( furn_str_id::NULL_ID().id() ) { }
 
 template<typename T>
 void read_and_set_or_throw( const JsonObject &jo, const std::string &member, T &target,
@@ -894,18 +894,14 @@ void groundcover_extra::finalize()   // FIXME: return bool for failure
 
     for( std::map<std::string, double>::const_iterator it = percent_str.begin();
          it != percent_str.end(); ++it ) {
-        tf_id.ter = ter_str_id::NULL_ID().id();
-        tf_id.furn = furn_str_id::NULL_ID();
+        tf_id = ter_furn_id();
         if( it->second < 0.0001 ) {
             continue;
         }
-        const ter_str_id tid( it->first );
-        const furn_str_id fid( it->first );
-        if( tid.is_valid() ) {
-            tf_id.ter = tid.id();
-        } else if( fid.is_valid() ) {
-            tf_id.furn = fid.id();
-        } else {
+
+        bool resolved = tf_id.resolve( it->first );
+
+        if( !resolved ) {
             debugmsg( "No clue what '%s' is!  No such terrain or furniture", it->first.c_str() );
             continue;
         }
@@ -915,19 +911,15 @@ void groundcover_extra::finalize()   // FIXME: return bool for failure
 
     for( std::map<std::string, double>::const_iterator it = boosted_percent_str.begin();
          it != boosted_percent_str.end(); ++it ) {
-        tf_id.ter = ter_str_id::NULL_ID().id();
-        tf_id.furn = furn_str_id::NULL_ID();
+        tf_id = ter_furn_id();
         if( it->second < 0.0001 ) {
             continue;
         }
         const ter_str_id tid( it->first );
         const furn_str_id fid( it->first );
 
-        if( tid.is_valid() ) {
-            tf_id.ter = tid.id();
-        } else if( fid.is_valid() ) {
-            tf_id.furn = fid.id();
-        } else {
+        bool resolved = tf_id.resolve( it->first );
+        if( !resolved ) {
             debugmsg( "No clue what '%s' is!  No such terrain or furniture", it->first.c_str() );
             continue;
         }
@@ -956,8 +948,7 @@ void groundcover_extra::finalize()   // FIXME: return bool for failure
         debugmsg( "boosted plant coverage total (%s=%de-4) exceeds 100%%", ss.str(), btotal );
     }
 
-    tf_id.furn = furn_str_id::NULL_ID();
-    tf_id.ter = default_ter;
+    tf_id.ter_furn = default_ter;
     weightlist[ 1000000 ] = tf_id;
     boosted_weightlist[ 1000000 ] = tf_id;
 
@@ -977,15 +968,8 @@ void forest_biome_component::finalize()
 {
     for( const std::pair<const std::string, int> &pr : unfinalized_types ) {
         ter_furn_id tf_id;
-        tf_id.ter = ter_str_id::NULL_ID().id();
-        tf_id.furn = furn_str_id::NULL_ID();
-        const ter_str_id tid( pr.first );
-        const furn_str_id fid( pr.first );
-        if( tid.is_valid() ) {
-            tf_id.ter = tid.id();
-        } else if( fid.is_valid() ) {
-            tf_id.furn = fid.id();
-        } else {
+        bool resolved = tf_id.resolve( pr.first );
+        if( !resolved ) {
             continue;
         }
         types.add( tf_id, pr.second );

src/regional_settings.h

@@ -81,12 +81,6 @@ struct city_settings {
     void finalize();
 };
 
-struct ter_furn_id {
-    ter_id ter;
-    furn_id furn;
-    ter_furn_id();
-};
-
 /*
  * template for random bushes and such.
  * supports occasional boost to a single ter/furn type (clustered blueberry bushes for example)