File: manual.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 (497 lines) | stat: -rw-r--r-- 23,645 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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497

<!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 User’s Guide &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="next" title="API Documentation for Ahven" href="api.html" />
    <link rel="prev" title="Welcome to Ahven’s documentation!" href="index.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.html" title="API Documentation for Ahven"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to Ahven’s documentation!"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Ahven 2.1 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="ahven-user-s-guide">
<h1>Ahven User&#8217;s Guide<a class="headerlink" href="#ahven-user-s-guide" title="Permalink to this headline">¶</a></h1>
<p>Tero Koskinen</p>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<div class="section" id="introduction">
<h3>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h3>
<p>Ahven is a unit test library. It is modeled after
JUnit framework for Java, but some ideas are also
taken from another Ada unit test library, AUnit.</p>
<p>The purpose of Ahven is to be a small and portable
unit test library, which works with multiple
different Ada 95 compilers. Ahven has no
external dependencies and therefore it is easy
to build on various platforms.</p>
<p>Ahven tries to be compatible with utilities related
to unit testing. For example, it uses same
XML format for test results as Java tools.
This allows easy integration to CruiseControl, Ant,
and other similar programs.</p>
</div>
<div class="section" id="license">
<h3>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h3>
<p>Ahven is distributed under permissive ISC license (shown below).</p>
<div class="highlight-python"><pre>--
-- Copyright (c) 2008, 2009, 2010 Tero Koskinen &lt;tero.koskinen@iki.fi&gt;
--
-- Permission to use, copy, modify, and distribute this software for any
-- purpose with or without fee is hereby granted, provided that the above
-- copyright notice and this permission notice appear in all copies.
--
-- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
--</pre>
</div>
<p>You are allowed to embed Ahven into a proprietary commercial application.
Only requirement is to keep the copyright notice and the permission notice
in the source code files. You do not need to distribute Ahven&#8217;s source code
if you distribute Ahven or some parts of Ahven in the binary form.</p>
</div>
</div>
<div class="section" id="building-and-installing-ahven">
<h2>Building and Installing Ahven<a class="headerlink" href="#building-and-installing-ahven" title="Permalink to this headline">¶</a></h2>
<p>To build and install Ahven source code, you need an Ada 95 compiler.
At the moment, Ahven is tested with four different
compiler families: GNAT, ObjectAda, Irvine ICCAda, and Janus/Ada.</p>
<div class="section" id="gnat-gpl-series-and-fsf-gcc">
<h3>GNAT GPL series and FSF GCC<a class="headerlink" href="#gnat-gpl-series-and-fsf-gcc" title="Permalink to this headline">¶</a></h3>
<p>When you have GNAT GPL or FSF GCC, the easieast way to
compile and install Ahven is to use
the <em>make</em> utility and Makefile.</p>
<p>When compiling using the <em>make</em> utility,
you need to tell your platform type. Currently,
only supported platform types are <em>unix</em>
and <em>windows</em>. The type can be told by
setting OS_VERSION variable to the selected platform.</p>
<div class="highlight-python"><pre>$ make OS_VERSION=unix</pre>
</div>
<p>If you are unable to use <em>make</em>, you
can use the GNAT project files directly.
Ahven distribution comes with three GNAT project files:
ahven.gpr, ahven_lib.gpr, and ahven_tests.gpr.
The <em>ahven.gpr</em> file is meant to be used
when compiling unit tests. The library itself is build
using the <em>ahven_lib.gpr</em> file.
To build the testsuite of the Ahven, one needs to
use the <em>ahven_tests.gpr</em> file.</p>
<p>Like with Makefile, you need to tell your platform type.
This time the selection happens by using an environment variable
called <em>OS</em>. The variable accepts same
values as Makefile.</p>
<div class="highlight-python"><pre>$ OS=windows gnatmake -P ahven_lib
$ OS=windows gnatmake -P ahven_tests</pre>
</div>
<div class="section" id="installing-library">
<h4>Installing Library<a class="headerlink" href="#installing-library" title="Permalink to this headline">¶</a></h4>
<p>You can install the library by using command <em>make install</em>.
By default the installation happens to the <em>/usr/local</em> directory.
Alternative directory can be set by overwriting the <em>PREFIX</em> variable.</p>
<div class="highlight-python"><pre>$ make OS_VERSION=unix PREFIX=/opt/ada install</pre>
</div>
</div>
</div>
<div class="section" id="gnat-3-15p">
<h3>GNAT 3.15p<a class="headerlink" href="#gnat-3-15p" title="Permalink to this headline">¶</a></h3>
<p>Version 3.15p of GNAT does not understand some features used in
the default GNAT project files. Therefore, you need to use
project files from the <em>contrib/gnat315p</em> directory.</p>
</div>
<div class="section" id="objectada">
<h3>ObjectAda<a class="headerlink" href="#objectada" title="Permalink to this headline">¶</a></h3>
<p>There is no project file included for ObjectAda.
To compile Ahven, you need to create
a new project and import the source code of Ahven
to the project.</p>
</div>
<div class="section" id="irvine-iccada">
<h3>Irvine ICCAda<a class="headerlink" href="#irvine-iccada" title="Permalink to this headline">¶</a></h3>
<p>Easiest way to build Ahven with ICCAda is to use <em>icm</em> utility:</p>
<div class="highlight-python"><pre>C:\ahven-2.1&gt;cd src
C:\ahven-2.1\src&gt;icm new
C:\ahven-2.1\src&gt;icm scan *.ad? windows\*.ad?
C:\ahven-2.1\src&gt;icm make libmain
C:\ahven-2.1\src&gt;cd ..\test
C:\ahven-2.1\test&gt;icm new -search=..\src
C:\ahven-2.1\test&gt;icm scan *.ad?
C:\ahven-2.1\test&gt;icm make tester</pre>
</div>
</div>
<div class="section" id="janus-ada">
<h3>Janus/Ada<a class="headerlink" href="#janus-ada" title="Permalink to this headline">¶</a></h3>
<p>Directory <em>janusada</em> contains project file creation scripts for Janus/Ada.
By default, the scripts assume Janus/Ada to be installed to directory
<em>C:\Janus312\</em>.  If that is not the case, change the path from
file <em>prepare.bat</em>.</p>
<div class="highlight-python"><pre>C:\ahven-2.1&gt;janusada\prepare.bat</pre>
</div>
<p>Before compiling the library, you need to run
the preparation script <em>janusada\prepare.bat</em>.
Then, scan the sources and create compilation script
by running <em>janusada\update.bat</em>.</p>
<div class="highlight-python"><pre>C:\ahven-2.1&gt;janusada\update.bat</pre>
</div>
<p>Now you are ready to compile the project.
This happens by running
<em>compile.bat</em> script.</p>
<div class="highlight-python"><pre>C:\ahven-2.1&gt;janusada\compile.bat</pre>
</div>
<p>After a while, you should have compiled library files
in the <em>lib_obj</em> directory and
an executable called <em>tap_test.exe</em>
in the <em>test_obj</em> directory.
The executable is Ahven&#8217;s test  suite and if it reports
no errors, everything is working as expected.</p>
<p>At the time of writing (Ahven 2.1), every test
should pass with the latest version of Janus/Ada.</p>
<p>However, with earlier versions of Janus/Ada some tests will fail.
The failing tests are worked around in Ahven&#8217;s source code, but
the test exists so that one can verify when the Janus/Ada bug
causing the failure is fixed.</p>
</div>
</div>
<div class="section" id="using-ahven">
<h2>Using Ahven<a class="headerlink" href="#using-ahven" title="Permalink to this headline">¶</a></h2>
<p>The heart of Ahven is an abstract type called <tt class="docutils literal"><span class="pre">Test</span></tt>.
It presents an entity which can be run by <em>a test runner</em>.
Types <tt class="docutils literal"><span class="pre">Test_Case</span></tt> and <tt class="docutils literal"><span class="pre">Test_Suite</span></tt> are derived from the
<tt class="docutils literal"><span class="pre">Test</span></tt> type. The <tt class="docutils literal"><span class="pre">Test_Case</span></tt> type is the base type
for unit tests and the <tt class="docutils literal"><span class="pre">Test_Suite</span></tt> type is a container,
which can hold other <tt class="docutils literal"><span class="pre">Test</span></tt> objects.</p>
<div class="section" id="writing-a-test-case">
<h3>Writing a Test Case<a class="headerlink" href="#writing-a-test-case" title="Permalink to this headline">¶</a></h3>
<p>To create a new test case you need to create a new package
and a new type, which is derived from
<tt class="docutils literal"><span class="pre">Ahven.Framework.Test_Case</span></tt>.
There are no required functions or procedures to
be implemented, but to make the test case do something
you need to override the <tt class="docutils literal"><span class="pre">Initialize</span></tt> procedure
and create at least one procedure which tests something:</p>
<div class="highlight-python"><pre>-- my_tests.ads
with Ahven.Framework;
package My_Tests is
   type Test is new Ahven.Framework.Test_Case with null record;
   procedure Initialize (T : in out Test);
private
   procedure Test_Addition;
end My_Tests;</pre>
</div>
<p>To add tests to the test case you need to
call procedure <tt class="docutils literal"><span class="pre">Ahven.Framework.Add_Test_Routine</span></tt>
during the test case initialization (in other words, in the
<tt class="docutils literal"><span class="pre">Initialize</span></tt> procedure).
<a class="reference internal" href="#testcase-a-body"><em>A test case package body</em></a> shows how the
<tt class="docutils literal"><span class="pre">Test_Addition</span></tt> is added to the test case.
It also shows how to set a name for the test case with
the <tt class="docutils literal"><span class="pre">Set_Name</span></tt> procedure.</p>
<div class="section" id="a-test-case-package-body">
<span id="testcase-a-body"></span><h4>A test case package body<a class="headerlink" href="#a-test-case-package-body" title="Permalink to this headline">¶</a></h4>
<div class="highlight-python"><pre>-- my_tests.adb
package body My_Tests is
   procedure Initialize (T : in out Test) is
   begin
      Set_Name (T, "My tests");
      Ahven.Framework.Add_Test_Routine
        (T, Test_Addition'Access, "Addition");
   end Initialize;

   procedure Test_Addition is
   begin
      null;
   end Test_Addition;
end My_Tests;</pre>
</div>
</div>
</div>
<div class="section" id="calling-assertion-procedures">
<h3>Calling Assertion Procedures<a class="headerlink" href="#calling-assertion-procedures" title="Permalink to this headline">¶</a></h3>
<p>To test whether a condition is true or false,
Ahven offers you three procedures. The first
procedure is <a class="reference internal" href="api-ahven.html#ahven-assert"><em>Ahven.Assert</em></a>.
It takes a boolean value and a message string as its parameters.
If the boolean value is false the <tt class="docutils literal"><span class="pre">Assert</span></tt>
raises an <tt class="docutils literal"><span class="pre">Assertion_Error</span></tt> exception
with the given string. The exception is catched by the framework.
and when the test results are shown the error is also shown
with the given message.</p>
<p>Another assertion procedure is a generic
<a class="reference internal" href="api-ahven.html#ahven-assert-equal"><em>Ahven.Assert_Equal</em></a> procedure.
It is meant for comparing two objects of same type.
If the objects are not equal
the <tt class="docutils literal"><span class="pre">Assertion_Error</span></tt> exception
with the given message string is raised.</p>
<p>The third assertion procedure is simple
<a class="reference internal" href="api-ahven.html#ahven-fail"><em>Ahven.Fail</em></a> which always raises
the <tt class="docutils literal"><span class="pre">Assertion_Error</span></tt> exception.
It is handy for situations where the execution should not
reach a certain place (see <a class="reference internal" href="#fail-example"><em>Fail in action</em></a>).</p>
<div class="section" id="fail-in-action">
<span id="fail-example"></span><h4>Fail in action<a class="headerlink" href="#fail-in-action" title="Permalink to this headline">¶</a></h4>
<div class="highlight-python"><pre>package body My_Tests is
   ...
   procedure Test_My_Proc is
   begin
      begin
         My_Proc (-1); -- should raise Custom_Error
         Fail ("Custom_Error expected");
      exception
         when Custom_Error =&gt;
            null; -- expected
            -- Note: the exception block should not
            -- catch Assertion_Error. Otherwise
            -- the assertion failure will not be noticed.
      end;
   end Test_My_Proc;
end My_Tests;</pre>
</div>
</div>
</div>
<div class="section" id="composing-test-hierarchies-with-test-suites">
<h3>Composing Test Hierarchies With Test Suites<a class="headerlink" href="#composing-test-hierarchies-with-test-suites" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">Test_Suite</span></tt> type is used to group related tests together.
You can also add other test suites to the suite and create
a hierarchy of tests.</p>
<p>The tests are added to the test suite using either procedure
<tt class="docutils literal"><span class="pre">Add_Static_Test</span></tt> or <tt class="docutils literal"><span class="pre">Add_Test</span></tt>.
The former procedure is meant for statically created tests and
it places a copy of the given test to the test suite.
The <tt class="docutils literal"><span class="pre">Add_Test</span></tt> procedure is used with dynamically created tests
and test objects of type Test_Class_Access.</p>
<p>At the moment, the dynamically added tests are executed first in
the order they have been added (first in, first out - FIFO)
and after them the statically added tests, also in FIFO order.</p>
<p><a class="reference internal" href="#suite-example"><em>Suite Example</em></a> shows how to put test cases in a test suite.</p>
<div class="section" id="suite-example">
<span id="id1"></span><h4>Suite Example<a class="headerlink" href="#suite-example" title="Permalink to this headline">¶</a></h4>
<div class="highlight-python"><pre>package body My_Tests is
   ...
   function Get_Test_Suite return Ahven.Framework.Test_Suite is
      S : Framework.Test_Suite := Framework.Create_Suite ("All");
      Hello_World_Test : Hello_World.Test;
      Listener_Test    : Basic_Listener_Tests.Test;
   begin
      Framework.Add_Static_Test (S, Hello_World_Test);
      Framework.Add_Static_Test (S, Listener_Test);
      return S;
   end Get_Test_Suite;
end My_Tests;</pre>
</div>
</div>
</div>
<div class="section" id="running-tests">
<h3>Running Tests<a class="headerlink" href="#running-tests" title="Permalink to this headline">¶</a></h3>
<p>The tests are run by test runners.  These runners are procedures which take
either test cases or test suites as their parameters.</p>
<p>Currently, there exists three test runners. Ahven.Runner is the basic
runner, which prints the test results as a hierarchy. Ahven.XML_Runner
on the other hand writes the test results to an XML file, which is
understood by continuous integration systems like CruiseControl and Hudson.
The third runner is Ahven.Tap_Runner. It produces the results in
Test-Anything-Protocol (TAP) format.</p>
<p>The recommended way to use these test runners is to call them from
the main program:</p>
<div class="highlight-python"><pre>with Ahven.Text_Runner;
with Ahven.Framework;
with Simple_Tests;
procedure Tester is
   S : Ahven.Framework.Test_Suite := Ahven.Framework.Create_Suite ("All");
begin
    Ahven.Framework.Add_Test (S, new Simple_Tests.Test);
    Ahven.Text_Runner.Run (S);
end Tester;</pre>
</div>
<div class="section" id="parameters">
<h4>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h4>
<p>Ahven.Text_Runner recognizes following parameters:</p>
<dl class="cmdoption">
<dt id="cmdoption-tester-d">
<tt class="descname">-d</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-tester-d" title="Permalink to this definition">¶</a></dt>
<dd><p>directory for test results</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-tester-x">
<tt class="descname">-x</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-tester-x" title="Permalink to this definition">¶</a></dt>
<dd><p>output in XML format</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-tester-c">
<tt class="descname">-c</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-tester-c" title="Permalink to this definition">¶</a></dt>
<dd><p>capture and report test outputs</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-tester-t">
<tt class="descname">-t</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-tester-t" title="Permalink to this definition">¶</a></dt>
<dd><p>specify timeout value for tests</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-tester-q">
<tt class="descname">-q</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-tester-q" title="Permalink to this definition">¶</a></dt>
<dd><p>quiet results</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-tester-v">
<tt class="descname">-v</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-tester-v" title="Permalink to this definition">¶</a></dt>
<dd><p>verbose results (default)</p>
</dd></dl>

</div>
</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="#">Ahven User&#8217;s Guide</a><ul>
<li><a class="reference internal" href="#overview">Overview</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li><a class="reference internal" href="#building-and-installing-ahven">Building and Installing Ahven</a><ul>
<li><a class="reference internal" href="#gnat-gpl-series-and-fsf-gcc">GNAT GPL series and FSF GCC</a><ul>
<li><a class="reference internal" href="#installing-library">Installing Library</a></li>
</ul>
</li>
<li><a class="reference internal" href="#gnat-3-15p">GNAT 3.15p</a></li>
<li><a class="reference internal" href="#objectada">ObjectAda</a></li>
<li><a class="reference internal" href="#irvine-iccada">Irvine ICCAda</a></li>
<li><a class="reference internal" href="#janus-ada">Janus/Ada</a></li>
</ul>
</li>
<li><a class="reference internal" href="#using-ahven">Using Ahven</a><ul>
<li><a class="reference internal" href="#writing-a-test-case">Writing a Test Case</a><ul>
<li><a class="reference internal" href="#a-test-case-package-body">A test case package body</a></li>
</ul>
</li>
<li><a class="reference internal" href="#calling-assertion-procedures">Calling Assertion Procedures</a><ul>
<li><a class="reference internal" href="#fail-in-action">Fail in action</a></li>
</ul>
</li>
<li><a class="reference internal" href="#composing-test-hierarchies-with-test-suites">Composing Test Hierarchies With Test Suites</a><ul>
<li><a class="reference internal" href="#suite-example">Suite Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#running-tests">Running Tests</a><ul>
<li><a class="reference internal" href="#parameters">Parameters</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Welcome to Ahven&#8217;s documentation!</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="api.html"
                        title="next chapter">API Documentation for Ahven</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/manual.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.html" title="API Documentation for Ahven"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Welcome to Ahven’s documentation!"
             >previous</a> |</li>
        <li><a href="index.html">Ahven 2.1 documentation</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>