Disentangle progress display from core of osmdata_t

The progress_display_t class is now a libosmium handler created
outside osmdata_t.

Author: joto

src/osm2pgsql.cpp

@@ -119,7 +119,8 @@ int main(int argc, char *argv[])
         // populating some of the tables.
         util::timer_t timer_parse;
 
-        auto const progress = osmdata.process_files(files);
+        progress_display_t progress{get_logger().show_progress()};
+        osmdata.process_files(files, progress);
 
         progress.print_status(std::time(nullptr));
         fmt::print(stderr, "  parse time: {}\n",

src/osmdata.cpp

@@ -233,7 +233,6 @@ void osmdata_t::node(osmium::Node const &node)
             }
         }
     }
-    m_progress.add_node(node.id());
 }
 
 void osmdata_t::way(osmium::Way &way)
@@ -252,7 +251,6 @@ void osmdata_t::way(osmium::Way &way)
             way_add(&way);
         }
     }
-    m_progress.add_way(way.id());
 }
 
 void osmdata_t::relation(osmium::Relation const &rel)
@@ -274,7 +272,6 @@ void osmdata_t::relation(osmium::Relation const &rel)
             relation_add(rel);
         }
     }
-    m_progress.add_rel(rel.id());
 }
 
 void osmdata_t::node_add(osmium::Node const &node) const
@@ -586,7 +583,8 @@ class multithreaded_processor
 
 } // anonymous namespace
 
-progress_display_t osmdata_t::process_file(osmium::io::File const &file)
+void osmdata_t::process_file(osmium::io::File const &file,
+                             progress_display_t &progress)
 {
     osmium::io::Reader reader{file};
     type_id_version last{osmium::item_type::node, 0, 0};
@@ -599,21 +597,20 @@ progress_display_t osmdata_t::process_file(osmium::io::File const &file)
                     "Input file contains deleted objects but "
                     "you are not in append mode."};
             }
-            osmium::apply_item(object, *this);
+            osmium::apply_item(object, *this, progress);
         }
     }
     flush();
 
     reader.close();
-
-    return m_progress;
 }
 
-progress_display_t
-osmdata_t::process_files(std::vector<osmium::io::File> const &files)
+void osmdata_t::process_files(std::vector<osmium::io::File> const &files,
+                              progress_display_t &progress)
 {
     if (files.size() == 1) {
-        return process_file(files.front());
+        process_file(files.front(), progress);
+        return;
     }
 
     std::vector<data_source_t> data_sources;
@@ -638,7 +635,7 @@ osmdata_t::process_files(std::vector<osmium::io::File> const &files)
                     "Input file contains deleted objects but "
                     "you are not in append mode."};
             }
-            osmium::apply_item(element.object(), *this);
+            osmium::apply_item(element.object(), *this, progress);
         }
 
         auto *source = element.data_source();
@@ -652,8 +649,6 @@ osmdata_t::process_files(std::vector<osmium::io::File> const &files)
     for (auto &data_source : data_sources) {
         data_source.close();
     }
-
-    return m_progress;
 }
 
 void osmdata_t::process_dependents() const

src/osmdata.hpp

@@ -64,8 +64,8 @@ class osmdata_t : public osmium::handler::Handler
     /**
      * Process the specified OSM files (stage 1a).
      */
-    progress_display_t
-    process_files(std::vector<osmium::io::File> const &files);
+    void process_files(std::vector<osmium::io::File> const &files,
+                       progress_display_t &progress);
 
     /**
      * Rest of the processing (stages 1b, 1c, 2, and database postprocessing).
@@ -90,7 +90,8 @@ class osmdata_t : public osmium::handler::Handler
     void flush() const;
 
     /// Process a single OSM file (stage 1a).
-    progress_display_t process_file(osmium::io::File const &file);
+    void process_file(osmium::io::File const &file,
+                      progress_display_t &progress);
 
     /**
      * Run stage 1b and stage 1c processing: Process dependent objects in
@@ -120,9 +121,6 @@ class osmdata_t : public osmium::handler::Handler
     // imported).
     osmium::Box m_bbox;
 
-    // The progress meter will be updated as we go.
-    progress_display_t m_progress;
-
     // Current type being parsed.
     osmium::item_type m_type = osmium::item_type::node;
 

src/progress-display.cpp

@@ -16,7 +16,7 @@ void progress_display_t::print_summary() const
 
 void progress_display_t::print_status(std::time_t now) const
 {
-    if (get_logger().show_progress()) {
+    if (m_enabled) {
         fmt::print(stderr,
                    "\rProcessing: Node({}k {:.1f}k/s) Way({}k {:.2f}k/s)"
                    " Relation({} {:.1f}/s)",

src/progress-display.hpp

@@ -11,13 +11,15 @@
 
 #include <ctime>
 
+#include <osmium/handler.hpp>
+
 #include "osmtypes.hpp"
 
 /**
  * The progress_display_t class is used to display how far the processing of
  * the input data has progressed.
  */
-class progress_display_t
+class progress_display_t : public osmium::handler::Handler
 {
     struct Counter
     {
@@ -38,28 +40,28 @@ class progress_display_t
     };
 
 public:
-    progress_display_t() noexcept : m_last_print_time(std::time(nullptr)) {}
+    progress_display_t(bool enabled = false) noexcept : m_enabled(enabled) {}
 
     void print_summary() const;
     void print_status(std::time_t now) const;
 
-    void add_node(osmid_t id)
+    void node(osmium::Node const &node)
     {
-        if (m_node.add(id) % 10000 == 0) {
+        if (m_node.add(node.id()) % 10000 == 0) {
             possibly_print_status();
         }
     }
 
-    void add_way(osmid_t id)
+    void way(osmium::Way const &way)
     {
-        if (m_way.add(id) % 1000 == 0) {
+        if (m_way.add(way.id()) % 1000 == 0) {
             possibly_print_status();
         }
     }
 
-    void add_rel(osmid_t id)
+    void relation(osmium::Relation const &relation)
     {
-        if (m_rel.add(id) % 10 == 0) {
+        if (m_rel.add(relation.id()) % 10 == 0) {
             possibly_print_status();
         }
     }
@@ -107,7 +109,8 @@ class progress_display_t
     Counter m_node{};
     Counter m_way{};
     Counter m_rel{};
-    std::time_t m_last_print_time;
+    std::time_t m_last_print_time{std::time(nullptr)};
+    bool m_enabled;
 };
 
 #endif // OSM2PGSQL_PROGRESS_DISPLAY_HPP

tests/common-import.hpp

@@ -44,7 +44,8 @@ inline void parse_file(options_t const &options,
         filepath += options.input_files[0];
     }
     osmium::io::File file{filepath};
-    osmdata.process_files({file});
+    progress_display_t progress;
+    osmdata.process_files({file}, progress);
 
     if (do_stop) {
         osmdata.stop();
@@ -155,7 +156,8 @@ class import_t
         for (auto const &data : input_data) {
             files.emplace_back(data.data(), data.size(), format);
         }
-        osmdata.process_files(files);
+        progress_display_t progress;
+        osmdata.process_files(files, progress);
 
         osmdata.stop();
     }