dk.salza.liq.editor — mogenslund/liquid 1.0.0

The editor is the central point of Liquid. Most of the data is immutable, but the editor has a ref, also called editor. It contains the state of the editor.

Most actions on the editor will replace content of this state with a transformed content.

For example:

When (forward-char 1) is called, the current buffer will be replaced with a new buffer, where the cursor is moved one char ahead.

add-command clj

(add-command fun)

Add a command to be availble for commandapp typeahead. add-interactive is in most cases more suitable.

add-file clj

(add-file f)

Add a single file to be availalbe through typeahead from the commandapp. When chosen the file will be opened. EXAMPLE: (editor/add-file "/home/mogens/.liq")

add-interactive clj

(add-interactive label fun & arglabels)

Add an interactive function. The label will be shown in typeahead. The user will be prompted to provide and input for each of the lables in arglabels. The function will be called with the input values as arguments.

add-rootfolder clj

(add-rootfolder s)

Add a folder to rootfolders. When using find file app, the rootfolders can be directly accessed through typeahead. EXAMPLE: (editor/add-rootfolder "/tmp")

add-searchpath clj

(add-searchpath s)

Add a folder to searchpaths. When using the commandapp files below folders in the searchpath will be available through typeahead. EXAMPLE: (editor/add-searchpath "/tmp")

add-snippet clj

(add-snippet s)

Add a snippet to list of snippets. They will be available through typeahead from the commandapp. When chosen the snippet text will be inserted. EXAMPLE: (editor/add-snippet "(ns user)")

add-to-setting clj

(add-to-setting keyw entry)

When a setting with a given key is a list, items can be added to that list using this function.

add-window clj

(add-window window)

(add-window name top left rows columns buffername)

Add a window to the editor. It takes as input a window created using dk.salza.liq.window/create function.

apply-to-slider clj

(apply-to-slider fun)

Apply function to the slider in the current buffer. It should take a slider as input and produce a slider as output.

backward-char clj

(backward-char)

(backward-char amount)

Moves the cursor backward the given amount, or 1 step, if no arguments are given.

backward-line clj

(backward-line)

Moves cursor backward one line in the current active buffer.

backward-word clj

(backward-word)

Moves the cursor to the beginning of the previous word.

beginning-of-buffer clj

(beginning-of-buffer)

Moves the cursor to the beginning of the buffer.

beginning-of-line clj

(beginning-of-line)

Moves the cursor to the beginning of the current line.

buffer-names clj

(buffer-names)

The names of the buffers as a list

changed-on-disk? clj

(changed-on-disk?)

If the current buffer is from a file, it returns if the file has changed on the disk, maybe by another program.

clear clj

(clear)

Clears the whole buffer.

context-action clj

(context-action)

copy-context clj

(copy-context)

Send the context to the clipboard. The context could be a filename, a function, an url depending on how the context is resolved.

copy-file clj

(copy-file)

If the current buffer is connected to a file, the filename is send to the clipboard.

copy-line clj

(copy-line)

Sends the current line to the clipboard.

copy-selection clj

(copy-selection)

If there is a selection, the selected text will be send to clipboard.

create-buffer-from-file clj

(create-buffer-from-file filepath)

Creates a new buffer, connects it to the given filepath and loads the content into the buffer.

current-buffer clj

(current-buffer)

Returns the current active buffer. Since buffers are immutable, this will be a copy of the actual buffer.

current-window clj

(current-window)

Get the current active window. Mostly used to get the dimensions for the related buffer.

delete clj

(delete)

(delete amount)

Deletes given amount of characters backwards. If no amount is supplied just one character will be deleted.

delete-char clj

(delete-char)

Deletes the character after the cursor.

delete-line clj

(delete-line)

Deletes the current line.

delete-selection clj

(delete-selection)

If there is a selection, the selected content will be deleted.

delete-window clj

(delete-window)

dirty-buffers clj

(dirty-buffers)

The names of the dirty buffers as a list.

dirty? clj

(dirty?)

Returns weather current buffer is dirty.

drop-tmp-keymap clj

(drop-tmp-keymap)

Drop the current temporary keymap.

editor clj

The ref which contains the editor data, that is

• List of buffers
• List of windows
• Global keymap
• Map of functions to evaluate different filetypes
• Settings with searchpaths, searchfiles, snippets, commands and interactive commands for typeahead.

Most functions in the editor namespace manipulates this ref.

end-of-buffer clj

(end-of-buffer)

Moved the cursor to the end of the buffer.

end-of-buffer? clj

(end-of-buffer?)

Returns true of the current point is the end of the current buffer.

end-of-line clj

(end-of-line)

Moves the cursor to the end of the current line. The next hard line break.

end-of-word clj

(end-of-word)

Moves the cursor to the end of the current word.

enlarge-window-below clj

(enlarge-window-below amount)

enlarge-window-right clj

(enlarge-window-right amount)

escape clj

(escape)

eval-last-sexp clj

(eval-last-sexp)

Evaluate the current s-expression.

eval-safe clj

(eval-safe fun)

Evaluate a function, catching errors if thrown.

eval-sexp clj

(eval-sexp sexp)

Evaluate the given s-expression in the current namespace.

evaluate-file clj

(evaluate-file)

(evaluate-file filepath)

Evaluate the given file. How evaluation is done depends on the file type.

evaluate-file-raw clj

(evaluate-file-raw)

(evaluate-file-raw filepath)

Evaluate a given file raw, without using with-out-str or other injected functionality. If no filepath is supplied the path connected to the current buffer will be used.

find-file clj

(find-file filepath)

Opens the file with the given name with the default app.

find-next clj

(find-next)

(find-next search)

force-quit clj

(force-quit)

force-reopen-file clj

(force-reopen-file)

Reopening file in buffer, ignore dirty flag.

forward-char clj

(forward-char)

(forward-char amount)

Moves the cursor forward the given amount, or 1 step, if no arguments are given.

forward-line clj

(forward-line)

Moves cursor forward one line in the current active buffer.

forward-page clj

(forward-page)

Moves one page forward on the current buffer. A page is what is visible in the current window.

forward-word clj

(forward-word)

Moves the cursor to the beginning of the next word.

fullupdate? clj

(fullupdate?)

If a full update of the ui has been requested. Resets the value afterwards.

get-action clj

(get-action keyw)

If the current buffer has an action for the given keyword the action (function) is return, otherwise, if there is a global action for the given keyword that will be returned.

get-available-functions clj

(get-available-functions)

get-buffer clj

(get-buffer name)

Get a buffer by its name. Since buffers are immutable, the buffer given will be a copy of the buffer.

get-char clj

(get-char)

Return the char at the point as a string.

get-content clj

(get-content)

Return the content of the current buffer as a string.

get-context clj

(get-context)

Returns a context map like {:type :file :value /tmp/tmp.txt} with a type and a value generated by analysing the context of the cursor.

get-default-app clj

(get-default-app)

Get the app to be used as default, if none has been specified.

get-default-highlighter clj

(get-default-highlighter)

Get the default highlighter function. Mostly used to set highlight on buffer until some is set by user or app.

get-default-typeahead-function clj

(get-default-typeahead-function)

Get the default function for typeahead.

get-filename clj

(get-filename)

The filename if one is associated with the current buffer, otherwise nil.

get-folder clj

(get-folder)

The folder part if a filename is associated with the current buffer, otherwise nil.

get-frame-columns clj

(get-frame-columns)

Get the number of columns in the current frame.

get-frame-rows clj

(get-frame-rows)

Get the number of rows in the current frame.

get-highlighter clj

(get-highlighter)

Returns the highlighter function from the current buffer.

get-key-list clj

(get-key-list)

List of all typed keys

get-keymap clj

(get-keymap)

Returns the active keymap on from the current buffer. This is used by the editor to determine what action to take.

get-line clj

(get-line)

Returns the current line as a string.

get-mark clj

(get-mark name)

Returns the named mark on the current buffer as a number, the position of the mark.

get-name clj

(get-name)

Returns the name of the current buffer.

get-point clj

(get-point)

Returns the point as a number.

get-rootfolders clj

(get-rootfolders)

Returns the list of root folders. Used by apps to navigate directly to these folders.

get-searchpaths clj

(get-searchpaths)

Returns the list of searchpaths.

get-selection clj

(get-selection)

Get current selected text as a string. Returns nil if nothing is selected.

get-slider clj

(get-slider)

Get the slider from the current buffer.

get-top-of-window clj

(get-top-of-window keyw)

Used by renderer to get the position of the first char to be rendered.

get-windows clj

(get-windows)

Returns the list of windows in the editor. Used by views to get the dimensions of the visible buffers.

goto-definition clj

(goto-definition funname)

handle-input clj

(handle-input keyw)

hide-selection clj

(hide-selection)

Hide the current selection. Will be collapsed into a symbol with 3 dots.

highlight-sexp-at-point clj

(highlight-sexp-at-point)

Like select-sexp-at-point but only highlights start and end of s-expression. Toggle this to see current s-expression.

insert clj

(insert string)

Inserts a string to the current active buffer at the cursor position.

insert-line clj

(insert-line)

Inserts an empty line below the current and move the cursor down.

kill-buffer clj

(kill-buffer)

new-buffer clj

(new-buffer name)

Create a new buffer with the given name. The buffer will be set as the current buffer in the current window. Default highlighter and keymaps are assign. They can be overridden afterwards.

other-window clj

(other-window)

Navigates to the next window and changes buffer accordingly.

paste clj

(paste)

Insert the text from the clipboard at the current position.

point-to-mark clj

(point-to-mark name)

Move the point to the mark on the current buffer.

previous-buffer clj

(previous-buffer)

Navigates to the previous buffer used.

previous-real-buffer clj

(previous-real-buffer)

Navigates to the prevous buffer, but skip over buffer with names containing dashes.

previous-real-buffer-same-window clj

(previous-real-buffer-same-window)

Navigates to the prevous buffer, but skip over buffer with names containing dashes.

prompt-append clj

(prompt-append & string)

Append the given strings to the prompt buffer.

prompt-input clj

(prompt-input & string)

prompt-set clj

(prompt-set & string)

Set the prompt buffer to the given strings.

prompt-to-tmp clj

(prompt-to-tmp)

quit clj

(quit)

record-macro clj

(record-macro)

remove-buffer clj

(remove-buffer buffername)

remove-mark clj

(remove-mark name)

Removes the named mark from the current buffer.

reopen-all-files clj

(reopen-all-files)

Reopen all files which are not dirty.

reopen-file clj

(reopen-file)

Reopen file in buffer, if the file is not dirty.

replace-char clj

(replace-char s)

Replaces the char at current point with the given one.

request-fullupdate clj

(request-fullupdate)

Used notify the ui to do a full updated.

reset clj

(reset)

Resets the editor. Mostly for testing purposes.

run-macro clj

(run-macro)

save-file clj

(save-file)

If the current buffer is connected to a file, saves the content of the buffer to the file.

search clj

(search)

search-files clj

(search-files search)

select-sexp-at-point clj

(select-sexp-at-point)

Selects the s-expression at the point (cursor) The cursor is moved backwards until the first startparenthesis where selection starts, and then forward until the selection has balanced parenthesis.

selection-active? clj

(selection-active?)

If something is selected.

selection-cancel clj

(selection-cancel)

Removes the selection point. Nothing will be selected afterwards.

selection-set clj

(selection-set)

Sets selection mark at the current point. This will be the starting point of a selection. Cursor position will be the end point of the selection.

selection-toggle clj

(selection-toggle)

If something is selected, the selection will be cancelled. If nothing is selected a selection will be initiated.

set-default-app clj

(set-default-app app)

Set the default app to be used when a new buffer is created.

set-default-highlighter clj

(set-default-highlighter highlighter)

Set the highlighter function to be used as default when a new buffer is created.

set-default-keymap clj

(set-default-keymap keymap)

Set the keymap to be used as default when a new buffer is created.

set-default-typeahead-function clj

(set-default-typeahead-function typeaheadfn)

Set the typeahead function to be used of none has been set.

set-eval-function clj

(set-eval-function extension fun)

Associate an extension with a function. The function is assumed to take one input - the filepath. EXAMPLE (To associate files with "py" extension with the python command): (editor/set-eval-function "py" #(cshell/cmd "python" %))

set-frame-dimensions clj

(set-frame-dimensions rows columns)

Setting rows and columns of the window frame.

set-global-key clj

(set-global-key keyw fun)

(set-global-key keyw1 keyw2 fun)

Define a global keybinding. It takes a keyword like :f5 and a function to call when that key is pressed.

set-highlighter clj

(set-highlighter highlighter)

Set the highlighter function on the current buffer. This determines how the content in the buffer is syntax highlighted.

set-keymap clj

(set-keymap keymap)

Sets the keymap on the current buffer.

set-mark clj

(set-mark name)

Sets a named mark at the current point on the current buffer

set-setting clj

(set-setting keyw value)

Set keyw to value in the settings part of the editor.

set-slider clj

(set-slider sl)

Replace the slider in the current buffer with the given.

set-tmp-keymap clj

(set-tmp-keymap keymap)

Overrule the current keymap temporarily. This keymap has highest priority.

set-top-of-window clj

(set-top-of-window keyw val)

Used by the renderer to store the position of the first char to be rendered.

set-undo-point clj

(set-undo-point)

setting clj

(setting keyw)

Get the setting with the given key.

Settings are used as a key value store in the editor.

Items like snippets or search paths are store in this.

sexp-at-point clj

(sexp-at-point)

Returns the s-expression at the cursor position.

shrink-window-below clj

(shrink-window-below amount)

shrink-window-right clj

(shrink-window-right amount)

split-window-below clj

(split-window-below)

(split-window-below amount)

split-window-right clj

(split-window-right)

(split-window-right amount)

swap-line-down clj

(swap-line-down)

Swaps the current line with the one below. The cursor follows the the current line down.

swap-line-up clj

(swap-line-up)

Swaps the current line with the line above. The cursor follows the current line up.

swap-windows clj

(swap-windows)

switch-to-buffer clj

(switch-to-buffer buffername)

Switch to the buffer with the given name.

switch-to-buffer-same-window clj

(switch-to-buffer-same-window buffername)

Switch to the buffer with the given name. Use the same window.

tmp-do-macro clj

(tmp-do-macro)

tmp-test clj

(tmp-test)

top-align-page clj

(top-align-page)

Scrolls so the current line is at the top of the window.

top-next-headline clj

(top-next-headline)

top-of-window clj

Atom to keep track of the position of the first char visible in a window. Keys are generated from window and buffer names.

typeahead clj

(typeahead items tostringfun callback)

undo clj

(undo)

Execute an undo on the current buffer.

unhide clj

(unhide)

If the current position has collapsed content it will be expanded.

update-mem-col clj

(update-mem-col)

Stores the current cursor position on the current line. Primarily used for forward-line and backward-line to remember the cursor position when navigation is done past shorter lines. That is what makes the cursor in and out when using arrow down.

updated clj

(updated)

Call this function to proclaim that an update has been made to the editor. This can be used by views to check for updates.

updates clj

Variable to be increased when updates are done to the editor, to allow easy check if redraw is needed.