gcc/ada/a-coorma.ads

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