Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > da2ed07af0cf0f424d74f4cc6829a27c > files > 991

ghc-ghc-devel-6.12.3-8.6.fc14.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Linker</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Linker.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>ghc-6.12.3: The GHC API</TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Linker</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>The dynamic linker for GHCi.
</P
><P
>This module deals with the top-level issues of dynamic linking,
 calling the object-code linker and the byte-code linker where
 necessary.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AHValue"
>HValue</A
> </TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetHValue"
>getHValue</A
> :: <A HREF="HscTypes.html#t%3AHscEnv"
>HscEnv</A
> -&gt; <A HREF="Name.html#t%3AName"
>Name</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Linker.html#t%3AHValue"
>HValue</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AshowLinkerState"
>showLinkerState</A
> :: <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AlinkExpr"
>linkExpr</A
> :: <A HREF="HscTypes.html#t%3AHscEnv"
>HscEnv</A
> -&gt; <A HREF="SrcLoc.html#t%3ASrcSpan"
>SrcSpan</A
> -&gt; <A HREF="ByteCodeAsm.html#t%3AUnlinkedBCO"
>UnlinkedBCO</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Linker.html#t%3AHValue"
>HValue</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aunload"
>unload</A
> :: <A HREF="DynFlags.html#t%3ADynFlags"
>DynFlags</A
> -&gt; [<A HREF="HscTypes.html#t%3ALinkable"
>Linkable</A
>] -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AwithExtendedLinkEnv"
>withExtendedLinkEnv</A
> :: (<A HREF="MonadUtils.html#t%3AMonadIO"
>MonadIO</A
> m, <A HREF="Exception.html#t%3AExceptionMonad"
>ExceptionMonad</A
> m) =&gt; [(<A HREF="Name.html#t%3AName"
>Name</A
>, <A HREF="Linker.html#t%3AHValue"
>HValue</A
>)] -&gt; m a -&gt; m a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AextendLinkEnv"
>extendLinkEnv</A
> :: [(<A HREF="Name.html#t%3AName"
>Name</A
>, <A HREF="Linker.html#t%3AHValue"
>HValue</A
>)] -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdeleteFromLinkEnv"
>deleteFromLinkEnv</A
> :: [<A HREF="Name.html#t%3AName"
>Name</A
>] -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AextendLoadedPkgs"
>extendLoadedPkgs</A
> :: [<A HREF="Module.html#t%3APackageId"
>PackageId</A
>] -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AlinkPackages"
>linkPackages</A
> :: <A HREF="DynFlags.html#t%3ADynFlags"
>DynFlags</A
> -&gt; [<A HREF="Module.html#t%3APackageId"
>PackageId</A
>] -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AinitDynLinker"
>initDynLinker</A
> :: <A HREF="DynFlags.html#t%3ADynFlags"
>DynFlags</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdataConInfoPtrToName"
>dataConInfoPtrToName</A
> :: <A HREF="../base-4.2.0.2/Foreign-Ptr.html#t%3APtr"
>Ptr</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
> -&gt; <A HREF="TcRnTypes.html#t%3ATcM"
>TcM</A
> (<A HREF="../base-4.2.0.2/Data-Either.html#t%3AEither"
>Either</A
> <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> <A HREF="Name.html#t%3AName"
>Name</A
>)</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:HValue"
><A NAME="t%3AHValue"
></A
></A
><B
>HValue</B
>  </TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:getHValue"
><A NAME="v%3AgetHValue"
></A
></A
><B
>getHValue</B
> :: <A HREF="HscTypes.html#t%3AHscEnv"
>HscEnv</A
> -&gt; <A HREF="Name.html#t%3AName"
>Name</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Linker.html#t%3AHValue"
>HValue</A
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Get the <TT
><A HREF="Linker.html#t%3AHValue"
>HValue</A
></TT
> associated with the given name.
</P
><P
>May cause loading the module that contains the name.
</P
><P
>Throws a <TT
><A HREF="Panic.html#v%3AProgramError"
>ProgramError</A
></TT
> if loading fails or the name cannot be found.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:showLinkerState"
><A NAME="v%3AshowLinkerState"
></A
></A
><B
>showLinkerState</B
> :: <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="doc"
>Display the persistent linker state.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:linkExpr"
><A NAME="v%3AlinkExpr"
></A
></A
><B
>linkExpr</B
> :: <A HREF="HscTypes.html#t%3AHscEnv"
>HscEnv</A
> -&gt; <A HREF="SrcLoc.html#t%3ASrcSpan"
>SrcSpan</A
> -&gt; <A HREF="ByteCodeAsm.html#t%3AUnlinkedBCO"
>UnlinkedBCO</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Linker.html#t%3AHValue"
>HValue</A
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Link a single expression, <EM
>including</EM
> first linking packages and
 modules that this expression depends on.
</P
><P
>Raises an IO exception (<TT
><A HREF="Panic.html#v%3AProgramError"
>ProgramError</A
></TT
>) if it can't find a compiled
 version of the dependents to link.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:unload"
><A NAME="v%3Aunload"
></A
></A
><B
>unload</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="DynFlags.html#t%3ADynFlags"
>DynFlags</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>-&gt; [<A HREF="HscTypes.html#t%3ALinkable"
>Linkable</A
>]</TD
><TD CLASS="rdoc"
>The linkables to *keep*.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
><P
>Unloading old objects ready for a new compilation sweep.
</P
><P
>The compilation manager provides us with a list of linkables that it
 considers &quot;stable&quot;, i.e. won't be recompiled this time around.  For
 each of the modules current linked in memory,
</P
><UL
><LI
> if the linkable is stable (and it's the same one -- the user may have
     recompiled the module on the side), we keep it,
</LI
><LI
> otherwise, we unload it.
</LI
><LI
> we also implicitly unload all temporary bindings at this point.
</LI
></UL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:withExtendedLinkEnv"
><A NAME="v%3AwithExtendedLinkEnv"
></A
></A
><B
>withExtendedLinkEnv</B
> :: (<A HREF="MonadUtils.html#t%3AMonadIO"
>MonadIO</A
> m, <A HREF="Exception.html#t%3AExceptionMonad"
>ExceptionMonad</A
> m) =&gt; [(<A HREF="Name.html#t%3AName"
>Name</A
>, <A HREF="Linker.html#t%3AHValue"
>HValue</A
>)] -&gt; m a -&gt; m a</TD
></TR
><TR
><TD CLASS="doc"
>Temporarily extend the linker state.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:extendLinkEnv"
><A NAME="v%3AextendLinkEnv"
></A
></A
><B
>extendLinkEnv</B
> :: [(<A HREF="Name.html#t%3AName"
>Name</A
>, <A HREF="Linker.html#t%3AHValue"
>HValue</A
>)] -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:deleteFromLinkEnv"
><A NAME="v%3AdeleteFromLinkEnv"
></A
></A
><B
>deleteFromLinkEnv</B
> :: [<A HREF="Name.html#t%3AName"
>Name</A
>] -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:extendLoadedPkgs"
><A NAME="v%3AextendLoadedPkgs"
></A
></A
><B
>extendLoadedPkgs</B
> :: [<A HREF="Module.html#t%3APackageId"
>PackageId</A
>] -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:linkPackages"
><A NAME="v%3AlinkPackages"
></A
></A
><B
>linkPackages</B
> :: <A HREF="DynFlags.html#t%3ADynFlags"
>DynFlags</A
> -&gt; [<A HREF="Module.html#t%3APackageId"
>PackageId</A
>] -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="doc"
>Link exactly the specified packages, and their dependents (unless of
 course they are already linked).  The dependents are linked
 automatically, and it doesn't matter what order you specify the input
 packages.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:initDynLinker"
><A NAME="v%3AinitDynLinker"
></A
></A
><B
>initDynLinker</B
> :: <A HREF="DynFlags.html#t%3ADynFlags"
>DynFlags</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Initialise the dynamic linker.  This entails
</P
><P
>a) Calling the C initialisation procedure,
</P
><P
>b) Loading any packages specified on the command line,
</P
><P
>c) Loading any packages specified on the command line, now held in the
     <TT
>-l</TT
> options in <TT
>v_Opt_l</TT
>,
</P
><P
>d) Loading any <TT
>.o/.dll</TT
> files specified on the command line, now held
     in <TT
>v_Ld_inputs</TT
>,
</P
><P
>e) Loading any MacOS frameworks.
</P
><P
>NOTE: This function is idempotent; if called more than once, it does
 nothing.  This is useful in Template Haskell, where we call it before
 trying to link.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:dataConInfoPtrToName"
><A NAME="v%3AdataConInfoPtrToName"
></A
></A
><B
>dataConInfoPtrToName</B
> :: <A HREF="../base-4.2.0.2/Foreign-Ptr.html#t%3APtr"
>Ptr</A
> <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
> -&gt; <A HREF="TcRnTypes.html#t%3ATcM"
>TcM</A
> (<A HREF="../base-4.2.0.2/Data-Either.html#t%3AEither"
>Either</A
> <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> <A HREF="Name.html#t%3AName"
>Name</A
>)</TD
></TR
><TR
><TD CLASS="doc"
><P
>Given a data constructor in the heap, find its Name.
   The info tables for data constructors have a field which records
   the source name of the constructor as a Ptr Word8 (UTF-8 encoded
   string). The format is:
</P
><PRE
> Package:Module.Name
</PRE
><P
>We use this string to lookup the interpreter's internal representation of the name
   using the lookupOrig.    
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>