Merge pull request #9 from vallode/feature/support-more-cpp-functions

Support functions declared in LuaApi

Author: vallode

dist/library/modules/matinfo.lua

@@ -0,0 +1,12 @@
+-- THIS FILE WAS GENERATED AUTOMATICALLY. DO NOT EDIT.
+---@meta
+
+---@class matinfo_module
+---@field find function
+---@field decode function
+---@field getToken function
+---@field toString function
+---@field getCraftClass function
+---@field matches function
+dfhack.matinfo = {}
+

dist/library/modules/pen.lua

@@ -0,0 +1,11 @@
+-- THIS FILE WAS GENERATED AUTOMATICALLY. DO NOT EDIT.
+---@meta
+
+---@class pen_module
+---@field parse function
+---@field make function
+---@field __index function
+---@field __pairs function
+---@field __newindex function
+dfhack.pen = {}
+

dist/library/modules/penarray.lua

@@ -0,0 +1,12 @@
+-- THIS FILE WAS GENERATED AUTOMATICALLY. DO NOT EDIT.
+---@meta
+
+---@class penarray_module
+---@field new function
+---@field clear function
+---@field get_dims function
+---@field get_tile function
+---@field set_tile function
+---@field draw function
+dfhack.penarray = {}
+

dist/library/modules/persistent.lua

@@ -0,0 +1,12 @@
+-- THIS FILE WAS GENERATED AUTOMATICALLY. DO NOT EDIT.
+---@meta
+
+---@class persistent_module
+---@field getSiteDataString function
+---@field saveSiteDataString function
+---@field deleteSiteData function
+---@field getWorldDataString function
+---@field saveWorldDataString function
+---@field deleteWorldData function
+dfhack.persistent = {}
+

dist/library/modules/random.lua

@@ -0,0 +1,15 @@
+-- THIS FILE WAS GENERATED AUTOMATICALLY. DO NOT EDIT.
+---@meta
+
+---@class random_module
+---@field new function
+---@field init function
+---@field random function
+---@field drandom function
+---@field drandom0 function
+---@field drandom1 function
+---@field unitrandom function
+---@field unitvector function
+---@field perlin function
+dfhack.random = {}
+

dist/library/modules/screen.lua

@@ -61,10 +61,6 @@ function dfhack.screen.keyToChar(key) end
 ---@return df.interface_key
 function dfhack.screen.charToKey(code) end
 
----@param cmd df.zoom_commands
----@return nil
-function dfhack.screen.zoom(cmd) end
-
 ---@return boolean
 function dfhack.screen.inGraphicsMode() end
 

dist/library/modules/textures.lua

@@ -0,0 +1,37 @@
+-- THIS FILE WAS GENERATED AUTOMATICALLY. DO NOT EDIT.
+---@meta
+
+---@class textures_module
+dfhack.textures = {}
+
+---@param file string
+---@param tile_px_w integer
+---@param tile_px_h integer
+---@param reserved boolean|nil
+---@return { [integer]: unknown }
+function dfhack.textures.loadTileset(file, tile_px_w, tile_px_h, reserved) end
+
+---@param handle unknown
+---@return number
+function dfhack.textures.getTexposByHandle(handle) end
+
+---@param handle unknown
+---@return nil
+function dfhack.textures.deleteHandle(handle) end
+
+---@param pixels { [integer]: integer }
+---@param tile_px_w integer
+---@param tile_px_h integer
+---@param reserved boolean|nil
+---@return unknown
+function dfhack.textures.createTile(pixels, tile_px_w, tile_px_h, reserved) end
+
+---@param pixels { [integer]: integer }
+---@param texture_px_w integer
+---@param texture_px_h integer
+---@param tile_px_w integer
+---@param tile_px_h integer
+---@param reserved boolean|nil
+---@return { [integer]: unknown }
+function dfhack.textures.createTileset(pixels, texture_px_w, texture_px_h, tile_px_w, tile_px_h, reserved) end
+

lib/cpp.rb

@@ -21,20 +21,23 @@ class << self
       # attempts to find the relevant module files and their function
       # signatures.
       def parse_cpp_modules(entry_point)
+        # TODO: Of course we cannot do this forever!
         ignored_modules = %w[console]
 
         file = File.read(entry_point)
         directory = File.dirname(entry_point)
 
-        file.scan(/^static.*module\[\][\s\S]+?};/) do |cpp_module|
-          module_name = cpp_module[/\S+(?=_module\[\])/].gsub('dfhack_', '')
-
-          next if ignored_modules.include? module_name
+        modules = file.scan(/^static.*dfhack_(.*)(?:_funcs|_module)\[\][\s\S]+?};/).flatten.uniq.reject do |name|
+          ignored_modules.include? name
+        end
 
-          module_file = if %w[dfhack internal].include? module_name
-                          file
+        modules.each do |module_name|
+          module_path = "#{directory}/modules/#{module_name.capitalize}.cpp"
+          is_module = file =~ /^static.*#{module_name}_module\[\]/
+          module_file = if File.exist? module_path
+                          File.read(module_path)
                         else
-                          File.read("#{directory}/modules/#{module_name.capitalize}.cpp")
+                          file
                         end
 
           File.open("dist/library/modules/#{module_name}.lua", 'w') do |output|
@@ -44,36 +47,59 @@ def parse_cpp_modules(entry_point)
 
             output << "---@class #{module_name}_module\n"
 
+            prefix = module_name == 'dfhack' ? '' : 'dfhack.'
+            namespace = is_module ? "#{module_name.capitalize}::" : ''
+
+            functions = []
+
+            module_declaration = file[/^static.*#{module_name}_module\[\][\s\S]+?};/]
+            function_declaration = file[/^static.*#{module_name}_funcs\[\][\s\S]+?};/]
+
             # Functions with signatures that are unlikely to be easily parsed.
-            cpp_module.scan(/(?:WRAP_VERSION_FUNC|WRAPN)\(([^)]+)\)/) do |match|
+            module_declaration&.scan(/(?:WRAP_VERSION_FUNC|WRAPN)\(([^)]+)\)/) do |match|
               function_name = match[0].split(', ')[0]
               output << "---@field #{function_name} function\n"
             end
 
-            prefix = module_name == 'dfhack' ? '' : 'dfhack.'
-            namespace = module_name == 'dfhack' ? '' : "#{module_name.capitalize}::"
-            output << "#{prefix}#{module_name} = {}\n\n"
-
-            functions = []
+            # Functions that manipulate lua_state (usually?)
+            unless is_module
+              function_declaration&.scan(/^\s*{\s*([^,]+),\s*([^}]+)\s*}/) do |name, signature|
+                next if name =~ /NULL/
 
-            # Guessing here a little bit.
-            file.scan(/^static.*#{module_name}_funcs\[\][\s\S]+?};/) do |funcs|
-              funcs.scan(/{([^}\n]+)}/) do
-                match = Regexp.last_match(1)
-                next if match =~ /NULL/
+                function_name = name.gsub(/"/, '').strip
+                signature_name = signature.gsub(/"/, '').strip
 
-                function_name = match.split(',')[0].strip.gsub(/"/, '')
-                signature_name = match.split(',')[1].strip.gsub('"', '').gsub("#{module_name}_", '')
+                module_file[/^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{namespace}#{signature_name.gsub(
+                  /#{module_name}_/, ''
+                )}\s?\(([^)]+)?\)/]
+                next if Regexp.last_match
 
-                module_file[/^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{namespace}#{signature_name}\s?\(([^)]+)?\)/]
+                file[/^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{signature_name}\s?\(([^)]+)?\)/] unless is_module
                 next unless Regexp.last_match
 
-                functions << DFHackLuaDefinitions::CPP.parse_function(Regexp.last_match, module_name:, prefix:,
-                                                                                         function_name:)
+                output << "---@field #{function_name} function\n"
               end
             end
 
-            cpp_module.scan(/(?:WRAP|WRAPM)\((.+)?\),?/) do |function_name,|
+            output << "#{prefix}#{module_name} = {}\n\n"
+
+            # Guessing here a little bit.
+            function_declaration&.scan(/^\s*{\s*([^,]+),\s*([^}]+)\s*}/) do |name, signature|
+              next if name =~ /NULL/
+
+              function_name = name.gsub(/"/, '').strip
+              signature_name = signature.gsub(/"/, '').strip
+
+              module_file[/^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{namespace}#{signature_name.gsub(
+                /#{module_name}_/, ''
+              )}\s?\(([^)]+)?\)/]
+              next unless Regexp.last_match
+
+              functions << DFHackLuaDefinitions::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}"
 
@@ -84,7 +110,6 @@ def parse_cpp_modules(entry_point)
               functions << DFHackLuaDefinitions::CPP.parse_function(Regexp.last_match, module_name:, prefix:,
                                                                                        function_name:)
             end
-
             output << functions.join
           end
         end