<!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>Annotations</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_Annotations.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">Annotations</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Main Annotation data types
</a></li><li><a href="#g:2">AnnEnv for collecting and querying Annotations
</a></li></ul></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"><span class="keyword">data</span> <a href="#t:Annotation">Annotation</a> = <a href="#v:Annotation">Annotation</a> {<ul class="subs"><li><a href="#v:ann_target">ann_target</a> :: <a href="Annotations.html#t:CoreAnnTarget">CoreAnnTarget</a></li><li><a href="#v:ann_value">ann_value</a> :: <a href="Serialized.html#t:Serialized">Serialized</a></li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:AnnTarget">AnnTarget</a> name<ul class="subs"><li>= <a href="#v:NamedTarget">NamedTarget</a> name </li><li>| <a href="#v:ModuleTarget">ModuleTarget</a> <a href="Module.html#t:Module">Module</a> </li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:CoreAnnTarget">CoreAnnTarget</a> = <a href="Annotations.html#t:AnnTarget">AnnTarget</a> <a href="Name.html#t:Name">Name</a></li><li class="src short"><a href="#v:getAnnTargetName_maybe">getAnnTargetName_maybe</a> :: <a href="Annotations.html#t:AnnTarget">AnnTarget</a> name -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> name</li><li class="src short"><span class="keyword">data</span> <a href="#t:AnnEnv">AnnEnv</a> </li><li class="src short"><a href="#v:mkAnnEnv">mkAnnEnv</a> :: [<a href="Annotations.html#t:Annotation">Annotation</a>] -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a></li><li class="src short"><a href="#v:extendAnnEnvList">extendAnnEnvList</a> :: <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> [<a href="Annotations.html#t:Annotation">Annotation</a>] -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a></li><li class="src short"><a href="#v:plusAnnEnv">plusAnnEnv</a> :: <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a></li><li class="src short"><a href="#v:emptyAnnEnv">emptyAnnEnv</a> :: <a href="Annotations.html#t:AnnEnv">AnnEnv</a></li><li class="src short"><a href="#v:findAnns">findAnns</a> :: <a href="../base-4.5.1.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> a => ([<a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a>] -> a) -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> <a href="Annotations.html#t:CoreAnnTarget">CoreAnnTarget</a> -> [a]</li><li class="src short"><a href="#v:deserializeAnns">deserializeAnns</a> :: <a href="../base-4.5.1.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> a => ([<a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a>] -> a) -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> <a href="UniqFM.html#t:UniqFM">UniqFM</a> [a]</li></ul></div><div id="interface"><h1 id="g:1">Main Annotation data types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Annotation" class="def">Annotation</a> </p><div class="doc"><p>Represents an annotation after it has been sufficiently desugared from
it's initial form of <code><a href="HsDecls.html#t:AnnDecl">AnnDecl</a></code>
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Annotation" class="def">Annotation</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:ann_target" class="def">ann_target</a> :: <a href="Annotations.html#t:CoreAnnTarget">CoreAnnTarget</a></dt><dd class="doc"><p>The target of the annotation
</p></dd><dt class="src"><a name="v:ann_value" class="def">ann_value</a> :: <a href="Serialized.html#t:Serialized">Serialized</a></dt><dd class="doc"><p><code><a href="Serialized.html#t:Serialized">Serialized</a></code> version of the annotation that
allows recovery of its value or can
be persisted to an interface file
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:Annotation" class="caption collapser" onclick="toggleSection('i:Annotation')">Instances</p><div id="section.i:Annotation" class="show"><table><tr><td class="src"><a href="Outputable.html#t:Outputable">Outputable</a> <a href="Annotations.html#t:Annotation">Annotation</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:AnnTarget" class="def">AnnTarget</a> name </p><div class="doc"><p>An annotation target
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:NamedTarget" class="def">NamedTarget</a> name</td><td class="doc"><p>We are annotating something with a name:
a type or identifier
</p></td></tr><tr><td class="src"><a name="v:ModuleTarget" class="def">ModuleTarget</a> <a href="Module.html#t:Module">Module</a></td><td class="doc"><p>We are annotating a particular module
</p></td></tr></table></div><div class="subs instances"><p id="control.i:AnnTarget" class="caption collapser" onclick="toggleSection('i:AnnTarget')">Instances</p><div id="section.i:AnnTarget" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Control-Monad.html#t:Functor">Functor</a> <a href="Annotations.html#t:AnnTarget">AnnTarget</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Outputable.html#t:Outputable">Outputable</a> name => <a href="Outputable.html#t:Outputable">Outputable</a> (<a href="Annotations.html#t:AnnTarget">AnnTarget</a> name)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Unique.html#t:Uniquable">Uniquable</a> name => <a href="Unique.html#t:Uniquable">Uniquable</a> (<a href="Annotations.html#t:AnnTarget">AnnTarget</a> name)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Binary.html#t:Binary">Binary</a> name => <a href="Binary.html#t:Binary">Binary</a> (<a href="Annotations.html#t:AnnTarget">AnnTarget</a> name)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:CoreAnnTarget" class="def">CoreAnnTarget</a> = <a href="Annotations.html#t:AnnTarget">AnnTarget</a> <a href="Name.html#t:Name">Name</a></p><div class="doc"><p>The kind of annotation target found in the middle end of the compiler
</p></div></div><div class="top"><p class="src"><a name="v:getAnnTargetName_maybe" class="def">getAnnTargetName_maybe</a> :: <a href="Annotations.html#t:AnnTarget">AnnTarget</a> name -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> name</p></div><h1 id="g:2">AnnEnv for collecting and querying Annotations
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:AnnEnv" class="def">AnnEnv</a> </p><div class="doc"><p>A collection of annotations
</p></div></div><div class="top"><p class="src"><a name="v:mkAnnEnv" class="def">mkAnnEnv</a> :: [<a href="Annotations.html#t:Annotation">Annotation</a>] -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a></p></div><div class="top"><p class="src"><a name="v:extendAnnEnvList" class="def">extendAnnEnvList</a> :: <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> [<a href="Annotations.html#t:Annotation">Annotation</a>] -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a></p></div><div class="top"><p class="src"><a name="v:plusAnnEnv" class="def">plusAnnEnv</a> :: <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a></p></div><div class="top"><p class="src"><a name="v:emptyAnnEnv" class="def">emptyAnnEnv</a> :: <a href="Annotations.html#t:AnnEnv">AnnEnv</a></p></div><div class="top"><p class="src"><a name="v:findAnns" class="def">findAnns</a> :: <a href="../base-4.5.1.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> a => ([<a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a>] -> a) -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> <a href="Annotations.html#t:CoreAnnTarget">CoreAnnTarget</a> -> [a]</p><div class="doc"><p>Find the annotations attached to the given target as <code><a href="../base-4.5.1.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a></code>
values of your choice. If no deserializer is specified,
only transient annotations will be returned.
</p></div></div><div class="top"><p class="src"><a name="v:deserializeAnns" class="def">deserializeAnns</a> :: <a href="../base-4.5.1.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> a => ([<a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a>] -> a) -> <a href="Annotations.html#t:AnnEnv">AnnEnv</a> -> <a href="UniqFM.html#t:UniqFM">UniqFM</a> [a]</p><div class="doc"><p>Deserialize all annotations of a given type. This happens lazily, that is
no deserialization will take place until the [a] is actually demanded and
the [a] can also be empty (the UniqFM is not filtered).
</p></div></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
>
2759
