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
  42    type Key_Type is private;
  43
  44    type Element_Type is private;
  45
  46    with function "<" (Left, Right : Key_Type) return Boolean is <>;
  47    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  48
  49 package Ada.Containers.Ordered_Maps is
  50    pragma Preelaborate;
  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 Query_Element
  73      (Position : Cursor;
  74       Process  : not null access
  75                    procedure (Key : Key_Type; Element : Element_Type));
  76
  77    procedure Update_Element
  78      (Position : Cursor;
  79       Process  : not null access
  80                    procedure (Key : Key_Type; Element : in out Element_Type));
  81
  82    procedure Replace_Element (Position : Cursor; By : in Element_Type);
  83
  84    procedure Move (Target : in out Map; Source : in out Map);
  85
  86    procedure Insert
  87      (Container : in out Map;
  88       Key       : Key_Type;
  89       New_Item  : Element_Type;
  90       Position  : out Cursor;
  91       Inserted  : out Boolean);
  92
  93    procedure Insert
  94      (Container : in out Map;
  95       Key       : Key_Type;
  96       Position  : out Cursor;
  97       Inserted  : out Boolean);
  98
  99    procedure Insert
 100      (Container : in out Map;
 101       Key       : Key_Type;
 102       New_Item  : Element_Type);
 103
 104    procedure Include
 105      (Container : in out Map;
 106       Key       : Key_Type;
 107       New_Item  : Element_Type);
 108
 109    procedure Replace
 110      (Container : in out Map;
 111       Key       : Key_Type;
 112       New_Item  : Element_Type);
 113
 114    procedure Delete (Container : in out Map; Key : Key_Type);
 115
 116    procedure Delete (Container : in out Map; 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 (Container : in out Map; Key : Key_Type);
 123
 124    function Contains (Container : Map; Key : Key_Type) return Boolean;
 125
 126    function Find (Container : Map; Key : Key_Type) return Cursor;
 127
 128    function Element (Container : Map; Key : Key_Type) return Element_Type;
 129
 130    function Floor (Container : Map; Key : Key_Type) return Cursor;
 131
 132    function Ceiling (Container : Map; Key : Key_Type) return Cursor;
 133
 134    function First (Container : Map) return Cursor;
 135
 136    function First_Key (Container : Map) return Key_Type;
 137
 138    function First_Element (Container : Map) return Element_Type;
 139
 140    function Last (Container : Map) return Cursor;
 141
 142    function Last_Key (Container : Map) return Key_Type;
 143
 144    function Last_Element (Container : Map) return Element_Type;
 145
 146    function Next (Position : Cursor) return Cursor;
 147
 148    procedure Next (Position : in out Cursor);
 149
 150    function Previous (Position : Cursor) return Cursor;
 151
 152    procedure Previous (Position : in out Cursor);
 153
 154    function Has_Element (Position : Cursor) return Boolean;
 155
 156    function "<" (Left, Right : Cursor) return Boolean;
 157
 158    function ">" (Left, Right : Cursor) return Boolean;
 159
 160    function "<" (Left : Cursor; Right : Key_Type) return Boolean;
 161
 162    function ">" (Left : Cursor; Right : Key_Type) return Boolean;
 163
 164    function "<" (Left : Key_Type; Right : Cursor) return Boolean;
 165
 166    function ">" (Left : Key_Type; Right : Cursor) return Boolean;
 167
 168    procedure Iterate
 169      (Container : Map;
 170       Process   : not null access procedure (Position : Cursor));
 171
 172    procedure Reverse_Iterate
 173      (Container : Map;
 174       Process   : not null access procedure (Position : Cursor));
 175
 176 private
 177
 178    type Node_Type;
 179    type Node_Access is access Node_Type;
 180
 181    type Node_Type is limited record
 182       Parent  : Node_Access;
 183       Left    : Node_Access;
 184       Right   : Node_Access;
 185       Color   : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
 186       Key     : Key_Type;
 187       Element : Element_Type;
 188    end record;
 189
 190    package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
 191      (Node_Type,
 192       Node_Access);
 193
 194    type Map is new Ada.Finalization.Controlled with record
 195       Tree : Tree_Types.Tree_Type;
 196    end record;
 197
 198    procedure Adjust (Container : in out Map);
 199
 200    procedure Finalize (Container : in out Map) renames Clear;
 201
 202    use Red_Black_Trees;
 203    use Tree_Types;
 204    use Ada.Finalization;
 205
 206    type Map_Access is access Map;
 207    for Map_Access'Storage_Size use 0;
 208
 209    type Cursor is record
 210       Container : Map_Access;
 211       Node      : Node_Access;
 212    end record;
 213
 214    No_Element : constant Cursor := Cursor'(null, null);
 215
 216    use Ada.Streams;
 217
 218    procedure Write
 219      (Stream    : access Root_Stream_Type'Class;
 220       Container : Map);
 221
 222    for Map'Write use Write;
 223
 224    procedure Read
 225      (Stream    : access Root_Stream_Type'Class;
 226       Container : out Map);
 227
 228    for Map'Read use Read;
 229
 230    Empty_Map : constant Map :=
 231                  (Controlled with Tree => (First  => null,
 232                                            Last   => null,
 233                                            Root   => null,
 234                                            Length => 0,
 235                                            Busy   => 0,
 236                                            Lock   => 0));
 237
 238 end Ada.Containers.Ordered_Maps;