/usr/share/doc/libghc-hspec-core-doc/html/src/Test-Hspec-Core-Tree.html is in libghc-hspec-core-doc 2.2.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 | <?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://code.haskell.org/~malcolm/hscolour/ -->
<title>src/Test/Hspec/Core/Tree.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE DeriveFunctor #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-4"></a><span class='hs-cpp'>#if MIN_VERSION_base(4,8,1)</span>
<a name="line-5"></a><span class='hs-cpp'>#define HAS_SOURCE_LOCATIONS</span>
<a name="line-6"></a><span class='hs-comment'>{-# LANGUAGE ImplicitParams #-}</span>
<a name="line-7"></a><span class='hs-cpp'>#endif</span>
<a name="line-8"></a>
<a name="line-9"></a><span class='hs-comment'>-- |</span>
<a name="line-10"></a><span class='hs-comment'>-- Stability: unstable</span>
<a name="line-11"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Tree</span> <span class='hs-layout'>(</span>
<a name="line-12"></a> <span class='hs-conid'>SpecTree</span>
<a name="line-13"></a><span class='hs-layout'>,</span> <span class='hs-conid'>Tree</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-14"></a><span class='hs-layout'>,</span> <span class='hs-conid'>Item</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-15"></a><span class='hs-layout'>,</span> <span class='hs-varid'>specGroup</span>
<a name="line-16"></a><span class='hs-layout'>,</span> <span class='hs-varid'>specItem</span>
<a name="line-17"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-18"></a>
<a name="line-19"></a><span class='hs-cpp'>#ifdef HAS_SOURCE_LOCATIONS</span>
<a name="line-20"></a><span class='hs-cpp'>#if !MIN_VERSION_base(4,9,0)</span>
<a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>SrcLoc</span>
<a name="line-22"></a><span class='hs-cpp'>#endif</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Stack</span>
<a name="line-24"></a><span class='hs-cpp'>#endif</span>
<a name="line-25"></a>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Prelude</span> <span class='hs-conid'>()</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Compat</span>
<a name="line-28"></a>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Example</span>
<a name="line-30"></a>
<a name="line-31"></a><a name="Tree"></a><span class='hs-comment'>-- | Internal tree data structure</span>
<a name="line-32"></a><a name="Tree"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Tree</span> <span class='hs-varid'>c</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span>
<a name="line-33"></a> <span class='hs-conid'>Node</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Tree</span> <span class='hs-varid'>c</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span>
<a name="line-34"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Tree</span> <span class='hs-varid'>c</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span>
<a name="line-35"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Leaf</span> <span class='hs-varid'>a</span>
<a name="line-36"></a> <span class='hs-keyword'>deriving</span> <span class='hs-conid'>Functor</span>
<a name="line-37"></a>
<a name="line-38"></a><a name="instance%20Foldable%20(Tree%20c)"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Foldable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Tree</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <span class='hs-comment'>-- Note: GHC 7.0.1 fails to derive this instance</span>
<a name="line-39"></a> <span class='hs-varid'>foldMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>go</span>
<a name="line-40"></a> <span class='hs-keyword'>where</span>
<a name="line-41"></a> <span class='hs-varid'>go</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Monoid</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Tree</span> <span class='hs-varid'>c</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span>
<a name="line-42"></a> <span class='hs-varid'>go</span> <span class='hs-varid'>f</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>t</span> <span class='hs-keyword'>of</span>
<a name="line-43"></a> <span class='hs-conid'>Node</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>foldMap</span> <span class='hs-layout'>(</span><span class='hs-varid'>foldMap</span> <span class='hs-varid'>f</span><span class='hs-layout'>)</span> <span class='hs-varid'>xs</span>
<a name="line-44"></a> <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>foldMap</span> <span class='hs-layout'>(</span><span class='hs-varid'>foldMap</span> <span class='hs-varid'>f</span><span class='hs-layout'>)</span> <span class='hs-varid'>xs</span>
<a name="line-45"></a> <span class='hs-conid'>Leaf</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>f</span> <span class='hs-varid'>x</span>
<a name="line-46"></a>
<a name="line-47"></a><a name="instance%20Traversable%20(Tree%20c)"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Traversable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Tree</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <span class='hs-comment'>-- Note: GHC 7.0.1 fails to derive this instance</span>
<a name="line-48"></a> <span class='hs-varid'>sequenceA</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>go</span>
<a name="line-49"></a> <span class='hs-keyword'>where</span>
<a name="line-50"></a> <span class='hs-varid'>go</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Applicative</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Tree</span> <span class='hs-varid'>c</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>f</span> <span class='hs-layout'>(</span><span class='hs-conid'>Tree</span> <span class='hs-varid'>c</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-51"></a> <span class='hs-varid'>go</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>t</span> <span class='hs-keyword'>of</span>
<a name="line-52"></a> <span class='hs-conid'>Node</span> <span class='hs-varid'>label</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Node</span> <span class='hs-varid'>label</span> <span class='hs-varop'><$></span> <span class='hs-varid'>sequenceA</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>go</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-53"></a> <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-varid'>action</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-varid'>action</span> <span class='hs-varop'><$></span> <span class='hs-varid'>sequenceA</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>go</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-54"></a> <span class='hs-conid'>Leaf</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Leaf</span> <span class='hs-varop'><$></span> <span class='hs-varid'>a</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="SpecTree"></a><span class='hs-comment'>-- | A tree is used to represent a spec internally. The tree is parametrize</span>
<a name="line-57"></a><a name="SpecTree"></a><span class='hs-comment'>-- over the type of cleanup actions and the type of the actual spec items.</span>
<a name="line-58"></a><a name="SpecTree"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Tree</span> <span class='hs-layout'>(</span><span class='hs-conid'>ActionWith</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Item</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-59"></a>
<a name="line-60"></a><a name="Item"></a><span class='hs-comment'>-- |</span>
<a name="line-61"></a><a name="Item"></a><span class='hs-comment'>-- @Item@ is used to represent spec items internally. A spec item consists of:</span>
<a name="line-62"></a><a name="Item"></a><span class='hs-comment'>--</span>
<a name="line-63"></a><a name="Item"></a><span class='hs-comment'>-- * a textual description of a desired behavior</span>
<a name="line-64"></a><a name="Item"></a><span class='hs-comment'>-- * an example for that behavior</span>
<a name="line-65"></a><a name="Item"></a><span class='hs-comment'>-- * additional meta information</span>
<a name="line-66"></a><a name="Item"></a><span class='hs-comment'>--</span>
<a name="line-67"></a><a name="Item"></a><span class='hs-comment'>-- Everything that is an instance of the `Example` type class can be used as an</span>
<a name="line-68"></a><a name="Item"></a><span class='hs-comment'>-- example, including QuickCheck properties, Hspec expectations and HUnit</span>
<a name="line-69"></a><a name="Item"></a><span class='hs-comment'>-- assertions.</span>
<a name="line-70"></a><a name="Item"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Item</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Item</span> <span class='hs-layout'>{</span>
<a name="line-71"></a> <span class='hs-comment'>-- | Textual description of behavior</span>
<a name="line-72"></a> <span class='hs-varid'>itemRequirement</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-73"></a> <span class='hs-comment'>-- | Source location of the spec item</span>
<a name="line-74"></a><span class='hs-layout'>,</span> <span class='hs-varid'>itemLocation</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Location</span>
<a name="line-75"></a> <span class='hs-comment'>-- | A flag that indicates whether it is safe to evaluate this spec item in</span>
<a name="line-76"></a> <span class='hs-comment'>-- parallel with other spec items</span>
<a name="line-77"></a><span class='hs-layout'>,</span> <span class='hs-varid'>itemIsParallelizable</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span>
<a name="line-78"></a> <span class='hs-comment'>-- | Example for behavior</span>
<a name="line-79"></a><span class='hs-layout'>,</span> <span class='hs-varid'>itemExample</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Params</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>ActionWith</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ProgressCallback</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Result</span>
<a name="line-80"></a><span class='hs-layout'>}</span>
<a name="line-81"></a>
<a name="line-82"></a><a name="specGroup"></a><span class='hs-comment'>-- | The @specGroup@ function combines a list of specs into a larger spec.</span>
<a name="line-83"></a><span class='hs-definition'>specGroup</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span>
<a name="line-84"></a><span class='hs-definition'>specGroup</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Node</span> <span class='hs-varid'>msg</span>
<a name="line-85"></a> <span class='hs-keyword'>where</span>
<a name="line-86"></a> <span class='hs-varid'>msg</span>
<a name="line-87"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>null</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"(no description given)"</span>
<a name="line-88"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>s</span>
<a name="line-89"></a>
<a name="line-90"></a><span class='hs-comment'>-- | The @specItem@ function creates a spec item.</span>
<a name="line-91"></a><span class='hs-cpp'>#ifdef HAS_SOURCE_LOCATIONS</span>
<a name="line-92"></a><a name="specItem"></a><span class='hs-definition'>specItem</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varop'>?</span><span class='hs-varid'>loc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CallStack</span><span class='hs-layout'>,</span> <span class='hs-conid'>Example</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecTree</span> <span class='hs-layout'>(</span><span class='hs-conid'>Arg</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-93"></a><span class='hs-cpp'>#else</span>
<a name="line-94"></a><span class='hs-definition'>specItem</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Example</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SpecTree</span> <span class='hs-layout'>(</span><span class='hs-conid'>Arg</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-95"></a><span class='hs-cpp'>#endif</span>
<a name="line-96"></a><span class='hs-definition'>specItem</span> <span class='hs-varid'>s</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Leaf</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Item</span> <span class='hs-varid'>requirement</span> <span class='hs-varid'>location</span> <span class='hs-conid'>False</span> <span class='hs-layout'>(</span><span class='hs-varid'>evaluateExample</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span>
<a name="line-97"></a> <span class='hs-keyword'>where</span>
<a name="line-98"></a> <span class='hs-varid'>requirement</span>
<a name="line-99"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>null</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"(unspecified behavior)"</span>
<a name="line-100"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>s</span>
<a name="line-101"></a>
<a name="line-102"></a> <span class='hs-varid'>location</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Location</span>
<a name="line-103"></a><span class='hs-cpp'>#ifdef HAS_SOURCE_LOCATIONS</span>
<a name="line-104"></a> <span class='hs-varid'>location</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>reverse</span> <span class='hs-layout'>(</span><span class='hs-varid'>getCallStack</span> <span class='hs-varop'>?</span><span class='hs-varid'>loc</span><span class='hs-layout'>)</span> <span class='hs-keyword'>of</span>
<a name="line-105"></a> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>loc</span><span class='hs-layout'>)</span> <span class='hs-conop'>:</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-conid'>Location</span> <span class='hs-layout'>(</span><span class='hs-varid'>srcLocFile</span> <span class='hs-varid'>loc</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>srcLocStartLine</span> <span class='hs-varid'>loc</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>srcLocStartCol</span> <span class='hs-varid'>loc</span><span class='hs-layout'>)</span> <span class='hs-conid'>ExactLocation</span><span class='hs-layout'>)</span>
<a name="line-106"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Nothing</span>
<a name="line-107"></a><span class='hs-cpp'>#else</span>
<a name="line-108"></a> <span class='hs-varid'>location</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Nothing</span>
<a name="line-109"></a><span class='hs-cpp'>#endif</span>
</pre></body>
</html>
|