core/text/edit package | Odin Programming Language

Text edit primitives to use in a text box. Based off the articles by rxi: - [[ https://rxi.github.io/textbox_behaviour.html ]] - [[ https://rxi.github.io/a_simple_undo_system.html ]]

Collection Info

View Source

Collection: core
Path: text/edit
Entries: 36

Constants 2

Jump to Constants

DEFAULT_UNDO_TIMEOUT MULTILINE_COMMANDS

Types 5

Jump to Types

Command Command_Set State Translation Undo_State

Procedures 29

Jump to Procedures

begin clear_all copy current_selected_text cut delete_to destroy end has_selection init input_rune input_runes input_text insert is_continuation_byte move_to +13 more

Procedure Groups 0

Variables 0

Source Files

text_edit.odin

Constants

DEFAULT_UNDO_TIMEOUT #

Source

DEFAULT_UNDO_TIMEOUT :: 300 * time.Millisecond

MULTILINE_COMMANDS #

Source

MULTILINE_COMMANDS :: Command_Set{.New_Line, .Up, .Down, .Select_Up, .Select_Down}

Types

Command #

Source

Command :: Command

Command_Set #

Source

Command_Set :: distinct Command_Set

State #

Source

State :: State

Translation #

Source

Translation :: Translation

Undo_State #

Source

Undo_State :: Undo_State

Procedures

begin #

Source

begin :: proc(s: ^State, id: u64, builder: ^Builder) {…}

Call at the beginning of each frame

clear_all #

Source

clear_all :: proc(s: ^State) -> (cleared: bool) {…}

returns true when the builder had content to be cleared clear builder&selection and the undo|redo stacks

copy #

Source

copy :: proc(s: ^State) -> bool {…}

try and copy the currently selected text to the clipboard State.set_clipboard needs to be assigned

current_selected_text #

Source

current_selected_text :: proc(s: ^State) -> string {…}

return the currently selected text

cut #

Source

cut :: proc(s: ^State) -> bool {…}

copy & delete the current selection when copy() succeeds

delete_to #

Source

delete_to :: proc(s: ^State, t: Translation) {…}

Deletes everything between the caret and resultant position

destroy #

Source

destroy :: proc(s: ^State) {…}

clear undo|redo strings and delete their stacks

end #

Source

end :: proc(s: ^State) {…}

Call at the end of each frame

has_selection #

Source

has_selection :: proc(s: ^State) -> bool {…}

true if selection head and tail dont match and form a selection of multiple characters

init #

Source

init :: proc(s: ^State, undo_text_allocator, undo_state_allocator: Allocator, undo_timeout: Duration = DEFAULT_UNDO_TIMEOUT) {…}

init the state to some timeout and set the respective allocators - undo_state_allocator dictates the dynamic undo|redo arrays allocators - undo_text_allocator is the allocator which allocates strings only

input_rune #

Source

input_rune :: proc(s: ^State, r: rune) {…}

insert a single rune into the edit state - deletes the current selection

input_runes #

Source

input_runes :: proc(s: ^State, text: []rune) {…}

insert slice of runes into the edit state - deletes the current selection

input_text #

Source

input_text :: proc(s: ^State, text: string) -> int {…}

insert text into the edit state - deletes the current selection

insert #

Source

insert :: proc(s: ^State, at: int, text: string) -> int {…}

insert a single rune into the edit state - deletes the current selection

is_continuation_byte #

Source

is_continuation_byte :: proc(b: u8) -> bool {…}

move_to #

Source

move_to :: proc(s: ^State, t: Translation) {…}

Moves the position of the caret (both sides of the selection)

paste #

Source

paste :: proc(s: ^State) -> bool {…}

reinsert whatever the get_clipboard would return State.get_clipboard needs to be assigned

perform_command #

Source

perform_command :: proc(s: ^State, cmd: Command) {…}

remove #

Source

remove :: proc(s: ^State, lo, hi: int) {…}

remove the wanted range withing, usually the selection within byte indices

select_to #

Source

select_to :: proc(s: ^State, t: Translation) {…}

Moves only the head of the selection and leaves the tail uneffected

selection_delete #

Source

selection_delete :: proc(s: ^State) {…}

delete the current selection range and set the proper selection afterwards

setup_once #

Source

setup_once :: proc(s: ^State, builder: ^Builder) {…}

setup the builder, selection and undo|redo state once allowing to retain selection

sorted_selection #

Source

sorted_selection :: proc(s: ^State) -> (lo, hi: int) {…}

return the clamped lo/hi of the current selection since the selection[0] moves around and could be ahead of selection[1] useful when rendering and needing left->right

translate_position #

Source

translate_position :: proc(s: ^State, t: Translation) -> int {…}

translates the caret position

undo #

Source

undo :: proc(s: ^State, undo, redo: ^[dynamic]^Undo_State) {…}

pop undo|redo state - push to redo|undo - set selection & text

undo_check #

Source

undo_check :: proc(s: ^State) {…}

clear redo stack and check if the undo timeout gets hit

undo_clear #

Source

undo_clear :: proc(s: ^State, undo: ^[dynamic]^Undo_State) {…}

iteratively clearn the undo|redo stack and free each allocated text state

undo_state_push #

Source

undo_state_push :: proc(s: ^State, undo: ^[dynamic]^Undo_State) -> Allocator_Error {…}

push current text state to the wanted undo|redo stack

update_time #

Source

update_time :: proc(s: ^State) {…}

update current time so "insert" can check for timeouts