Merge pull request #1126 from joto/rename-plural-functions

Rename plural functions

Author: lonvia

src/middle-pgsql.cpp

@@ -266,7 +266,7 @@ middle_query_pgsql_t::local_nodes_get_list(osmium::WayNodeList *nodes) const
     return count;
 }
 
-void middle_pgsql_t::nodes_set(osmium::Node const &node)
+void middle_pgsql_t::node_set(osmium::Node const &node)
 {
     m_cache->set(node.id(), node.location());
 
@@ -288,7 +288,7 @@ size_t middle_query_pgsql_t::nodes_get_list(osmium::WayNodeList *nodes) const
                               : local_nodes_get_list(nodes);
 }
 
-void middle_pgsql_t::nodes_delete(osmid_t osm_id)
+void middle_pgsql_t::node_delete(osmid_t osm_id)
 {
     assert(m_append);
 
@@ -322,7 +322,7 @@ void middle_pgsql_t::node_changed(osmid_t osm_id)
     }
 }
 
-void middle_pgsql_t::ways_set(osmium::Way const &way)
+void middle_pgsql_t::way_set(osmium::Way const &way)
 {
     m_db_copy.new_line(m_tables[WAY_TABLE].m_copy_target);
 
@@ -340,8 +340,8 @@ void middle_pgsql_t::ways_set(osmium::Way const &way)
     m_db_copy.finish_line();
 }
 
-bool middle_query_pgsql_t::ways_get(osmid_t id,
-                                    osmium::memory::Buffer &buffer) const
+bool middle_query_pgsql_t::way_get(osmid_t id,
+                                   osmium::memory::Buffer &buffer) const
 {
     auto const res = exec_prepared("get_way", id);
 
@@ -417,7 +417,7 @@ middle_query_pgsql_t::rel_way_members_get(osmium::Relation const &rel,
     return outres;
 }
 
-void middle_pgsql_t::ways_delete(osmid_t osm_id)
+void middle_pgsql_t::way_delete(osmid_t osm_id)
 {
     assert(m_append);
     m_db_copy.new_line(m_tables[WAY_TABLE].m_copy_target);
@@ -449,7 +449,7 @@ void middle_pgsql_t::way_changed(osmid_t osm_id)
     }
 }
 
-void middle_pgsql_t::relations_set(osmium::Relation const &rel)
+void middle_pgsql_t::relation_set(osmium::Relation const &rel)
 {
     // Sort relation members by their type.
     idlist_t parts[3];
@@ -492,8 +492,8 @@ void middle_pgsql_t::relations_set(osmium::Relation const &rel)
     m_db_copy.finish_line();
 }
 
-bool middle_query_pgsql_t::relations_get(osmid_t id,
-                                         osmium::memory::Buffer &buffer) const
+bool middle_query_pgsql_t::relation_get(osmid_t id,
+                                        osmium::memory::Buffer &buffer) const
 {
     auto const res = exec_prepared("get_rel", id);
     // Fields are: members, tags, member_count */
@@ -515,7 +515,7 @@ bool middle_query_pgsql_t::relations_get(osmid_t id,
     return true;
 }
 
-void middle_pgsql_t::relations_delete(osmid_t osm_id)
+void middle_pgsql_t::relation_delete(osmid_t osm_id)
 {
     assert(m_append);
     //keep track of whatever ways this relation interesects

src/middle-pgsql.hpp

@@ -28,13 +28,13 @@ class middle_query_pgsql_t : public middle_query_t
 
     size_t nodes_get_list(osmium::WayNodeList *nodes) const override;
 
-    bool ways_get(osmid_t id, osmium::memory::Buffer &buffer) const override;
+    bool way_get(osmid_t id, osmium::memory::Buffer &buffer) const override;
     size_t rel_way_members_get(osmium::Relation const &rel, rolelist_t *roles,
                                osmium::memory::Buffer &buffer) const override;
 
     idlist_t relations_using_way(osmid_t way_id) const override;
-    bool relations_get(osmid_t id,
-                       osmium::memory::Buffer &buffer) const override;
+    bool relation_get(osmid_t id,
+                      osmium::memory::Buffer &buffer) const override;
 
     void exec_sql(std::string const &sql_cmd) const;
 
@@ -58,16 +58,16 @@ struct middle_pgsql_t : public slim_middle_t
     void analyze() override;
     void commit() override;
 
-    void nodes_set(osmium::Node const &node) override;
-    void nodes_delete(osmid_t id) override;
+    void node_set(osmium::Node const &node) override;
+    void node_delete(osmid_t id) override;
     void node_changed(osmid_t id) override;
 
-    void ways_set(osmium::Way const &way) override;
-    void ways_delete(osmid_t id) override;
+    void way_set(osmium::Way const &way) override;
+    void way_delete(osmid_t id) override;
     void way_changed(osmid_t id) override;
 
-    void relations_set(osmium::Relation const &rel) override;
-    void relations_delete(osmid_t id) override;
+    void relation_set(osmium::Relation const &rel) override;
+    void relation_delete(osmid_t id) override;
     void relation_changed(osmid_t id) override;
 
     void flush() override;

src/middle-ram.cpp

@@ -33,17 +33,17 @@
  *
  */
 
-void middle_ram_t::nodes_set(osmium::Node const &node)
+void middle_ram_t::node_set(osmium::Node const &node)
 {
     m_cache->set(node.id(), node.location());
 }
 
-void middle_ram_t::ways_set(osmium::Way const &way)
+void middle_ram_t::way_set(osmium::Way const &way)
 {
     m_ways.set(way.id(), new ramWay{way, m_extra_attributes});
 }
 
-void middle_ram_t::relations_set(osmium::Relation const &rel)
+void middle_ram_t::relation_set(osmium::Relation const &rel)
 {
     m_rels.set(rel.id(), new ramRel{rel, m_extra_attributes});
 }
@@ -92,7 +92,7 @@ void middle_ram_t::release_relations() { m_rels.clear(); }
 
 void middle_ram_t::release_ways() { m_ways.clear(); }
 
-bool middle_ram_t::ways_get(osmid_t id, osmium::memory::Buffer &buffer) const
+bool middle_ram_t::way_get(osmid_t id, osmium::memory::Buffer &buffer) const
 {
     if (m_simulate_ways_deleted) {
         return false;
@@ -117,7 +117,7 @@ size_t middle_ram_t::rel_way_members_get(osmium::Relation const &rel,
 {
     size_t count = 0;
     for (auto const &m : rel.members()) {
-        if (m.type() == osmium::item_type::way && ways_get(m.ref(), buffer)) {
+        if (m.type() == osmium::item_type::way && way_get(m.ref(), buffer)) {
             if (roles) {
                 roles->emplace_back(m.role());
             }
@@ -128,8 +128,8 @@ size_t middle_ram_t::rel_way_members_get(osmium::Relation const &rel,
     return count;
 }
 
-bool middle_ram_t::relations_get(osmid_t id,
-                                 osmium::memory::Buffer &buffer) const
+bool middle_ram_t::relation_get(osmid_t id,
+                                osmium::memory::Buffer &buffer) const
 {
     auto const *ele = m_rels.get(id);
 

src/middle-ram.hpp

@@ -99,17 +99,17 @@ struct middle_ram_t : public middle_t, public middle_query_t
     void analyze(void) override;
     void commit(void) override;
 
-    void nodes_set(osmium::Node const &node) override;
+    void node_set(osmium::Node const &node) override;
     size_t nodes_get_list(osmium::WayNodeList *nodes) const override;
 
-    void ways_set(osmium::Way const &way) override;
-    bool ways_get(osmid_t id, osmium::memory::Buffer &buffer) const override;
+    void way_set(osmium::Way const &way) override;
+    bool way_get(osmid_t id, osmium::memory::Buffer &buffer) const override;
     size_t rel_way_members_get(osmium::Relation const &rel, rolelist_t *roles,
                                osmium::memory::Buffer &buffer) const override;
 
-    bool relations_get(osmid_t id,
-                       osmium::memory::Buffer &buffer) const override;
-    void relations_set(osmium::Relation const &rel) override;
+    bool relation_get(osmid_t id,
+                      osmium::memory::Buffer &buffer) const override;
+    void relation_set(osmium::Relation const &rel) override;
 
     void flush() override {}
 

src/middle.hpp

@@ -42,7 +42,7 @@ struct middle_query_t : std::enable_shared_from_this<middle_query_t>
      *
      * \return true if the way was retrieved
      */
-    virtual bool ways_get(osmid_t id, osmium::memory::Buffer &buffer) const = 0;
+    virtual bool way_get(osmid_t id, osmium::memory::Buffer &buffer) const = 0;
 
     /**
      * Retrieves the way members of a relation and stores them in
@@ -65,8 +65,8 @@ struct middle_query_t : std::enable_shared_from_this<middle_query_t>
      *
      * \return true if the relation was retrieved
      */
-    virtual bool relations_get(osmid_t id,
-                               osmium::memory::Buffer &buffer) const = 0;
+    virtual bool relation_get(osmid_t id,
+                              osmium::memory::Buffer &buffer) const = 0;
 
     /*
      * Retrieve a list of relations with a particular way as a member
@@ -78,7 +78,10 @@ struct middle_query_t : std::enable_shared_from_this<middle_query_t>
 inline middle_query_t::~middle_query_t() = default;
 
 /**
- * Interface for storing raw OSM data in an intermediate cache.
+ * Interface for storing raw OSM data in an intermediate object store.
+ *
+ * This interface only allows for setting OSM data once, not changing it.
+ * If you need updates and deletions, look at the derived class slim_middle_t.
  */
 struct middle_t
 {
@@ -89,11 +92,33 @@ struct middle_t
     virtual void analyze(void) = 0;
     virtual void commit(void) = 0;
 
-    virtual void nodes_set(osmium::Node const &node) = 0;
-    virtual void ways_set(osmium::Way const &way) = 0;
-    virtual void relations_set(osmium::Relation const &rel) = 0;
+    /**
+     * Add a node to data storage. The node must not already be in the
+     * data storage.
+     */
+    virtual void node_set(osmium::Node const &node) = 0;
+
+    /**
+     * Add a way to data storage. The way must not already be in the data
+     * storage.
+     */
+    virtual void way_set(osmium::Way const &way) = 0;
+
+    /**
+     * Add a relation to data storage. The way must not already be in the
+     * data storage.
+     */
+    virtual void relation_set(osmium::Relation const &rel) = 0;
 
-    /// Write all pending data to permanent storage.
+    /**
+     * Ensure all pending data is written to the storage.
+     *
+     * You can only query objects from the storage after they have been
+     * flushed.
+     *
+     * The function is called after setting all the nodes, then after setting
+     * all the ways, and again after setting all the relations.
+     */
     virtual void flush() = 0;
 
     struct pending_processor
@@ -116,20 +141,49 @@ struct middle_t
 inline middle_t::~middle_t() = default;
 
 /**
- * Extended interface for permanent caching of raw OSM data.
- * It also allows updates.
+ * Extends the middle_t interface to allow updates and deletions of objects.
  */
 struct slim_middle_t : public middle_t
 {
     virtual ~slim_middle_t() = 0;
 
-    virtual void nodes_delete(osmid_t id) = 0;
+    /**
+     * Delete a node from data storage. Either because you want it removed
+     * entirely or before you can node_set() a new version of it.
+     */
+    virtual void node_delete(osmid_t id) = 0;
+
+    /**
+     * Mark a node as changed. This has to be called *after* node_delete()
+     * and node_set() is called to trigger the propagation of this change
+     * to ways and relations.
+     */
     virtual void node_changed(osmid_t id) = 0;
 
-    virtual void ways_delete(osmid_t id) = 0;
+    /**
+     * Delete a way from data storage. Either because you want it removed
+     * entirely or before you can way_set() a new version of it.
+     */
+    virtual void way_delete(osmid_t id) = 0;
+
+    /**
+     * Mark a way as changed. This has to be called *after* way_delete()
+     * and way_set() is called to trigger the propagation of this change
+     * to relations.
+     */
     virtual void way_changed(osmid_t id) = 0;
 
-    virtual void relations_delete(osmid_t id) = 0;
+    /**
+     * Delete a relation from data storage. Either because you want it removed
+     * entirely or before you can relation_set() a new version of it.
+     */
+    virtual void relation_delete(osmid_t id) = 0;
+
+    /**
+     * Mark a relation as changed. This has to be called *after*
+     * relation_delete() and relation_set() is called to trigger the
+     * propagation of this change to other relations.
+     */
     virtual void relation_changed(osmid_t id) = 0;
 };