File : src/aws-containers-tables.ads
------------------------------------------------------------------------------
-- Ada Web Server --
-- --
-- Copyright (C) 2000-2003 --
-- ACT-Europe --
-- --
-- Authors: Dmitriy Anisimkov - Pascal Obry --
-- --
-- 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. --
------------------------------------------------------------------------------
-- $Id: aws-containers-tables.ads,v 1.15 2003/10/20 22:39:54 anisimko Exp $
with Ada.Strings.Unbounded;
with GNAT.Dynamic_Tables;
with Table_Of_Strings_And_Static_Values_G;
package AWS.Containers.Tables is
type Table_Type is tagged private;
type Element (Name_Length, Value_Length : Natural) is record
Name : String (1 .. Name_Length);
Value : String (1 .. Value_Length);
end record;
-- Data type to store name/value pair retrieved from a Table_Type
Null_Element : constant Element;
type VString_Array is array (Positive range <>)
of Ada.Strings.Unbounded.Unbounded_String;
function Count (Table : in Table_Type) return Natural;
-- Returns the number of item in Table.
function Name_Count (Table : in Table_Type) return Natural;
-- Returns the number of unique key name in Table.
function Count (Table : in Table_Type; Name : in String) return Natural;
-- Returns the number of value for Key Name in Table. It returns
-- 0 if Key does not exist.
function Exist (Table : in Table_Type; Name : in String) return Boolean;
-- Returns True if Key exist in Table.
function Get
(Table : in Table_Type;
Name : in String;
N : in Positive := 1)
return String;
-- Returns the Nth value associated with Key into Table. Returns
-- the emptry string if key does not exist.
function Get_Name
(Table : in Table_Type;
N : in Positive := 1)
return String;
-- Returns the Nth Name in Table or the empty string if there is
-- no parameter with this number.
function Get_Value
(Table : in Table_Type;
N : in Positive := 1)
return String;
-- Returns the Nth Value in Table or the empty string if there is
-- no parameter with this number.
function Get
(Table : in Table_Type;
N : in Positive)
return Element;
-- Returns N'th name/value pair. Returns Null_Element if there is no
-- such item in the table.
function Get_Names
(Table : in Table_Type;
Sort : in Boolean := False)
return VString_Array;
-- Returns array of unique key names. If Sort is True, the returned names
-- array is sorted in alphabetical order. This is of course slightly
-- slower than returning unsorted results.
function Get_Values
(Table : in Table_Type;
Name : in String)
return VString_Array;
-- Returns all values for the specified parameter key name.
private
-- A Table_Type must be initialized by calling
-- AWS.Containers.Tables.Set.Reset, Server is responsible for doing that.
Null_Element : constant Element := (0, 0, "", "");
type Element_Access is access all Element;
-- Data type to keep the name/value pair in the
-- GNAT.Dynamic_Tables.Table_Type.
-- We cannot use Unbounded_String because GNAT.Dynamic_Tables
-- does not support controlled objects.
type Key_Positive is new Positive;
package Name_Indexes is new GNAT.Dynamic_Tables
(Table_Component_Type => Positive,
Table_Index_Type => Key_Positive,
Table_Low_Bound => 1,
Table_Initial => 4,
Table_Increment => 30);
subtype Name_Index_Table is Name_Indexes.Instance;
package Data_Table is new GNAT.Dynamic_Tables
(Table_Component_Type => Element_Access,
Table_Index_Type => Natural,
Table_Low_Bound => 1,
Table_Initial => 8,
Table_Increment => 30);
package Index_Table is new Table_Of_Strings_And_Static_Values_G
(Character, String, "<", "=", Name_Index_Table);
-- Index of the Element_Array.
type Index_Table_Type is new Index_Table.Table_Type;
type Index_Access is access Index_Table_Type;
type Table_Type is tagged record
Case_Sensitive : Boolean := True;
Index : Index_Access;
-- Index to find appropriate Name/Value pairs in Data by the name
Data : Data_Table.Instance;
-- Ordered array of name and value pairs
end record;
function Normalize_Name
(Name : in String;
To_Upper : in Boolean)
return String;
-- Returns Name in upper case if To_Upper is set to True and it returns
-- Name unchanged otherwise.
end AWS.Containers.Tables;