/usr/share/doc/libalog0.4.1-base-dev/api/src_alog-maps.ads.html is in libalog0.4.1-base-dev 0.4.1-2.
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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | <?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>
File: alog-maps.ads
</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='toc.html'><div class="button2">Table of Contents</div></a>
<a href='tree.html'><div class="button2">Class Inheritance Tree</div></a>
</div>
</div>
</div> <!-- leftSide -->
<div class='subprograms'>
<div class='details'><ol><li id="l1"><pre><span class="comment">--</span> </pre></li>
<li id="l2"><pre><span class="comment">-- Copyright (c) 2009,</span> </pre></li>
<li id="l3"><pre><span class="comment">-- Reto Buerki, Adrian-Ken Rueegsegger</span> </pre></li>
<li id="l4"><pre><span class="comment">--</span> </pre></li>
<li id="l5"><pre><span class="comment">-- This file is part of Alog.</span> </pre></li>
<li id="l6"><pre><span class="comment">--</span> </pre></li>
<li id="l7"><pre><span class="comment">-- Alog is free software; you can redistribute it and/or modify</span> </pre></li>
<li id="l8"><pre><span class="comment">-- it under the terms of the GNU Lesser General Public License as published</span> </pre></li>
<li id="l9"><pre><span class="comment">-- by the Free Software Foundation; either version 2.1 of the License, or</span> </pre></li>
<li id="l10"><pre><span class="comment">-- (at your option) any later version.</span> </pre></li>
<li id="l11"><pre><span class="comment">--</span> </pre></li>
<li id="l12"><pre><span class="comment">-- Alog is distributed in the hope that it will be useful,</span> </pre></li>
<li id="l13"><pre><span class="comment">-- but WITHOUT ANY WARRANTY; without even the implied warranty of</span> </pre></li>
<li id="l14"><pre><span class="comment">-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> </pre></li>
<li id="l15"><pre><span class="comment">-- GNU Lesser General Public License for more details.</span> </pre></li>
<li id="l16"><pre><span class="comment">--</span> </pre></li>
<li id="l17"><pre><span class="comment">-- You should have received a copy of the GNU Lesser General Public License</span> </pre></li>
<li id="l18"><pre><span class="comment">-- along with Alog; if not, write to the Free Software</span> </pre></li>
<li id="l19"><pre><span class="comment">-- Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,</span> </pre></li>
<li id="l20"><pre><span class="comment">-- MA 02110-1301 USA</span> </pre></li>
<li id="l21"><pre><span class="comment">--</span> </pre></li>
<li id="l22"><pre> </pre></li>
<li id="l23"><pre><span class="keyword">with</span> Ada.Strings.Unbounded.Hash; </pre></li>
<li id="l24"><pre><span class="keyword">with</span> Ada.Containers.Hashed_Maps; </pre></li>
<li id="l25"><pre> </pre></li>
<li id="l26"><pre><span class="comment">-- Alog maps package. Provides map data types.</span> </pre></li>
<li id="l27"><pre><span class="keyword">package</span> <span class="droplink">Alog.Maps<ul><li><a href="alog-maps.ads.html#alog-maps.ads:27:14" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l27" title="To spec">To spec</a></li><li><a href="src_alog-maps.adb.html#l25" title="To body">To body</a></li></ul></span> <span class="keyword">is</span> </pre></li>
<li id="l28"><pre> </pre></li>
<li id="l29"><pre> <span class="keyword">type</span> <span class="droplink">Wildcard_Level_Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:29:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l99" title="To body">To body</a></li></ul></span> <span class="keyword">is</span> <span class="keyword">tagged</span> <span class="keyword">private</span>; </pre></li>
<li id="l30"><pre> <span class="comment">-- A map of loglevels with string as key type.</span> </pre></li>
<li id="l31"><pre> </pre></li>
<li id="l32"><pre> <span class="keyword">type</span> <span class="droplink">Cursor<ul><li><a href="alog-maps.ads.html#alog-maps.ads:32:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l103" title="To body">To body</a></li></ul></span> <span class="keyword">is</span> <span class="keyword">private</span>; </pre></li>
<li id="l33"><pre> <span class="comment">-- Index for a map element.</span> </pre></li>
<li id="l34"><pre> </pre></li>
<li id="l35"><pre> <span class="droplink">No_Element<ul><li><a href="alog-maps.ads.html#alog-maps.ads:35:4" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l105" title="To body">To body</a></li></ul></span> : <span class="keyword">constant</span> <span class="droplink">Cursor<ul><li><a href="alog-maps.ads.html#alog-maps.ads:32:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l32" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l103" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l36"><pre> </pre></li>
<li id="l37"><pre> <a href="alog-maps.ads.html#alog-maps.ads:37:4" title="defined at alog-maps.ads:37:4">Wildcard</a> : <span class="keyword">constant</span> Character := <span class="string">'*'</span>; </pre></li>
<li id="l38"><pre> <span class="comment">-- Character used as wildcard indicator in lookups.</span> </pre></li>
<li id="l39"><pre> </pre></li>
<li id="l40"><pre> <span class="keyword">function</span> <span class="droplink">Element<ul><li><a href="alog-maps.ads.html#alog-maps.ads:40:13" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l36" title="To body">To body</a></li></ul></span> </pre></li>
<li id="l41"><pre> (<span class="droplink">Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:41:7" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l37" title="To body">To body</a></li></ul></span> : <span class="droplink">Wildcard_Level_Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:29:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l29" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l99" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l42"><pre> <a href="alog-maps.ads.html#alog-maps.ads:42:7" title="defined at alog-maps.ads:42:7">Key</a> : String) </pre></li>
<li id="l43"><pre> <span class="keyword">return</span> <span class="droplink">Log_Level<ul><li><a href="alog.ads.html#alog.ads:31:9" title="To API doc">To API doc</a></li><li><a href="src_alog.ads.html#l31" title="To spec">To spec</a></li></ul></span>; </pre></li>
<li id="l44"><pre> <span class="comment">-- Returns the loglevel element for given key.</span> </pre></li>
<li id="l45"><pre> </pre></li>
<li id="l46"><pre> <span class="keyword">function</span> <span class="droplink">Element<ul><li><a href="alog-maps.ads.html#alog-maps.ads:46:13" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l47" title="To body">To body</a></li></ul></span> (<span class="droplink">Position<ul><li><a href="alog-maps.ads.html#alog-maps.ads:46:22" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l47" title="To body">To body</a></li></ul></span> : <span class="droplink">Cursor<ul><li><a href="alog-maps.ads.html#alog-maps.ads:32:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l32" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l103" title="To body">To body</a></li></ul></span>) <span class="keyword">return</span> <span class="droplink">Log_Level<ul><li><a href="alog.ads.html#alog.ads:31:9" title="To API doc">To API doc</a></li><li><a href="src_alog.ads.html#l31" title="To spec">To spec</a></li></ul></span>; </pre></li>
<li id="l47"><pre> <span class="comment">-- Returns the loglevel element at given position.</span> </pre></li>
<li id="l48"><pre> </pre></li>
<li id="l49"><pre> <span class="keyword">function</span> <span class="droplink">Find<ul><li><a href="alog-maps.ads.html#alog-maps.ads:49:13" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l54" title="To body">To body</a></li></ul></span> </pre></li>
<li id="l50"><pre> (<span class="droplink">Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:50:7" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l55" title="To body">To body</a></li></ul></span> : <span class="droplink">Wildcard_Level_Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:29:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l29" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l99" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l51"><pre> <a href="alog-maps.ads.html#alog-maps.ads:51:7" title="defined at alog-maps.ads:51:7">Key</a> : String) </pre></li>
<li id="l52"><pre> <span class="keyword">return</span> <span class="droplink">Cursor<ul><li><a href="alog-maps.ads.html#alog-maps.ads:32:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l32" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l103" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l53"><pre> <span class="comment">-- Returns the position for an element with specified key. If no element is</span> </pre></li>
<li id="l54"><pre> <span class="comment">-- found No_Element is returned.</span> </pre></li>
<li id="l55"><pre> </pre></li>
<li id="l56"><pre> <span class="keyword">function</span> <span class="droplink">Lookup<ul><li><a href="alog-maps.ads.html#alog-maps.ads:56:13" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l93" title="To body">To body</a></li></ul></span> </pre></li>
<li id="l57"><pre> (<span class="droplink">Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:57:7" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l94" title="To body">To body</a></li></ul></span> : <span class="droplink">Wildcard_Level_Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:29:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l29" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l99" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l58"><pre> <a href="alog-maps.ads.html#alog-maps.ads:58:7" title="defined at alog-maps.ads:58:7">Key</a> : String) </pre></li>
<li id="l59"><pre> <span class="keyword">return</span> <span class="droplink">Cursor<ul><li><a href="alog-maps.ads.html#alog-maps.ads:32:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l32" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l103" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l60"><pre> <span class="comment">-- Returns the position of the element with the closest match to given key.</span> </pre></li>
<li id="l61"><pre> <span class="comment">-- This function considers wildcards when searching for an element.</span> </pre></li>
<li id="l62"><pre> <span class="comment">--</span> </pre></li>
<li id="l63"><pre> <span class="comment">-- Example: Key | Element</span> </pre></li>
<li id="l64"><pre> <span class="comment">-- -------------------</span> </pre></li>
<li id="l65"><pre> <span class="comment">-- Foo.* | Debug</span> </pre></li>
<li id="l66"><pre> <span class="comment">-- Foo.Bar | Alert</span> </pre></li>
<li id="l67"><pre> <span class="comment">--</span> </pre></li>
<li id="l68"><pre> <span class="comment">-- A lookup for "Foo.Foo" has no exact match. The next closest match is</span> </pre></li>
<li id="l69"><pre> <span class="comment">-- "Foo.*" which will return the Debug element. Looking for "Foo" will</span> </pre></li>
<li id="l70"><pre> <span class="comment">-- return Debug since it matches the wildcard "Foo.*".</span> </pre></li>
<li id="l71"><pre> <span class="comment">--</span> </pre></li>
<li id="l72"><pre> <span class="comment">-- If no exact and wildcard match is found No_Element is returned.</span> </pre></li>
<li id="l73"><pre> </pre></li>
<li id="l74"><pre> <span class="keyword">procedure</span> <span class="droplink">Insert<ul><li><a href="alog-maps.ads.html#alog-maps.ads:74:14" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l65" title="To body">To body</a></li></ul></span> </pre></li>
<li id="l75"><pre> (<span class="droplink">Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:75:7" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l66" title="To body">To body</a></li></ul></span> : <span class="keyword">in</span> <span class="keyword">out</span> <span class="droplink">Wildcard_Level_Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:29:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l29" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l99" title="To body">To body</a></li></ul></span>; </pre></li>
<li id="l76"><pre> <a href="alog-maps.ads.html#alog-maps.ads:76:7" title="defined at alog-maps.ads:76:7">Key</a> : String; </pre></li>
<li id="l77"><pre> <span class="droplink">Item<ul><li><a href="alog-maps.ads.html#alog-maps.ads:77:7" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l68" title="To body">To body</a></li></ul></span> : <span class="droplink">Log_Level<ul><li><a href="alog.ads.html#alog.ads:31:9" title="To API doc">To API doc</a></li><li><a href="src_alog.ads.html#l31" title="To spec">To spec</a></li></ul></span>); </pre></li>
<li id="l78"><pre> <span class="comment">-- Insert given key/item pair into map. If given key is already present the</span> </pre></li>
<li id="l79"><pre> <span class="comment">-- associated item is replaced.</span> </pre></li>
<li id="l80"><pre> </pre></li>
<li id="l81"><pre> <span class="keyword">procedure</span> <span class="droplink">Clear<ul><li><a href="alog-maps.ads.html#alog-maps.ads:81:14" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l29" title="To body">To body</a></li></ul></span> (<span class="droplink">Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:81:21" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l29" title="To body">To body</a></li></ul></span> : <span class="keyword">in</span> <span class="keyword">out</span> <span class="droplink">Wildcard_Level_Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:29:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l29" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l99" title="To body">To body</a></li></ul></span>); </pre></li>
<li id="l82"><pre> <span class="comment">-- Clears the wildcard map.</span> </pre></li>
<li id="l83"><pre> </pre></li>
<li id="l84"><pre> <span class="keyword">function</span> <span class="droplink">Length<ul><li><a href="alog-maps.ads.html#alog-maps.ads:84:13" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l86" title="To body">To body</a></li></ul></span> (<span class="droplink">Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:84:21" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.adb.html#l86" title="To body">To body</a></li></ul></span> : <span class="droplink">Wildcard_Level_Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:29:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l29" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l99" title="To body">To body</a></li></ul></span>) <span class="keyword">return</span> Natural; </pre></li>
<li id="l85"><pre> <span class="comment">-- Return the number of elements in the map.</span> </pre></li>
<li id="l86"><pre> </pre></li>
<li id="l87"><pre><span class="keyword">private</span> </pre></li>
<li id="l88"><pre> </pre></li>
<li id="l89"><pre> <span class="keyword">use</span> Ada.Strings.Unbounded; </pre></li>
<li id="l90"><pre> </pre></li>
<li id="l91"><pre> <span class="keyword">package</span> Map_Of_Loglevels_Package <span class="keyword">is</span> <span class="keyword">new</span> Ada.Containers.Hashed_Maps </pre></li>
<li id="l92"><pre> (Key_Type => Unbounded_String, </pre></li>
<li id="l93"><pre> Element_Type => <span class="droplink">Log_Level<ul><li><a href="alog.ads.html#alog.ads:31:9" title="To API doc">To API doc</a></li><li><a href="src_alog.ads.html#l31" title="To spec">To spec</a></li></ul></span>, </pre></li>
<li id="l94"><pre> Hash => Hash, </pre></li>
<li id="l95"><pre> Equivalent_Keys => <span class="string">"="</span>); </pre></li>
<li id="l96"><pre> </pre></li>
<li id="l97"><pre> <span class="keyword">package</span> MOLP <span class="keyword">renames</span> Map_Of_Loglevels_Package; </pre></li>
<li id="l98"><pre> </pre></li>
<li id="l99"><pre> <span class="keyword">type</span> <span class="droplink">Wildcard_Level_Map<ul><li><a href="alog-maps.ads.html#alog-maps.ads:29:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l29" title="To spec">To spec</a></li></ul></span> <span class="keyword">is</span> <span class="keyword">tagged</span> <span class="keyword">record</span> </pre></li>
<li id="l100"><pre> Data : MOLP.Map; </pre></li>
<li id="l101"><pre> <span class="keyword">end</span> <span class="keyword">record</span>; </pre></li>
<li id="l102"><pre> </pre></li>
<li id="l103"><pre> <span class="keyword">type</span> <span class="droplink">Cursor<ul><li><a href="alog-maps.ads.html#alog-maps.ads:32:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l32" title="To spec">To spec</a></li></ul></span> <span class="keyword">is</span> <span class="keyword">new</span> MOLP.Cursor; </pre></li>
<li id="l104"><pre> </pre></li>
<li id="l105"><pre> <span class="droplink">No_Element<ul><li><a href="alog-maps.ads.html#alog-maps.ads:35:4" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l35" title="To spec">To spec</a></li></ul></span> : <span class="keyword">constant</span> <span class="droplink">Cursor<ul><li><a href="alog-maps.ads.html#alog-maps.ads:32:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l32" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l103" title="To body">To body</a></li></ul></span> := <span class="droplink">Cursor<ul><li><a href="alog-maps.ads.html#alog-maps.ads:32:9" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l32" title="To spec">To spec</a></li><li><a href="src_alog-maps.ads.html#l103" title="To body">To body</a></li></ul></span> (MOLP.No_Element); </pre></li>
<li id="l106"><pre> </pre></li>
<li id="l107"><pre><span class="keyword">end</span> <span class="droplink">Alog.Maps<ul><li><a href="alog-maps.ads.html#alog-maps.ads:27:14" title="To API doc">To API doc</a></li><li><a href="src_alog-maps.ads.html#l27" title="To spec">To spec</a></li><li><a href="src_alog-maps.adb.html#l25" title="To body">To body</a></li></ul></span>; </pre></li>
</ol></div>
</div>
</body>
</html>
|