File: api-ahven.html

package info (click to toggle)
ahven 2.1-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,724 kB
  • sloc: ada: 3,928; makefile: 259; xml: 108; sh: 57; python: 25; perl: 7
file content (190 lines) | stat: -rw-r--r-- 7,908 bytes parent folder | download
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

<!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>Ahven – Package &mdash; Ahven 2.1 documentation</title>
    
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '2.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="Ahven 2.1 documentation" href="index.html" />
    <link rel="up" title="API Documentation for Ahven" href="api.html" />
    <link rel="next" title="Ahven.Framework – Package" href="api-ahven-framework.html" />
    <link rel="prev" title="API Documentation for Ahven" href="api.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="ada-modindex.html" title="Ada Module Index"
             >Ada modules</a> |</li>
        <li class="right" >
          <a href="api-ahven-framework.html" title="Ahven.Framework – Package"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="api.html" title="API Documentation for Ahven"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Ahven 2.1 documentation</a> &raquo;</li>
          <li><a href="api.html" accesskey="U">API Documentation for Ahven</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-Ahven">
<span id="ahven-package"></span><h1><a class="reference internal" href="#module-Ahven" title="Ahven"><tt class="xref py py-mod docutils literal"><span class="pre">Ahven</span></tt></a> &#8211; Package<a class="headerlink" href="#module-Ahven" title="Permalink to this headline">¶</a></h1>
<div class="section" id="exceptions">
<h2>Exceptions<a class="headerlink" href="#exceptions" title="Permalink to this headline">¶</a></h2>
<p><strong>Assertion_Error</strong></p>
<blockquote>
<div>Exception, raised when Assert fails.</div></blockquote>
</div>
<div class="section" id="procedures-and-functions">
<h2>Procedures and Functions<a class="headerlink" href="#procedures-and-functions" title="Permalink to this headline">¶</a></h2>
<div class="section" id="assert">
<span id="ahven-assert"></span><h3>Assert<a class="headerlink" href="#assert" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>procedure Assert (Condition : Boolean; Message : String);</pre>
</div>
<p>If Condition is false, Assert raises Assertion_Error
with given Message.</p>
</div>
<div class="section" id="assert-equal">
<span id="ahven-assert-equal"></span><h3>Assert_Equal<a class="headerlink" href="#assert-equal" title="Permalink to this headline">¶</a></h3>
<p class="versionadded">
<span class="versionmodified">New in version 1.4.</span></p>
<div class="highlight-python"><pre>generic
   type Data_Type is private;
   with function Image (Item : Data_Type) return String is &lt;&gt;;
procedure Assert_Equal (Actual : Data_Type; Expected : Data_Type; Message : String);</pre>
</div>
<p>If Expected /= Actual, Assert raises Assertion_Error
with given Message.</p>
<p>Example:</p>
<div class="highlight-python"><pre>declare
   procedure Assert_Eq_Nat is
     new Ahven.Assert_Equal (Data_Type =&gt; Natural,
                             Image     =&gt; Natural'Image);

begin
   Assert_Eq_Nat (Actual   =&gt; Test_Count,
                  Expected =&gt; 4,
                  "test count");
end;</pre>
</div>
</div>
<div class="section" id="fail">
<span id="ahven-fail"></span><h3>Fail<a class="headerlink" href="#fail" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>procedure Fail (Message : String);</pre>
</div>
<p>Fail always raises Assertion_Error with given Message.</p>
</div>
<div class="section" id="skip">
<span id="ahven-skip"></span><h3>Skip<a class="headerlink" href="#skip" title="Permalink to this headline">¶</a></h3>
<p class="versionadded">
<span class="versionmodified">New in version 2.0.</span></p>
<div class="highlight-python"><pre>procedure Skip (Message : String);</pre>
</div>
<p>Skip always raises Test_Skipped_Error with given Message.</p>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#"><tt class="docutils literal"><span class="pre">Ahven</span></tt> &#8211; Package</a><ul>
<li><a class="reference internal" href="#exceptions">Exceptions</a></li>
<li><a class="reference internal" href="#procedures-and-functions">Procedures and Functions</a><ul>
<li><a class="reference internal" href="#assert">Assert</a></li>
<li><a class="reference internal" href="#assert-equal">Assert_Equal</a></li>
<li><a class="reference internal" href="#fail">Fail</a></li>
<li><a class="reference internal" href="#skip">Skip</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="api.html"
                        title="previous chapter">API Documentation for Ahven</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="api-ahven-framework.html"
                        title="next chapter"><tt class="docutils literal"><span class="pre">Ahven.Framework</span></tt> &#8211; Package</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/api-ahven.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="ada-modindex.html" title="Ada Module Index"
             >Ada modules</a> |</li>
        <li class="right" >
          <a href="api-ahven-framework.html" title="Ahven.Framework – Package"
             >next</a> |</li>
        <li class="right" >
          <a href="api.html" title="API Documentation for Ahven"
             >previous</a> |</li>
        <li><a href="index.html">Ahven 2.1 documentation</a> &raquo;</li>
          <li><a href="api.html" >API Documentation for Ahven</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011, Tero Koskinen.
      Last updated on Sep 24, 2011.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1pre.
    </div>
  </body>
</html>