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

forall n.KnownNat n => Searcher

Fields

• getSearcher :: SearcherSized n a

data SearchEvent a

Constructors

forall n.KnownNat n => SearchEvent (SearchEventSized n a)

data SearchEnv n a b

The constant environment in which the search runs.

Constructors

SearchEnv

Fields

• _searchFunctions :: SearchFunctions a b

  The functions used to find and display matches.

• _send :: forall n m. (KnownNat n, KnownNat m) => Chunks n -> SearchReport -> MatcherSized m a -> MatchSetSized m -> IO ()
• _maxMatches :: Int
• _candidates :: Chunks n
• _query :: MVar (Maybe Text)
• _allMatches :: IOVector (Vector n Bit)

data EventHooks a

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

Constructors

EventHooks

Fields

• keyHook :: Key -> [Modifier] -> EventM Bool a ()
• pasteHook :: ByteString -> EventM Bool a ()
• resizeHook :: Int -> Int -> EventM Bool a ()
• mouseDownHook :: Int -> Int -> Button -> [Modifier] -> EventM Bool a ()
• mouseUpHook :: Int -> Int -> Maybe Button -> EventM Bool a ()
• focusLostHook :: EventM Bool a ()
• focusGainedHook :: EventM Bool 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

type AppSettings n a = AppSettingsG n a (Widget Bool) AppTheme

data AppSettingsG (n :: Nat) a b t

Constructors

AppSettings

Fields

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

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

• _chunkSize :: Proxy n
• _maximumMatches :: Int
• _eventStrategy :: SearchReport -> Bool

data CaseSensitivity

Constructors

CaseSensitive

IgnoreCase

Instances

FromJSON CaseSensitivity

Defined in Data.Text.CaseSensitivity

Methods

parseJSON :: Value -> Parser CaseSensitivity

parseJSONList :: Value -> Parser [CaseSensitivity]

ToJSON CaseSensitivity

Defined in Data.Text.CaseSensitivity

Methods

toJSON :: CaseSensitivity -> Value

toEncoding :: CaseSensitivity -> Encoding

toJSONList :: [CaseSensitivity] -> Value

toEncodingList :: [CaseSensitivity] -> Encoding

Generic CaseSensitivity

Defined in Data.Text.CaseSensitivity

Associated Types

type Rep CaseSensitivity :: Type -> Type

Methods

from :: CaseSensitivity -> Rep CaseSensitivity x

to :: Rep CaseSensitivity x -> CaseSensitivity

Show CaseSensitivity

Defined in Data.Text.CaseSensitivity

Methods

showsPrec :: Int -> CaseSensitivity -> ShowS

show :: CaseSensitivity -> String

showList :: [CaseSensitivity] -> ShowS

NFData CaseSensitivity

Defined in Data.Text.CaseSensitivity

Methods

rnf :: CaseSensitivity -> ()

Eq CaseSensitivity

Defined in Data.Text.CaseSensitivity

Methods

(==) :: CaseSensitivity -> CaseSensitivity -> Bool

(/=) :: CaseSensitivity -> CaseSensitivity -> Bool

Hashable CaseSensitivity

Defined in Data.Text.CaseSensitivity

Methods

hashWithSalt :: Int -> CaseSensitivity -> Int

hash :: CaseSensitivity -> Int

type Rep CaseSensitivity

Defined in Data.Text.CaseSensitivity

type Rep CaseSensitivity = D1 ('MetaData "CaseSensitivity" "Data.Text.CaseSensitivity" "alfred-margaret-2.0.0.0-5xj5mmrDprP1Dn3hNNnaoN" 'False) (C1 ('MetaCons "CaseSensitive" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IgnoreCase" 'PrefixI 'False) (U1 :: Type -> Type))

The Brick App and Helpers

searchApp :: KnownNat n => AppSettings n a -> SearchEnv n a (Widget Bool) -> App (Searcher a) (SearchEvent a) Bool

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

defSettings :: KnownNat n => AppSettings n a

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

fuzzyFunctions :: CaseSensitivity -> SearchFunctions MatchPart b

orderlessFunctions :: CaseSensitivity -> SearchFunctions Int b

runApp :: KnownNat n => AppSettings n a -> SearchFunctions a (Widget Bool) -> Chunks n -> IO (Searcher a)

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

runAppFromHandle :: KnownNat n => AppSettings n a -> SearchFunctions a (Widget Bool) -> Handle -> IO (Searcher a)

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

selected :: KnownNat n => AppSettings n a -> SearchFunctions a (Widget Bool) -> Chunks n -> IO (Maybe Text)

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

selectedFromHandle :: KnownNat n => AppSettings n a -> SearchFunctions a (Widget Bool) -> Handle -> IO (Maybe Text)

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

selectedFromHandleWith :: KnownNat n => (Text -> Text) -> (Vector Text -> Vector Text) -> AppSettings n a -> SearchFunctions a (Widget Bool) -> 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 :: KnownNat n => AppSettings n a -> SearchFunctions a (Widget Bool) -> Handle -> IO (Maybe Text)

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

selectedFromFiles :: KnownNat n => AppSettings n a -> SearchFunctions a (Widget Bool) -> [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.

selectedUsing :: KnownNat n => AppSettings n a -> SearchFunctions a (Widget Bool) -> (a -> Text) -> Vector a -> IO (Maybe a)

runSearch :: AppSettings 64 a -> SearchFunctions a (Widget Bool) -> IO ()

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

makeChunks :: forall n. KnownNat n => Vector Text -> Chunks n

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

queryEditor :: forall n a. Lens' (SearcherSized n a) (Editor Text Bool)

allMatches :: forall n a b. Lens' (SearchEnv n a b) (IOVector (Vector n Bit))

matches :: forall n a. Lens' (SearcherSized n a) (GenericList Bool MatchSetG (ScoredMatchSized n))

numMatches :: forall n a. Lens' (SearcherSized n a) Int

SearchEvent

matchedTop :: forall n a. Lens' (SearchEventSized n a) (MatchSetSized n)

totalMatches :: forall n a a. Lens (SearchStateSized n a) (SearchStateSized n a) Int Int

term :: forall n a. Lens' (SearchEventSized n a) Text

SearchEnv

candidates :: forall n a b. Lens' (SearchEnv n a b) (Chunks n)

eventSource :: forall n a. Lens' (SearcherSized n a) (BChan (SearchEvent a))

SearchFunctions

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

match :: forall a b n. KnownNat n => SimpleGetter (SearchFunctions a b) (MatcherSized n a -> Text -> Maybe (MatchFull n))

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

AppTheme

prompt :: Lens' AppTheme Text

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

borderStyle :: Lens' AppTheme BorderStyle

SearchSettings

theme :: forall n a b t t. Lens (AppSettingsG n a b t) (AppSettingsG n a b t) t t

hooks :: forall n a b t a b. Lens (AppSettingsG n a b t) (AppSettingsG n a b t) (ReaderT (SearchEnv n a b) EventHooks (Searcher a)) (ReaderT (SearchEnv n a b) EventHooks (Searcher a))

defTheme :: AppTheme

defHooks :: EventHooks a

Exposed Internals

handleKeyEvent :: KnownNat n => SearchEnv n a c -> Key -> [Modifier] -> EventM Bool (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 :: SearchEvent a -> EventM Bool (Searcher a) ()

searcherWidget :: (KnownNat n, KnownNat m) => SearchEnv n a (Widget Bool) -> Text -> SearcherSized m a -> Widget Bool

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

initialSearcher :: SearchEnv n a c -> BChan (SearchEvent a) -> SearcherSized 0 a

The initial state of the searcher. The editor is empty.

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)