diff options
| author | Edward Z. Yang <ezyang@cs.stanford.edu> | 2014-11-04 02:07:01 -0800 |
|---|---|---|
| committer | Edward Z. Yang <ezyang@cs.stanford.edu> | 2014-11-07 13:42:49 -0800 |
| commit | c942688917e385c02b73811083f647329785f752 (patch) | |
| tree | f5342fbc40978800b0a6544c0f5d1b972b915e55 | |
| parent | b60886891bd8faae066cbf8c5c2da775a049cd88 (diff) | |
| download | haskell-c942688917e385c02b73811083f647329785f752.tar.gz | |
Miscellaneous documentation for the Finder.
Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
| -rw-r--r-- | compiler/main/Finder.lhs | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/compiler/main/Finder.lhs b/compiler/main/Finder.lhs index 12838553cf..189ef50fb6 100644 --- a/compiler/main/Finder.lhs +++ b/compiler/main/Finder.lhs @@ -171,7 +171,12 @@ orIfNotFound this or_this = do _other -> return res2 _other -> return res - +-- | Helper function for 'findHomeModule': this function wraps an IO action +-- which would look up @mod_name@ in the file system (the home package), +-- and first consults the 'hsc_FC' cache to see if the lookup has already +-- been done. Otherwise, do the lookup (with the IO action) and save +-- the result in the finder cache and the module location cache (if it +-- was successful.) homeSearchCache :: HscEnv -> ModuleName -> IO FindResult -> IO FindResult homeSearchCache hsc_env mod_name do_this = do m <- lookupFinderCache (hsc_FC hsc_env) mod_name @@ -234,7 +239,22 @@ uncacheModule hsc_env mod = do -- ----------------------------------------------------------------------------- -- The internal workers --- | Search for a module in the home package only. +-- | Implements the search for a module name in the home package only. Calling +-- this function directly is usually *not* what you want; currently, it's used +-- as a building block for the following operations: +-- +-- 1. When you do a normal package lookup, we first check if the module +-- is available in the home module, before looking it up in the package +-- database. +-- +-- 2. When you have a package qualified import with package name "this", +-- we shortcut to the home module. +-- +-- 3. When we look up an exact 'Module', if the package key associated with +-- the module is the current home module do a look up in the home module. +-- +-- 4. Some special-case code in GHCi (ToDo: Figure out why that needs to +-- call this.) findHomeModule :: HscEnv -> ModuleName -> IO FindResult findHomeModule hsc_env mod_name = homeSearchCache hsc_env mod_name $ |