Parse WRAPN functions better

Author: vallode

dist/library/modules/buildings.lua

@@ -2,7 +2,6 @@
 ---@meta
 
 ---@class dfhack.buildings
----@field containsTile function
 ---@field setSize function
 ---@field getStockpileContents function
 ---@field getCageOccupants function
@@ -30,6 +29,12 @@ function dfhack.buildings.getCorrectSize(center, type, subtype, custom, directio
 ---@return df.building
 function dfhack.buildings.findPenPitAt(coord) end
 
+---@param bld df.building
+---@param x integer
+---@param y integer
+---@return boolean
+function dfhack.buildings.containsTile(bld, x, y) end
+
 ---@param building df.building
 ---@param type df.general_ref_type
 ---@return df.general_ref

dist/library/modules/burrows.lua

@@ -2,14 +2,27 @@
 ---@meta
 
 ---@class dfhack.burrows
----@field isAssignedBlockTile function
----@field setAssignedBlockTile function
 dfhack.burrows = {}
 
 ---@param pvec { [integer]: df.map_block }
 ---@param burrow df.burrow
 function dfhack.burrows.listBlocks(pvec, burrow) end
 
+---@param burrow df.burrow
+---@param block df.map_block
+---@param x integer
+---@param y integer
+---@return boolean
+function dfhack.burrows.isAssignedBlockTile(burrow, block, x, y) end
+
+---@param burrow df.burrow
+---@param block df.map_block
+---@param x integer
+---@param y integer
+---@param enable boolean|nil
+---@return boolean
+function dfhack.burrows.setAssignedBlockTile(burrow, block, x, y, enable) end
+
 ---@param name string
 ---@param ignore_final_plus boolean|nil
 ---@return df.burrow

dist/library/modules/gui.lua

@@ -2,8 +2,6 @@
 ---@meta
 
 ---@class dfhack.gui
----@field addCombatReport function
----@field addCombatReportAuto function
 ---@field getCurFocus function
 ---@field getWidgetChildren function
 dfhack.gui = {}

dist/library/modules/internal.lua

@@ -2,16 +2,6 @@
 ---@meta
 
 ---@class dfhack.internal
----@field strerror function
----@field md5 function
----@field heapTakeSnapshot function
----@field getHeapState function
----@field isAddressInHeap function
----@field isAddressActiveInHeap function
----@field isAddressUsedAfterFreeInHeap function
----@field getAddressSizeInHeap function
----@field getRootAddressOfHeapObject function
----@field msizeAddress function
 ---@field getPE function
 ---@field getMD5 function
 ---@field getAddress function
@@ -44,3 +34,44 @@
 ---@field getPerfCounters function
 dfhack.internal = {}
 
+---@param n integer
+---@return string
+function dfhack.internal.strerror(n) end
+
+---@param s string
+---@return string
+function dfhack.internal.md5(s) end
+
+-- this function only allocates the first time it is called
+---@return integer
+function dfhack.internal.heapTakeSnapshot() end
+
+---@return integer
+function dfhack.internal.getHeapState() end
+
+---@param ptr unknown
+---@return boolean
+function dfhack.internal.isAddressInHeap(ptr) end
+
+---@param ptr unknown
+---@return boolean
+function dfhack.internal.isAddressActiveInHeap(ptr) end
+
+---@param ptr unknown
+---@return boolean
+function dfhack.internal.isAddressUsedAfterFreeInHeap(ptr) end
+
+---@param ptr unknown
+---@return integer
+function dfhack.internal.getAddressSizeInHeap(ptr) end
+
+-- eg if I have a struct, does any address lie within the struct?
+---@param ptr unknown
+---@return unknown
+function dfhack.internal.getRootAddressOfHeapObject(ptr) end
+
+-- is in the heap/valid
+---@param ptr unknown
+---@return integer
+function dfhack.internal.msizeAddress(ptr) end
+

dist/library/modules/items.lua

@@ -2,13 +2,6 @@
 ---@meta
 
 ---@class dfhack.items
----@field moveToGround function
----@field moveToContainer function
----@field moveToInventory function
----@field makeProjectile function
----@field remove function
----@field findType function
----@field findSubtype function
 dfhack.items = {}
 
 ---@param item df.item
@@ -41,6 +34,40 @@ function dfhack.items.moveToBuilding(item, building, use_mode, force_in_building
 ---@return boolean
 function dfhack.items.createItem(unit, item_type, item_subtype, mat_type, mat_index, growth_print, no_floor) end
 
+---@param item df.item
+---@param pos df.coord
+---@return boolean
+function dfhack.items.moveToGround(item, pos) end
+
+---@param item df.item
+---@param container df.item
+---@return boolean
+function dfhack.items.moveToContainer(item, container) end
+
+---@param item df.item
+---@param unit df.unit
+---@param mode df.unit_inventory_item::T_mode
+---@param body_part integer
+---@return boolean
+function dfhack.items.moveToInventory(item, unit, mode, body_part) end
+
+---@param item df.item
+---@return df.proj_itemst
+function dfhack.items.makeProjectile(item) end
+
+---@param item df.item
+---@param no_uncat boolean|nil
+---@return boolean
+function dfhack.items.remove(item, no_uncat) end
+
+---@param token string
+---@return number
+function dfhack.items.findType(token) end
+
+---@param token string
+---@return number
+function dfhack.items.findSubtype(token) end
+
 ---@param item df.item
 ---@param type df.general_ref_type
 ---@return df.general_ref

dist/library/modules/job.lua

@@ -2,15 +2,23 @@
 ---@meta
 
 ---@class dfhack.job
----@field is_equal function
----@field is_item_equal function
 dfhack.job = {}
 
 ---@param pvec { [integer]: df.job }
 ---@param id_var integer
 ---@return boolean
 function dfhack.job.listNewlyCreated(pvec, id_var) end
 
+---@param job1 df.job
+---@param job2 df.job
+---@return boolean
+function dfhack.job.is_equal(job1, job2) end
+
+---@param job1 df.job_item
+---@param job2 df.job_item
+---@return boolean
+function dfhack.job.is_item_equal(job1, job2) end
+
 ---@param job df.job
 ---@param item df.item
 ---@param role df.job_item_ref::T_role

dist/library/modules/maps.lua

@@ -2,11 +2,6 @@
 ---@meta
 
 ---@class dfhack.maps
----@field getBlock function
----@field hasTileAssignment function
----@field getTileAssignment function
----@field setTileAssignment function
----@field resetTileAssignment function
 ---@field getTileFlags function
 ---@field getTileBiomeRgn function
 ---@field getBiomeType function
@@ -52,6 +47,26 @@ function dfhack.maps.getRegionBiome(rgn_pos) end
 ---@return df.plant
 function dfhack.maps.getPlantAtTile(x, y, z) end
 
+---@param bm df.tile_bitmask
+---@return boolean
+function dfhack.maps.hasTileAssignment(bm) end
+
+---@param bm df.tile_bitmask
+---@param x integer
+---@param y integer
+---@return boolean
+function dfhack.maps.getTileAssignment(bm, x, y) end
+
+---@param bm df.tile_bitmask
+---@param x integer
+---@param y integer
+---@param val boolean|nil
+function dfhack.maps.setTileAssignment(bm, x, y, val) end
+
+---@param bm df.tile_bitmask
+---@param val boolean|nil
+function dfhack.maps.resetTileAssignment(bm, val) end
+
 ---@param blk df.map_block
 ---@param flow boolean|nil
 ---@param temperature boolean|nil

lib/cpp.rb

@@ -58,7 +58,7 @@ def parse_cpp_modules(entry_point)
 
             # Functions with signatures that I currently don't understand well
             # enough to parse.
-            module_declaration&.scan(/(?:WRAP_VERSION_FUNC|WRAPN)\(([^)]+)\)/) do |match|
+            module_declaration&.scan(/(?:WRAP_VERSION_FUNC)\(([^)]+)\)/) do |match|
               function_name = match[0].split(', ')[0]
               output << "---@field #{function_name} function\n"
             end
@@ -77,12 +77,10 @@ def parse_cpp_modules(entry_point)
               signature_name = signature.gsub(/"/, '').strip
 
               cleaned_signature_name = signature_name.gsub(/#{module_name}_/, '')
-              module_file[/^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{namespace}#{cleaned_signature_name}\s?\(([^)]+)?\)/]
+              module_file[/^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{namespace}#{cleaned_signature_name}\R?\s*\(([^)]+)?\)/]
               next if Regexp.last_match
 
-              file[/^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{signature_name}\s?\(([^)]+)?\)/]
-              next unless Regexp.last_match
-
+              file[/^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{signature_name}\R?\s*\(([^)]+)?\)/]
               output << "---@field #{function_name} function\n"
             end
 
@@ -98,13 +96,18 @@ def parse_cpp_modules(entry_point)
               signature_name = signature.gsub(/"/, '').strip
 
               cleaned_signature_name = signature_name.gsub(/#{module_name}_/, '')
-              module_file[%r{(//.*\R)?^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{namespace}#{cleaned_signature_name}\s?\(([^)]+)?\)}]
+              module_file[%r{(//.*\R)?^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{namespace}#{cleaned_signature_name}\R?\s*\(([^)]+)?\)}]
               next unless Regexp.last_match
 
               functions << DFHackLuaDefinitions::CPP.parse_function(Regexp.last_match, module_name:, prefix:,
                                                                                        function_name:)
             end
 
+            module_declaration&.scan(/WRAPN\(\s*(\w+)\s*,\s*(\w+)\s*\)/) do |function_name, signature_name|
+              file[%r{(//.*\R)?^(?:static\s)?(\S+).*?#{signature_name}\R?\s*\(([^)]+)?\)}]
+              functions << CPP.parse_function(Regexp.last_match, module_name:, prefix:, function_name:)
+            end
+
             module_declaration&.scan(/(?:WRAP|WRAPM)\((.+)?\),?/) do |function_name,|
               function_name = Regexp.last_match(1) if function_name =~ /,\s?(\S+)/
               signature = "#{namespace}#{function_name}"