CreateFunctionHeader LUA Functions

[Beege]

Some time ago I was playing around in the AutoITTools.lua file and learned that there was a function for generating function headers. For reasons I don't know, it was never added to the scite tools menu. So if you would like to get it working here is how I got it to work.

Add this code to file au3.properties located in "C:\Program Files\AutoIt3\SciTE\properties". You can also get to it from Scite menu Options --> open au3.properties. Restart Scite and it should be in your menu.

# 37 Generates a function header and inserts it into the document.
command.name.37.$(au3)=Generate Function Header
command.subsystem.37.$(au3)=3
command.37.$(au3)=InvokeTool AutoItTools.InsertFunctionHeader
command.shortcut.37.$(au3)=Ctrl+Alt+H
command.save.before.37.$(au3)=2

The generated header will look something like this

; ===================================================================
; _ExampleFunction($iKey, ByRef $second, $third, $forth = 4, $fifth = 5, $sixth =  6)
;
; Description -
; Parameters:
;   $iKey - IN -
;   $second - IN/OUT -
;   $third - IN -
;   $forth - IN/OPTIONAL -
;   $fifth - IN/OPTIONAL -
;   $sixth - IN/OPTIONAL -
; Returns:
;   Success -
;   Error -
; Remarks -
; ===================================================================
Func _ExampleFunction($iKey, ByRef $second, $third, $forth = 4, $fifth = 5, $sixth =  6)
    ;;
EndFunc

I also made a modified version of these functions that will generate a header more like the ones you are used to seeing around autoit.

To use copy and paste these two functions attached to file AutoITtools.lua located in C:\Program Files\AutoIt3\SciTE\LUA.

CreateAutoITFunctionHeader.zip

Then again, add this code to file au3.properties (code is different from above code)

# 37 Generates a function header and inserts it into the document.
command.name.37.$(au3)=Generate Function Header
command.subsystem.37.$(au3)=3
command.37.$(au3)=InvokeTool AutoItTools.InsertAutoitFunctionHeader
command.shortcut.37.$(au3)=Ctrl+Alt+H
command.save.before.37.$(au3)=2

Only part I couldn't figure out was how to set default parameters..

; #FUNCTION# ====================================================================================================
; Name...........: _ExampleFunction
; Description ...:
; Syntax.........: _ExampleFunction($iKey , ByRef $second, $third [, $forth =  [, $fifth =  [, $sixth = ]]])
; Parameters ....: $iKey    -
;                  $second  -
;                  $third   -
;                  $forth   -
;                  $fifth   -
;                  $sixth   -
; Return values .: Success  -
;                  Failure  -
; Author ........: Beege
; Modified.......:
; Remarks .......: None
; Link ..........:
; Example .......:
; ===============================================================================================================
Func _ExampleFunction($iKey, ByRef $second, $third, $forth = 4, $fifth = 5, $sixth =  6)
    ;;
EndFunc

Don't forget to add your name to the "Author" variable. Let me know if you have any problems.

Edited April 4, 2010 by Beege

[MrCreatoR]

I use this script (modified):

expandcollapse popup

function InsertFunctionHeader()
    local line, pos = editor:GetCurLine()
    local pos = editor.CurrentPos - pos
    local lineNum = editor:LineFromPosition(pos)
-- "()([Ff][Uu][Nn][Cc][%s]*([%w_]*)%(.-%))([^\r\n]*)"
--    local from, to, name = string.find(line, "Func ([%w_]*)")
    local from, to, name = string.find(line, "[Ff][Uu][Nn][Cc][%s]*([%w_]*)")
    if to ~= nil then
--        local pfrom, pto, pname = string.find(line, "(%([%w%s\"_,$%=@-%.]*[%)_])")
        local pfrom, pto, pname = string.find(line, "(%(.-%))")
        local i = 0
        while string.find(pname, "_%s*$") do    -- Found an underscore, so need to get the next line, too
            i = i + 1
            local tmp = editor:GetLine(lineNum+i)
            local wfrom = string.find(pname, "_%s*$")
            local nfrom = string.find(tmp, "[^%s]")
            pname = string.sub(pname, 1, wfrom-1) .. string.sub(tmp, nfrom, -1)
            pname =     string.gsub(pname, "[\n\r]", "")
        end
        editor:Home()

        editor:AddText(_CreateFunctionHeader(name,pname))
    else
        local ws = editor:WordStartPosition(editor.CurrentPos)
        local we = editor:WordEndPosition(editor.CurrentPos)
        local word = editor:textrange(ws, we)
        -- Must strip the new lines for this to work.
        line = string.gsub(line, "[\n\r]", "")
        word = string.gsub(word, "[\n\r]", "")
        if word == "" then
            editor:AddText(_CreateFunctionHeader("Name", ""))
        elseif word == line then
            editor:LineEnd()
            local lend = editor.CurrentPos
            editor:Home()
            local lstart = editor.CurrentPos
            editor:SetSel(lstart, lend)
            editor:ReplaceSel(_CreateFunctionHeader(word, "") .. "Func " .. word .. "()\r\nEndFunc; " .. word)
         end
    end
end    -- InsertFunctionheader()

function _CreateFunctionHeader(s, p)
    local params = false
    local res = "; #FUNCTION# " .. string.rep("=", 100)
    res = res .. "\r\n; Name...........:\t" .. s
    res = res .. "\r\n; Description....:\t"
    res = res .. "\r\n; Syntax.........:\t" .. s .. p
    res = res .. "\r\n; Parameters.....:\t"
    
    for byref, parameter, optional in string.gfind(p, "(%w-)%s*($[%w_]+)%s*([=]?)") do
        if parameter ~= "" and parameter ~= nil then
            params = true
            if byref ~= "" and byref ~= nil then
                res = res .. parameter .. " - [ByRef] \r\n;\t\t\t\t\t"
            elseif optional ~= "" and optional ~= nil then
                res = res .. parameter .. " - [Optional] \r\n;\t\t\t\t\t"
            else
                res = res .. parameter .. " - \r\n;\t\t\t\t\t"
            end
        end
    end
    
    if params == false then
        res = res .. "None."
    end
    
    res = res .. "\r\n; Return values..:\tSuccess - \r\n;\t\t\t\t\tFailure - "
    res = res .. "\r\n; Author.........:\t"
    res = res .. "\r\n; Modified.......:\t"
    res = res .. "\r\n; Remarks........:\t"
    res = res .. "\r\n; Related........:\t"
    res = res .. "\r\n; Link...........:\t"
    res = res .. "\r\n; Example........:\t"
    
    res = res .. "\r\n; " .. string.rep("=", 111) .. "\r\n"
    
    return res
end    -- _CreateFunctionHeader()

And this is the output:

; #FUNCTION# ====================================================================================================
; Name...........:  TestFunc
; Description....:  
; Syntax.........:  TestFunc($sVar, $sOptVar=1)
; Parameters.....:  $sVar - 
;                   $sOptVar - [Optional] 
;                   
; Return values..:  Success - 
;                   Failure - 
; Author.........:  
; Modified.......:  
; Remarks........:  
; Related........:  
; Link...........:  
; Example........:  
; ===============================================================================================================
Func TestFunc($sVar, $sOptVar=1)
    
EndFunc

[Beege]

Nice.

[dantay9]

Great job to both of you. This will save me a lot of time.

[Beege]

Great job to both of you. This will save me a lot of time.

Thanks!