Copyright	(c) Eric Mertens, 2016
License	ISC
Maintainer	emertens@gmail.com
Safe Haskell	None
Language	Haskell2010

Client.Commands.WordCompletion

Description

This module provides the tab-completion logic used for nicknames and channels.

Synopsis

Documentation

class (IsString a, Ord a) => Prefix a Source #

Minimal complete definition

isPrefix, toString

Instances

Prefix Text Source #
Methods isPrefix :: Text -> Text -> Bool toString :: Text -> String
Prefix Identifier Source #
Methods isPrefix :: Identifier -> Identifier -> Bool toString :: Identifier -> String

wordComplete Source #

Arguments

:: Prefix a
=> (String -> String)	leading update operation
-> Bool	reversed
-> [a]	priority completions
-> [a]	possible completions
-> EditBox
-> Maybe EditBox

Perform word completion on a text box.

The leading update operation is applied to the result of tab-completion when tab completing from the beginning of the text box. This is useful when auto-completing a nick and including a trailing colon.

The reversed parameter indicates that tab-completion should return the previous entry. When starting a fresh tab completion the priority completions will be considered in order before resorting to the set of possible completions.