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
|
<?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>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta http-equiv="Content-Script-Type" content="text/javascript"/>
<title>
Package: Alog.Facilities.File_Descriptor
</title>
<link rel='stylesheet' href='support/docgen.css' type='text/css'/>
<link rel='stylesheet' href='support/tags.css' type='text/css'/>
<script src='support/docgen.js' type='text/javascript' charset='utf-8'></script>
</head>
<body onload="onloadDoc();">
<div id='leftSide'>
<div id='leftSideInside'>
<div id='header'>
<h2 class="button">Documentation</h2>
<a href='index.html'><div class="button2">Table of Contents</div></a>
<a href='tree.html'><div class="button2">Class Inheritance Tree</div></a>
</div>
<div id='navigation'>
<h2 class="button">Navigation</h2>
<a href='#Description'><div class="button2">Description</div></a>
<a href='#Classes'><div class="button2">Classes</div></a>
<a href='#Types'><div class="button2">Types</div></a>
<a href='#Constants'><div class="button2">Constants & Global variables</div></a>
<a href='#Methods'><div class="button2">Subprograms & Entries</div></a>
</div><!-- navigation -->
</div>
</div> <!-- leftSide -->
<div class='default' id='rightSide'>
<div id='rightSideInside'>
<div id='Index'>
<h2>Index</h2>
<script type="text/javascript">
var names = new Array (
new Array ('Instance', 'alog-facilities-file_descriptor.ads:30:9', 'class-spec'),
new Array ('Handle', 'alog-facilities-file_descriptor.ads:33:9', 'type-spec'),
new Array ('Open_<wbr/>File_<wbr/>Error', 'alog-facilities-file_descriptor.ads:54:4', 'var-spec'),
new Array ('Teardown', 'alog-facilities-file_descriptor.ads:36:14', 'subp-spec'),
new Array ('Set_<wbr/>Logfile', 'alog-facilities-file_descriptor.ads:39:14', 'subp-spec'),
new Array ('Get_<wbr/>Logfile', 'alog-facilities-file_descriptor.ads:46:13', 'subp-spec'),
new Array ('Close_<wbr/>Logfile', 'alog-facilities-file_descriptor.ads:49:14', 'subp-spec'),
new Array ('dummy', '', ''));
printIndexList (names);
</script>
<noscript>
<ul>
<li class='class-spec'><a href="#alog-facilities-file_descriptor.ads:30:9">Instance</a></li>
<li class='type-spec'><a href="#alog-facilities-file_descriptor.ads:33:9">Handle</a></li>
<li class='var-spec'><a href="#alog-facilities-file_descriptor.ads:54:4">Open_<wbr/>File_<wbr/>Error</a></li>
<li class='subp-spec'><a href="#alog-facilities-file_descriptor.ads:36:14">Teardown</a></li>
<li class='subp-spec'><a href="#alog-facilities-file_descriptor.ads:39:14">Set_<wbr/>Logfile</a></li>
<li class='subp-spec'><a href="#alog-facilities-file_descriptor.ads:46:13">Get_<wbr/>Logfile</a></li>
<li class='subp-spec'><a href="#alog-facilities-file_descriptor.ads:49:14">Close_<wbr/>Logfile</a></li>
</ul>
</noscript>
</div>
</div>
</div>
<div class='default' id='documentation'>
<div class='title'>
Package:
<span class="droplink"><i>Alog.Facilities.File_Descriptor</i><ul>
<li><a href="src_alog-facilities-file_descriptor.ads.html">Goto spec source</a></li>
</ul></span>
</div>
<div class='subprograms'>
<h1><a name='Description' id='Description'></a>Description</h1>
<div class="class">
<div class='details'><pre><span class="keyword">package</span> <span class="name"><b>Alog.Facilities.File_Descriptor</b></span> <span class="keyword">is</span></pre></div>
<div class='comment'>File_Descriptor facility. Used to log to a console or file. If no file is specified by a Set_Logfile()-call, console logging is used. </div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Classes' id='Classes'></a>Classes</h1>
<div class="class">
<h3><a name='alog-facilities-file_descriptor.ads:30:9' id='alog-facilities-file_descriptor.ads:30:9'></a>
<span class="droplink">Instance<ul>
<li><a href="src_alog-facilities-file_descriptor.ads.html#l30">Goto declaration in source</a></li>
<li><a href="src_alog-facilities-file_descriptor.ads.html#l67">Goto full declaration in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">type</span> <span class="name"><b>Instance</b></span> <span class="keyword">is</span> <span class="keyword">new</span> <a href="alog-facilities.ads.html#alog-facilities.ads:38:9" title="defined at alog-facilities.ads:38:9">Alog.Facilities.Instance</a> <span class="keyword">with</span> <span class="keyword">private</span>;</pre></div>
<div class='profile'>
<div>
<h4>Ancestors:</h4>
<div><a href="alog-facilities.ads.html#alog-facilities.ads:38:9" title="defined at alog-facilities.ads:38:9">Alog.Facilities.Instance</a></div>
</div>
<div>
<h4>Primitive operations:</h4>
<div><i><span class="droplink">Alog.Facilities.Setup<ul><li><a href="alog-facilities.ads.html#alog-facilities.ads:110:14" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities.ads.html#l110" title="To spec">To spec</a></li></ul></span> (Inherited)</i></div>
<div><span class="droplink">Close_Logfile<ul><li><a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:49:14" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities-file_descriptor.ads.html#l49" title="To spec">To spec</a></li></ul></span></div>
<div><span class="droplink">Get_Logfile<ul><li><a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:46:13" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities-file_descriptor.ads.html#l46" title="To spec">To spec</a></li></ul></span></div>
<div><span class="droplink">Set_Logfile<ul><li><a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:39:14" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities-file_descriptor.ads.html#l39" title="To spec">To spec</a></li></ul></span></div>
<div><span class="droplink">Teardown<ul><li><a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:36:14" title="To API doc">To API doc</a></li><li><a href="src_alog-facilities-file_descriptor.ads.html#l36" title="To spec">To spec</a></li></ul></span> <i>(overriding <a href="alog-facilities.ads.html#alog-facilities.ads:115:14" title="defined at alog-facilities.ads:115:14">Alog.Facilities.Teardown</a>)</i></div>
<div>Write <i>(overriding <a href="alog-facilities.ads.html#alog-facilities.ads:71:14" title="defined at alog-facilities.ads:71:14">Alog.Facilities.Write</a>)</i></div>
</div>
</div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l30" title="alog-facilities-file_descriptor.ads:30:9">alog-facilities-file_descriptor.ads:30:9</a> (declaration)</i></div>
<div><i>alog-facilities-file_descriptor.adb:32:25 (reference)</i></div>
<div><i>alog-facilities-file_descriptor.adb:51:37 (reference)</i></div>
<div><i>alog-facilities-file_descriptor.adb:60:25 (reference)</i></div>
<div><i>alog-facilities-file_descriptor.adb:100:42 (reference)</i></div>
<div><i>alog-facilities-file_descriptor.adb:108:18 (reference)</i></div>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l33" title="alog-facilities-file_descriptor.ads:33:30">alog-facilities-file_descriptor.ads:33:30</a> (reference)</i></div>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l36" title="alog-facilities-file_descriptor.ads:36:42">alog-facilities-file_descriptor.ads:36:42</a> (reference)</i></div>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l40" title="alog-facilities-file_descriptor.ads:40:25">alog-facilities-file_descriptor.ads:40:25</a> (reference)</i></div>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l46" title="alog-facilities-file_descriptor.ads:46:37">alog-facilities-file_descriptor.ads:46:37</a> (reference)</i></div>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l50" title="alog-facilities-file_descriptor.ads:50:25">alog-facilities-file_descriptor.ads:50:25</a> (reference)</i></div>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l62" title="alog-facilities-file_descriptor.ads:62:18">alog-facilities-file_descriptor.ads:62:18</a> (reference)</i></div>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l67" title="alog-facilities-file_descriptor.ads:67:9">alog-facilities-file_descriptor.ads:67:9</a> (full declaration)</i></div>
<div><i>alog-logger.adb:40:62 (reference)</i></div>
</div>
<div class='comment'>File Descriptor based logging facility. </div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Types' id='Types'></a>Types</h1>
<div class="class">
<h3>
<a name='alog-facilities-file_descriptor.ads:33:9' id='alog-facilities-file_descriptor.ads:33:9'></a>
<span class="droplink">Handle<ul>
<li><a href="src_alog-facilities-file_descriptor.ads.html#l33">Goto declaration in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">type</span> <span class="name"><b>Handle</b></span> <span class="keyword">is</span> <span class="keyword">access</span> <span class="keyword">all</span> <a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:30:9" title="defined at alog-facilities-file_descriptor.ads:30:9">Instance</a>;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l33" title="alog-facilities-file_descriptor.ads:33:9">alog-facilities-file_descriptor.ads:33:9</a> (declaration)</i></div>
<div><i>alog-logger.adb:38:57 (reference)</i></div>
</div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Constants' id='Constants'></a>Constants & Global variables</h1>
<div class="class">
<h3><a name='alog-facilities-file_descriptor.ads:54:4' id='alog-facilities-file_descriptor.ads:54:4'></a>
<span class="droplink">Open_File_Error<ul>
<li><a href="src_alog-facilities-file_descriptor.ads.html#l54">Goto declaration in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="name"><b>Open_File_Error</b></span> : <span class="keyword">exception</span>;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l54" title="alog-facilities-file_descriptor.ads:54:4">alog-facilities-file_descriptor.ads:54:4</a> (declaration)</i></div>
<div><i>alog-facilities-file_descriptor.adb:94:16 (reference)</i></div>
</div>
<div class='comment'>This exception is raised if an error occurs while trying to open a logfile. </div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Methods' id='Methods'></a>Subprograms & Entries</h1>
<div class="class">
<h3>
<a name='alog-facilities-file_descriptor.ads:36:14' id='alog-facilities-file_descriptor.ads:36:14'></a>
<span class="droplink">Teardown<ul>
<li><a href="src_alog-facilities-file_descriptor.ads.html#l36">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name"><b>Teardown</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities-file_descriptor.ads:36:24"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:30:9" title="defined at alog-facilities-file_descriptor.ads:30:9">Instance</a>);</td></tr></table></pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l36" title="alog-facilities-file_descriptor.ads:36:14">alog-facilities-file_descriptor.ads:36:14</a> (declaration)</i></div>
<div><i>alog-facilities-file_descriptor.adb:100:14 (body)</i></div>
<div><i>alog-facilities-file_descriptor.adb:103:8 (label)</i></div>
</div>
<div class='profile'>
<h4>Calls:</h4>
<div><i><a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:49:14" title="defined at alog-facilities-file_descriptor.ads:49:14">Close_Logfile</a> defined at <a href="src_alog-facilities-file_descriptor.ads.html#l49" title="alog-facilities-file_descriptor.ads:49:14">alog-facilities-file_descriptor.ads:49:14</a></i></div>
</div>
<div class='comment'>Implementation of Teardown-procedure. </div>
</div>
<div class="class">
<h3>
<a name='alog-facilities-file_descriptor.ads:39:14' id='alog-facilities-file_descriptor.ads:39:14'></a>
<span class="droplink">Set_Logfile<ul>
<li><a href="src_alog-facilities-file_descriptor.ads.html#l39">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name"><b>Set_Logfile</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities-file_descriptor.ads:40:7"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:30:9" title="defined at alog-facilities-file_descriptor.ads:30:9">Instance</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities-file_descriptor.ads:41:7"></a>Path</span></td><td>: String;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities-file_descriptor.ads:42:7"></a>Append</span></td><td>: Boolean := True);</td></tr></table></pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l39" title="alog-facilities-file_descriptor.ads:39:14">alog-facilities-file_descriptor.ads:39:14</a> (declaration)</i></div>
<div><i>alog-facilities-file_descriptor.adb:59:14 (body)</i></div>
<div><i>alog-facilities-file_descriptor.adb:96:8 (label)</i></div>
</div>
<div class='profile'>
<h4>Calls:</h4>
<div><i>Create defined at a-textio.ads:86:14</i></div>
<div><i>Exception_Message defined at a-except.ads:97:13</i></div>
<div><i>Exists defined at a-direct.ads:241:13</i></div>
<div><i>Open defined at a-textio.ads:92:14</i></div>
<div><i>To_Bounded_String defined at a-strbou.ads:63:16</i></div>
</div>
<div class='comment'>Set logfile to use. If not set, standard output is used for logging. Set Append to False if an existing logfile should be overwritten. </div>
</div>
<div class="class">
<h3>
<a name='alog-facilities-file_descriptor.ads:46:13' id='alog-facilities-file_descriptor.ads:46:13'></a>
<span class="droplink">Get_Logfile<ul>
<li><a href="src_alog-facilities-file_descriptor.ads.html#l46">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name"><b>Get_Logfile</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities-file_descriptor.ads:46:26"></a>Facility</span></td><td>: <a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:30:9" title="defined at alog-facilities-file_descriptor.ads:30:9">Instance</a>)</td></tr></table><span class="keyword">return</span> Ada.Text_IO.File_Access;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l46" title="alog-facilities-file_descriptor.ads:46:13">alog-facilities-file_descriptor.ads:46:13</a> (declaration)</i></div>
<div><i>alog-facilities-file_descriptor.adb:51:13 (body)</i></div>
<div><i>alog-facilities-file_descriptor.adb:55:8 (label)</i></div>
</div>
<div class='comment'>Get currently used logfile. </div>
</div>
<div class="class">
<h3>
<a name='alog-facilities-file_descriptor.ads:49:14' id='alog-facilities-file_descriptor.ads:49:14'></a>
<span class="droplink">Close_Logfile<ul>
<li><a href="src_alog-facilities-file_descriptor.ads.html#l49">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name"><b>Close_Logfile</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-facilities-file_descriptor.ads:50:7"></a>Facility</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:30:9" title="defined at alog-facilities-file_descriptor.ads:30:9">Instance</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-facilities-file_descriptor.ads:51:7"></a>Remove</span></td><td>: Boolean := False);</td></tr></table></pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-facilities-file_descriptor.ads.html#l49" title="alog-facilities-file_descriptor.ads:49:14">alog-facilities-file_descriptor.ads:49:14</a> (declaration)</i></div>
<div><i>alog-facilities-file_descriptor.adb:31:14 (body)</i></div>
<div><i>alog-facilities-file_descriptor.adb:47:8 (label)</i></div>
<div><i>alog-facilities-file_descriptor.adb:102:16 (reference)</i></div>
</div>
<div class='profile'>
<h4>Called by:</h4>
<div><i><a href="alog-facilities-file_descriptor.ads.html#alog-facilities-file_descriptor.ads:36:14" title="defined at alog-facilities-file_descriptor.ads:36:14">Teardown</a> defined at <a href="src_alog-facilities-file_descriptor.ads.html#l36" title="alog-facilities-file_descriptor.ads:36:14">alog-facilities-file_descriptor.ads:36:14</a></i></div>
</div>
<div class='profile'>
<h4>Calls:</h4>
<div><i>Close defined at a-textio.ads:98:14</i></div>
<div><i>Delete defined at a-textio.ads:99:14</i></div>
<div><i>Is_Open defined at a-textio.ads:107:13</i></div>
<div><i>Standard_Output defined at a-textio.ads:128:13</i></div>
</div>
<div class='comment'>Close opened logfile. </div>
</div>
</div>
</div> <!-- documentation -->
</body>
</html>
|
