Client.State.EditBox

This module provides support for the text operations important for providing a text input in the IRC client. It tracks user input history, tab completion history, and provides many update operations which are mapped to the keyboard in Client.EventLoop.

Edit box type

data EditBox

Instances

Read EditBox

Methods

readsPrec :: Int -> ReadS EditBox

readList :: ReadS [EditBox]

readPrec :: ReadPrec EditBox

readListPrec :: ReadPrec [EditBox]

Show EditBox

Methods

showsPrec :: Int -> EditBox -> ShowS

show :: EditBox -> String

showList :: [EditBox] -> ShowS

HasLine EditBox

Methods

line :: Lens' EditBox Line

pos :: Lens' EditBox Int

text :: Lens' EditBox String

defaultEditBox :: EditBox

Default EditBox value

content :: Lens' EditBox Content

lastOperation :: Lens' EditBox LastOperation

Line type

data Line

Constructors

Line !Int !String

Instances

Read Line

Methods

readsPrec :: Int -> ReadS Line

readList :: ReadS [Line]

readPrec :: ReadPrec Line

readListPrec :: ReadPrec [Line]

Show Line

Methods

showsPrec :: Int -> Line -> ShowS

show :: Line -> String

showList :: [Line] -> ShowS

HasLine Line

Methods

line :: Lens' Line Line

pos :: Lens' Line Int

text :: Lens' Line String

singleLine :: Line -> Content

Single line Content.

endLine :: String -> Line

class HasLine c where

Minimal complete definition

line

Methods

line :: Lens' c Line

pos :: Lens' c Int

text :: Lens' c String

Instances

HasLine Line

Methods

line :: Lens' Line Line

pos :: Lens' Line Int

text :: Lens' Line String

HasLine Content

Methods

line :: Lens' Content Line

pos :: Lens' Content Int

text :: Lens' Content String

HasLine EditBox

Methods

line :: Lens' EditBox Line

pos :: Lens' EditBox Int

text :: Lens' EditBox String

Content type

data Content

Zipper-ish view of the multi-line content of an EditBox. Lines above the currentLine are stored in reverse order.

Instances

Read Content

Methods

readsPrec :: Int -> ReadS Content

readList :: ReadS [Content]

readPrec :: ReadPrec Content

readListPrec :: ReadPrec [Content]

Show Content

Methods

showsPrec :: Int -> Content -> ShowS

show :: Content -> String

showList :: [Content] -> ShowS

HasLine Content

Methods

line :: Lens' Content Line

pos :: Lens' Content Int

text :: Lens' Content String

shift :: Content -> (String, Content)

Shifts the first line off of the Content, yielding the text of the line and the rest of the content.

above :: Lens' Content [String]

below :: Lens' Content [String]

Operations

delete :: Content -> Content

Delete the character after/under the cursor.

backspace :: Content -> Content

Delete the character before the cursor.

home :: EditBox -> EditBox

Jump the cursor to the beginning of the input.

end :: EditBox -> EditBox

Jump the cursor to the end of the input.

killHome :: EditBox -> EditBox

Delete all text from the cursor to the beginning and store it in the yank buffer.

killEnd :: EditBox -> EditBox

Delete all text from the cursor to the end and store it in the yank buffer.

killWordBackward

Arguments

:: Bool

yank

-> EditBox

-> EditBox

Kill the content from the cursor back to the previous word boundary. When yank is set the yank buffer will be updated.

killWordForward

Arguments

:: Bool

yank

-> EditBox

-> EditBox

Kill the content from the curser forward to the next word boundary. When yank is set the yank buffer will be updated

yank :: EditBox -> EditBox

Insert the yank buffer at the cursor.

toggle :: Content -> Content

left :: Content -> Content

Move the cursor left, across lines if necessary.

right :: Content -> Content

Move the cursor right, across lines if necessary.

leftWord :: Content -> Content

Move the cursor left to the previous word boundary.

rightWord :: Content -> Content

Move the cursor right to the next word boundary.

insert :: Char -> EditBox -> EditBox

Insert a character at the cursor and advance the cursor.

insertPaste :: String -> EditBox -> EditBox

insertString :: String -> Content -> Content

Insert string at cursor, cursor is advanced to the end of the inserted string.

earlier :: EditBox -> Maybe EditBox

Update the editbox to reflect the earlier element in the history.

later :: EditBox -> Maybe EditBox

Update the editbox to reflect the later element in the history.

success :: EditBox -> EditBox

Indicate that the contents of the text box were successfully used by the program. This clears the first line of the contents and updates the history.

insertDigraph :: EditBox -> Maybe EditBox

Last operation

data LastOperation

Constructors

TabOperation String

KillOperation

OtherOperation

Instances

Read LastOperation

Methods

readsPrec :: Int -> ReadS LastOperation

readList :: ReadS [LastOperation]

readPrec :: ReadPrec LastOperation

readListPrec :: ReadPrec [LastOperation]

Show LastOperation

Methods

showsPrec :: Int -> LastOperation -> ShowS

show :: LastOperation -> String

showList :: [LastOperation] -> ShowS