Change opt-in method

Author: MarcelloPerathoner

docs/areas.md

@@ -13,19 +13,13 @@ This feature is still EXPERIMENTAL.
 ## Configuration
 
 To opt-in to this feature, you must declare an algorithm to be used for area meshing.
-Find the place where the @ref properties are defined in your LUA profile's @ref setup
-function and insert this line:
+Find your LUA profile's @ref setup function and insert this line:
 
 ```lua
 function setup()
   ...
-  return {
-    properties = {
-      ...
-      area_meshing_algorithm = 'visgraph+dijkstra', -- << insert this line
-      ...
-    },
-  }
+  area_manager:init('visgraph+dijkstra')
+  ...
 end
 ```
 

docs/lua-types.dox

@@ -401,6 +401,17 @@ class ObstacleMap
 class AreaManager
 {
   public:
+    /**
+     * @brief Initialize the area manager
+     *
+     * Call this function inside @ref setup to initialize the area manager.
+     * The supplied algorithm will be used for meshing.
+     *
+     * @param algorithm_name The algorithm to use for meshing. At present only one
+     *                       algorithm is supported: 'visgraph+dijkstra'.
+     */
+    void init(String algorithm_name);
+
     /**
      * @brief Register a multipolygon relation for meshing.
      *

docs/profiles.md

@@ -110,7 +110,6 @@ continue_straight_at_waypoint | Boolean  | Must the route continue straight on a
 max_speed_for_map_matching    | Float    | Maximum vehicle speed to be assumed in matching (in m/s)
 max_turn_weight               | Float    | Maximum turn penalty weight
 force_split_edges             | Boolean  | True value forces a split of forward and backward edges of extracted ways and guarantees that `process_segment` will be called for all segments (default `false`)
-area_meshing_algorithm        | String   | The algorithm to be used for @ref pedestrian_areas "pedestrian area meshing".
 
 The following additional global properties can be set in the hash you return in the `setup` function:
 

include/extractor/area/area_manager.hpp

@@ -31,13 +31,16 @@ class AreaManager
     MutexType mutex;
 
     using relation_ids = std::vector<osmium::object_id_type>;
+    std::string algorithm_name;
+    bool enabled{false};
 
   public:
     AreaManager(ExtractionRelationContainer &c) : relations_stash{c}
     {
         m_assembler_config.debug_level = 0;
     };
 
+    void init(const char *algorithm_name);
     void way(const osmium::Way &way);
     void relation(const osmium::Relation &relation);
     void prepare_for_lookup();
@@ -47,6 +50,7 @@ class AreaManager
 
     void complete_relation(const osmium::Relation &relation);
     void after_way(const osmium::Way &way);
+    bool is_enabled() { return enabled; }
 
     std::size_t number_of_ways{0};
     std::size_t number_of_relations{0};

include/extractor/profile_properties.hpp

@@ -3,7 +3,6 @@
 
 #include "extractor/class_data.hpp"
 
-#include "util/log.hpp"
 #include "util/typedefs.hpp"
 
 #include <boost/assert.hpp>
@@ -12,7 +11,6 @@
 #include <algorithm>
 #include <array>
 #include <cstdint>
-#include <cstring>
 #include <optional>
 
 namespace osrm::extractor
@@ -24,14 +22,13 @@ struct ProfileProperties
 {
     static constexpr int MAX_WEIGHT_NAME_LENGTH = 255;
     static constexpr int MAX_CLASS_NAME_LENGTH = 255;
-    static constexpr int MAX_MESHING_ALGORITHM_LENGTH = 255;
 
     ProfileProperties()
         : traffic_signal_penalty(0), u_turn_penalty(0),
           max_speed_for_map_matching(DEFAULT_MAX_SPEED), continue_straight_at_waypoint(true),
-          use_turn_restrictions(false), left_hand_driving(false),
-          fallback_to_duration(true), weight_name{"duration"}, area_meshing_algorithm{""},
-          class_names{{}}, excludable_classes{{}}, call_tagless_node_function(true)
+          use_turn_restrictions(false), left_hand_driving(false), fallback_to_duration(true),
+          weight_name{"duration"}, class_names{{}}, excludable_classes{{}},
+          call_tagless_node_function(true)
     {
         std::fill(excludable_classes.begin(), excludable_classes.end(), INAVLID_CLASS_DATA);
         BOOST_ASSERT(weight_name[MAX_WEIGHT_NAME_LENGTH] == '\0');
@@ -76,14 +73,6 @@ struct ProfileProperties
         return std::string(weight_name);
     }
 
-    void SetAreaMeshingAlgorithm(const std::string &name)
-    {
-        strncpy(area_meshing_algorithm, name.c_str(), MAX_MESHING_ALGORITHM_LENGTH);
-        area_meshing_algorithm[MAX_MESHING_ALGORITHM_LENGTH] = '\0';
-    }
-
-    std::string GetAreaMeshingAlgorithm() const { return std::string(area_meshing_algorithm); }
-
     // Mark this combination of classes as excludable
     void SetExcludableClasses(std::size_t index, ClassData classes)
     {
@@ -139,8 +128,6 @@ struct ProfileProperties
     bool fallback_to_duration;
     //! stores the name of the weight (e.g. 'duration', 'distance', 'safety')
     char weight_name[MAX_WEIGHT_NAME_LENGTH + 1];
-    //! the name of the algorithm to use for area meshing
-    char area_meshing_algorithm[MAX_MESHING_ALGORITHM_LENGTH + 1];
     //! stores the names of each class
     std::array<char[MAX_CLASS_NAME_LENGTH + 1], MAX_CLASS_INDEX + 1> class_names;
     //! stores the masks of excludable class combinations

profiles/foot_area.lua

@@ -9,6 +9,8 @@ find_access_tag = require("lib/access").find_access_tag
 
 function setup()
   local walking_speed = 5
+  area_manager:init('visgraph+dijkstra')
+
   return {
     properties = {
       weight_name                   = 'duration',
@@ -18,7 +20,6 @@ function setup()
       u_turn_penalty                = 2,
       continue_straight_at_waypoint = false,
       use_turn_restrictions         = false,
-      area_meshing_algorithm        = 'visgraph+dijkstra',
     },
 
     default_mode            = mode.walking,

src/extractor/area/area_manager.cpp

@@ -7,6 +7,22 @@
 namespace osrm::extractor::area
 {
 
+/**
+ * @brief Initialize the area manager
+ *
+ * @param algorithm_name The alogorithm to use for meshing. At present only one
+ *                       algorithm is supported: 'visgraph+dijkstra'.
+ */
+void AreaManager::init(const char *algorithm_name)
+{
+    MutexType::scoped_lock lock(mutex);
+    if (!enabled)
+    {
+        this->algorithm_name = algorithm_name;
+        enabled = true;
+    }
+}
+
 /**
  * @brief Register the given closed way for area-building.
  *

src/extractor/extractor.cpp

@@ -565,7 +565,7 @@ Extractor::ParsedOSMData Extractor::ParseOSMData(ScriptingEnvironment &scripting
                     << " relations in " << TIMER_SEC(parse_relations) << " seconds";
     }
     auto &area_manager = scripting_environment.m_area_manager;
-    if (!profile_properties.GetAreaMeshingAlgorithm().empty())
+    if (area_manager.is_enabled())
     {
         // Next we read the relations again and pass them to LUA's process_relation
         // function, so they can be registered for meshing.  Unfortunately we cannot

src/extractor/scripting_environment_lua.cpp

@@ -234,8 +234,6 @@ void Sol2ScriptingEnvironment::InitContext(LuaScriptingContext &context)
         &ProfileProperties::continue_straight_at_waypoint,
         "use_turn_restrictions",
         &ProfileProperties::use_turn_restrictions,
-        "area_meshing_algorithm",
-        sol::property(&ProfileProperties::GetAreaMeshingAlgorithm),
         "left_hand_driving",
         &ProfileProperties::left_hand_driving,
         "weight_precision",
@@ -433,6 +431,8 @@ void Sol2ScriptingEnvironment::InitContext(LuaScriptingContext &context)
 
     context.state.new_usertype<area::AreaManager>(
         "AreaManager",
+        "init",
+        &area::AreaManager::init,
         "get_relations",
         sol::overload(&area::AreaManager::get_relations_for_node,
                       &area::AreaManager::get_relations_for_way),
@@ -742,11 +742,6 @@ void Sol2ScriptingEnvironment::InitContext(LuaScriptingContext &context)
             if (weight_name != sol::nullopt)
                 context.properties.SetWeightName(weight_name.value());
 
-            sol::optional<std::string> area_meshing_algorithm =
-                properties["area_meshing_algorithm"];
-            if (area_meshing_algorithm != sol::nullopt)
-                context.properties.SetAreaMeshingAlgorithm(area_meshing_algorithm.value());
-
             sol::optional<std::int32_t> traffic_signal_penalty =
                 properties["traffic_signal_penalty"];
             if (traffic_signal_penalty != sol::nullopt)