-- --
-- B o d y --
-- --
--- Copyright (C) 2004-2005 Free Software Foundation, Inc. --
--- --
--- This specification is derived from the Ada Reference Manual for use with --
--- GNAT. The copyright notice above, and the license provisions that follow --
--- apply solely to the contents of the part following the private keyword. --
+-- Copyright (C) 2004-2010, Free Software Foundation, Inc. --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
--- ware Foundation; either version 2, or (at your option) any later ver- --
+-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
--- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
--- for more details. You should have received a copy of the GNU General --
--- Public License distributed with GNAT; see file COPYING. If not, write --
--- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
--- MA 02111-1307, USA. --
+-- or FITNESS FOR A PARTICULAR PURPOSE. --
+-- --
+-- As a special exception under Section 7 of GPL version 3, you are granted --
+-- additional permissions described in the GCC Runtime Library Exception, --
+-- version 3.1, as published by the Free Software Foundation. --
-- --
--- As a special exception, if other files instantiate generics from this --
--- unit, or you link this unit with other files to produce an executable, --
--- this unit does not by itself cause the resulting executable to be --
--- covered by the GNU General Public License. This exception does not --
--- however invalidate any other reasons why the executable file might be --
--- covered by the GNU Public License. --
+-- You should have received a copy of the GNU General Public License and --
+-- a copy of the GCC Runtime Library Exception along with this program; --
+-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
+-- <http://www.gnu.org/licenses/>. --
-- --
-- This unit was originally developed by Matthew J Heaney. --
------------------------------------------------------------------------------
function Copy_Node (Source : Node_Access) return Node_Access;
pragma Inline (Copy_Node);
+ procedure Free (X : in out Node_Access);
+
function Is_Equal_Node_Node (L, R : Node_Access) return Boolean;
pragma Inline (Is_Equal_Node_Node);
-- Local Instantiations --
--------------------------
- procedure Free is new Ada.Unchecked_Deallocation (Node_Type, Node_Access);
-
package Tree_Operations is
new Red_Black_Trees.Generic_Operations (Tree_Types);
function "<" (Left, Right : Cursor) return Boolean is
begin
+ if Left.Node = null then
+ raise Constraint_Error with "Left cursor of ""<"" equals No_Element";
+ end if;
+
+ if Right.Node = null then
+ raise Constraint_Error with "Right cursor of ""<"" equals No_Element";
+ end if;
+
+ pragma Assert (Vet (Left.Container.Tree, Left.Node),
+ "Left cursor of ""<"" is bad");
+
+ pragma Assert (Vet (Right.Container.Tree, Right.Node),
+ "Right cursor of ""<"" is bad");
+
return Left.Node.Key < Right.Node.Key;
end "<";
function "<" (Left : Cursor; Right : Key_Type) return Boolean is
begin
+ if Left.Node = null then
+ raise Constraint_Error with "Left cursor of ""<"" equals No_Element";
+ end if;
+
+ pragma Assert (Vet (Left.Container.Tree, Left.Node),
+ "Left cursor of ""<"" is bad");
+
return Left.Node.Key < Right;
end "<";
function "<" (Left : Key_Type; Right : Cursor) return Boolean is
begin
+ if Right.Node = null then
+ raise Constraint_Error with "Right cursor of ""<"" equals No_Element";
+ end if;
+
+ pragma Assert (Vet (Right.Container.Tree, Right.Node),
+ "Right cursor of ""<"" is bad");
+
return Left < Right.Node.Key;
end "<";
function ">" (Left, Right : Cursor) return Boolean is
begin
+ if Left.Node = null then
+ raise Constraint_Error with "Left cursor of "">"" equals No_Element";
+ end if;
+
+ if Right.Node = null then
+ raise Constraint_Error with "Right cursor of "">"" equals No_Element";
+ end if;
+
+ pragma Assert (Vet (Left.Container.Tree, Left.Node),
+ "Left cursor of "">"" is bad");
+
+ pragma Assert (Vet (Right.Container.Tree, Right.Node),
+ "Right cursor of "">"" is bad");
+
return Right.Node.Key < Left.Node.Key;
end ">";
function ">" (Left : Cursor; Right : Key_Type) return Boolean is
begin
+ if Left.Node = null then
+ raise Constraint_Error with "Left cursor of "">"" equals No_Element";
+ end if;
+
+ pragma Assert (Vet (Left.Container.Tree, Left.Node),
+ "Left cursor of "">"" is bad");
+
return Right < Left.Node.Key;
end ">";
function ">" (Left : Key_Type; Right : Cursor) return Boolean is
begin
+ if Right.Node = null then
+ raise Constraint_Error with "Right cursor of "">"" equals No_Element";
+ end if;
+
+ pragma Assert (Vet (Right.Container.Tree, Right.Node),
+ "Right cursor of "">"" is bad");
+
return Right.Node.Key < Left;
end ">";
function Copy_Node (Source : Node_Access) return Node_Access is
Target : constant Node_Access :=
- new Node_Type'(Parent => null,
- Left => null,
- Right => null,
- Color => Source.Color,
+ new Node_Type'(Color => Source.Color,
Key => Source.Key,
- Element => Source.Element);
+ Element => Source.Element,
+ Parent => null,
+ Left => null,
+ Right => null);
begin
return Target;
end Copy_Node;
------------
procedure Delete (Container : in out Map; Position : in out Cursor) is
+ Tree : Tree_Type renames Container.Tree;
+
begin
if Position.Node = null then
- raise Constraint_Error;
+ raise Constraint_Error with
+ "Position cursor of Delete equals No_Element";
end if;
- if Position.Container /= Map_Access'(Container'Unrestricted_Access) then
- raise Program_Error;
+ if Position.Container /= Container'Unrestricted_Access then
+ raise Program_Error with
+ "Position cursor of Delete designates wrong map";
end if;
- Tree_Operations.Delete_Node_Sans_Free (Container.Tree, Position.Node);
+ pragma Assert (Vet (Tree, Position.Node),
+ "Position cursor of Delete is bad");
+
+ Tree_Operations.Delete_Node_Sans_Free (Tree, Position.Node);
Free (Position.Node);
Position.Container := null;
begin
if X = null then
- raise Constraint_Error;
+ raise Constraint_Error with "key not in map";
end if;
- Delete_Node_Sans_Free (Container.Tree, X);
+ Tree_Operations.Delete_Node_Sans_Free (Container.Tree, X);
Free (X);
end Delete;
procedure Delete_First (Container : in out Map) is
X : Node_Access := Container.Tree.First;
+
begin
if X /= null then
Tree_Operations.Delete_Node_Sans_Free (Container.Tree, X);
procedure Delete_Last (Container : in out Map) is
X : Node_Access := Container.Tree.Last;
+
begin
if X /= null then
Tree_Operations.Delete_Node_Sans_Free (Container.Tree, X);
function Element (Position : Cursor) return Element_Type is
begin
+ if Position.Node = null then
+ raise Constraint_Error with
+ "Position cursor of function Element equals No_Element";
+ end if;
+
+ pragma Assert (Vet (Position.Container.Tree, Position.Node),
+ "Position cursor of function Element is bad");
+
return Position.Node.Element;
end Element;
function Element (Container : Map; Key : Key_Type) return Element_Type is
Node : constant Node_Access := Key_Ops.Find (Container.Tree, Key);
+
begin
+ if Node = null then
+ raise Constraint_Error with "key not in map";
+ end if;
+
return Node.Element;
end Element;
+ ---------------------
+ -- Equivalent_Keys --
+ ---------------------
+
+ function Equivalent_Keys (Left, Right : Key_Type) return Boolean is
+ begin
+ if Left < Right
+ or else Right < Left
+ then
+ return False;
+ else
+ return True;
+ end if;
+ end Equivalent_Keys;
+
-------------
-- Exclude --
-------------
begin
if X /= null then
- Delete_Node_Sans_Free (Container.Tree, X);
+ Tree_Operations.Delete_Node_Sans_Free (Container.Tree, X);
Free (X);
end if;
end Exclude;
-----------
function First (Container : Map) return Cursor is
+ T : Tree_Type renames Container.Tree;
+
begin
- if Container.Tree.First = null then
+ if T.First = null then
return No_Element;
end if;
- return Cursor'(Container'Unrestricted_Access, Container.Tree.First);
+ return Cursor'(Container'Unrestricted_Access, T.First);
end First;
-------------------
-------------------
function First_Element (Container : Map) return Element_Type is
+ T : Tree_Type renames Container.Tree;
+
begin
- return Container.Tree.First.Element;
+ if T.First = null then
+ raise Constraint_Error with "map is empty";
+ end if;
+
+ return T.First.Element;
end First_Element;
---------------
---------------
function First_Key (Container : Map) return Key_Type is
+ T : Tree_Type renames Container.Tree;
+
begin
- return Container.Tree.First.Key;
+ if T.First = null then
+ raise Constraint_Error with "map is empty";
+ end if;
+
+ return T.First.Key;
end First_Key;
-----------
return Cursor'(Container'Unrestricted_Access, Node);
end Floor;
+ ----------
+ -- Free --
+ ----------
+
+ procedure Free (X : in out Node_Access) is
+ procedure Deallocate is
+ new Ada.Unchecked_Deallocation (Node_Type, Node_Access);
+
+ begin
+ if X = null then
+ return;
+ end if;
+
+ X.Parent := X;
+ X.Left := X;
+ X.Right := X;
+
+ Deallocate (X);
+ end Free;
+
-----------------
-- Has_Element --
-----------------
if not Inserted then
if Container.Tree.Lock > 0 then
- raise Program_Error;
+ raise Program_Error with
+ "attempt to tamper with elements (map is locked)";
end if;
Position.Node.Key := Key;
end if;
end Include;
+ ------------
+ -- Insert --
+ ------------
+
procedure Insert
(Container : in out Map;
Key : Key_Type;
--------------
function New_Node return Node_Access is
- Node : constant Node_Access :=
- new Node_Type'(Parent => null,
- Left => null,
- Right => null,
- Color => Red,
- Key => Key,
- Element => New_Item);
begin
- return Node;
+ return new Node_Type'(Key => Key,
+ Element => New_Item,
+ Color => Red_Black_Trees.Red,
+ Parent => null,
+ Left => null,
+ Right => null);
end New_Node;
-- Start of processing for Insert
New_Item : Element_Type)
is
Position : Cursor;
+ pragma Unreferenced (Position);
+
Inserted : Boolean;
begin
Insert (Container, Key, New_Item, Position, Inserted);
if not Inserted then
- raise Constraint_Error;
+ raise Constraint_Error with "key already in map";
end if;
end Insert;
- ------------
- -- Insert --
- ------------
-
procedure Insert
(Container : in out Map;
Key : Key_Type;
--------------
function New_Node return Node_Access is
- Node : Node_Access := new Node_Type;
-
begin
- begin
- Node.Key := Key;
- exception
- when others =>
- Free (Node);
- raise;
- end;
-
- return Node;
+ return new Node_Type'(Key => Key,
+ Element => <>,
+ Color => Red_Black_Trees.Red,
+ Parent => null,
+ Left => null,
+ Right => null);
end New_Node;
-- Start of processing for Insert
function Key (Position : Cursor) return Key_Type is
begin
+ if Position.Node = null then
+ raise Constraint_Error with
+ "Position cursor of function Key equals No_Element";
+ end if;
+
+ pragma Assert (Vet (Position.Container.Tree, Position.Node),
+ "Position cursor of function Key is bad");
+
return Position.Node.Key;
end Key;
----------
function Last (Container : Map) return Cursor is
+ T : Tree_Type renames Container.Tree;
+
begin
- if Container.Tree.Last = null then
+ if T.Last = null then
return No_Element;
end if;
- return Cursor'(Container'Unrestricted_Access, Container.Tree.Last);
+ return Cursor'(Container'Unrestricted_Access, T.Last);
end Last;
------------------
------------------
function Last_Element (Container : Map) return Element_Type is
+ T : Tree_Type renames Container.Tree;
+
begin
- return Container.Tree.Last.Element;
+ if T.Last = null then
+ raise Constraint_Error with "map is empty";
+ end if;
+
+ return T.Last.Element;
end Last_Element;
--------------
--------------
function Last_Key (Container : Map) return Key_Type is
+ T : Tree_Type renames Container.Tree;
+
begin
- return Container.Tree.Last.Key;
+ if T.Last = null then
+ raise Constraint_Error with "map is empty";
+ end if;
+
+ return T.Last.Key;
end Last_Key;
----------
return No_Element;
end if;
+ pragma Assert (Vet (Position.Container.Tree, Position.Node),
+ "Position cursor of Next is bad");
+
declare
Node : constant Node_Access :=
Tree_Operations.Next (Position.Node);
return No_Element;
end if;
+ pragma Assert (Vet (Position.Container.Tree, Position.Node),
+ "Position cursor of Previous is bad");
+
declare
Node : constant Node_Access :=
Tree_Operations.Previous (Position.Node);
Process : not null access procedure (Key : Key_Type;
Element : Element_Type))
is
- K : Key_Type renames Position.Node.Key;
- E : Element_Type renames Position.Node.Element;
+ begin
+ if Position.Node = null then
+ raise Constraint_Error with
+ "Position cursor of Query_Element equals No_Element";
+ end if;
- T : Tree_Type renames Position.Container.Tree;
+ pragma Assert (Vet (Position.Container.Tree, Position.Node),
+ "Position cursor of Query_Element is bad");
- B : Natural renames T.Busy;
- L : Natural renames T.Lock;
+ declare
+ T : Tree_Type renames Position.Container.Tree;
- begin
- B := B + 1;
- L := L + 1;
+ B : Natural renames T.Busy;
+ L : Natural renames T.Lock;
begin
- Process (K, E);
- exception
- when others =>
- L := L - 1;
- B := B - 1;
- raise;
- end;
+ B := B + 1;
+ L := L + 1;
- L := L - 1;
- B := B - 1;
+ declare
+ K : Key_Type renames Position.Node.Key;
+ E : Element_Type renames Position.Node.Element;
+
+ begin
+ Process (K, E);
+ exception
+ when others =>
+ L := L - 1;
+ B := B - 1;
+ raise;
+ end;
+
+ L := L - 1;
+ B := B - 1;
+ end;
end Query_Element;
----------
----------
procedure Read
- (Stream : access Root_Stream_Type'Class;
+ (Stream : not null access Root_Stream_Type'Class;
Container : out Map)
is
function Read_Node
- (Stream : access Root_Stream_Type'Class) return Node_Access;
+ (Stream : not null access Root_Stream_Type'Class) return Node_Access;
pragma Inline (Read_Node);
procedure Read is
---------------
function Read_Node
- (Stream : access Root_Stream_Type'Class) return Node_Access
+ (Stream : not null access Root_Stream_Type'Class) return Node_Access
is
Node : Node_Access := new Node_Type;
begin
Read (Stream, Container.Tree);
end Read;
+ procedure Read
+ (Stream : not null access Root_Stream_Type'Class;
+ Item : out Cursor)
+ is
+ begin
+ raise Program_Error with "attempt to stream map cursor";
+ end Read;
+
-------------
-- Replace --
-------------
begin
if Node = null then
- raise Constraint_Error;
+ raise Constraint_Error with "key not in map";
end if;
if Container.Tree.Lock > 0 then
- raise Program_Error;
+ raise Program_Error with
+ "attempt to tamper with elements (map is locked)";
end if;
Node.Key := Key;
-- Replace_Element --
---------------------
- procedure Replace_Element (Position : Cursor; By : Element_Type) is
- E : Element_Type renames Position.Node.Element;
-
+ procedure Replace_Element
+ (Container : in out Map;
+ Position : Cursor;
+ New_Item : Element_Type)
+ is
begin
- if Position.Container.Tree.Lock > 0 then
- raise Program_Error;
+ if Position.Node = null then
+ raise Constraint_Error with
+ "Position cursor of Replace_Element equals No_Element";
end if;
- E := By;
+ if Position.Container /= Container'Unrestricted_Access then
+ raise Program_Error with
+ "Position cursor of Replace_Element designates wrong map";
+ end if;
+
+ if Container.Tree.Lock > 0 then
+ raise Program_Error with
+ "attempt to tamper with elements (map is locked)";
+ end if;
+
+ pragma Assert (Vet (Container.Tree, Position.Node),
+ "Position cursor of Replace_Element is bad");
+
+ Position.Node.Element := New_Item;
end Replace_Element;
---------------------
--------------------
procedure Update_Element
- (Position : Cursor;
- Process : not null access procedure (Key : Key_Type;
- Element : in out Element_Type))
+ (Container : in out Map;
+ Position : Cursor;
+ Process : not null access procedure (Key : Key_Type;
+ Element : in out Element_Type))
is
- K : Key_Type renames Position.Node.Key;
- E : Element_Type renames Position.Node.Element;
+ begin
+ if Position.Node = null then
+ raise Constraint_Error with
+ "Position cursor of Update_Element equals No_Element";
+ end if;
- T : Tree_Type renames Position.Container.Tree;
+ if Position.Container /= Container'Unrestricted_Access then
+ raise Program_Error with
+ "Position cursor of Update_Element designates wrong map";
+ end if;
- B : Natural renames T.Busy;
- L : Natural renames T.Lock;
+ pragma Assert (Vet (Container.Tree, Position.Node),
+ "Position cursor of Update_Element is bad");
- begin
- B := B + 1;
- L := L + 1;
+ declare
+ T : Tree_Type renames Container.Tree;
+
+ B : Natural renames T.Busy;
+ L : Natural renames T.Lock;
begin
- Process (K, E);
- exception
- when others =>
- L := L - 1;
- B := B - 1;
- raise;
- end;
+ B := B + 1;
+ L := L + 1;
- L := L - 1;
- B := B - 1;
+ declare
+ K : Key_Type renames Position.Node.Key;
+ E : Element_Type renames Position.Node.Element;
+
+ begin
+ Process (K, E);
+
+ exception
+ when others =>
+ L := L - 1;
+ B := B - 1;
+ raise;
+ end;
+
+ L := L - 1;
+ B := B - 1;
+ end;
end Update_Element;
-----------
-----------
procedure Write
- (Stream : access Root_Stream_Type'Class;
+ (Stream : not null access Root_Stream_Type'Class;
Container : Map)
is
procedure Write_Node
- (Stream : access Root_Stream_Type'Class;
+ (Stream : not null access Root_Stream_Type'Class;
Node : Node_Access);
pragma Inline (Write_Node);
----------------
procedure Write_Node
- (Stream : access Root_Stream_Type'Class;
+ (Stream : not null access Root_Stream_Type'Class;
Node : Node_Access)
is
begin
Write (Stream, Container.Tree);
end Write;
+ procedure Write
+ (Stream : not null access Root_Stream_Type'Class;
+ Item : Cursor)
+ is
+ begin
+ raise Program_Error with "attempt to stream map cursor";
+ end Write;
+
end Ada.Containers.Ordered_Maps;