gcc/ada/a-ciormu.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 U L T I S E T 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 Element_Type (<>) is private;
  43
  44    with function "<" (Left, Right : Element_Type) return Boolean is <>;
  45    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  46
  47 package Ada.Containers.Indefinite_Ordered_Multisets is
  48    pragma Preelaborate;
  49    pragma Remote_Types;
  50
  51    function Equivalent_Elements (Left, Right : Element_Type) return Boolean;
  52
  53    type Set is tagged private;
  54    pragma Preelaborable_Initialization (Set);
  55
  56    type Cursor is private;
  57    pragma Preelaborable_Initialization (Cursor);
  58
  59    Empty_Set : constant Set;
  60
  61    No_Element : constant Cursor;
  62
  63    function "=" (Left, Right : Set) return Boolean;
  64
  65    function Equivalent_Sets (Left, Right : Set) return Boolean;
  66
  67    function To_Set (New_Item : Element_Type) return Set;
  68
  69    function Length (Container : Set) return Count_Type;
  70
  71    function Is_Empty (Container : Set) return Boolean;
  72
  73    procedure Clear (Container : in out Set);
  74
  75    function Element (Position : Cursor) return Element_Type;
  76
  77    procedure Replace_Element
  78      (Container : in out Set;
  79       Position  : Cursor;
  80       New_Item  : Element_Type);
  81
  82    procedure Query_Element
  83      (Position : Cursor;
  84       Process  : not null access procedure (Element : Element_Type));
  85
  86    procedure Move (Target : in out Set; Source : in out Set);
  87
  88    procedure Insert
  89      (Container : in out Set;
  90       New_Item  : Element_Type;
  91       Position  : out Cursor);
  92
  93    procedure Insert (Container : in out Set; New_Item : Element_Type);
  94
  95 --  TODO: include Replace too???
  96 --
  97 --     procedure Replace
  98 --       (Container : in out Set;
  99 --        New_Item  : Element_Type);
 100
 101    procedure Exclude (Container : in out Set; Item : Element_Type);
 102
 103    procedure Delete (Container : in out Set; Item : Element_Type);
 104
 105    procedure Delete (Container : in out Set; Position : in out Cursor);
 106
 107    procedure Delete_First (Container : in out Set);
 108
 109    procedure Delete_Last (Container : in out Set);
 110
 111    procedure Union (Target : in out Set; Source : Set);
 112
 113    function Union (Left, Right : Set) return Set;
 114
 115    function "or" (Left, Right : Set) return Set renames Union;
 116
 117    procedure Intersection (Target : in out Set; Source : Set);
 118
 119    function Intersection (Left, Right : Set) return Set;
 120
 121    function "and" (Left, Right : Set) return Set renames Intersection;
 122
 123    procedure Difference (Target : in out Set; Source : Set);
 124
 125    function Difference (Left, Right : Set) return Set;
 126
 127    function "-" (Left, Right : Set) return Set renames Difference;
 128
 129    procedure Symmetric_Difference (Target : in out Set; Source : Set);
 130
 131    function Symmetric_Difference (Left, Right : Set) return Set;
 132
 133    function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
 134
 135    function Overlap (Left, Right : Set) return Boolean;
 136
 137    function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
 138
 139    function First (Container : Set) return Cursor;
 140
 141    function First_Element (Container : Set) return Element_Type;
 142
 143    function Last (Container : Set) return Cursor;
 144
 145    function Last_Element (Container : Set) return Element_Type;
 146
 147    function Next (Position : Cursor) return Cursor;
 148
 149    procedure Next (Position : in out Cursor);
 150
 151    function Previous (Position : Cursor) return Cursor;
 152
 153    procedure Previous (Position : in out Cursor);
 154
 155    function Find (Container : Set; Item : Element_Type) return Cursor;
 156
 157    function Floor (Container : Set; Item : Element_Type) return Cursor;
 158
 159    function Ceiling (Container : Set; Item : Element_Type) return Cursor;
 160
 161    function Contains (Container : Set; Item : Element_Type) return Boolean;
 162
 163    function Has_Element (Position : Cursor) return Boolean;
 164
 165    function "<" (Left, Right : Cursor) return Boolean;
 166
 167    function ">" (Left, Right : Cursor) return Boolean;
 168
 169    function "<" (Left : Cursor; Right : Element_Type) return Boolean;
 170
 171    function ">" (Left : Cursor; Right : Element_Type) return Boolean;
 172
 173    function "<" (Left : Element_Type; Right : Cursor) return Boolean;
 174
 175    function ">" (Left : Element_Type; Right : Cursor) return Boolean;
 176
 177    procedure Iterate
 178      (Container : Set;
 179       Process   : not null access procedure (Position : Cursor));
 180
 181    procedure Reverse_Iterate
 182      (Container : Set;
 183       Process   : not null access procedure (Position : Cursor));
 184
 185    procedure Iterate
 186      (Container : Set;
 187       Item      : Element_Type;
 188       Process   : not null access procedure (Position : Cursor));
 189
 190    procedure Reverse_Iterate
 191      (Container : Set;
 192       Item      : Element_Type;
 193       Process   : not null access procedure (Position : Cursor));
 194
 195    generic
 196       type Key_Type (<>) is private;
 197
 198       with function Key (Element : Element_Type) return Key_Type;
 199
 200       with function "<" (Left, Right : Key_Type) return Boolean is <>;
 201
 202    package Generic_Keys is
 203
 204       function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
 205
 206       function Key (Position : Cursor) return Key_Type;
 207
 208       function Element (Container : Set; Key : Key_Type) return Element_Type;
 209
 210       procedure Exclude (Container : in out Set; Key : Key_Type);
 211
 212       procedure Delete (Container : in out Set; Key : Key_Type);
 213
 214       function Find (Container : Set; Key : Key_Type) return Cursor;
 215
 216       function Floor (Container : Set; Key : Key_Type) return Cursor;
 217
 218       function Ceiling (Container : Set; Key : Key_Type) return Cursor;
 219
 220       function Contains (Container : Set; Key : Key_Type) return Boolean;
 221
 222       procedure Update_Element
 223         (Container : in out Set;
 224          Position  : Cursor;
 225          Process   : not null access
 226                        procedure (Element : in out Element_Type));
 227
 228       procedure Iterate
 229         (Container : Set;
 230          Key       : Key_Type;
 231          Process   : not null access procedure (Position : Cursor));
 232
 233       procedure Reverse_Iterate
 234         (Container : Set;
 235          Key       : Key_Type;
 236          Process   : not null access procedure (Position : Cursor));
 237
 238    end Generic_Keys;
 239
 240 private
 241
 242    pragma Inline (Next);
 243    pragma Inline (Previous);
 244
 245    type Node_Type;
 246    type Node_Access is access Node_Type;
 247
 248    type Element_Access is access Element_Type;
 249
 250    type Node_Type is limited record
 251       Parent  : Node_Access;
 252       Left    : Node_Access;
 253       Right   : Node_Access;
 254       Color   : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
 255       Element : Element_Access;
 256    end record;
 257
 258    package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
 259      (Node_Type,
 260       Node_Access);
 261
 262    type Set is new Ada.Finalization.Controlled with record
 263       Tree : Tree_Types.Tree_Type;
 264    end record;
 265
 266    procedure Adjust (Container : in out Set);
 267
 268    procedure Finalize (Container : in out Set) renames Clear;
 269
 270    use Red_Black_Trees;
 271    use Tree_Types;
 272    use Ada.Finalization;
 273    use Ada.Streams;
 274
 275    type Set_Access is access all Set;
 276    for Set_Access'Storage_Size use 0;
 277
 278    type Cursor is record
 279       Container : Set_Access;
 280       Node      : Node_Access;
 281    end record;
 282
 283    procedure Write
 284      (Stream : not null access Root_Stream_Type'Class;
 285       Item   : Cursor);
 286
 287    for Cursor'Write use Write;
 288
 289    procedure Read
 290      (Stream : not null access Root_Stream_Type'Class;
 291       Item   : out Cursor);
 292
 293    for Cursor'Read use Read;
 294
 295    No_Element : constant Cursor := Cursor'(null, null);
 296
 297    procedure Write
 298      (Stream    : not null access Root_Stream_Type'Class;
 299       Container : Set);
 300
 301    for Set'Write use Write;
 302
 303    procedure Read
 304      (Stream    : not null access Root_Stream_Type'Class;
 305       Container : out Set);
 306
 307    for Set'Read use Read;
 308
 309    Empty_Set : constant Set :=
 310                  (Controlled with Tree => (First  => null,
 311                                            Last   => null,
 312                                            Root   => null,
 313                                            Length => 0,
 314                                            Busy   => 0,
 315                                            Lock   => 0));
 316
 317 end Ada.Containers.Indefinite_Ordered_Multisets;