- search :: Browser -> Site -> Query -> X ()
- data SearchEngine = SearchEngine Name Site
- searchEngine :: Name -> String -> SearchEngine
- searchEngineF :: Name -> Site -> SearchEngine
- promptSearch :: XPConfig -> SearchEngine -> X ()
- promptSearchBrowser :: XPConfig -> Browser -> SearchEngine -> X ()
- selectSearch :: SearchEngine -> X ()
- selectSearchBrowser :: Browser -> SearchEngine -> X ()
- isPrefixOf :: Eq a => [a] -> [a] -> Bool
- escape :: String -> String
- use :: SearchEngine -> Site
- intelligent :: SearchEngine -> SearchEngine
- (!>) :: SearchEngine -> SearchEngine -> SearchEngine
- prefixAware :: SearchEngine -> SearchEngine
- namedEngine :: Name -> SearchEngine -> SearchEngine
- amazon, youtube, wiktionary, wikipedia, wayback, thesaurus, scholar, openstreetmap, mathworld, maps, lucky, isohunt, imdb, images, hoogle, hackage, google, dictionary, debpts, debbts, deb, codesearch, alpha :: SearchEngine
- multi :: SearchEngine
- type Browser = FilePath
- type Site = String -> String
- type Query = String
- type Name = String
- data Search
This module is intended to allow easy access to databases on the Internet through xmonad's interface. The idea is that one wants to run a search but the query string and the browser to use must come from somewhere. There are two places the query string can come from - the user can type it into a prompt which pops up, or the query could be available already in the X Windows copy/paste buffer (perhaps you just highlighted the string of interest).
Thus, there are two main functions:
selectSearch (implemented using the more primitive
each of these is passed an engine function; this is a function that
knows how to search a particular site.
For example, the
selectSearch the engine you
want, the browser you want, and anything special they might need;
this whole line is then bound to a key of you choosing in your
xmonad.hs. For specific examples, see each function. This module
is easily extended to new sites by using
The currently available search engines are:
amazon-- Amazon keyword search.
alpha-- Wolfram|Alpha query.
codesearch-- Google Labs Code Search search.
deb-- Debian package search.
debbts-- Debian Bug Tracking System.
debpts-- Debian Package Tracking System.
dictionary-- dictionary.reference.com search.
hackage-- Hackage, the Haskell package database.
hoogle-- Hoogle, the Haskell libraries API search engine.
images-- Google images.
imdb-- the Internet Movie Database.
isohunt-- isoHunt search.
lucky-- Google I'm feeling lucky search.
maps-- Google maps.
mathworld-- Wolfram MathWorld search.
openstreetmap-- OpenStreetMap free wiki world map.
scholar-- Google scholar academic search.
thesaurus-- thesaurus.reference.com search.
wayback-- the Wayback Machine.
wikipedia-- basic Wikipedia search.
youtube-- Youtube video search.
multi-- Search based on the prefix. "amazon:Potter" will use amazon, etc. With no prefix searches google.
Feel free to add more!
Given a browser, a search engine's transformation function, and a search term, perform the requested search in the browser.
Given a base URL, create the
SearchEngine that escapes the query and
appends it to the base. You can easily define a new engine locally using
exported functions without needing to modify XMonad.Actions.Search:
myNewEngine = searchEngine "site" "http://site.com/search="
The important thing is that the site has a interface which accepts the escaped query string as part of the URL. Alas, the exact URL to feed searchEngine varies from site to site, often considerably, so there's no general way to cover this.
Generally, examining the resultant URL of a search will allow you to reverse-engineer it if you can't find the necessary URL already described in other projects such as Surfraw.
If your search engine is more complex than this (you may want to identify
the kind of input and make the search URL dependent on the input or put the query
inside of a URL instead of in the end) you can use the alternative
searchFunc :: String -> String searchFunc s | "wiki:" `isPrefixOf` s = "http://en.wikipedia.org/wiki/" ++ (escape $ tail $ snd $ break (==':') s) | "http://" `isPrefixOf` s = s | otherwise = (use google) s myNewEngine = searchEngineF "mymulti" searchFunc
searchFunc here searches for a word in wikipedia if it has a prefix
of "wiki:" (you can use the
escape function to escape any forbidden characters), opens an address
directly if it starts with "http://" and otherwise uses the provided google search engine.
You can use other engines inside of your own through the
use function as shown above to make
search, but for use with the output from a Prompt; it grabs the
Prompt's result, passes it to a given searchEngine and opens it in a given
search, but for use with the X selection; it grabs the selection,
passes it to a given searchEngine and opens it in the default browser . Example:
, ((modm .|. shiftMask, xK_g), selectSearch google)
search, but for use with the X selection; it grabs the selection,
passes it to a given searchEngine and opens it in a given browser.
Escape the search string so search engines understand it. Only digits and ASCII letters are not encoded. All non ASCII characters which are encoded as UTF8
Given an already defined search engine, extracts its transformation
function, making it easy to create compound search engines.
For an instance you can use
use google to get a function which
makes the same transformation as the google search engine would.
This function wraps up a search engine and creates a new one, which works like the argument, but goes directly to a URL if one is given rather than searching.
myIntelligentGoogleEngine = intelligent google
Now if you search for http://xmonad.org it will directly open in your browser
Connects a few search engines into one. If the search engines' names are
"s1", "s2" and "s3", then the resulting engine will use s1 if the query
s1:word, s2 if you type
s2:word and s3 in all other cases.
multiEngine = intelligent (wikipedia !> mathworld !> (prefixAware google))
Now if you type "wiki:Haskell" it will search for "Haskell" in Wikipedia, "mathworld:integral" will search mathworld, and everything else will fall back to google. The use of intelligent will make sure that URLs are opened directly.
Makes a search engine prefix-aware. Especially useful together with
It will automatically remove the prefix from a query so that you don't end
up searching for google:xmonad if google is your fallback engine and you
explicitly add the prefix.
amazon, youtube, wiktionary, wikipedia, wayback, thesaurus, scholar, openstreetmap, mathworld, maps, lucky, isohunt, imdb, images, hoogle, hackage, google, dictionary, debpts, debbts, deb, codesearch, alpha :: SearchEngineSource
Use case: searching with a submap
In combination with XMonad.Actions.Submap you can create a powerful and easy way to search without adding a whole bunch of bindings.
First import the necessary modules:
import qualified XMonad.Prompt as P import qualified XMonad.Actions.Submap as SM import qualified XMonad.Actions.Search as S
Then add the following to your key bindings:
... -- Search commands , ((modm, xK_s), SM.submap $ searchEngineMap $ S.promptSearch P.defaultXPConfig) , ((modm .|. shiftMask, xK_s), SM.submap $ searchEngineMap $ S.selectSearch) ... searchEngineMap method = M.fromList $ [ ((0, xK_g), method S.google) , ((0, xK_h), method S.hoogle) , ((0, xK_w), method S.wikipedia) ]
Or in combination with XMonad.Util.EZConfig:
... ] -- end of regular keybindings -- Search commands ++ [("M-s " ++ k, S.promptSearch P.defaultXPConfig f) | (k,f) <- searchList ] ++ [("M-S-s " ++ k, S.selectSearch f) | (k,f) <- searchList ] ... searchList :: [(String, S.SearchEngine)] searchList = [ ("g", S.google) , ("h", S.hoohle) , ("w", S.wikipedia) ]
Make sure to set firefox to open new pages in a new window instead of
in a new tab:
Firefox -> Edit -> Preferences -> Tabs -> New pages
should be opened in...
Now mod-s + g/h/w prompts you for a search string, then opens a new firefox window that performs the search on Google, Hoogle or Wikipedia respectively.
If you select something in whatever application and hit mod-shift-s + g/h/w it will search the selected string with the specified engine.