SciTE shortcut to jump to the beginning of a function

[Imbuter2000]

Is there in SciTE a keyboard shortcut for jumping to the beginning of the function the cursor is in?

I feel many times the need of it.... having many and long functions...

[BrewManNH]

SciteJump should be able to help with that.

[guinness]

As BrewManNH said, SciTE Jump. Hit Ctrl + J in SciTE if you're using SciTE4AutoIt3 and look in my signature for the latest version.

[Jos]

The way I read the question is that the OP is somewhere working in the FUNC-ENDFUNC itself and want to jump to the first line of the FUNC.

Ctrl-J works out of the box when you have the full version of SciTE loaded, and jump from a Function reference to the FUNC Definition.

Jos

[Imbuter2000]

The way I read the question is that the OP is somewhere working in the FUNC-ENDFUNC itself and want to jump to the first line of the FUNC.

Yes Jos correctly understood my different question: I would a shortcut that when my cursor is somewhere inside FUNC-ENDFUNC jumps to the FUNC line.

Ctrl+J doesn't do this and neither do SciTE jump

[Jos]

Ctrl+J doesn't do this and neither do SciTE jump

Correct, as I stated, that jumps from a Func Refference to the FUNC definition.

There is no buildin way to jump to the top of the FUNC you are working in.

I am sure it is possible but can't see the general use of it to build this in via a LUA script option.

Jos

[jdelaney]

How large a function is this? Maybe it would be better to have the function built with other function calls, to keep it from growing too large.

[Imbuter2000]

Correct, as I stated, that jumps from a Func Refference to the FUNC definition.

There is no buildin way to jump to the top of the FUNC you are working in.

I am sure it is possible but can't see the general use of it to build this in via a LUA script option.

Jos

I'ld like it mainly for two uses:

- when I want to add local or global variables at the beginning of the current function

- when I want to (fastly) read the function from the beginning of it for remind

[Jos]

This is a lua func that should be close to what you want. It uses Ctrl+u to jump up to FUNC and also uses Ctrl+Shift+J to Jump back.

Add this to sciteuser.properties:

# 35 Jump up to Func def
command.name.35.$(au3)=Jump up to Func begin
command.mode.35.$(au3)=subsystem:lua,savebefore:yes
command.shortcut.35.$(au3)=Ctrl+u
command.35.$(au3)=InvokeTool AutoItGotoDefinition.GobacktoDefinition

Add this to file AutoItGotoDefinition.lua

expandcollapse popup

--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- GobacktoDefinition()
--
-- Jumps up to a function definition.
--
-- Tool: AutoItGotoDefinition.GobacktoDefinition $(au3) savebefore:yes Ctrl+u Goto Definition
--------------------------------------------------------------------------------
function AutoItGotoDefinition:GobacktoDefinition()
    -- Get current pos
    local Pos_Carret = editor.CurrentPos
    -- get current text
    local text = editor:GetText()
    -- Force to lower case
    text = text:lower()
    local Next_Pos_Func = 0
    local Next_Pos_EndFunc = 0
    local Pos_Func = 0
    local Pos_EndFunc = 0
    -- Look for the Func definition above current line and find belonging EndFunc.
    repeat
        Pos_Func = Next_Pos_Func
        Pos_EndFunc = Next_Pos_EndFunc
        Next_Pos_Func = text:find("func .*%(", Pos_Func + 1)
        if Next_Pos_Func ~= nil then
           Next_Pos_EndFunc = text:find("endfunc", Next_Pos_Func + 1)
        end
    until Next_Pos_Func == nil or Next_Pos_Func > Pos_Carret
    --
    if Pos_Func == nil then Pos_Func = 0 end
    if Pos_EndFunc == nil then Pos_EndFunc = 0 end
    -- Check if we found a Func definition above the Carret and an EndFunc below the carret to ensure we are inside an Func.
    -- set up a marker and go to the function.
    if Pos_Func ~= 0 and Pos_Func < Pos_Carret and Pos_EndFunc > Pos_Carret then
        -- save current location
        if props['SciteLastJumpFromFile'] == nil or props['SciteLastJumpFromFile'] == "" then
            props['SciteLastJumpFromFile'] = string.gsub(props["FilePath"],"\\","\\\\") .. "|"
            props['SciteLastJumpFromPos'] = editor.CurrentPos .. "|"
        else
            props['SciteLastJumpFromFile'] = string.gsub(props["FilePath"],"\\","\\\\") .. "|" .. props['SciteLastJumpFromFile']
            props['SciteLastJumpFromPos'] = editor.CurrentPos .. "|" .. props['SciteLastJumpFromPos']
        end
        editor:EnsureVisible(editor:LineFromPosition(Pos_Func))
        editor:GotoLine(editor:LineFromPosition(Pos_Func))
    end
end    -- GobacktoDefinition()

Enjoy,

Jos

Edited December 26, 2012 by Jos

[Imbuter2000]

This is a lua func that should be close to what you want. It uses Ctrl+u to jump up to FUNC and also uses Ctrl+Shift+J to Jump back.

Add this to sciteuser.properties:

# 35 Jump up to Func def
command.name.35.$(au3)=Jump up to Func begin
command.mode.35.$(au3)=subsystem:lua,savebefore:yes
command.shortcut.35.$(au3)=Ctrl+u
command.35.$(au3)=InvokeTool AutoItGotoDefinition.GobacktoDefinition

Add this to file AutoItGotoDefinition.lua

--------------------------------------------------------------------------------
-- GobacktoDefinition()
--
-- Jumps up to a function definition.
--
-- Tool: AutoItGotoDefinition.GobacktoDefinition $(au3) savebefore:yes Ctrl+u Goto Definition
--------------------------------------------------------------------------------
function AutoItGotoDefinition:GobacktoDefinition()
    -- Get current pos
    local cpos = editor.CurrentPos
    -- get current text
    local text = editor:GetText()
    -- Force to lower case
    text = text:lower()
    local pos = 0
    local lpos = 0
    -- Look for the function definition above current line.
    repeat
        lpos = pos
        pos = text:find("func .*%(", pos + 1)
    until pos == nil or pos > cpos
    -- We found a function definition, set up a marker and go to the function.
    if lpos ~= nil and lpos ~= 0 and lpos < pos then
        -- save current location
        if props['SciteLastJumpFromFile'] == nil or props['SciteLastJumpFromFile'] == "" then
            props['SciteLastJumpFromFile'] = string.gsub(props["FilePath"],"","") .. "|"
            props['SciteLastJumpFromPos'] = editor.CurrentPos .. "|"
        else
            props['SciteLastJumpFromFile'] = string.gsub(props["FilePath"],"","") .. "|" .. props['SciteLastJumpFromFile']
            props['SciteLastJumpFromPos'] = editor.CurrentPos .. "|" .. props['SciteLastJumpFromPos']
        end
        editor:EnsureVisible(editor:LineFromPosition(lpos))
        editor:GotoLine(editor:LineFromPosition(lpos))
    end
end -- GobacktoDefinition()

Enjoy,

Jos

WOW!

There's only a problem: after I added and saved those pieces of codes to the two files, I restarted SciTE and tried the keyboard shortcuts and nothing happened

[Jos]

WOW!

There's only a problem: after I added and saved those pieces of codes to the two files, I restarted SciTE and tried the keyboard shortcuts and nothing happened

Works for me, tried in on a clean install of SciTE4AutoIt3.

It doesn't do anything when there is no FUNC above the caret, else it will go to the first FUNC up.

[JohnOne]

I tried it, perhaps I did something wrong but I get this error output...

...ram FilesAutoIt3SciTELuaAutoItGotoDefinition.lua:328: attempt to compare number with nil

>Lua: error occurred while processing command

EDIT:

Line is in the new definition...

if lpos ~= nil and lpos ~= 0 and lpos < pos then

Edited December 7, 2012 by JohnOne

[Jos]

if lpos ~= nil and lpos ~= 0 and lpos < pos then

Yeap ... that statement is wrong and should be:

if lpos ~= nil and lpos ~= 0 and lpos < cpos then

Let me know if that solves it.

Jos

Edited December 7, 2012 by Jos

[JohnOne]

That fixes it.

[Imbuter2000]

Works for me, tried in on a clean install of SciTE4AutoIt3.

It doesn't do anything when there is no FUNC above the caret, else it will go to the first FUNC up.

ah, damn, I tried it while inside a function of your file AutoItGotoDefinition.lua without notifing that it's not an AutoIT code! the function code there starts with "function" instead than "func".

On AutoIT code it works! )) thanks!!!

Edited December 9, 2012 by Imbuter2000

[Jos]

Sweet,

I will leave the code in the production LUA file but probably won't add the shortcut to au3.properties unless there is a greater demand for it.

Jos

[Imbuter2000]

Update about my main uses of these shortcuts:

- when I want to add local or global variables at the beginning of the current function

- when I want to check or modify the parameters passed to the current function

- when I want to read again the function from the beginning of it for remind

[Melba23]

Imbuter2000,

Just an aside on that list - declaring Global variables within a function should be avoided. Although the code will still run, AU3Check will give you a warning as it is considered bad coding practice - Global variables should really be declared at the top of the script.

M23

[Imbuter2000]

There's a little bug/lack in the ctrl+U function:

when you use it while your cursor is out of any function it jumps to the first previous "func" (if any), despite the fact that your cursor is not inside it.

I know that it's not usually recommended to have (non function) code after a function but I would expect it to jump to the absolute beginning of the code in that case. Jumping to the first previous "func" made my (wrongly) believe that cursor was inside that function...

Edited December 11, 2012 by Imbuter2000

[Melba23]

Imbuter2000,

Perhaps reorder your script so that there is no code after the final function. You are quite correct that it is not recommended - so why do it?

M23