SciTE - DebugToMsgBox/~Console also with array variables

[BugFix]

At the moment you can debug with DebugToMsgBox/DebugToConsole only simple variables like $variable but not some like $a[ubound($a) -1][$j] or other complex array variables.

I've made a LUA script that detects simple variables and complex array variables up to 4D-arrays. AutoIt allows dirty syntax with any desired spaces between closing and following opening squared brackets. This cases will respected.

To use this script:

- open your file ..AutoIt3SciTELUAAutoItTools.lua in editor

- copy the function GetVarFromCursor() above the function DebugMsgBoxAdd()

- make following changes in DebugMsgBoxAdd() and DebugConsoleWriteAdd()

function AutoItTools:DebugMsgBoxAdd()
--~  local word = self:GetWord2()
    local word = GetVarFromCursor()

function AutoItTools:DebugConsoleWriteAdd()
--~  local word = self:GetWord2()
    local word = GetVarFromCursor()

Here the function GetVarFromCursor():

expandcollapse popup

--------------------------------------------------------------------------------
-- GetVarFromCursor()
--
-- Get variable from cursor position (somewhere inside variable, left or right touching).
-- Detection of variables also if they build as an array construct (up to 4 dimensions).
-- i.e. (pipe as cursor position): "$a [ Ubound($a) -1 ] [ |$i ] [ $j ]" gets the whole exception: "$a [ Ubound($a) -1 ] [ $i ] [ $j ]"
-- The bad syntax in AutoIt ( any desired spaces between closing and following opening squared bracket ) will also detect.
-- Variables with following point and method/property are ignored because its not to guess if method/property returns a value.
-- by BugFix
--------------------------------------------------------------------------------
function GetVarFromCursor()
    local iCaret = editor.CurrentPos
    local iTmp = iCaret
    local sSel = string.char(editor.CharAt[iCaret])
    if (string.byte(sSel) == 13) or (sSel == ' ') or (sSel == ',') then
        iCaret = iCaret -1
    end
    local sLeft = string.char(editor.CharAt[iTmp-1])
    local iLine = editor:LineFromPosition(iCaret)
    local iLine1stPos = editor:PositionFromLine(iLine)
    local iDiffPos = iCaret - iLine1stPos +1
    local sLine = editor:GetLine(iLine)
    local tPatternArray = {'%$[%w_]+%s*%b[]%s*%b[]%s*%b[]%s*%b[]','%$[%w_]+%s*%b[]%s*%b[]%s*%b[]','%$[%w_]+%s*%b[]%s*%b[]','%$[%w_]+%s*%b[]'}
    local sPatternNormal = '%$[%w_]+%s*[^[]'
    function SearchVar(_sLine, _sPattern, _iCursor)
        local tVars = {}
        local iMatchStart iMatchEnd = 0
        while true do
            iMatchStart, iMatchEnd = string.find(_sLine, _sPattern, iMatchEnd +1)
            if iMatchStart == nil then break end
            table.insert(tVars, {iMatchStart, iMatchEnd})
        end
        if table.getn(tVars) > 0 then
            for i = 1, table.getn(tVars) do
                if ( _iCursor >= tVars[i][1] ) and ( _iCursor <= tVars[i][2] ) then
                    return string.sub(_sLine, tVars[i][1], tVars[i][2])
                end
            end
        end
        return nil
    end
    local sVarUnderCursor
    for i = 1, 4 do
        sVarUnderCursor = SearchVar(sLine, tPatternArray[i], iDiffPos)
        if sVarUnderCursor ~= nil then return sVarUnderCursor end
    end
    if sVarUnderCursor == nil then
        local fLeftVar = false fRightVar = false
        if string.find(sLeft, '[%w_$]') ~= nil then
            fLeftVar = true
        else
            if sSel == '$' then fRightVar = true end
        end
        if not fLeftVar and not fRightVar then return '' end
        sVarUnderCursor = SearchVar(sLine, sPatternNormal, iDiffPos)
        if sVarUnderCursor == nil then return '' end
    end
    if string.find(sVarUnderCursor, '%.$') then return '' end
    sVarUnderCursor = string.sub(sVarUnderCursor, string.find(sVarUnderCursor, '%$[%w_]+'))
    return sVarUnderCursor
end -- GetVarFromCursor()

Edit: Oops - has detect a mistake and fixed it. If someone find also an mistake - please let me know to fix.

Edit2: Sometimes, i think to complicated...

So now i've made it easier. And i hope, all bugs are fixed.

Edited December 31, 2011 by BugFix

[guinness]

Brilliant! I will give it a try.

[BugFix]

Thanks for your reply.

I'm still a beginner with LUA. It's sure possible to make this script more professional. I still try my best.

[Marcelos]

Awsome

i fixed it to my teaste :-) as.

 

elseif option == 1 then

ConsoleWrite('@@(' & @ScriptName   & '-' & @ScriptLineNumber  & ') : $VARIABLE = ' & $VARIABLE & @crlf)

Thanks for sharing