MouseHoverCallTips [11/24/2023]

[AdmiralAlkex]

Pretty please

[Valik]

Here's my latest version. No major changes, just a bit of cleanup in a couple spots.

expandcollapse popup

MouseHoverCallTips = EventClass:new(Common)

-- If you are experiencing problems with this script then set the following
-- variable to true to enable diagnostic messages.
MouseHoverCallTips.Debug = false

--------------------------------------------------------------------------------
-- OnSwitchFile
--
--------------------------------------------------------------------------------
function MouseHoverCallTips:OnSwitchFile(path)
    self:initialize_mouse_dwell()
    return false
end

--------------------------------------------------------------------------------
-- initialize_mouse_dwell
--
--------------------------------------------------------------------------------
function MouseHoverCallTips:initialize_mouse_dwell()
    --if (self:IsAu3File(path)) then
        local mousehover_calltips_dwelltime = tonumber(props["mousehover.calltips.dwelltime"])
        if (mousehover_calltips_dwelltime == nil) then mousehover_calltips_dwelltime = 700 end -- default
        scite.SendEditor(SCI_SETMOUSEDWELLTIME, mousehover_calltips_dwelltime)
    --end

    return true
end

--------------------------------------------------------------------------------
-- IsAu3File
--
--------------------------------------------------------------------------------
function MouseHoverCallTips:IsAu3File(path)
    if (string.lower(string.sub(path, -4)) == string.lower(string.sub(props["au3"], -4))) then
        return true
    end

    return false
end

--------------------------------------------------------------------------------
-- find_instance
--
--------------------------------------------------------------------------------
function MouseHoverCallTips:find_instance(source, pattern)
    local function find_first_instance(source, pattern, acc)
        if (source == '') then return 0 end

        if (pattern == '') then return 0 end

        if (acc == string.len(source)) then return 0 end

        if (string.sub(source, acc, acc) == pattern) then
            return acc
        else
            acc = acc + 1
            return find_first_instance(source, pattern, acc)
        end
    end

    return find_first_instance(source, pattern, 1)
end

--------------------------------------------------------------------------------
-- get_func_def
--
--------------------------------------------------------------------------------
function MouseHoverCallTips:get_func_def(line, word, style)
    local var = string.gsub(line, " (", '(', 1)

    local position = self:find_instance(var, '(')

    if (position ~= 0) then
        local func_name = string.sub(var, 1, position - 1)

        if (style == 14) then func_name = string.gsub(func_name, "_AutoItObject_", '') end

        func_name = string.lower(func_name)

        word = string.lower(word)

        if (func_name == word) then return string.gsub(line, "%)(.)", "%)n%1") end -- changed: was adding a trailing empty line in some cases.
    end

    return nil
end

--------------------------------------------------------------------------------
-- get_function_calltip
--
--------------------------------------------------------------------------------
function MouseHoverCallTips:get_function_calltip(directory, style, word)
    local function_calltip = nil

    local file = io.open(directory, 'r')
    if file ~= nil then
        for line in file:lines() do
            -- filter out constants
            if (style == 4) then
                local string_end = string.sub(line, -2)

                for i = 1, 4 do
                    if (string_end == '?' .. i) then break end
                end
            end

            function_calltip = self:get_func_def(line, word, style)

            if (function_calltip ~= nil) then break end
        end

        file:close()
    end

    return function_calltip
end

--------------------------------------------------------------------------------
-- OnDwellStart
--
--------------------------------------------------------------------------------
function MouseHoverCallTips:OnDwellStart(position, word)
    if (word == "") then
        if (scite.SendEditor(SCI_CALLTIPACTIVE)) then scite.SendEditor(SCI_CALLTIPCANCEL) end
        return true
    end

    local style = scite.SendEditor(SCI_GETSTYLEAT, position)

    if (style == 4 or style == 14 or style == 15) then
        local directories = props["api.$(au3)"]

        if (directories ~= nil) then
            self:DebugPrint("API files: " .. directories)
            for directory in directories:gmatch("([^;rn]+)") do
                self:DebugPrint("Searching API file: " .. directory)
                local function_calltip = self:get_function_calltip(directory, style, word)
                if (function_calltip ~= nil) then
                    self:DebugPrint("Found calltip in API file: " .. directory)
                    scite.SendEditor(SCI_CALLTIPSHOW, position, function_calltip)
                    break
                end
            end
        else
            self:DebugPrint("The api.$(au3) is missing or empty.")
        end
    else
        self:DebugPrint("Unsupported style detected.")
    end
    return true
end

[jaberwacky]

OK peoples. I'm very excited to bring you the latest update which I've been putting off forever. See the Updates spoiler in the OP for more details!

[trancexx]

Cool! Thank you.

I would just like to point that this will be valid syntax soon:

Func SomeFunc(vParam = 3)
    Local SomeFunc = "StringVal"
    ConsoleWrite(VarGetType(SomeFunc) & " " & SomeFunc & @CRLF)
EndFunc

SomeFunc()

I guess it would be too much/impossible to process that correctly. Right?

Edited September 23, 2012 by trancexx

[jaberwacky]

As long as the au3 lexer can keep them separated and assign to them two different styles.

Mmm, so it will be possible to use the same variable name and the same function name and not get them all confused?

Edited September 23, 2012 by LaCastiglione

[trancexx]

Yeah baby, dog's bollocks!

[czardas]

Yeah baby, it's the dog's bollocks!

[trancexx]

Yeah baby, it's the dog's bollocks!

...I'm sure people using dog's bollocks would mind.

[czardas]

I never heard of the mutt's nuts being used without the the. muttley

[FaridAgl]

Good job, a really really really god job.

I know it's not your duty to do what others say, but I have a feature request that may be even impossible, but worth hearing!

For me, I usually keep my functions in a separated file, Functions.au3 for example and include it in the main file of the project, Main.au3 for example.

Would be nice if hovering the mouse cursor on the functions call in the Main.au3, shows its call tips (Functions that has been declared in Functions.au3).

Hope you understand me

Edited September 24, 2012 by D4RKON3

[trancexx]

I never heard of the mutt's nuts being used without the the. muttley

Our chitchat reminded me of Sandra Bullock + Stallone film Demolition Man or something, when she says "Let's blow this guy!", and Stallone says "...away! Dammit away!"

So, don't make me blow you.

[czardas]

blow your mind

You always blow my mind anyway (in a nice way).

I meant that as a compliment.

@LaCastiglione I like your idea BTW.

Edited September 24, 2012 by czardas

[jaberwacky]

Good job, a really really really god job.

I know it's not your duty to do what others say, but I have a feature request that may be even impossible, but worth hearing!

For me, I usually keep my functions in a separated file, Functions.au3 for example and include it in the main file of the project, Main.au3 for example.

Would be nice if hovering the mouse cursor on the functions call in the Main.au3, shows its call tips (Functions that has been declared in Functions.au3).

Hope you understand me

As long as you dont' mind waiting four to six months before I decide to get around to it. =P Kidding. I'm already thinking of a simple method.

@LaCastiglione I like your idea BTW.

Well, thank ye kindly. (It wasn't my idea)

Edited September 24, 2012 by LaCastiglione

[MvGulik]

I personal would ditch the " -- changed: was adding a trailing empty line in some cases." comment. As the related context is long gone (the org code that was changes). Or/and: It was only intended as temporary additional modification background/reason.

---

czardas:

... Twilight zone ... (can be anything, including real stuff)

Edited September 24, 2012 by MvGulik

[czardas]

czardas:

... Twilight zone ... (can be anything, including real stuff)

I thought the distinction was important in this case, with there being a fine line between something really good and something really crude, otherwise I would have kept it zipped. Anyway, enough digression from me.

I love the original series.

Edited September 24, 2012 by czardas

[jaberwacky]

Here is a basic attempt at the feature requested by D4RKON3. See 'Updates' spoiler in OP for more details.

[FaridAgl]

Impressive.

Working fine for me as long as the file we are working on includes the other file directly.

[jaberwacky]

Latest Update!

Now all of the includes file of a project are searched for user defined functions! Also see update from 10/01/2012 for additional updates.

[FaridAgl]

Sounds good, going to try it now.

Edit: You know, that's amazing, specially the comment part ( ; ) after the function.

Good job, keep it up.

Edited October 8, 2012 by D4RKON3

[jaberwacky]

Sounds good, going to try it now.

Edit: You know, that's amazing, specially the comment part ( ; ) after the function.

Good job, keep it up.

Why thank ye kin'ly. =)