File : asgc-ordered-sortable-vector-expandable.ads
-- The Ada Structured Library - A set of container classes and general
-- tools for use with Ada95.
-- Copyright (C) 1998-1999 Corey Minyard (minyard@acm.org)
--
-- This library is free software; you can redistribute it and/or modify it
-- under the terms of the GNU General Public License as published by the
-- Free Software Foundation; either version 2 of the License, or (at your
-- option) any later version.
--
-- This library is distributed in the hope that it will be useful, but
-- WITHOUT 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 along
-- with this library; if not, write to the Free Software Foundation, Inc.,
-- 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
--
-- 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.
--
generic
package Asgc.Ordered.Sortable.Vector.Expandable is
------------------------------------------------------------------------
-- This is the vector container. Setting the increment to zero will
-- disable expansion.
subtype Parent_Object is Ordered.Sortable.Object;
type Object (Initial_Size : Positive;
Increment : Natural)
is new Parent_Object with private;
type Object_Class is access all Object'Class;
type Object_Ptr is access all Object;
procedure Initialize (O : in out Object);
procedure Adjust (O : in out Object);
procedure Finalize (O : in out Object);
------------------------------------------------------------------------
-- Abstract functions from other places that we are implementing. See
-- the definitions in the parent packages for descriptions of these.
function "=" (O1, O2 : in Object) return Boolean;
procedure Verify_Integrity (O : in Object);
function Copy (O : in Object) return Asgc.Object_Class;
function Member_Count (O : in Object) return Natural;
procedure Delete (O : in out Object;
Val : in Contained_Type);
function Value_Exists (O : in Object;
Val : in Contained_Type)
return Boolean;
procedure Add_At (O : in out Object;
Loc : in Positive;
Val : in Contained_Type);
procedure Set_At (O : in out Object;
Loc : in Positive;
Val : in Contained_Type);
function Get_At (O : in Object;
Loc : in Positive)
return Contained_Type;
procedure Swap_At (O : in out Object;
Loc1, Loc2 : in Positive);
procedure Delete_At (O : in out Object;
Loc : in Positive);
procedure Push (O : in out Object;
Val : in Contained_Type);
procedure Pop (O : in out Object;
Val : out Contained_Type);
procedure Enqueue (O : in out Object;
Val : in Contained_Type);
procedure Dequeue (O : in out Object;
Val : out Contained_Type);
------------------------------------------------------------------------
-- An iterator for an ordered container.
subtype Parent_Iterator is Ordered.Sortable.Iterator;
type Iterator is new Parent_Iterator with private;
type Iterator_Class is access all Iterator'Class;
type Iterator_Ptr is access all Iterator;
procedure Finalize (Iter : in out Iterator);
------------------------------------------------------------------------
-- Abstract functions from other places that we are implementing. See
-- the definitions in the parent packages for descriptions of these.
function New_Iterator (O : access Object) return Asgc.Iterator_Class;
function New_Iterator (O : in Object_Class) return Iterator;
procedure Free (Iter : access Iterator);
procedure Set_Container (Iter : in out Iterator;
O : in Asgc.Object_Class);
procedure First (Iter : in out Iterator; Is_End : out End_Marker);
procedure Next (Iter : in out Iterator; Is_End : out End_Marker);
procedure Delete (Iter : in out Iterator; Is_End : out End_Marker);
function Is_Same (Iter1, Iter2 : in Iterator) return Boolean;
function Get (Iter : in Iterator) return Contained_Type;
procedure Get_Incr (Iter : in out Iterator;
Val : out Contained_Type;
Is_End : out End_Marker);
function "=" (Iter1, Iter2 : in Iterator) return Boolean;
function "=" (Iter : in Iterator; Val : in Contained_Type) return Boolean;
function "=" (Val : in Contained_Type; Iter : in Iterator) return Boolean;
procedure Last (Iter : in out Iterator; Is_End : out End_Marker);
procedure Prev (Iter : in out Iterator; Is_End : out End_Marker);
procedure Set_Loc (Iter : out Iterator; Loc : in Positive);
function Get_Loc (Iter : in Iterator) return Natural;
function Is_After (Iter1, Iter2 : in Iterator) return Boolean;
function Is_Before (Iter1, Iter2 : in Iterator) return Boolean;
function "+" (Iter : in Iterator; Offset : in Integer)
return Iterator;
function "-" (Iter : in Iterator; Offset : in Integer)
return Iterator;
procedure Swap (Iter1, Iter2 : in out Iterator);
procedure Add_After (Iter : in out Iterator; Val : in Contained_Type);
procedure Add_Before (Iter : in out Iterator; Val : in Contained_Type);
procedure Set (Iter : in Iterator; Val : in Contained_Type);
procedure Get_Decr (Iter : in out Iterator;
Val : out Contained_Type;
Is_End : out End_Marker);
function ">" (Iter1, Iter2 : in Iterator) return Boolean;
function ">" (Iter : in Iterator; Val : in Contained_Type) return Boolean;
function ">" (Val : in Contained_Type; Iter : in Iterator) return Boolean;
function "<" (Iter1, Iter2 : in Iterator) return Boolean;
function "<" (Iter : in Iterator; Val : in Contained_Type) return Boolean;
function "<" (Val : in Contained_Type; Iter : in Iterator) return Boolean;
function ">=" (Iter1, Iter2 : in Iterator) return Boolean;
function ">=" (Iter : in Iterator; Val : in Contained_Type) return Boolean;
function ">=" (Val : in Contained_Type; Iter : in Iterator) return Boolean;
function "<=" (Iter1, Iter2 : in Iterator) return Boolean;
function "<=" (Iter : in Iterator; Val : in Contained_Type) return Boolean;
function "<=" (Val : in Contained_Type; Iter : in Iterator) return Boolean;
private
-- A vector is just an array, not a big deal.
type Vector_Array is array (Positive range <>) of Contained_Type;
type Vector_Array_Ptr is access all Vector_Array;
type Object (Initial_Size : Positive;
Increment : Natural)
is new Parent_Object with record
The_Vector : Vector_Array_Ptr := new Vector_Array(1 .. Initial_Size);
Last : Natural := 0;
end record;
type Iterator is new Parent_Iterator with record
Robj : Object_Class := null;
Pos : Natural := 0;
end record;
end Asgc.Ordered.Sortable.Vector.Expandable;