Hi,

I have been having some internal dialogue about folding:

Wantit: I want text folding in my editor.

Me: Why?

Wantit: I want to collapse sections and show the structure of my code.

Me: Why?

Wantit: I want to see more on one screen - just the "highlights".

Me: Why?

Wantit: I want to have an overview and navigate quickly between the important parts.

Me: So you want to pick some lines which are important, scroll over code to see the highlights,
and quickly navigate to the selected area?

Wantit: Yes.

Me: Well how about a filter to select useful lines,
with a fuzzy finder interface to select and navigate to the chosen line?

Wantit: What, like folding without a mouse?

Me: Precisely.

Wantit: How will I define important lines to display?

Me: Well, regular expressions are very capable at finding matches.

Wantit: But REs are an enormous PIA at the command line!

Me: We could use "awk -f " and store all the REs in a file,
perhaps one for each filetype in the syntax folder.
AWK can also easily prepend the line number for navigation:

    # Lua.awk
    # default RS (newline) and FS (space) work well here
    # prepend NR (record number) which is the line number.
    # Select all lines beginning with "--" or "function", or lines containing "TODO"
    /^function/ || /^--/ || /TODO/ {print(NR,$0)}

Wantit: Neat

So I have a function which uses cmd.exe, awk.exe and fzf.exe to achieve pseudo-folding:

function fzffoldgoto(Current)
-- Goto fold markers, defined as AWK scripts by file type
    -- Requires fzf.exe in your path (https://github.com/junegunn/fzf/releases)
    -- Requires awk.exe in your path (https://gnuwin32.sourceforge.net/packages/gawk.htm)

    -- Get filename (NB fzf needs unix paths)
    local filename = Current.Buf.AbsPath:gsub([[\]],[[/]])

    -- Check for file type
    local filetype = Current.Buf:FileType()
    if filetype=="batch" then filetype="bat" end
    if filetype=="markdown" then filetype="md" end
    if filetype=="unknown" then
        -- Check for txt which are reported as unknown
        local mypath, myfile, myext = string.match(Current.Buf.AbsPath, "(.-)([^\\]-([^%.]+))$")
        if myext=="txt" then
            filetype="txt"
        else
            return
        end
    end

    -- Locate AWK script for filetype
    local target = config.ConfigDir..[[/syntax/]]..filetype..[[.awk]]
    if not io.exists(target) then return end

    -- Run fzf (NB fails if no history file)
    local options = "--prompt='> goto ' --color prompt:110 "
    options = options.."--color='dark' "
    options = options.."--no-sort --tac "
    options = options.." --history='"..config.ConfigDir.."/history/find.fzf' "
    local command = 'cmd.exe /c awk.exe -f '..target..' '..filename..' | fzf.exe '..options
    local sel = fzf(command)

    -- Check return value
    if not sel or sel=="" then return end

    -- Extract line number (i.e. First match) and goto
    local linenumber = sel:match("%d+")
    editor.Goto(Current,linenumber)
end

-- Dependencies
local osutil        = import("os")
local shell         = import("micro/shell")

function io.exists(filename)
-- See if a file exists
    -- Check it's a string
    if type(filename)~="string" then return false end

    -- Check for unacceptable characters
    if filename:match("[\n<|>$]") then return false end

    -- Convert to unix directory separators - for Go
    filename = filename:gsub([[/]],[[\]])

    local fileinfo, err = osutil.Stat(filename)
    if osutil.IsNotExist(err) then
        return false
    else
        return true
    end
end


function fzf(command)
-- Run fzf with title set to "fzf" - to allow autohotkey rebindings
    shell.RunCommand('cmd.exe /c title fzf')
    -- https://pkg.go.dev/github.com/zyedidia/micro/v2/internal/shell#RunInteractiveShell
    -- wait=false, getOutput=true
    local sel, err = shell.RunInteractiveShell(command, false, true)
    shell.RunCommand('cmd.exe /c title micro.exe')
    return sel
end

-- Make a Lua table for all my generic functions
editor = {}

function editor.Goto(Current,linenumber)
-- Focus and scroll to a specific line
    if linenumber and tonumber(linenumber)>0 then
        Current:GotoCmd({linenumber})
        return true
    else
        return false
    end
end

Applying the pseudofolding to this code:

Kind Regards Gavin Holt

Feature request: Add support for code folding #618

Description

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions