Fix DFHACK_EXPORT prefixed methods

Author: vallode

dist/library/modules/dfhack.lua

@@ -4,41 +4,69 @@
 ---@class dfhack_module
 dfhack = {}
 
+---@return string
 function dfhack.getOSType() end
 
+---@return integer
 function dfhack.getArchitecture() end
 
+---@return string
 function dfhack.getArchitectureName() end
 
+---@return string
 function dfhack.getDFVersion() end
 
+---@return string
 function dfhack.getDFPath() end
 
+---@return integer
 function dfhack.getTickCount() end
 
+---@return string
 function dfhack.getHackPath() end
 
+---@return boolean
 function dfhack.isWorldLoaded() end
 
+---@return boolean
 function dfhack.isMapLoaded() end
 
+---@return boolean
 function dfhack.isSiteLoaded() end
 
 function dfhack.TranslateName() end
 
-function dfhack.df2utf() end
+---@param s string
+---@return string
+function dfhack.df2utf(s) end
 
-function dfhack.utf2df() end
+---@param s string
+---@return string
+function dfhack.utf2df(s) end
 
-function dfhack.df2console() end
+---@param s string
+---@return string
+function dfhack.df2console(s) end
 
-function dfhack.upperCp437() end
+---@param s string
+---@return string
+function dfhack.upperCp437(s) end
 
-function dfhack.lowerCp437() end
+---@param s string
+---@return string
+function dfhack.lowerCp437(s) end
 
-function dfhack.toSearchNormalized() end
+---@param s string
+---@return string
+function dfhack.toSearchNormalized(s) end
 
-function dfhack.capitalizeStringWords() end
+---@param s string
+---@return string
+function dfhack.capitalizeStringWords(s) end
 
-function dfhack.addCommandToHistory() end
+---@param id string
+---@param srcfile string
+---@param command string
+---@return nil
+function dfhack.addCommandToHistory(id, srcfile, command) end
 

dist/library/modules/gui.lua

@@ -77,7 +77,9 @@ function dfhack.gui.getAnyStockpile(top) end
 ---@return plant
 function dfhack.gui.getAnyPlant(top) end
 
-function dfhack.gui.writeToGamelog() end
+---@param message string
+---@return nil
+function dfhack.gui.writeToGamelog(message) end
 
 ---@param pause boolean|nil
 ---@return nil

dist/library/modules/job.lua

@@ -4,13 +4,27 @@
 ---@class job_module
 dfhack.job = {}
 
-function dfhack.job.attachJobItem() end
+---@param job job
+---@param item item
+---@param role job_item_ref::T_role
+---@param filteridx integer
+---@param insertidx integer
+---@return boolean
+function dfhack.job.attachJobItem(job, item, role, filteridx, insertidx) end
 
-function dfhack.job.cloneJobStruct() end
+---@param job job
+---@param keepEverything boolean|nil
+---@return job
+function dfhack.job.cloneJobStruct(job, keepEverything) end
 
-function dfhack.job.printItemDetails() end
+---@param item job_item
+---@param idx integer
+---@return nil
+function dfhack.job.printItemDetails(item, idx) end
 
-function dfhack.job.printJobDetails() end
+---@param job job
+---@return nil
+function dfhack.job.printJobDetails(job) end
 
 ---@param job job
 ---@param type general_ref_type
@@ -22,16 +36,29 @@ function dfhack.job.getGeneralRef(job, type) end
 ---@return specific_ref
 function dfhack.job.getSpecificRef(job, type) end
 
-function dfhack.job.getHolder() end
+---@param job job
+---@return building
+function dfhack.job.getHolder(job) end
 
-function dfhack.job.getWorker() end
+---@param job job
+---@return unit
+function dfhack.job.getWorker(job) end
 
-function dfhack.job.setJobCooldown() end
+---@param workshop building
+---@param worker unit
+---@param cooldown integer
+---@return nil
+function dfhack.job.setJobCooldown(workshop, worker, cooldown) end
 
-function dfhack.job.removeWorker() end
+---@param job job
+---@param cooldown integer
+---@return boolean
+function dfhack.job.removeWorker(job, cooldown) end
 
+---@return nil
 function dfhack.job.checkBuildingsNow() end
 
+---@return nil
 function dfhack.job.checkDesignationsNow() end
 
 ---@param item job_item
@@ -51,13 +78,27 @@ function dfhack.job.isSuitableMaterial(item, mattype, matindex, itype) end
 ---@return string
 function dfhack.job.getName(job) end
 
-function dfhack.job.linkIntoWorld() end
+---@param job job
+---@param newid boolean|nil
+---@return boolean
+function dfhack.job.linkIntoWorld(job, newid) end
 
-function dfhack.job.removePostings() end
+---@param job job
+---@param removeall boolean|nil
+---@return boolean
+function dfhack.job.removePostings(job, removeall) end
 
-function dfhack.job.disconnectJobItem() end
+---@param job job
+---@param itemref job_item_ref
+---@return nil
+function dfhack.job.disconnectJobItem(job, itemref) end
 
-function dfhack.job.disconnectJobGeneralRef() end
+---@param job job
+---@param ref general_ref
+---@return boolean
+function dfhack.job.disconnectJobGeneralRef(job, ref) end
 
-function dfhack.job.removeJob() end
+---@param job job
+---@return boolean
+function dfhack.job.removeJob(job) end
 

lib/cpp.rb

@@ -53,7 +53,9 @@ def parse_type(string)
       end
 
       def sanitize(string)
-        string.gsub(/[^A-Za-z0-9]/, '')
+        return nil unless string
+
+        string.gsub(/[^A-Za-z0-9]/, '').strip
       end
     end
   end

lib/generate.rb

@@ -45,17 +45,16 @@ def parse_cpp_modules(files)
 
       output << "---@class #{module_name}_module\n"
       prefix = module_name == 'dfhack' ? '' : 'dfhack.'
+      namespace = module_name == 'dfhack' ? '' : "#{module_name.capitalize}::"
       output << "#{prefix}#{module_name} = {}\n\n"
 
       cpp_module.scan(/(?:WRAP|WRAPM)\((.+)?\),?/) do |function_name,|
         function_name = Regexp.last_match(1) if function_name =~ /,\s?(\S+)/
-        signature = "#{module_name.capitalize}::#{function_name}"
+        signature = "#{namespace}#{function_name}"
 
-        module_file[/^(?:static)?(\S+)\s+\S?#{signature}\s?\(([^)]+)?\)/]
-        # binding.irb if function_name == 'dhasSupport'
+        module_file[/^(?:static\s)?(?:DFHACK_EXPORT\s)?(\S+).*?#{signature}\s?\(([^)]+)?\)/]
         return_type = DFHackLuaDefinitions::CPP.parse_type(Regexp.last_match(1))
         arguments = Regexp.last_match(2)&.gsub(/const\s|[*&]/, '')&.split(',')&.map(&:strip)
-        # binding.irb if function_name == 'chdirfun'
 
         arguments = arguments&.map do |argument|
           type, name = argument.split(' ')
@@ -226,13 +225,13 @@ def generate_annotations
   lua_api = './dfhack/library/LuaApi.cpp'
   parse_cpp_modules(lua_api)
 
-  print "Parsing DFHack Lua library\n"
-  library_files = Dir.glob('./dfhack/library/lua/**/*.lua')
-  parse_lua_files(library_files)
+  # print "Parsing DFHack Lua library\n"
+  # library_files = Dir.glob('./dfhack/library/lua/**/*.lua')
+  # parse_lua_files(library_files)
 
-  print "Parsing DF-Structures XML files\n"
-  structure_files = Dir.glob('./df-structures/df.*.xml')
-  parse_xml_files(structure_files)
+  # print "Parsing DF-Structures XML files\n"
+  # structure_files = Dir.glob('./df-structures/df.*.xml')
+  # parse_xml_files(structure_files)
 end
 
 generate_annotations if $PROGRAM_NAME == __FILE__