fix liniting issues and add type annotations

[nominatim.git] / settings / flex-base.lua

diff --git a/settings/flex-base.lua b/settings/flex-base.lua
index a4c1d561df881bdc7cc2d9efe2620b16041a3ed2..0e11273633cfc6dabcda67b1f3f1f50954527fe8 100644 (file)
--- a/settings/flex-base.lua
+++ b/settings/flex-base.lua
@@ -1,9 +1,19 @@
 -- Core functions for Nominatim import flex style.
 --
 
 -- Core functions for Nominatim import flex style.
 --
 

+local module = {}
+
+local PRE_DELETE = nil
+local PRE_EXTRAS = nil
+local MAIN_KEYS = nil
+local NAMES = nil
+local ADDRESS_TAGS = nil
+local SAVE_EXTRA_MAINS = false
+local POSTCODE_FALLBACK = true
+

 
 -- The single place table.
 
 -- The single place table.

-place_table = osm2pgsql.define_table{
+local place_table = osm2pgsql.define_table{

     name = "place",
     ids = { type = 'any', id_column = 'osm_id', type_column = 'osm_type' },
     columns = {
     name = "place",
     ids = { type = 'any', id_column = 'osm_id', type_column = 'osm_type' },
     columns = {


@@ -18,6 +28,23 @@ place_table = osm2pgsql.define_table{
     indexes = {}
 }
 
     indexes = {}
 }
 

+------------ Geometry functions for relations ---------------------
+
+function module.relation_as_multipolygon(o)
+    return o:as_multipolygon()
+end
+
+function module.relation_as_multiline(o)
+    return o:as_multilinestring():line_merge()
+end
+
+
+module.RELATION_TYPES = {
+    multipolygon = module.relation_as_multipolygon,
+    boundary = module.relation_as_multipolygon,
+    waterway = module.relation_as_multiline
+}
+

 ------------- Place class ------------------------------------------
 
 local Place = {}
 ------------- Place class ------------------------------------------
 
 local Place = {}


@@ -44,56 +71,35 @@ function Place.new(object, geom_func)
     return self
 end
 
     return self
 end
 

-function Place:delete(data)
-    if data.match ~= nil then
-        for k, v in pairs(self.object.tags) do
-            if data.match(k, v) then
-                self.object.tags[k] = nil
-            end
+function Place:clean(data)
+    for k, v in pairs(self.object.tags) do
+        if data.delete ~= nil and data.delete(k, v) then
+            self.object.tags[k] = nil
+        elseif data.extra ~= nil and data.extra(k, v) then
+            self.extratags[k] = v
+            self.object.tags[k] = nil

         end
     end
 end
 
         end
     end
 end
 

-function Place:grab_extratags(data)
-    local count = 0
-
+function Place:delete(data)

     if data.match ~= nil then
         for k, v in pairs(self.object.tags) do
             if data.match(k, v) then
                 self.object.tags[k] = nil
     if data.match ~= nil then
         for k, v in pairs(self.object.tags) do
             if data.match(k, v) then
                 self.object.tags[k] = nil

-                self.extratags[k] = v
-                count = count + 1

             end
         end
     end
             end
         end
     end

-
-    return count

 end
 
 end
 

-function Place:grab_address(data)
+function Place:grab_extratags(data)

     local count = 0
 
     if data.match ~= nil then
         for k, v in pairs(self.object.tags) do
             if data.match(k, v) then
                 self.object.tags[k] = nil
     local count = 0
 
     if data.match ~= nil then
         for k, v in pairs(self.object.tags) do
             if data.match(k, v) then
                 self.object.tags[k] = nil

-
-                if data.include_on_name == true then
-                    self.has_name = true
-                end
-
-                if data.out_key ~= nil then
-                    self.address[data.out_key] = v
-                    return 1
-                end
-
-                if k:sub(1, 5) == 'addr:' then
-                    self.address[k:sub(6)] = v
-                elseif k:sub(1, 6) == 'is_in:' then
-                    self.address[k:sub(7)] = v
-                else
-                    self.address[k] = v
-                end
+                self.extratags[k] = v

                 count = count + 1
             end
         end
                 count = count + 1
             end
         end


@@ -122,14 +128,17 @@ function Place:grab_address_parts(data)
         for k, v in pairs(self.object.tags) do
             local atype = data.groups(k, v)
 
         for k, v in pairs(self.object.tags) do
             local atype = data.groups(k, v)
 

-            if atype == 'main' then
-                self.has_name = true
-                self.address[strip_address_prefix(k)] = v
-                count = count + 1
-            elseif atype == 'extra' then
-                self.address[strip_address_prefix(k)] = v
-            elseif atype ~= nil then
-                self.address[atype] = v
+            if atype ~= nil then
+                if atype == 'main' then
+                    self.has_name = true
+                    self.address[strip_address_prefix(k)] = v
+                    count = count + 1
+                elseif atype == 'extra' then
+                    self.address[strip_address_prefix(k)] = v
+                else
+                    self.address[atype] = v
+                end
+                self.object.tags[k] = nil

             end
         end
     end
             end
         end
     end


@@ -137,28 +146,30 @@ function Place:grab_address_parts(data)
     return count
 end
 
     return count
 end
 

-function Place:grab_name(data)
-    local count = 0

 
 

-    if data.match ~= nil then
+function Place:grab_name_parts(data)
+    local fallback = nil
+
+    if data.groups ~= nil then

         for k, v in pairs(self.object.tags) do
         for k, v in pairs(self.object.tags) do

-            if data.match(k, v) then
-                self.object.tags[k] = nil
+            local atype = data.groups(k, v)
+
+            if atype ~= nil then

                 self.names[k] = v
                 self.names[k] = v

-                if data.include_on_name ~= false then
+                self.object.tags[k] = nil
+                if atype == 'main' then
+                    self.has_name = true
+                elseif atype == 'house' then

                     self.has_name = true
                     self.has_name = true

+                    fallback = {'place', 'house', 'always'}

                 end
                 end

-                count = count + 1

             end
         end
     end
 
             end
         end
     end
 

-    return count
+    return fallback

 end
 
 end
 

-function Place:grab_tag(key)
-    return self.object:grab_tag(key)
-end

 
 function Place:write_place(k, v, mtype, save_extra_mains)
     if mtype == nil then
 
 function Place:write_place(k, v, mtype, save_extra_mains)
     if mtype == nil then


@@ -242,7 +253,7 @@ function Place:write_row(k, v, save_extra_mains)
 end
 
 
 end
 
 

-function tag_match(data)
+function module.tag_match(data)

     if data == nil or next(data) == nil then
         return nil
     end
     if data == nil or next(data) == nil then
         return nil
     end


@@ -304,7 +315,7 @@ function tag_match(data)
 end
 
 
 end
 
 

-function key_group(data)
+function module.tag_group(data)

     if data == nil or next(data) == nil then
         return nil
     end
     if data == nil or next(data) == nil then
         return nil
     end


@@ -360,16 +371,16 @@ function key_group(data)
 end
 
 -- Process functions for all data types
 end
 
 -- Process functions for all data types

-function osm2pgsql.process_node(object)
+function module.process_node(object)

 
     local function geom_func(o)
         return o:as_point()
     end
 
 
     local function geom_func(o)
         return o:as_point()
     end
 

-    process_tags(Place.new(object, geom_func))
+    module.process_tags(Place.new(object, geom_func))

 end
 
 end
 

-function osm2pgsql.process_way(object)
+function module.process_way(object)

 
     local function geom_func(o)
         local geom = o:as_polygon()
 
     local function geom_func(o)
         local geom = o:as_polygon()


@@ -381,30 +392,24 @@ function osm2pgsql.process_way(object)
         return geom
     end
 
         return geom
     end
 

-    process_tags(Place.new(object, geom_func))
-end
-
-function relation_as_multipolygon(o)
-    return o:as_multipolygon()
-end
-
-function relation_as_multiline(o)
-    return o:as_multilinestring():line_merge()
+    module.process_tags(Place.new(object, geom_func))

 end
 
 end
 

-function osm2pgsql.process_relation(object)
-    local geom_func = RELATION_TYPES[object.tags.type]
+function module.process_relation(object)
+    local geom_func = module.RELATION_TYPES[object.tags.type]

 
     if geom_func ~= nil then
 
     if geom_func ~= nil then

-        process_tags(Place.new(object, geom_func))
+        module.process_tags(Place.new(object, geom_func))

     end
 end
 
     end
 end
 

-function process_tags(o)
-    local fallback
+-- The process functions are used by default by osm2pgsql.
+osm2pgsql.process_node = module.process_node
+osm2pgsql.process_way = module.process_way
+osm2pgsql.process_relation = module.process_relation

 
 

-    o:delete{match = PRE_DELETE}
-    o:grab_extratags{match = PRE_EXTRAS}
+function module.process_tags(o)
+    o:clean{delete = PRE_DELETE, extra = PRE_EXTRAS}

 
     -- Exception for boundary/place double tagging
     if o.object.tags.boundary == 'administrative' then
 
     -- Exception for boundary/place double tagging
     if o.object.tags.boundary == 'administrative' then


@@ -413,17 +418,17 @@ function process_tags(o)
         end}
     end
 
         end}
     end
 

+    -- name keys
+    local fallback = o:grab_name_parts{groups=NAMES}
+

     -- address keys
     -- address keys

-    if o:grab_name{match=HOUSENAME_TAGS} > 0 then
-        fallback = {'place', 'house', 'always'}
-    end

     if o:grab_address_parts{groups=ADDRESS_TAGS} > 0 and fallback == nil then
         fallback = {'place', 'house', 'always'}
     end
     if o.address.country ~= nil and #o.address.country ~= 2 then
         o.address['country'] = nil
     end
     if o:grab_address_parts{groups=ADDRESS_TAGS} > 0 and fallback == nil then
         fallback = {'place', 'house', 'always'}
     end
     if o.address.country ~= nil and #o.address.country ~= 2 then
         o.address['country'] = nil
     end

-    if fallback == nil and o.address.postcode ~= nil then
+    if POSTCODE_FALLBACK and fallback == nil and o.address.postcode ~= nil then

         fallback = {'place', 'postcode', 'always'}
     end
 
         fallback = {'place', 'postcode', 'always'}
     end
 


@@ -432,12 +437,7 @@ function process_tags(o)
         return
     end
 
         return
     end
 

-    -- name keys
-    o:grab_name{match = NAMES}
-    o:grab_name{match = REFS, include_on_name = false}
-
-    o:delete{match = POST_DELETE}
-    o:grab_extratags{match = POST_EXTRAS}
+    o:clean{delete = POST_DELETE, extra = POST_EXTRAS}

 
     -- collect main keys
     for k, v in pairs(o.object.tags) do
 
     -- collect main keys
     for k, v in pairs(o.object.tags) do


@@ -456,4 +456,55 @@ function process_tags(o)
     end
 end
 
     end
 end
 

+--------- Convenience functions for simple style configuration -----------------
+
+
+function module.set_prefilters(data)
+    PRE_DELETE = module.tag_match{keys = data.delete_keys, tags = data.delete_tags}
+    PRE_EXTRAS = module.tag_match{keys = data.extra_keys,
+                                  tags = data.extra_tags}
+end
+
+function module.set_main_tags(data)
+    MAIN_KEYS = data
+end
+
+function module.set_name_tags(data)
+    NAMES = module.tag_group(data)
+end
+
+function module.set_address_tags(data)
+    if data.postcode_fallback ~= nil then
+        POSTCODE_FALLBACK = data.postcode_fallback
+        data.postcode_fallback = nil
+    end
+
+    ADDRESS_TAGS = module.tag_group(data)
+end
+
+function module.set_unused_handling(data)
+    if data.extra_keys == nil and data.extra_tags == nil then
+        POST_DELETE = module.tag_match{keys = data.delete_keys, tags = data.delete_tags}
+        POST_EXTRAS = nil
+        SAVE_EXTRA_MAINS = true
+    elseif data.delete_keys == nil and data.delete_tags == nil then
+        POST_DELETE = nil
+        POST_EXTRAS = module.tag_match{keys = data.extra_keys, tags = data.extra_tags}
+        SAVE_EXTRA_MAINS = false
+    else
+        error("unused handler can have only 'extra_keys' or 'delete_keys' set.")
+    end
+end
+
+function set_relation_types(data)
+    module.RELATION_TYPES = {}
+    for k, v in data do
+        if v == 'multipolygon' then
+            module.RELATION_TYPES[k] = module.relation_as_multipolygon
+        elseif v == 'multiline' then
+            module.RELATION_TYPES[k] = module.relation_as_multiline
+        end
+    end
+end

 
 

+return module