<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Finder</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Finder.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">ghc-7.4.2: The GHC API</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Finder</p></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:flushFinderCaches">flushFinderCaches</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><span class="keyword">data</span> <a href="#t:FindResult">FindResult</a> <ul class="subs"><li>= <a href="#v:Found">Found</a> <a href="Module.html#t:ModLocation">ModLocation</a> <a href="Module.html#t:Module">Module</a> </li><li>| <a href="#v:NoPackage">NoPackage</a> <a href="Module.html#t:PackageId">PackageId</a> </li><li>| <a href="#v:FoundMultiple">FoundMultiple</a> [<a href="Module.html#t:PackageId">PackageId</a>] </li><li>| <a href="#v:NotFound">NotFound</a> { <ul class="subs"><li><a href="#v:fr_paths">fr_paths</a> :: [<a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>]</li><li><a href="#v:fr_pkg">fr_pkg</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Module.html#t:PackageId">PackageId</a></li><li><a href="#v:fr_mods_hidden">fr_mods_hidden</a> :: [<a href="Module.html#t:PackageId">PackageId</a>]</li><li><a href="#v:fr_pkgs_hidden">fr_pkgs_hidden</a> :: [<a href="Module.html#t:PackageId">PackageId</a>]</li><li><a href="#v:fr_suggestions">fr_suggestions</a> :: [<a href="Module.html#t:Module">Module</a>]</li></ul> }</li></ul></li><li class="src short"><a href="#v:findImportedModule">findImportedModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="FastString.html#t:FastString">FastString</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Finder.html#t:FindResult">FindResult</a></li><li class="src short"><a href="#v:findExactModule">findExactModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:Module">Module</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Finder.html#t:FindResult">FindResult</a></li><li class="src short"><a href="#v:findHomeModule">findHomeModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Finder.html#t:FindResult">FindResult</a></li><li class="src short"><a href="#v:findExposedPackageModule">findExposedPackageModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="FastString.html#t:FastString">FastString</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Finder.html#t:FindResult">FindResult</a></li><li class="src short"><a href="#v:mkHomeModLocation">mkHomeModLocation</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Module.html#t:ModLocation">ModLocation</a></li><li class="src short"><a href="#v:mkHomeModLocation2">mkHomeModLocation2</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Module.html#t:ModLocation">ModLocation</a></li><li class="src short"><a href="#v:mkHiOnlyModLocation">mkHiOnlyModLocation</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Util.html#t:Suffix">Suffix</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Module.html#t:ModLocation">ModLocation</a></li><li class="src short"><a href="#v:addHomeModuleToFinder">addHomeModuleToFinder</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="Module.html#t:ModLocation">ModLocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Module.html#t:Module">Module</a></li><li class="src short"><a href="#v:uncacheModule">uncacheModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:mkStubPaths">mkStubPaths</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="Module.html#t:ModLocation">ModLocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></li><li class="src short"><a href="#v:findObjectLinkableMaybe">findObjectLinkableMaybe</a> :: <a href="Module.html#t:Module">Module</a> -> <a href="Module.html#t:ModLocation">ModLocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="HscTypes.html#t:Linkable">Linkable</a>)</li><li class="src short"><a href="#v:findObjectLinkable">findObjectLinkable</a> :: <a href="Module.html#t:Module">Module</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../old-time-1.1.0.0/System-Time.html#t:ClockTime">ClockTime</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="HscTypes.html#t:Linkable">Linkable</a></li><li class="src short"><a href="#v:cannotFindModule">cannotFindModule</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="Finder.html#t:FindResult">FindResult</a> -> <a href="Outputable.html#t:SDoc">SDoc</a></li><li class="src short"><a href="#v:cannotFindInterface">cannotFindInterface</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="Finder.html#t:FindResult">FindResult</a> -> <a href="Outputable.html#t:SDoc">SDoc</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:flushFinderCaches" class="def">flushFinderCaches</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:FindResult" class="def">FindResult</a> </p><div class="doc"><p>The result of searching for an imported module.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Found" class="def">Found</a> <a href="Module.html#t:ModLocation">ModLocation</a> <a href="Module.html#t:Module">Module</a></td><td class="doc"><p>The module was found
</p></td></tr><tr><td class="src"><a name="v:NoPackage" class="def">NoPackage</a> <a href="Module.html#t:PackageId">PackageId</a></td><td class="doc"><p>The requested package was not found
</p></td></tr><tr><td class="src"><a name="v:FoundMultiple" class="def">FoundMultiple</a> [<a href="Module.html#t:PackageId">PackageId</a>]</td><td class="doc"><p>_Error_: both in multiple packages
</p></td></tr><tr><td class="src"><a name="v:NotFound" class="def">NotFound</a></td><td class="doc"><p>Not found
</p></td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:fr_paths" class="def">fr_paths</a> :: [<a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:fr_pkg" class="def">fr_pkg</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Module.html#t:PackageId">PackageId</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:fr_mods_hidden" class="def">fr_mods_hidden</a> :: [<a href="Module.html#t:PackageId">PackageId</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:fr_pkgs_hidden" class="def">fr_pkgs_hidden</a> :: [<a href="Module.html#t:PackageId">PackageId</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:fr_suggestions" class="def">fr_suggestions</a> :: [<a href="Module.html#t:Module">Module</a>]</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:findImportedModule" class="def">findImportedModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="FastString.html#t:FastString">FastString</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Finder.html#t:FindResult">FindResult</a></p><div class="doc"><p>Locate a module that was imported by the user. We have the
module's name, and possibly a package name. Without a package
name, this function will use the search path and the known exposed
packages to find the module, if a package is specified then only
that package is searched for the module.
</p></div></div><div class="top"><p class="src"><a name="v:findExactModule" class="def">findExactModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:Module">Module</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Finder.html#t:FindResult">FindResult</a></p><div class="doc"><p>Locate a specific <code><a href="Module.html#t:Module">Module</a></code>. The purpose of this function is to
create a <code><a href="Module.html#t:ModLocation">ModLocation</a></code> for a given <code><a href="Module.html#t:Module">Module</a></code>, that is to find out
where the files associated with this module live. It is used when
reading the interface for a module mentioned by another interface,
for example (a <a href="system import.html">system import</a>).
</p></div></div><div class="top"><p class="src"><a name="v:findHomeModule" class="def">findHomeModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Finder.html#t:FindResult">FindResult</a></p><div class="doc"><p>Search for a module in the home package only.
</p></div></div><div class="top"><p class="src"><a name="v:findExposedPackageModule" class="def">findExposedPackageModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="FastString.html#t:FastString">FastString</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Finder.html#t:FindResult">FindResult</a></p></div><div class="top"><p class="src"><a name="v:mkHomeModLocation" class="def">mkHomeModLocation</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Module.html#t:ModLocation">ModLocation</a></p></div><div class="top"><p class="src"><a name="v:mkHomeModLocation2" class="def">mkHomeModLocation2</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Module.html#t:ModLocation">ModLocation</a></p></div><div class="top"><p class="src"><a name="v:mkHiOnlyModLocation" class="def">mkHiOnlyModLocation</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Util.html#t:Suffix">Suffix</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Module.html#t:ModLocation">ModLocation</a></p></div><div class="top"><p class="src"><a name="v:addHomeModuleToFinder" class="def">addHomeModuleToFinder</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="Module.html#t:ModLocation">ModLocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Module.html#t:Module">Module</a></p></div><div class="top"><p class="src"><a name="v:uncacheModule" class="def">uncacheModule</a> :: <a href="HscTypes.html#t:HscEnv">HscEnv</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:mkStubPaths" class="def">mkStubPaths</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="Module.html#t:ModLocation">ModLocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></p></div><div class="top"><p class="src"><a name="v:findObjectLinkableMaybe" class="def">findObjectLinkableMaybe</a> :: <a href="Module.html#t:Module">Module</a> -> <a href="Module.html#t:ModLocation">ModLocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="HscTypes.html#t:Linkable">Linkable</a>)</p></div><div class="top"><p class="src"><a name="v:findObjectLinkable" class="def">findObjectLinkable</a> :: <a href="Module.html#t:Module">Module</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../old-time-1.1.0.0/System-Time.html#t:ClockTime">ClockTime</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="HscTypes.html#t:Linkable">Linkable</a></p></div><div class="top"><p class="src"><a name="v:cannotFindModule" class="def">cannotFindModule</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="Finder.html#t:FindResult">FindResult</a> -> <a href="Outputable.html#t:SDoc">SDoc</a></p></div><div class="top"><p class="src"><a name="v:cannotFindInterface" class="def">cannotFindInterface</a> :: <a href="DynFlags.html#t:DynFlags">DynFlags</a> -> <a href="Module.html#t:ModuleName">ModuleName</a> -> <a href="Finder.html#t:FindResult">FindResult</a> -> <a href="Outputable.html#t:SDoc">SDoc</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
6e204a966e8c42d976f99a1700ce5f20
>
files
>
2878
