<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Data/Generics/Biplate.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE MultiParamTypeClasses #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>{- |
<a name="line-4"></a> /RECOMMENDATION/: Use "Data.Generics.Uniplate.Operations" instead.
<a name="line-5"></a>
<a name="line-6"></a> Requires multi-parameter type classes, so is no longer Haskell 98. These operations
<a name="line-7"></a> are easier to use and construct than the equivalent "Data.Generics.UniplateStrOn" methods,
<a name="line-8"></a> but perform the same operation.
<a name="line-9"></a>
<a name="line-10"></a> It is recommended that instead of importing this module, you import one of the following
<a name="line-11"></a> modules, to construct instances:
<a name="line-12"></a>
<a name="line-13"></a> * "Data.Generics.PlateDirect" - does not require overlapping instances, highest performance
<a name="line-14"></a> but requires /O(n^2)/ instances in the worst case.
<a name="line-15"></a>
<a name="line-16"></a> * "Data.Generics.PlateTypeable" - requires the "Data.Typeable" class for all data structures.
<a name="line-17"></a>
<a name="line-18"></a> * "Data.Generics.PlateData" - requires "Data.Generics" and the 'Data' class, which is only
<a name="line-19"></a> available on GHC, but automatically infers instances.
<a name="line-20"></a>-}</span>
<a name="line-21"></a>
<a name="line-22"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Generics</span><span class='hs-varop'>.</span><span class='hs-conid'>Biplate</span><span class='hs-layout'>(</span>
<a name="line-23"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Generics</span><span class='hs-varop'>.</span><span class='hs-conid'>UniplateStrOn</span><span class='hs-layout'>,</span>
<a name="line-24"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Generics</span><span class='hs-varop'>.</span><span class='hs-conid'>Biplate</span>
<a name="line-25"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-26"></a>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Generics</span><span class='hs-varop'>.</span><span class='hs-conid'>UniplateStrOn</span>
<a name="line-28"></a>
<a name="line-29"></a>
<a name="line-30"></a><span class='hs-comment'>-- * The Class</span>
<a name="line-31"></a>
<a name="line-32"></a><a name="Biplate"></a><span class='hs-comment'>-- | Children are defined as the top-most items of type to</span>
<a name="line-33"></a><a name="Biplate"></a><span class='hs-comment'>-- /starting at the root/.</span>
<a name="line-34"></a><a name="Biplate"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>Uniplate</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span> <span class='hs-keyword'>where</span>
<a name="line-35"></a> <span class='hs-varid'>biplate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>BiplateType</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span>
<a name="line-36"></a>
<a name="line-37"></a>
<a name="line-38"></a><a name="biplateList"></a><span class='hs-comment'>-- | Compatibility method, for direct users of the 'biplate' function</span>
<a name="line-39"></a><span class='hs-definition'>biplateList</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>to</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>to</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span><span class='hs-layout'>)</span>
<a name="line-40"></a><span class='hs-definition'>biplateList</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>c</span><span class='hs-layout'>,</span> <span class='hs-varid'>b</span> <span class='hs-varop'>.</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span>
<a name="line-41"></a> <span class='hs-keyword'>where</span>
<a name="line-42"></a> <span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>biplate</span> <span class='hs-varid'>x</span>
<a name="line-43"></a> <span class='hs-layout'>(</span><span class='hs-varid'>c</span><span class='hs-layout'>,</span><span class='hs-varid'>d</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>strStructure</span> <span class='hs-varid'>a</span>
<a name="line-44"></a>
<a name="line-45"></a>
<a name="line-46"></a>
<a name="line-47"></a><span class='hs-comment'>-- * The Operations</span>
<a name="line-48"></a>
<a name="line-49"></a><span class='hs-comment'>-- ** Queries</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="universeBi"></a><span class='hs-definition'>universeBi</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>to</span><span class='hs-keyglyph'>]</span>
<a name="line-52"></a><span class='hs-definition'>universeBi</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>universeOn</span> <span class='hs-varid'>biplate</span>
<a name="line-53"></a>
<a name="line-54"></a>
<a name="line-55"></a><a name="childrenBi"></a><span class='hs-definition'>childrenBi</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>to</span><span class='hs-keyglyph'>]</span>
<a name="line-56"></a><span class='hs-definition'>childrenBi</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>childrenOn</span> <span class='hs-varid'>biplate</span>
<a name="line-57"></a>
<a name="line-58"></a>
<a name="line-59"></a><span class='hs-comment'>-- ** Transformations</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="transformBi"></a><span class='hs-definition'>transformBi</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-varid'>to</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>to</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span>
<a name="line-62"></a><span class='hs-definition'>transformBi</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>transformOn</span> <span class='hs-varid'>biplate</span>
<a name="line-63"></a>
<a name="line-64"></a>
<a name="line-65"></a><a name="transformBiM"></a><span class='hs-definition'>transformBiM</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-varid'>to</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>to</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>from</span>
<a name="line-66"></a><span class='hs-definition'>transformBiM</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>transformOnM</span> <span class='hs-varid'>biplate</span>
<a name="line-67"></a>
<a name="line-68"></a>
<a name="line-69"></a><a name="rewriteBi"></a><span class='hs-definition'>rewriteBi</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-varid'>to</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-varid'>to</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span>
<a name="line-70"></a><span class='hs-definition'>rewriteBi</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rewriteOn</span> <span class='hs-varid'>biplate</span>
<a name="line-71"></a>
<a name="line-72"></a>
<a name="line-73"></a><a name="rewriteBiM"></a><span class='hs-definition'>rewriteBiM</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-varid'>to</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-varid'>to</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>from</span>
<a name="line-74"></a><span class='hs-definition'>rewriteBiM</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rewriteOnM</span> <span class='hs-varid'>biplate</span>
<a name="line-75"></a>
<a name="line-76"></a>
<a name="line-77"></a><a name="descendBi"></a><span class='hs-definition'>descendBi</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-varid'>to</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>to</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span>
<a name="line-78"></a><span class='hs-definition'>descendBi</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>descendOn</span> <span class='hs-varid'>biplate</span>
<a name="line-79"></a>
<a name="line-80"></a>
<a name="line-81"></a><a name="descendBiM"></a><span class='hs-definition'>descendBiM</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-varid'>to</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>to</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>from</span>
<a name="line-82"></a><span class='hs-definition'>descendBiM</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>descendOnM</span> <span class='hs-varid'>biplate</span>
<a name="line-83"></a>
<a name="line-84"></a>
<a name="line-85"></a><span class='hs-comment'>-- ** Others</span>
<a name="line-86"></a>
<a name="line-87"></a><a name="contextsBi"></a><span class='hs-definition'>contextsBi</span><span class='hs-keyglyph'>::</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>to</span><span class='hs-layout'>,</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-88"></a><span class='hs-definition'>contextsBi</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>contextsOn</span> <span class='hs-varid'>biplate</span>
<a name="line-89"></a>
<a name="line-90"></a>
<a name="line-91"></a><a name="holesBi"></a><span class='hs-definition'>holesBi</span><span class='hs-keyglyph'>::</span> <span class='hs-conid'>Biplate</span> <span class='hs-varid'>from</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>from</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>to</span><span class='hs-layout'>,</span> <span class='hs-varid'>to</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>from</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-92"></a><span class='hs-definition'>holesBi</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>holesOn</span> <span class='hs-varid'>biplate</span>
</pre></body>
</html>
