mirror of
https://github.com/xmonad/xmonad-contrib.git
synced 2025-05-19 11:30:22 -07:00
+ FuzzyMatch by @nzeh
Provides a predicate 'fuzzyMatch' that is much more lenient in matching completions in XMonad.Prompt than the default prefix match. Also provides a function 'fuzzySort' that allows sorting the fuzzy matches by "how well" they match. Not sure why wasn't it accepted. Discussion: https://markmail.org/thread/kgrybzqarqzqiige
This commit is contained in:
parent
d7c6ee940b
commit
d5d82267c5
@ -81,6 +81,13 @@
|
||||
Also provides the `repeatableAction` helper function which can be used to
|
||||
build actions that can be repeated while a modifier key is held down.
|
||||
|
||||
* `XMonad.Prompt.FuzzyMatch`
|
||||
|
||||
Provides a predicate 'fuzzyMatch' that is much more lenient in matching
|
||||
completions in XMonad.Prompt than the default prefix match. Also provides
|
||||
a function 'fuzzySort' that allows sorting the fuzzy matches by "how well"
|
||||
they match.
|
||||
|
||||
* `XMonad.Utils.SessionStart`
|
||||
|
||||
A new module that allows to query if this is the first time xmonad is
|
||||
|
104
XMonad/Prompt/FuzzyMatch.hs
Normal file
104
XMonad/Prompt/FuzzyMatch.hs
Normal file
@ -0,0 +1,104 @@
|
||||
--------------------------------------------------------------------------------
|
||||
-- |
|
||||
-- Module : XMonad.Prompt.FuzzyMatch
|
||||
-- Copyright : (C) 2015 Norbert Zeh
|
||||
-- License : GPL
|
||||
--
|
||||
-- Maintainer : Norbert Zeh <norbert.zeh@gmail.com>
|
||||
-- Stability : unstable
|
||||
-- Portability : unportable
|
||||
--
|
||||
-- A module for fuzzy completion matching in prompts akin to emacs ido mode.
|
||||
--
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
module XMonad.Prompt.FuzzyMatch ( -- * Usage
|
||||
-- $usage
|
||||
fuzzyMatch
|
||||
, fuzzySort
|
||||
) where
|
||||
|
||||
-- $usage
|
||||
--
|
||||
-- This module offers two aspects of fuzzy matching of completions offered by
|
||||
-- XMonad.Prompt.
|
||||
--
|
||||
-- 'fuzzyMatch' can be used as the searchPredicate in the XPConfig. The effect
|
||||
-- is that any completion that contains the currently typed characters as a
|
||||
-- subsequence is a valid completion; matching is case insensitive. This means
|
||||
-- that the sequence of typed characters can be obtained from the completion by
|
||||
-- deleting an appropriate subset of its characters. Example: "spr" matches
|
||||
-- "FastSPR" but also "SuccinctParallelTrees" because it's a subsequence of the
|
||||
-- latter: "S.......P.r..........".
|
||||
--
|
||||
-- While this type of inclusiveness is helpful most of the time, it sometimes
|
||||
-- also produces surprising matches. 'fuzzySort' helps sorting matches by
|
||||
-- relevance, using a simple heuristic for measuring relevance. The matches are
|
||||
-- sorted primarily by the length of the substring that contains the query
|
||||
-- characters and secondarily the starting position of the match. So, if the
|
||||
-- search string is "spr" and the matches are "FastSPR", "FasterSPR", and
|
||||
-- "SuccinctParallelTrees", then the order is "FastSPR", "FasterSPR",
|
||||
-- "SuccinctParallelTrees" because both "FastSPR" and "FasterSPR" contain "spr"
|
||||
-- within a substring of length 3 ("SPR") while the shortest substring of
|
||||
-- "SuccinctParallelTrees" that matches "spr" is "SuccinctPar", which has length
|
||||
-- 11. "FastSPR" is ranked before "FasterSPR" because its match starts at
|
||||
-- position 5 while the match in "FasterSPR" starts at position 7.
|
||||
--
|
||||
-- To use these functions in an XPrompt, for example, for windowPromptGoto:
|
||||
--
|
||||
-- > import XMonad.Prompt
|
||||
-- > import XMonad.Prompt.Window ( windowPromptGoto )
|
||||
-- > import XMonad.Prompt.FuzzyMatch
|
||||
-- >
|
||||
-- > myXPConfig = def { searchPredicate = fuzzyMatch
|
||||
-- , sorter = fuzzySort
|
||||
-- }
|
||||
--
|
||||
-- then add this to your keys definition:
|
||||
--
|
||||
-- > , ((modm .|. shiftMask, xK_g), windowPromptGoto myXPConfig)
|
||||
--
|
||||
-- For detailed instructions on editing the key bindings, see
|
||||
-- "Xmonad.Doc.Extending#Editing_key_bindings".
|
||||
|
||||
import Data.Char
|
||||
import Data.Function
|
||||
import Data.List
|
||||
|
||||
-- | Returns True if the first argument is a subsequence of the second argument,
|
||||
-- that is, it can be obtained from the second sequence by deleting elements.
|
||||
fuzzyMatch :: String -> String -> Bool
|
||||
fuzzyMatch [] _ = True
|
||||
fuzzyMatch _ [] = False
|
||||
fuzzyMatch xxs@(x:xs) (y:ys) | toLower x == toLower y = fuzzyMatch xs ys
|
||||
| otherwise = fuzzyMatch xxs ys
|
||||
|
||||
-- | Sort the given set of strings by how well they match. Match quality is
|
||||
-- measured first by the length of the substring containing the match and second
|
||||
-- by the positions of the matching characters in the string.
|
||||
fuzzySort :: String -> [String] -> [String]
|
||||
fuzzySort q = map snd . sortBy (compare `on` fst) . map (rankMatch q)
|
||||
|
||||
rankMatch :: String -> String -> ((Int, Int), String)
|
||||
rankMatch q s = (minimum $ rankMatches q s, s)
|
||||
|
||||
rankMatches :: String -> String -> [(Int, Int)]
|
||||
rankMatches [] _ = [(0, 0)]
|
||||
rankMatches q s = map (\(l, r) -> (r - l, l)) $ findShortestMatches q s
|
||||
|
||||
findShortestMatches :: String -> String -> [(Int, Int)]
|
||||
findShortestMatches q s = foldl' extendMatches spans oss
|
||||
where (os:oss) = map (findOccurrences s) q
|
||||
spans = [(o, o) | o <- os]
|
||||
|
||||
findOccurrences :: String -> Char -> [Int]
|
||||
findOccurrences s c = map snd $ filter ((toLower c ==) . toLower . fst) $ zip s [0..]
|
||||
|
||||
extendMatches :: [(Int, Int)] -> [Int] -> [(Int, Int)]
|
||||
extendMatches spans xs = map last $ groupBy ((==) `on` snd) $ extendMatches' spans xs
|
||||
|
||||
extendMatches' :: [(Int, Int)] -> [Int] -> [(Int, Int)]
|
||||
extendMatches' [] _ = []
|
||||
extendMatches' _ [] = []
|
||||
extendMatches' spans@((l, r):spans') xs@(x:xs') | r < x = (l, x) : extendMatches' spans' xs
|
||||
| otherwise = extendMatches' spans xs'
|
@ -291,6 +291,7 @@ library
|
||||
XMonad.Prompt.DirExec
|
||||
XMonad.Prompt.Directory
|
||||
XMonad.Prompt.Email
|
||||
XMonad.Prompt.FuzzyMatch
|
||||
XMonad.Prompt.Input
|
||||
XMonad.Prompt.Layout
|
||||
XMonad.Prompt.Man
|
||||
|
Loading…
x
Reference in New Issue
Block a user