gcc/ada/a-ciorma.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT LIBRARY COMPONENTS                          --
   4 --                                                                          --
   5 --                      A D A . C O N T A I N E R S .                       --
   6 --             I N D E F I N I T E _ O R D E R E D _ M A P S                --
   7 --                                                                          --
   8 --                                 S p e c                                  --
   9 --                                                                          --
  10 --          Copyright (C) 2004-2005 Free Software Foundation, Inc.          --
  11 --                                                                          --
  12 -- This specification is derived from the Ada Reference Manual for use with --
  13 -- GNAT. The copyright notice above, and the license provisions that follow --
  14 -- apply solely to the  contents of the part following the private keyword. --
  15 --                                                                          --
  16 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  17 -- terms of the  GNU General Public License as published  by the Free Soft- --
  18 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  19 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  20 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  21 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  22 -- for  more details.  You should have  received  a copy of the GNU General --
  23 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  24 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  25 -- MA 02111-1307, USA.                                                      --
  26 --                                                                          --
  27 -- As a special exception,  if other files  instantiate  generics from this --
  28 -- unit, or you link  this unit with other files  to produce an executable, --
  29 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  30 -- covered  by the  GNU  General  Public  License.  This exception does not --
  31 -- however invalidate  any other reasons why  the executable file  might be --
  32 -- covered by the  GNU Public License.                                      --
  33 --                                                                          --
  34 -- This unit was originally developed by Matthew J Heaney.                  --
  35 ------------------------------------------------------------------------------
  36
  37 with Ada.Containers.Red_Black_Trees;
  38 with Ada.Finalization;
  39 with Ada.Streams;
  40
  41 generic
  42
  43    type Key_Type (<>) is private;
  44
  45    type Element_Type (<>) is private;
  46
  47    with function "<" (Left, Right : Key_Type) return Boolean is <>;
  48
  49    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  50
  51 package Ada.Containers.Indefinite_Ordered_Maps is
  52 pragma Preelaborate (Indefinite_Ordered_Maps);
  53
  54    type Map is tagged private;
  55
  56    type Cursor is private;
  57
  58    Empty_Map : constant Map;
  59
  60    No_Element : constant Cursor;
  61
  62    function "=" (Left, Right : Map) return Boolean;
  63
  64    function Length (Container : Map) return Count_Type;
  65
  66    function Is_Empty (Container : Map) return Boolean;
  67
  68    procedure Clear (Container : in out Map);
  69
  70    function Key (Position : Cursor) return Key_Type;
  71
  72    function Element (Position : Cursor) return Element_Type;
  73
  74    procedure Query_Element
  75      (Position : Cursor;
  76       Process  : not null access procedure (Key     : Key_Type;
  77                                             Element : Element_Type));
  78
  79    procedure Update_Element
  80      (Position : Cursor;
  81       Process  : not null access procedure (Key     : Key_Type;
  82                                             Element : in out Element_Type));
  83
  84    procedure Replace_Element (Position : Cursor; By : Element_Type);
  85
  86    procedure Move (Target : in out Map; Source : in out Map);
  87
  88    procedure Insert
  89      (Container : in out Map;
  90       Key       : Key_Type;
  91       New_Item  : Element_Type;
  92       Position  : out Cursor;
  93       Inserted  : out Boolean);
  94
  95    procedure Insert
  96      (Container : in out Map;
  97       Key       : Key_Type;
  98       New_Item  : Element_Type);
  99
 100    procedure Include
 101      (Container : in out Map;
 102       Key       : Key_Type;
 103       New_Item  : Element_Type);
 104
 105    procedure Replace
 106      (Container : in out Map;
 107       Key       : Key_Type;
 108       New_Item  : Element_Type);
 109
 110    procedure Delete
 111      (Container : in out Map;
 112       Key       : Key_Type);
 113
 114    procedure Delete
 115      (Container : in out Map;
 116       Position  : in out Cursor);
 117
 118    procedure Delete_First (Container : in out Map);
 119
 120    procedure Delete_Last (Container : in out Map);
 121
 122    procedure Exclude
 123      (Container : in out Map;
 124       Key       : Key_Type);
 125
 126    function Contains
 127      (Container : Map;
 128       Key       : Key_Type) return Boolean;
 129
 130    function Find
 131      (Container : Map;
 132       Key       : Key_Type) return Cursor;
 133
 134    function Element
 135      (Container : Map;
 136       Key       : Key_Type) return Element_Type;
 137
 138    function Floor
 139      (Container : Map;
 140       Key       : Key_Type) return Cursor;
 141
 142    function Ceiling
 143      (Container : Map;
 144       Key       : Key_Type) return Cursor;
 145
 146    function First (Container : Map) return Cursor;
 147
 148    function First_Key (Container : Map) return Key_Type;
 149
 150    function First_Element (Container : Map) return Element_Type;
 151
 152    function Last (Container : Map) return Cursor;
 153
 154    function Last_Key (Container : Map) return Key_Type;
 155
 156    function Last_Element (Container : Map) return Element_Type;
 157
 158    function Next (Position : Cursor) return Cursor;
 159
 160    procedure Next (Position : in out Cursor);
 161
 162    function Previous (Position : Cursor) return Cursor;
 163
 164    procedure Previous (Position : in out Cursor);
 165
 166    function Has_Element (Position : Cursor) return Boolean;
 167
 168    function "<" (Left, Right : Cursor) return Boolean;
 169
 170    function ">" (Left, Right : Cursor) return Boolean;
 171
 172    function "<" (Left : Cursor; Right : Key_Type) return Boolean;
 173
 174    function ">" (Left : Cursor; Right : Key_Type) return Boolean;
 175
 176    function "<" (Left : Key_Type; Right : Cursor) return Boolean;
 177
 178    function ">" (Left : Key_Type; Right : Cursor) return Boolean;
 179
 180    procedure Iterate
 181      (Container : Map;
 182       Process   : not null access procedure (Position : Cursor));
 183
 184    procedure Reverse_Iterate
 185      (Container : Map;
 186       Process   : not null access procedure (Position : Cursor));
 187
 188 private
 189
 190    type Node_Type;
 191    type Node_Access is access Node_Type;
 192
 193    type Key_Access is access Key_Type;
 194    type Element_Access is access Element_Type;
 195
 196    type Node_Type is limited record
 197       Parent  : Node_Access;
 198       Left    : Node_Access;
 199       Right   : Node_Access;
 200       Color   : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
 201       Key     : Key_Access;
 202       Element : Element_Access;
 203    end record;
 204
 205    package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
 206      (Node_Type,
 207       Node_Access);
 208
 209    type Map is new Ada.Finalization.Controlled with record
 210       Tree : Tree_Types.Tree_Type;
 211    end record;
 212
 213    procedure Adjust (Container : in out Map);
 214
 215    procedure Finalize (Container : in out Map) renames Clear;
 216
 217    use Red_Black_Trees;
 218    use Tree_Types;
 219    use Ada.Finalization;
 220
 221    type Map_Access is access Map;
 222    for Map_Access'Storage_Size use 0;
 223
 224    type Cursor is record
 225       Container : Map_Access;
 226       Node      : Node_Access;
 227    end record;
 228
 229    No_Element : constant Cursor := Cursor'(null, null);
 230
 231    use Ada.Streams;
 232
 233    procedure Write
 234      (Stream    : access Root_Stream_Type'Class;
 235       Container : Map);
 236
 237    for Map'Write use Write;
 238
 239    procedure Read
 240      (Stream    : access Root_Stream_Type'Class;
 241       Container : out Map);
 242
 243    for Map'Read use Read;
 244
 245    Empty_Map : constant Map :=
 246                  (Controlled with Tree => (First  => null,
 247                                            Last   => null,
 248                                            Root   => null,
 249                                            Length => 0,
 250                                            Busy   => 0,
 251                                            Lock   => 0));
 252
 253 end Ada.Containers.Indefinite_Ordered_Maps;