This file is indexed.

/usr/share/doc/libghc-configfile-doc/html/src/Data-ConfigFile-Monadic.html is in libghc-configfile-doc 1.1.4-4build3.

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
<?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/Data/ConfigFile/Monadic.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ConfigFile</span><span class='hs-varop'>.</span><span class='hs-conid'>Monadic</span> <span class='hs-layout'>(</span>
<a name="line-2"></a>  <span class='hs-comment'>-- * Overview</span>
<a name="line-3"></a>  <span class='hs-comment'>-- $overview</span>
<a name="line-4"></a>  
<a name="line-5"></a>  <span class='hs-keyword'>module</span> <span class='hs-conid'>Reexporting</span><span class='hs-layout'>,</span>
<a name="line-6"></a>  <span class='hs-varid'>simpleAccess</span><span class='hs-layout'>,</span>
<a name="line-7"></a>  <span class='hs-varid'>interpolatingAccess</span><span class='hs-layout'>,</span>
<a name="line-8"></a>  <span class='hs-varid'>readfile</span><span class='hs-layout'>,</span> <span class='hs-varid'>readhandle</span><span class='hs-layout'>,</span> <span class='hs-varid'>readstring</span><span class='hs-layout'>,</span>
<a name="line-9"></a>  <span class='hs-varid'>has_section</span><span class='hs-layout'>,</span> <span class='hs-varid'>options</span><span class='hs-layout'>,</span> <span class='hs-varid'>has_option</span><span class='hs-layout'>,</span> <span class='hs-varid'>items</span><span class='hs-layout'>,</span>
<a name="line-10"></a>  <span class='hs-varid'>set</span><span class='hs-layout'>,</span> <span class='hs-varid'>setshow</span><span class='hs-layout'>,</span> <span class='hs-varid'>remove_option</span><span class='hs-layout'>,</span> <span class='hs-varid'>add_section</span><span class='hs-layout'>,</span> <span class='hs-varid'>remove_section</span>
<a name="line-11"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-12"></a>
<a name="line-13"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Error</span>
<a name="line-14"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-layout'>(</span><span class='hs-conid'>Handle</span><span class='hs-layout'>)</span>
<a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ConfigFile</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Reexporting</span> <span class='hs-layout'>(</span><span class='hs-conid'>SectionSpec</span><span class='hs-layout'>,</span> <span class='hs-conid'>OptionSpec</span><span class='hs-layout'>,</span> <span class='hs-conid'>ConfigParser</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-16"></a>                                  <span class='hs-conid'>CPErrorData</span><span class='hs-layout'>,</span> <span class='hs-conid'>CPError</span><span class='hs-layout'>,</span> <span class='hs-varid'>emptyCP</span><span class='hs-layout'>,</span> <span class='hs-conid'>Get_C</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>sections</span><span class='hs-layout'>,</span> <span class='hs-varid'>merge</span><span class='hs-layout'>,</span> <span class='hs-varid'>to_string</span><span class='hs-layout'>)</span>
<a name="line-17"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ConfigFile</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>C</span>
<a name="line-18"></a>
<a name="line-19"></a><span class='hs-comment'>{- $overview
<a name="line-20"></a>This module reexports a slightly different version of the standard API which makes it more convenient for chaining monadically.  Everywhere a 'ConfigParser' was the first argument in a function in the standard API, it is now the last.  This lets you rewrite 
<a name="line-21"></a>
<a name="line-22"></a>&gt; do let cp = emptyCP
<a name="line-23"></a>&gt;    cp &lt;- add_section cp "sect1"
<a name="line-24"></a>&gt;    cp &lt;- set cp "sect1" "opt1" "foo"
<a name="line-25"></a>&gt;    cp &lt;- set cp "sect1" "opt2" "bar"
<a name="line-26"></a>&gt;    options cp "sect1"
<a name="line-27"></a>
<a name="line-28"></a>as
<a name="line-29"></a>
<a name="line-30"></a>&gt; return emptyCP &gt;&gt;=
<a name="line-31"></a>&gt;  add_section "sect1" &gt;&gt;=
<a name="line-32"></a>&gt;  set "sect1" "opt1" "foo" &gt;&gt;=
<a name="line-33"></a>&gt;  set "sect1" "opt2" "bar" &gt;&gt;=
<a name="line-34"></a>&gt;  options "sect1"
<a name="line-35"></a>
<a name="line-36"></a>which may be more elegant in some cases.  A future development might be to chain the 'ConfigParser' implicitly with a state monad, which would be yet more elegant.
<a name="line-37"></a>
<a name="line-38"></a>-}</span>
<a name="line-39"></a>
<a name="line-40"></a><a name="simpleAccess"></a><span class='hs-definition'>simpleAccess</span> <span class='hs-keyglyph'>::</span>  <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-41"></a>                 <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-conid'>String</span>
<a name="line-42"></a><span class='hs-definition'>simpleAccess</span> <span class='hs-varid'>s</span> <span class='hs-varid'>o</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>simpleAccess</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span> <span class='hs-varid'>o</span>
<a name="line-43"></a>
<a name="line-44"></a><a name="interpolatingAccess"></a><span class='hs-definition'>interpolatingAccess</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-45"></a>                       <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-46"></a>                       <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span>
<a name="line-47"></a>                       <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-conid'>String</span>
<a name="line-48"></a><span class='hs-definition'>interpolatingAccess</span> <span class='hs-varid'>maxdepth</span> <span class='hs-varid'>s</span> <span class='hs-varid'>o</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>interpolatingAccess</span> <span class='hs-varid'>maxdepth</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span> <span class='hs-varid'>o</span>
<a name="line-49"></a>
<a name="line-50"></a><a name="readfile"></a><span class='hs-definition'>readfile</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-varid'>m</span> <span class='hs-conid'>ConfigParser</span><span class='hs-layout'>)</span>
<a name="line-51"></a><span class='hs-definition'>readfile</span> <span class='hs-varid'>fp</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>readfile</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>fp</span>
<a name="line-52"></a>
<a name="line-53"></a><a name="readhandle"></a><span class='hs-definition'>readhandle</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Handle</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-varid'>m</span> <span class='hs-conid'>ConfigParser</span><span class='hs-layout'>)</span>
<a name="line-54"></a><span class='hs-definition'>readhandle</span> <span class='hs-varid'>h</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>readhandle</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>h</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="readstring"></a><span class='hs-definition'>readstring</span> <span class='hs-keyglyph'>::</span>  <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-57"></a>               <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ConfigParser</span>
<a name="line-58"></a><span class='hs-definition'>readstring</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>readstring</span> <span class='hs-varid'>s</span> <span class='hs-varid'>cp</span>
<a name="line-59"></a>
<a name="line-60"></a><a name="has_section"></a><span class='hs-definition'>has_section</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Bool</span>
<a name="line-61"></a><span class='hs-definition'>has_section</span> <span class='hs-varid'>x</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>has_section</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>x</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="add_section"></a><span class='hs-definition'>add_section</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-64"></a>               <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ConfigParser</span>
<a name="line-65"></a><span class='hs-definition'>add_section</span> <span class='hs-varid'>s</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>add_section</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span>
<a name="line-66"></a>
<a name="line-67"></a><a name="options"></a><span class='hs-definition'>options</span> <span class='hs-keyglyph'>::</span>  <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-68"></a>            <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>OptionSpec</span><span class='hs-keyglyph'>]</span>
<a name="line-69"></a><span class='hs-definition'>options</span> <span class='hs-varid'>x</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>options</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>x</span>
<a name="line-70"></a>
<a name="line-71"></a><a name="has_option"></a><span class='hs-definition'>has_option</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Bool</span>
<a name="line-72"></a><span class='hs-definition'>has_option</span> <span class='hs-varid'>s</span> <span class='hs-varid'>o</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>has_option</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span> <span class='hs-varid'>o</span>
<a name="line-73"></a>
<a name="line-74"></a><a name="items"></a><span class='hs-definition'>items</span> <span class='hs-keyglyph'>::</span>  <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-75"></a>          <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>OptionSpec</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-76"></a><span class='hs-definition'>items</span> <span class='hs-varid'>s</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>items</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span>
<a name="line-77"></a>
<a name="line-78"></a><a name="set"></a><span class='hs-definition'>set</span> <span class='hs-keyglyph'>::</span>  <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-79"></a>        <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ConfigParser</span>
<a name="line-80"></a><span class='hs-definition'>set</span> <span class='hs-varid'>s</span> <span class='hs-varid'>passedo</span> <span class='hs-varid'>val</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>set</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span> <span class='hs-varid'>passedo</span> <span class='hs-varid'>val</span>
<a name="line-81"></a>
<a name="line-82"></a><a name="setshow"></a><span class='hs-definition'>setshow</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-83"></a>           <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ConfigParser</span>
<a name="line-84"></a><span class='hs-definition'>setshow</span> <span class='hs-varid'>s</span> <span class='hs-varid'>o</span> <span class='hs-varid'>val</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>setshow</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span> <span class='hs-varid'>o</span> <span class='hs-varid'>val</span>
<a name="line-85"></a>
<a name="line-86"></a><a name="remove_option"></a><span class='hs-definition'>remove_option</span> <span class='hs-keyglyph'>::</span>  <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-87"></a>                  <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>OptionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ConfigParser</span>
<a name="line-88"></a><span class='hs-definition'>remove_option</span> <span class='hs-varid'>s</span> <span class='hs-varid'>passedo</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>remove_option</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span> <span class='hs-varid'>passedo</span>
<a name="line-89"></a>
<a name="line-90"></a>
<a name="line-91"></a><a name="remove_section"></a><span class='hs-definition'>remove_section</span> <span class='hs-keyglyph'>::</span>  <span class='hs-conid'>MonadError</span> <span class='hs-conid'>CPError</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-92"></a>                   <span class='hs-conid'>SectionSpec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ConfigParser</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ConfigParser</span>
<a name="line-93"></a><span class='hs-definition'>remove_section</span> <span class='hs-varid'>s</span> <span class='hs-varid'>cp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-varid'>remove_section</span> <span class='hs-varid'>cp</span> <span class='hs-varid'>s</span>
<a name="line-94"></a>
</pre></body>
</html>