New SciTE4AutoIt3 available with SciTE v1.79

[wraithdu]

SciTE can highlight all occurrences of the current word or selected text. Here is an example of the settings I now have set:

Nice, I like that one from Notepad++. Any way to make it act like N++, where it only highlights if you select the word? Now it highlights all the time even if you just place the cursor somewhere. Edited June 15, 2011 by wraithdu

[Mat]

AutoIt Menu does a nice job of this.

But thats for firefox. I have no doubt that it does but I was using that as an example of when I would use such functionality. I also may want to test an idea or prove a theory.

[Valik]

Mat, is there some reason you need to keep multiple files? Why not keep a single file, paste the contents into that file and run it. That is what I do although I'm sure I run far less code than you since I tend not to run code from the forum.

[Mat]

Mat, is there some reason you need to keep multiple files? Why not keep a single file, paste the contents into that file and run it. That is what I do although I'm sure I run far less code than you since I tend not to run code from the forum.

Where possible I do use the same file, but sometimes it's not really possible. TBH I've got used to it. I have an AutoIt script that creates the next file and opens it in SciTE, but I seem to remember PSPad had something where they would save as temp files... IIRC they even let you run just the selected text which was interesting.

[BrewManNH]

Something I found in the new SciTE version that I really like is the file preview when you open a file inside SciTE. I don't know if it had this in the previous version, but it never showed before if it did. It's very cool if you have ambiguous names of some test files, like I do, lets you make sure you're opening the right one before actually opening it.

[Valik]

Something I found in the new SciTE version that I really like is the file preview when you open a file inside SciTE. I don't know if it had this in the previous version, but it never showed before if it did. It's very cool if you have ambiguous names of some test files, like I do, lets you make sure you're opening the right one before actually opening it.

The Preview Pane is a feature of Windows Explorer and is available for every application. See the ? icon on the right below the search bar? See the icon directly to the left of that? Yeah, that toggles the Preview pane on/off. It works for the standard dialogs other applications use as well as for Explorer itself. It has nothing to do with SciTE.

[BrewManNH]

The Preview Pane is a feature of Windows Explorer and is available for every application. See the ? icon on the right below the search bar? See the icon directly to the left of that? Yeah, that toggles the Preview pane on/off. It works for the standard dialogs other applications use as well as for Explorer itself. It has nothing to do with SciTE.

Interesting, I never played around with that button before, and it's not showing in the normal Windows Explorer that way. I wonder why it shows the preview pane by default in SciTE even though I'm not using it in Windows?

[MvGulik]

So everybody is still happy with this new version of SciTE?

Mmm. well, sins you asked.

The potential flickering from the "document closing and reopening" part when using, for example, [Tidy AutoIt Source] seems to got worse. (never really noted it until changing to 2.26(scite4autoit3 beta).)

- seems directly related to the position of the edit-screen in swapping document. (lower down, scite taking longer to display the new document, ergo: temporary showing a other open document longer. (having documents open with different backgrounds(style) makes it of course also harder to digest/ignore.)

[wraithdu]

As much as I love the word highlight feature in Scintilla, SciTE's implementation bugs the hell outta me. It should be more like Notepad++ where you have to highlight a whole word before it kicks in, instead of highlighting ALL THE TIME. But I digress. Here's a quickie LUA function to toggle on the fly. Stick it in the Tools.lua file.

function Tools:toggleWordHighlight()
    if props['highlight.current.word'] == '' or props['highlight.current.word'] == '0' then
        props['highlight.current.word'] = '1'
    else
        props['highlight.current.word'] = '0'
    end
end

And the shortcut:

# 38 Toggle word highlight
command.name.38.$(au3)=Toggle Word Highlight
command.mode.38.$(au3)=subsystem:lua,savebefore:no
command.38.$(au3)=InvokeTool Tools.toggleWordHighlight
command.shortcut.38.$(au3)=Alt+H

Edited June 21, 2011 by wraithdu

[Valik]

You could use the OnUpdateUI() event to poll the current selection and if there is a single-word selection then programatticaly toggle the property. Alternatively you may be able to use OnDwellStart() to turn it on only when actually hovering over a word. I too don't exactly like how it works so I may see about trying OnDwellStart() toggling or something.

[wraithdu]

I feel like I'm really close, but the highlighting is not appearing. The property is set correctly however. Any idea what I'm missing?

It's worth noting that even with the hotkey toggle I posted above, if an entire word is selected, then highlighting is toggled, nothing happens until the caret moves again. I've tried some tricks with CurrentPos, SetSel, etc with no luck.

expandcollapse popup

MyTools = EventClass:new(Common)

function MyTools:OnUpdateUI()
    local selStart = editor.SelectionStart
    local selEnd = editor.SelectionEnd
    -- check no spaces in selection
    local selText = editor:GetSelText()
    local spcIndex = string.find(selText, ' ')
    if selStart ~= selEnd and spcIndex == nil then
        -- check if selected whole word
        if self:IsWordBoundry(editor.CharAt[selStart-1]) and self:IsWordBoundry(editor.CharAt[selEnd]) then
            if props['highlight.current.word'] ~= '1' then
                props['highlight.current.word'] = '1'
            end
        else
            if props['highlight.current.word'] ~= '0' then
                props['highlight.current.word'] = '0'
            end
        end
    else
        if props['highlight.current.word'] ~= '0' then
            props['highlight.current.word'] = '0'
        end
    end
    
    return false
end

function MyTools:IsWordBoundry(char)
    local strChar = string.char(char)
    local beginIndex = string.find(strChar, '%w')
    if beginIndex == nil and strChar ~= '_' and strChar ~= '$' and strChar ~= '#' then
        return true
    end
    
    return false
end

[wraithdu]

This however, works great. I can't take all the credit as I found a sample script for marking stuff, then adapted it.

*snip*

One question though. The SciTE docs here: http://www.scintilla.org/ScintillaDoc.html#Indicators say indicators 0-7 are reserved for lexers. Does AutoIt's lexer use any of these indicators? My function above just uses indicator 0, but I'm not sure if that is safe.

Edited June 23, 2011 by wraithdu

[wraithdu]

Based on my above class, can I do this to create a new class property? I want a private variable that only my class can access.

MyTools = EventClass:new(Common)
MyTools.myPrivateVar = 'private'

function MyTools:foo()
    -- not sure this is correct, since self.myPrivateVar does not work here
    print(MyTools.myPrivateVar)
end

Edited June 22, 2011 by wraithdu

[Valik]

Well, if by private you really mean "member" then yes, that is correct. Lua doesn't have access control. I'm not sure why self.myPrivateVar won't work unless you are calling foo() before myPrivateVar is initialized. I just tested the following code and it works correctly:

MyTools = EventClass:new(Common)
MyTools.myPrivateVar = 'private'

function MyTools:foo()
    -- not sure this is correct, since self.myPrivateVar does not work here
    print(self.myPrivateVar)
end

MyTools:foo()

Unless you really need to create myPrivateVar outside the class (for example, if another class is going to access it) then you should really use this code:

MyTools = EventClass:new(Common)

function MyTools:OnStartup()
    self.myPrivateVar = 'private'
    print(self.myPrivateVar)
end

onstartup() is called whenever EventClass:BeginEvents() is invoked which should be the last thing that appears in SciTEStartup.lua. It is guaranteed to be called before any other events fire. Placing member declarations at global scope as you have done is only required if that member may be accessed before EventClass:BeginEvents() is invoked which generally only happens in very rare cases.

Edit: The other reason self.myPrivateVar would fail is if you used dot syntax to invoke foo() instead of colon syntax. There is a difference. The dot syntax does not pass the object as the first parameter, the colon syntax secretly passes the object as the parameter named self. In order to access self you must use colon notation.

Edited June 22, 2011 by Valik

[wraithdu]

Awesome. I like the onstartup method better... and I found my syntax error with period versus colon - I had one call where I mistakenly used a period. Here's the updated functions to get highlighting just like Notepad++

expandcollapse popup

MyTools = EventClass:new(Common)

function MyTools:OnStartup()
    -- class property to hold active marker state so we only update when necessary
    self.bMarkersActive = false
    -- initialize missing prop
    if props['highlight.sel.text'] == '' then
        props['highlight.sel.text'] = '1'
    end
end

function MyTools:OnUpdateUI()
    if props['highlight.sel.text'] == '1' then
        local selStart = editor.SelectionStart
        local selEnd = editor.SelectionEnd
        local selText = editor:GetSelText()
        -- check if selected text is an allowed word
        if selStart ~= selEnd and self:IsWord(selText) then
            -- check for word boundaries at ends of selection
            if not self:IsWord(string.char(editor.CharAt[selStart-1])) and not self:IsWord(string.char(editor.CharAt[selEnd])) then
                self:markOccurrences(selText)
            else
                self:clearOccurrences()
            end
        else
            self:clearOccurrences()
        end
    end

    return false
end

function MyTools:IsWord(word)
    -- look for anything not allowed
    local find = string.find(word, '[^%a%d_$#@.]')
    if find == nil then
        return true
    else
        return false
    end
end

function MyTools:clearOccurrences()
    if self.bMarkersActive then
        self.bMarkersActive = false
        scite.SendEditor(SCI_INDICATORCLEARRANGE, 0, editor.Length)
    end
end

function MyTools:markOccurrences(selText)
    if not self.bMarkersActive then
        -- self:clearOccurrences()
        -- set flag markers are active
        self.bMarkersActive = true
        -- set indicator style
        local curIndic = 0
        scite.SendEditor(SCI_SETINDICATORCURRENT, curIndic)
        scite.SendEditor(SCI_INDICSETALPHA, curIndic, 255)
        scite.SendEditor(SCI_INDICSETUNDER, curIndic, true)
        scite.SendEditor(SCI_INDICSETSTYLE, curIndic, INDIC_ROUNDBOX)
        scite.SendEditor(SCI_INDICSETFORE, curIndic, 0xFFF55D)
        -- find each occurrence of the word and set the indicator range
        local flags = SCFIND_WHOLEWORD
        local s,e = editor:findtext(selText, flags, 0)
        while s do
            scite.SendEditor(SCI_INDICATORFILLRANGE, s, e - s)
            s,e = editor:findtext(selText, flags, e+1)
        end
    end
end

My other question about the indicator values... is 0 safe to use in this script? Or does the AutoIt lexer use some of them?

Edit-

Updated code to allow disabling highlighting with prop:

highlight.sel.text=0

Edited June 23, 2011 by wraithdu

[Mat]

Just out of interest Wraithdu, how are you working on this? Are you making changes and restarting SciTE to test or developing in Lua and somehow testing it that way?

[wraithdu]

Heh, the shitty way. Writing LUA (poorly) in Notepad++ and restarting SciTE to test.

[Valik]

*cough* Read SciTE documentation *cough*

ext.lua.auto.reload=1
ext.lua.reset=1

[wraithdu]

Nice I like that those options can be changed on the fly.

[Jos]

Uploaded a Beta version of SciTE v 2.27 with our modification is it here for those who would like to give that a try.

Just copy the 3 files to your SciTE directory.

The 2 HTML files contain the updated Docs and History so you can see the changes made to SciTE since the latest v1.79 and v2.26 Beta we currently use.

Jos

Edited June 23, 2011 by Jos