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-2007, 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,  51  Franklin  Street,  Fifth  Floor, --
  25 -- Boston, MA 02110-1301, 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    type Key_Type (<>) is private;
  43    type Element_Type (<>) is private;
  44
  45    with function "<" (Left, Right : Key_Type) return Boolean is <>;
  46    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  47
  48 package Ada.Containers.Indefinite_Ordered_Maps is
  49    pragma Preelaborate;
  50    pragma Remote_Types;
  51
  52    function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
  53
  54    type Map is tagged private;
  55    pragma Preelaborable_Initialization (Map);
  56
  57    type Cursor is private;
  58    pragma Preelaborable_Initialization (Cursor);
  59
  60    Empty_Map : constant Map;
  61
  62    No_Element : constant Cursor;
  63
  64    function "=" (Left, Right : Map) return Boolean;
  65
  66    function Length (Container : Map) return Count_Type;
  67
  68    function Is_Empty (Container : Map) return Boolean;
  69
  70    procedure Clear (Container : in out Map);
  71
  72    function Key (Position : Cursor) return Key_Type;
  73
  74    function Element (Position : Cursor) return Element_Type;
  75
  76    procedure Replace_Element
  77      (Container : in out Map;
  78       Position  : Cursor;
  79       New_Item  : Element_Type);
  80
  81    procedure Query_Element
  82      (Position : Cursor;
  83       Process  : not null access procedure (Key     : Key_Type;
  84                                             Element : Element_Type));
  85
  86    procedure Update_Element
  87      (Container : in out Map;
  88       Position  : Cursor;
  89       Process   : not null access procedure (Key     : Key_Type;
  90                                              Element : in out Element_Type));
  91
  92    procedure Move (Target : in out Map; Source : in out Map);
  93
  94    procedure Insert
  95      (Container : in out Map;
  96       Key       : Key_Type;
  97       New_Item  : Element_Type;
  98       Position  : out Cursor;
  99       Inserted  : out Boolean);
 100
 101    procedure Insert
 102      (Container : in out Map;
 103       Key       : Key_Type;
 104       New_Item  : Element_Type);
 105
 106    procedure Include
 107      (Container : in out Map;
 108       Key       : Key_Type;
 109       New_Item  : Element_Type);
 110
 111    procedure Replace
 112      (Container : in out Map;
 113       Key       : Key_Type;
 114       New_Item  : Element_Type);
 115
 116    procedure Exclude (Container : in out Map; Key : Key_Type);
 117
 118    procedure Delete (Container : in out Map; Key : Key_Type);
 119
 120    procedure Delete (Container : in out Map; Position : in out Cursor);
 121
 122    procedure Delete_First (Container : in out Map);
 123
 124    procedure Delete_Last (Container : in out Map);
 125
 126    function First (Container : Map) return Cursor;
 127
 128    function First_Element (Container : Map) return Element_Type;
 129
 130    function First_Key (Container : Map) return Key_Type;
 131
 132    function Last (Container : Map) return Cursor;
 133
 134    function Last_Element (Container : Map) return Element_Type;
 135
 136    function Last_Key (Container : Map) return Key_Type;
 137
 138    function Next (Position : Cursor) return Cursor;
 139
 140    procedure Next (Position : in out Cursor);
 141
 142    function Previous (Position : Cursor) return Cursor;
 143
 144    procedure Previous (Position : in out Cursor);
 145
 146    function Find (Container : Map; Key : Key_Type) return Cursor;
 147
 148    function Element (Container : Map; Key : Key_Type) return Element_Type;
 149
 150    function Floor (Container : Map; Key : Key_Type) return Cursor;
 151
 152    function Ceiling (Container : Map; Key : Key_Type) return Cursor;
 153
 154    function Contains (Container : Map; Key : Key_Type) return Boolean;
 155
 156    function Has_Element (Position : Cursor) return Boolean;
 157
 158    function "<" (Left, Right : Cursor) return Boolean;
 159
 160    function ">" (Left, Right : Cursor) return Boolean;
 161
 162    function "<" (Left : Cursor; Right : Key_Type) return Boolean;
 163
 164    function ">" (Left : Cursor; Right : Key_Type) return Boolean;
 165
 166    function "<" (Left : Key_Type; Right : Cursor) return Boolean;
 167
 168    function ">" (Left : Key_Type; Right : Cursor) return Boolean;
 169
 170    procedure Iterate
 171      (Container : Map;
 172       Process   : not null access procedure (Position : Cursor));
 173
 174    procedure Reverse_Iterate
 175      (Container : Map;
 176       Process   : not null access procedure (Position : Cursor));
 177
 178 private
 179
 180    pragma Inline (Next);
 181    pragma Inline (Previous);
 182
 183    type Node_Type;
 184    type Node_Access is access Node_Type;
 185
 186    type Key_Access is access Key_Type;
 187    type Element_Access is access Element_Type;
 188
 189    type Node_Type is limited record
 190       Parent  : Node_Access;
 191       Left    : Node_Access;
 192       Right   : Node_Access;
 193       Color   : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
 194       Key     : Key_Access;
 195       Element : Element_Access;
 196    end record;
 197
 198    package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
 199      (Node_Type,
 200       Node_Access);
 201
 202    type Map is new Ada.Finalization.Controlled with record
 203       Tree : Tree_Types.Tree_Type;
 204    end record;
 205
 206    procedure Adjust (Container : in out Map);
 207
 208    procedure Finalize (Container : in out Map) renames Clear;
 209
 210    use Red_Black_Trees;
 211    use Tree_Types;
 212    use Ada.Finalization;
 213    use Ada.Streams;
 214
 215    type Map_Access is access all Map;
 216    for Map_Access'Storage_Size use 0;
 217
 218    type Cursor is record
 219       Container : Map_Access;
 220       Node      : Node_Access;
 221    end record;
 222
 223    procedure Write
 224      (Stream : not null access Root_Stream_Type'Class;
 225       Item   : Cursor);
 226
 227    for Cursor'Write use Write;
 228
 229    procedure Read
 230      (Stream : not null access Root_Stream_Type'Class;
 231       Item   : out Cursor);
 232
 233    for Cursor'Read use Read;
 234
 235    No_Element : constant Cursor := Cursor'(null, null);
 236
 237    procedure Write
 238      (Stream    : not null access Root_Stream_Type'Class;
 239       Container : Map);
 240
 241    for Map'Write use Write;
 242
 243    procedure Read
 244      (Stream    : not null access Root_Stream_Type'Class;
 245       Container : out Map);
 246
 247    for Map'Read use Read;
 248
 249    Empty_Map : constant Map :=
 250                  (Controlled with Tree => (First  => null,
 251                                            Last   => null,
 252                                            Root   => null,
 253                                            Length => 0,
 254                                            Busy   => 0,
 255                                            Lock   => 0));
 256
 257 end Ada.Containers.Indefinite_Ordered_Maps;