Talash.Brick

A simple brick app to search among the candidates from a vector of text and get the selection. By default the app doesn't do anything except return a single selection but more complicated actions can be performed by using the _hooks which allow abitrary IO actions (due to EventM being a MonadIO) in response to input events. The most convenient function to use the brick app are selected and related functions. runApp provides some more flexibility.

Types

data Searcher a

Constructors

Searcher

Fields

• _query :: Editor Text Bool

  The editor to get the query from.

• _prevQuery :: Maybe Text

  The last query which is saved to check if we should only search among the matches for it or all the candidates.

• _allMatches :: IORef (Vector Int)

  An IORef containing the indices of the filtered candidates. These are in an IORef to make it easier to deal with them in a different thread than the UI of the app. Maybe it should be moved to SearchEnv

• _matches :: List Bool [Text]

  The matches received split up as alternating sequences of match substrings and the gap between them. The first substring is always a gap and can be empty, the rest should be no empty.

• _numMatches :: Int

  The (maximum possible) number of matches. This is the length of vector stored in _allMatches which also contains the indices of which weren't matched in case enough matches were found before going through all the candidates.

• _wait :: Maybe ThreadId

  ThreadId of the thread currently computing matches. Nothing if there is no such thread.

• _extension :: a

  Unused by default but can be used store extra state needed for any extension to the functionality. For example to have multiple selections this can be set to a Vector that stores them.

Instances

Functor Searcher

Defined in Talash.Brick

Methods

fmap :: (a -> b) -> Searcher a -> Searcher b

(<$) :: a -> Searcher b -> Searcher a

data SearchEvent

Constructors

SearchEvent

Fields

• _matchedTop :: Vector [Text]

  The matches received.

• _totalMatches :: Int

  The (maximum possible) number of matches. See the note on _numMatches.

• _term :: Maybe Text

  The term which was searched for.

data SearchEnv a

The constant environment in which the search app runs.

Constructors

SearchEnv

Fields

• _searchFunctions :: SearchFunctions a

  The functions used to find and display matches.

• _candidates :: Vector Text

  The vector of candidates.

• _eventSource :: BChan SearchEvent

  The BChan from which the app receives search events.

data SearchFunctions a

Constructors

SearchFunctions

Fields

• _makeMatcher :: Text -> Maybe (Matcher a)

  Construct the matcher given the string to match.

• _lister :: forall n. KnownNat n => MatcherSized n a -> Vector Text -> Vector Int -> (Vector Int, Vector (Indices n))

  Obtain the result for searching.

• _displayer :: forall n. KnownNat n => MatcherSized n a -> Text -> Vector n Int -> [Text]

  Given the matcher m, the matched string t and the indices of matches in t divide t in alternating strings that are a matches and the gap between these matches. The first of these is always a gap and can be empty. The rest should be non empty.

data EventHooks a

Event hooks are almost direct translations of the events from vty i.e. see Event.

Constructors

EventHooks

Fields

• keyHook :: Key -> [Modifier] -> a -> EventM Bool (Next a)
• pasteHook :: ByteString -> a -> EventM Bool (Next a)
• resizeHook :: Int -> Int -> a -> EventM Bool (Next a)
• mouseDownHook :: Int -> Int -> Button -> [Modifier] -> a -> EventM Bool (Next a)
• mouseUpHook :: Int -> Int -> Maybe Button -> a -> EventM Bool (Next a)
• focusLostHook :: a -> EventM Bool (Next a)
• focusGainedHook :: a -> EventM Bool (Next a)

data AppTheme

Constructors

AppTheme

Fields

• _prompt :: Text

  The prompt to display next to the editor.

• _themeAttrs :: [(AttrName, Attr)]

  This is used to construct the attrMap for the app. By default the used attarNmaes are listSelectedAttr , borderAttr , "Prompt" , "Highlight" and "Stats"

• _borderStyle :: BorderStyle

  The border style to use. By default unicodeRounded

data AppSettings a b

Constructors

AppSettings

Fields

• _theme :: AppTheme
• _hooks :: ReaderT (SearchEnv a) EventHooks (Searcher b)

  The event hooks which can make use of the search environment.

The Brick App and Helpers

searchApp :: AppSettings a b -> SearchEnv a -> App (Searcher b) SearchEvent Bool

Tha app itself. selected and the related functions are probably more convenient for embedding into a larger program.

defSettings :: AppSettings a b

Default settings. Uses blue for various highlights and cyan for borders. All the hooks except keyHook which is handleKeyEvent are trivial.

searchFunctionsFuzzy :: SearchFunctions MatchPart

Search functions suitable for fuzzy matching. The candidate c will match the query s if c contains all the characters in s in order. In general there can be several ways of matching. This tries to find a match with the minimum number of parts. It does not find the minimum number of parts, if that requires reducing the extent of the partial match during search. E.g. matching "as" against "talash" the split will be ["tal","as","h"] and not ["t","a","la","s","h"]. While matching "talash best match testing hat" against "tea" will not result in ["talash best match ","te","sting h","a","t"] since "te" occurs only after we have match all three letters and we can't know if we will find the "a" without going through the string.

searchFunctionsOL :: SearchFunctions Int

Search functions that match the words in i.e. space separated substring in any order. "talash best" will match "be as" with the split ["tal","as","h","be","st"] but "talash best" will not match "bet".

runApp :: b -> AppSettings a b -> SearchFunctions a -> Vector Text -> IO (Searcher b)

Run app with given settings and return the final Searcher state.

runAppFromHandle :: b -> AppSettings a b -> SearchFunctions a -> Handle -> IO (Searcher b)

Run app with a vector that contains lines read from a handle and return the final Searcher state.

selected :: AppSettings a () -> SearchFunctions a -> Vector Text -> IO (Maybe Text)

Run app and return the text of the selection if there is one else Nothing.

selectedFromHandle :: AppSettings a () -> SearchFunctions a -> Handle -> IO (Maybe Text)

Same as selected but reads the vector from the supplied handle.

selectedFromHandleWith :: (Text -> Text) -> (Vector Text -> Vector Text) -> AppSettings a () -> SearchFunctions a -> Handle -> IO (Maybe Text)

Same as selectedFromHandle but allows for transforming the lines read and the final vector with supplied functions. See also readVectorHandleWith.

selectedFromFileNamesSorted :: AppSettings a () -> SearchFunctions a -> Handle -> IO (Maybe Text)

Another variation on selectedFromHandle. See fileNamesSorted for what happens to read vector.

selectedFromFiles :: AppSettings a () -> SearchFunctions a -> [FindInDirs] -> IO (Maybe Text)

Version of selected for file search using a simple implementation of searching file trees from Talash.Files. Better to use either other libraries like unix-recursive or external programs like fd for more complicated tasks.

runSearch :: AppSettings a () -> SearchFunctions a -> IO ()

A version of selected that puts the selected text on the stdout.

Default program

run :: IO ()

Defualt program for the brick app that reads candidates from stdin and prints the selected text to the stdout. Can be called from the executable with talash tui which uses the orderless style. The search style can be set explicitly by calling talash tui fuzzy or talash tui orderless

run' :: [String] -> IO ()

The backend for run

Lenses

Searcher

query :: forall a. Lens' (Searcher a) (Editor Text Bool)

prevQuery :: forall a. Lens' (Searcher a) (Maybe Text)

allMatches :: forall a. Lens' (Searcher a) (IORef (Vector Int))

matches :: forall a. Lens' (Searcher a) (List Bool [Text])

numMatches :: forall a. Lens' (Searcher a) Int

wait :: forall a. Lens' (Searcher a) (Maybe ThreadId)

SearchEvent

matchedTop :: Lens' SearchEvent (Vector [Text])

totalMatches :: Lens' SearchEvent Int

term :: Lens' SearchEvent (Maybe Text)

SearchEnv

searchFunctions :: forall a a. Lens (SearchEnv a) (SearchEnv a) (SearchFunctions a) (SearchFunctions a)

candidates :: forall a. Lens' (SearchEnv a) (Vector Text)

eventSource :: forall a. Lens' (SearchEnv a) (BChan SearchEvent)

SearchFunctions

makeMatcher :: forall a. Lens' (SearchFunctions a) (Text -> Maybe (Matcher a))

lister :: forall a n. KnownNat n => SimpleGetter (SearchFunctions a) (MatcherSized n a -> Vector Text -> Vector Int -> (Vector Int, Vector (Indices n)))

displayer :: forall a n. KnownNat n => SimpleGetter (SearchFunctions a) (MatcherSized n a -> Text -> Vector n Int -> [Text])

AppTheme

prompt :: Lens' AppTheme Text

themeAttrs :: Lens' AppTheme [(AttrName, Attr)]

borderStyle :: Lens' AppTheme BorderStyle

SearchSettings

theme :: forall a b. Lens' (AppSettings a b) AppTheme

hooks :: forall a b a b. Lens (AppSettings a b) (AppSettings a b) (ReaderT (SearchEnv a) EventHooks (Searcher b)) (ReaderT (SearchEnv a) EventHooks (Searcher b))

Exposed Internals

makeQuery :: Searcher a -> Maybe Text

Get the current query from the editor of the searcher.

haltQuit :: Searcher a -> EventM n (Next (Searcher a))

Quit without any selection.

handleKeyEvent :: SearchEnv a -> Key -> [Modifier] -> Searcher b -> EventM Bool (Next (Searcher b))

Handling of keypresses. The default bindings are Enter exits the app with the current selection. Esc exits without any selection Up , Down , PageUp and PageDown move through the matches. All others keys are used for editing the query. See handleEditorEvent for details.

handleSearch :: Vector Text -> Searcher a -> SearchEvent -> EventM Bool (Next (Searcher a))

Handle a search event by updating _numMatches , _matches and _wait.

editStep :: SearchEnv a -> Searcher b -> IO (Searcher b)

Handle the editing of the query by starting the computation of the matches in a new thread and storing the ThreadId in _wait. If the new query contains the last query then doesn't try to match the candidates that didn't match the last query, otherwise search among all the candidates. Might be possible to make the performance better by storing the indices of the filtered candidates for more than one previous query.

replaceSearch

Arguments

:: Bool

If True then search among all matches by writing a vector of all the indices into _allMatches. If False use _allMatches as is.

-> SearchEnv a

-> Searcher b

-> IO ThreadId

This function dispatches the computation of matches to a new thread and returns the new threadId. It also tries to kill the thread in which a previous computation was going on (Not sure if it actually accomplishes that, my understanding of exceptions is not good enough).

search :: forall a. SearchFunctions a -> Vector Text -> Maybe Text -> IORef (Vector Int) -> IO SearchEvent

The functions for generating a search event. It is executed in a separate thread via forkIO in replaceSearch.

searcherWidget :: Text -> Text -> Searcher a -> Widget Bool

The brick widget used to display the editor and the search result.

initialSearcher :: a -> Vector Text -> IORef (Vector Int) -> Searcher a

The initial state of the searcher. The editor is empty, the first 512 elements of the vector are disaplyed as matches.

searchWithMatcher

Arguments

:: SearchFunctions a

The configuration to use to carry out the search.

-> Vector Text

The vector v of candidates.

-> Maybe Text

The query string

-> Vector Int

The subset of indices of v to search against. If input changes from talas to talash we only search among candidates that matched talas.

-> (Vector Int, (Int, Vector [Text]))

The indices of the matched candidates (see the note above) and the matched candidates broken up according to the match.

searchWithMatcher carries out one step of the search. Note that the search can stops before going through the whole vector of text. In that case the returned vector of indices should contain not only the indices matched candidates but also the indices of candidates that weren't tested for a match.

readVectorStdIn :: IO (Vector Text)

Read a vector of newline separated candidates from the stdin.

readVectorHandle :: Handle -> IO (Vector Text)

Read a vector of newline separated candidates from a handle.

readVectorHandleWith

Arguments

:: (Text -> Text)

The function to transform the candidates.

-> (Vector Text -> Vector Text)

The function to apply to the constructed vector before compacting.

-> Handle

The handle to read from

-> IO (Vector Text)

A generalized version of readVectorHandle allowing for the transformation of candidates and the resulting vector. See fileNamesSorted for an example of use.

emptyIndices :: Int -> Vector (Indices 0)