BSD3 licensed and maintained by Neil Mitchell

Module documentation for 5.0.10

Hoogle Hackage version Stackage version Linux Build Status Windows Build Status

The development branch for Hoogle version 5. The current released version lives on the hoogle4 branch. For details of the current state and future direction see this blog post.


This page describes how Hoogle 5 might work, and has not yet been fully implemented.


Hoogle is a Haskell API search engine, which allows you to search many standard Haskell libraries by either function name, or by approximate type signature. To experiment, visit the online version at http://haskell.org/hoogle.

  • Online version: https://www.haskell.org/hoogle/
  • Hackage page: https://hackage.haskell.org/package/hoogle
  • Source code: http://github.com/ndmitchell/hoogle
  • Bug tracker: https://github.com/ndmitchell/hoogle/issues

Hoogle Use

Hoogle can be used in several ways:

Searches

Searching

Here are some example searches:

  • map searches as text, finding map, concatMap, mapM
  • con map searches for the text "map" and "con" finding concatMap, but not map
  • a -> a searches by type, finding id :: a -> a
  • a searches for the text "a"
  • :: a searches for the type "a"
  • id :: a -> a searches for the text "id" and the type "a -> a"

Scope

By default, searches look at the Haskell Platform and Haskell keywords. However, all Hackage packages are available to search. As some examples:

  • mode +cmdargs searches only the "cmdargs" package
  • file -base searches the Haskell Platform, excluding the "base" package
  • mode +platform +cmdargs searches both the Haskell Platform and the "cmdargs" package
  • count +missingh searches only the "MissingH" package - all packages are written in lower-case

With the set of packages you are searching, you can also restrict the set of modules searched:

  • file -System excludes results from modules such as System.IO, System.FilePath.Windows and Distribution.System
  • fold +Data.Map finds results in the Data.Map module

Integration

Command Line Version

To invoke Hoogle type:

hoogle "[a] -> [b]"

Note the quotes, otherwise you will redirect the output to the file [b].

To ensure you have data files for the Hackage modules, you will first need to type:

hoogle data

Which will download and build Hoogle databases.

Chrome Integration

As a keyword search: With a keyword search you can type h map directly into the location bar to perform a Hoogle search. Go to the Hoogle website in Chrome, right-click in the Hoogle search field and select "Add as a search engine...". Give it a keyword such as "h".

Firefox Integration

From the search bar: Go to the Hoogle website in Firefox and click on the drop-down arrow at the left of the search bar, and select the "Add Hoogle" option. Click the arrow again to select Hoogle as your search engine.

As a keyword search: With a keyword search you can type h map directly into the location bar to perform a Hoogle search. Go to the Hoogle website in Firefox, right-click in the Hoogle search field and select "Add a Keyword for this Search...". Given it a keyword such as "h".

If you want to search for special symbols in Firefox keyword search, modify the keyword search URL to be: javascript:window.location.href="http://haskell.org/hoogle?q=" + encodeURIComponent("%s")

Firefox Ubiquity Integration

Ubiquity provides a graphical command-line for Firefox. To install the Ubiquity Hoogle command, visit the this page and click "Subscribe..." when asked whether you want to install it. Further information is available here.

The Source Code

$ darcs get http://code.haskell.org/hoogle/

Contributions are most welcome. Hoogle is written in Haskell 98 + Heirarchical Modules, I do not wish to change this. Other than that, I'm pretty flexible about most aspects of Hoogle. The [http://code.google.com/p/ndmitchell/issues/list bug tracker] has many outstanding tasks, but please contact me if you have thoughts on doing something major to Hoogle, so I can give some advice.

Background

Hoogle work is licensed under the GPL version 2.0. Any patches are assumed to be dual licensed under the BSD license and the GPL, to allow re-licensing Hoogle under the BSD license in future, if that proves beneficial to the Haskell community. The work is intended to be helpful, open and free. If the license doesn't meet your needs then talk to me.

Theoretical Foundations

A lot of related work was done by Rittri [1] and Runciman [2] in the late 80's. Since then Di Cosmo [3] has produced a book on type isomorphisms. Unfortunately the implementations that accompanied the earlier works were for functional languages that have since become less popular.

  1. Mikael Rittri, Using Types as Search Keys in Function Libraries. Proceedings of the fourth international conference on Functional Programming languages and Computer Architecture: 174-183, June 1989.
  2. Colin Runciman and Ian Toyn, Retrieving reusable software components by polymorphic type. Journal of Functional Programming 1 (2): 191-211, April 1991.
  3. Roberto Di Cosmo, Isomorphisms of types: from lambda-calculus to information retrieval and language design. Birkhauser, 1995. ISBN-0-8176-3763-X

I have given several presentations on type searching all available from my home page.

Folders

The folders in the distribution, and their meaning are:

data - tools to generate a hoogle data file

docs - documentation on hoogle

misc - presentations, icons, emacs scripts, logos

src - source code

web - additional resources for the web front end (css, jpg etc.)

Similar Tools

I was unaware of any similar tools before starting development, and no other tool has really influenced this tool (except the first on this list). Some related tools are:

  • Google, the leader in online search
  • Hayoo, similar to Hoogle, but with less focus on type search
  • Krugle, search code, but no Haskell :(

Acknowledgements

All code is all © Neil Mitchell, 2004-present. The initial version was done over my summer holiday, and further work was done during my PhD. During Summer 2008 I was funded to full-time on Hoogle by Google Summer of Code with the haskell.org mentoring organisation. Since then I have been working on Hoogle in my spare time. Various people have given lots of useful ideas, including my PhD supervisor Colin Runciman, and various members of the Plasma group. In addition, the following people have also contributed code or significant debugging work:

In previous versions, all the data was taken from Zvon's Haskell Guide. Thanks to their open and friendly policy of allowing the data to be reused, this project became possible. More recent versions use the Hierarchical Libraries as distributed with GHC, and databases generated by Haddock.

Interesting links

  • https://atom.io/packages/haskell-hoogle
  • https://hackage.haskell.org/package/hoogle-index

Changes

Changelog for Hoogle

5.0.10
#205, change how the link URL is computed
#206, put newer versions of a package first
5.0.9
#202, add --haddock functionality
5.0.8
#194, make --local work regardless of code page
5.0.7
#200, make sure the content-type is set properly
5.0.6
#196, make --local look for .cabal files as well
Fix up Frege documentation generation
5.0.5
#193, support multiple --local flags
#195, add --home flag to server mode
Allow haskell-src-exts-1.19
5.0.4
#184, use file URLs for local docs
#183, make --local look for .txt files recursively
5.0.3
#181, use the proper network constraints
Avoid deprecated Aeson modules
5.0.2
Move to haskell-src-exts-1.18
5.0.1
#178, support the --link argument
#178, add module names to results on the command line
#177, require containers 0.5 or above
5.0
#172, make sure --local links work on Linux
#116, store data files in getAppUserDataDirectory by default
G472, be robust to corrupt Hoogle files
G521, make sure it works with inverted color preferences
Rewrite from scratch
4.2.38
#96, allow certicate verification failures
#95, allow a higher version of Cabal on older GHCs
4.2.37
#94, GHC 7.10 support
4.2.36
#85, add support for missing type constructors
4.2.35
Allow haskell-src-exts-1.16
4.2.34
Add defaultDatabaseLocation
4.2.33
Allow WAI-3.0
4.2.32
Allow haskell-src-exts-1.15
4.2.31
#61, support conduit-1.1
4.2.30
#57, support QuickCheck-2.7
4.2.29
#55, if reading as UTF8 fails, explicitly try Latin1
Add QuickCheck as a dependency
Change createDatabase to also save the file
Disable rank feature
Remove running a hoogle query without converting the database
Ignore packages without documentation to hoogle data
4.2.28
Upgrade to shake-0.11
#49, update "hoogle data" to be incremental
4.2.27
Rewrite how "hoogle data" works
#45, if you are building all, also depend on default
#47, switch to using Shake to build the recipes
Add a dependency on Shake
4.2.26
Fix omission of the Test file
4.2.25
Fix timestamps in .tar.gz dist file
4.2.24
Allow WAI 2.0
Fix the Keyword generator
4.2.23
Improvements to Haddock conversion
4.2.22
Download Hoogle data from the old Hackage server
4.2.21
#25, make the tarball pass the tests
#26, GHC 7.8 compatibility
Ensure alias resolution is bottom-up and recursive
4.2.20
#619, do not depend on unix on Windows
4.2.19
Fix version bounds
4.2.18
Allow bytestring-0.9
4.2.17
Upgrade to haskell-src-exts-1.14
Visual redesign
Require bytestring-0.10 or above, due to NFData instances
Add NFData instance to Database
4.2.16
Remove lots of explicit upper bounds
4.2.15
Allow http-types-0.8
Allow case-insensitive-1.0
Support --local for GHC docs
#568, rewrite Haddock links in --local
4.2.14
Switch license from GPL to BSD3
GHC 7.6 fixes
##4, Allow Cabal-1.16.*
4.2.13
Allow cmdargs-0.10.*
4.2.12
Allow conduit-0.5, wai-1.3 and warp-1.3
Upgrade to http-types-0.7.*
In embedded mode, don't hijack the URL bar or title
Upgrade to jQuery 1.7.2
#89, add a format=json output mode
#476, update the URL as you type
Improve iPhone support
Update the copyright year in the footer
Double the speed of hoogle server responses
4.2.11
Allow transformers-0.3
Allow conduit-0.4, wai-1.2 and warp-1.2
Allow haskell-src-exts-1.12 and 1.13
4.2.10
#533, be paranoid when parsing Cabal files
4.2.9
Upgrade to WAI-1.1 and Warp-1.1
#525, don't rely on a redirect to find files
Allow Cabal-1.14
4.2.8
Allow cmdargs-0.9
Fix setting the global read flags and unsetting them properly
Allow case-insensitive-0.4.*
Make data --local have a good default on Linux
Make server --local work on Windows
#407, rewrite OpenSearch plugin to work regardless of the server
4.2.7
Allow cmdargs-0.8
4.2.6
Permit GHC 7.2
Allow case-insensitive-0.3.*
Fix bug when searching for toString in the embed mode
Make --redownload work on the tarballs
4.2.5
Fix hyperlinks to symbols (i.e. &&) in Haddock
4.2.4
#434, use either wget or curl to download the files
Allow haskell-src-exts 1.11.*
Upgrade to cmdargs==0.7.*
4.2.3
Generate database for ghc internals
Give an error if the database is the wrong version
Add -fno-cse, to make cmdargs work (was losing args annotations)
4.2.2
Upgrade to WAI==0.4.* and Warp==0.4.*
Allow parsec 3, since various people have reported it works
Default module URL's correctly when not on Hackage
#417, use proper Haddock parsing for package descriptions
Make sure https: links work through the web mode
Rewrite the binary defer layer, cleaner and slightly faster
Eliminate escaping problems when entering "'s in the search
Some work on #375, add links to the library page
Add --template to override the templates at runtime
Add --dynamic flag to server mode, include update stamps
Upgrade wai and warp, adds an exception handler
#82, rewrite showing document snippets, better expand/collapse
Support <em> tags in Haddock output (as well as <i>)
Make package matching case insensitive
#372, add features to improve module name search
Make module name searching case insensitive
4.2.1
Fix for pattern match failure when searching for "to"
Fix for not sending text/html when serving local files
Eliminate the --nostdin flag, now unnecessary
Change to use WAI/Warp instead of HTTP and custom server
Fix a bug, didn't ever show Waiting... on the real website
Make embed work in IE8
4.2
Make the CGI interface send the right number of newlines
Accept prefix and suffix web parameters
Eliminate isBlankQuery, make Query a Monoid
Make Query abstract, add queryPackages/querySetPackage
Rename querySuggestions/queryCompletions by dropping the query
Add mode=embed support
Add some log analysis features
Ignore some whitespace in the input file
Work around a cabal bug, include jquery.cookie.js
Add ?version=xxx to .css and .js, to make it auto refresh
4.1.5
#399, rehabilitate mode=suggest
Stop mode=suggest failing entirely, now cleanly gives no answers
Combine --web and --webmode
Complete the command line flag help
#327, ensure utf8 is found
#187, ensure LT is found
Use the Hoogle tarball direct from Hackage
#54, rework packages, entries and keywords
#87, make all database files lowercase
Various javascript/ajax enhancements
4.1.4
Running data on Posix sets all files to global read/execute
Relax haskell-src-exts to allow 1.10.1
Rework the web page display further
4.1.3
Read and write all database files in UTF8
#391, add tar -xzf when extracting from the tarball
Change search results display, packages/modules on separate line
Exclude haskellN* from the platform, they are in base
Add --nostdin to server mode, to support running with nohup
Loosen dependencies for tagsoup (typo'd it before)
4.1.2
Loosen dependencies for tagsoup and HTTP (but not parsec)
Avoid self circular dependencies
4.1.1
#195, include all the necessary resources to run as a server
When in server mode, be more robust to errors
4.1
#320, make sure system is found
#146, preserve forall's in everywhere
#186, switch to using haskell-src-exts to parse input files
#249, make sure you find MonadWriter
#235, make sure you find forall
#309, make sure there are links for keywords
#78, add --link flag
#59, operators look nicer, and have blue brackets round them
#352, can now parse ( # ) as a function name in the input
#280, searching for "~ +keyword" should find keyword
#116, fix links for types/classes
#83, all searching for package-name
#94, allow textbases to be used automatically
#92, short flags are now handled by cmdargs, so work
#51, test mode now does what test and testfile did
#66, turn Hoogle into a library
Add --server flag, to run as a server
4.0.7
Start of changelog
comments powered byDisqus