Skip to content

overview.md

Latest commit

 

History

History
128 lines (92 loc) · 3.26 KB

overview.md

File metadata and controls

128 lines (92 loc) · 3.26 KB
Raw

Overview and conventions

The Lua side of Hollow is one global: hollow. Every feature is reached through a dotted path under it.

The global

local hollow = require("hollow")

require("hollow") is provided by the host; it returns the same global that is also assigned to _G.hollow. Modules under src/lua/hollow/ are loaded on demand.

Patterns

Namespaces are dotted paths

Every public function lives at hollow.<namespace>.<verb>(...). There are no positional arguments; everything is an opts table.

hollow.config.set({ fonts = { size = 16 } })
hollow.term.split_pane({ direction = "vertical", ratio = 0.4 })
hollow.ui.notify.info("saved", { ttl = 1500 })

Snapshots are read-only

hollow.term.current_tab(), hollow.term.tabs(), and hollow.term.current_pane() return snapshots. Mutate state through the verb functions (set_title, split_pane, set_pane_tags, ...); never write to fields on a snapshot.

Async results

split_pane, new_tab, and new_workspace accept an on_complete callback that fires on the next frame. Successful results include the created id (pane_id, tab_id, workspace_index); every result has a success boolean.

hollow.term.split_pane({
  direction = "vertical",
  on_complete = function(result)
    if result.success then
      hollow.term.set_pane_tags({ "editor" }, result.pane_id)
    end
  end,
})

For sequential flows, use hollow.async.

Events

hollow.events.on(name, handler) subscribes; the handler is called on the host thread with a payload table. Built-in events cannot be emitted from Lua. See hollow.events.

Log and inspect

hollow.log("starting up", some_value)
hollow.inspect({ a = 1, b = 2 })

hollow.log writes to the host log. On Windows, this is %APPDATA%\hollow\hollow.log; on Linux, it is $XDG_DATA_HOME/hollow/hollow.log or $HOME/.local/share/hollow/hollow.log. hollow.inspect returns a pretty-printed string.

Filesystem helpers

local entries = hollow.read_dir("/path/to/dir")

hollow.read_dir(path) returns an array of absolute entry paths. For more, use the hollow.fs namespace.

Date and time

local s = hollow.strftime("%H:%M:%S")

hollow.strftime(fmt) formats the current time using the host's strftime. Widgets also receive ctx.time.epoch_ms and ctx.time.iso in their render context.

Scheduling

hollow.schedule(function()
  -- runs on the next frame
end)

hollow.defer(function()
  -- runs on the next frame (no delay)
end, 1500)
-- or with a 1500ms delay

hollow.on_gui_ready(function()
  -- runs once the GUI is up
end)

schedule and defer are one-shot; the callback is cleaned up after execution.

Modal keymaps

Keymaps live in a mode. The default mode is "normal"; the runtime also ships "copy_mode". Bind to a specific mode with { mode = "..." }. See hollow.keymap.

Errors

hollow.util.unsupported(name) raises a controlled error for features that exist in the API shape but are not implemented in this build.

See also