-----------------------------------------------------------------------------
--
--                     Onions Network Streams Library
--
--                        O N I O N S . N A M I N G
--
--                                 S p e c
--
--     Copyright (C) 1997-1998  Regents of the University of California
--
--  Onions 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, with or without the single exception listed below;
--  either version 2, or (at your option) any later version.  Onions 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
--  distributed with Onions; see the file COPYING.  If not, write to the
--  Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
--  02111-1307, USA.
--
--  As a special exception, if other files instantiate generics from this
--  library, or you link this library with other files to produce an
--  executable, this library 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 General Public License.
--
--  Portions of this unit have been derived from version 1.02 of the Garlic
--  library of GLADE, the Ada95 Distributed Systems Annex for GNAT.  GLADE
--  is maintained by ACT Europe (see <http://www.act-europe.fr/glade.html>).
--
--     GLADE is Copyright (C) 1996,1997 Free Software Foundation, Inc.
--     All source code that is shared by both GLADE version 1.02 and
--     this unit remains under the FSF copyright.
--
-----------------------------------------------------------------------------

--  Mappings between IP names and IP addresses.
--

with Ada.Finalization;
with Onions.Thin;

package Onions.Naming is

   type String_Access is access all String;
   type String_Array is array (Positive range <>) of String_Access;

   subtype Address_Component is Natural range 0 .. 255;

   type Address is record
      H1, H2, H3, H4 : Address_Component;
   end record;
   --  An address such as 137.194.160.12

   type Address_Array is array (Positive range <>) of Address;

   type Host_Entry (N_Aliases, N_Addresses : Natural) is
      new Ada.Finalization.Controlled with record
         Name      : String_Access;
         Aliases   : String_Array  (1 .. N_Aliases);
         Addresses : Address_Array (1 .. N_Addresses);
      end record;
   --  A complete host structure. A host may have several IP addresses as
   --  well as several aliases.

   procedure Adjust   (Object : in out Host_Entry);
   procedure Finalize (Object : in out Host_Entry);

   Naming_Error : exception;
   --  This exception is raised when a name cannot be resolved.

   function Image (Add : Address) return String;
   --  The dotted form corresponding to an IP address.

   function Value (Add : String) return Address;
   --  The IP address corresponding to a dotted form.

   function Info_Of (Name : String)
     return Host_Entry;
   --  Host entry of an IP name.

   function Info_Of (Addr : Address)
     return Host_Entry;
   --  Host entry of an IP address.

   function Is_IP_Address (Something : String)
     return Boolean;
   --  Return True if the name looks like an IP address, False otherwise.

   function Info_Of_Name_Or_IP (Something : String)
     return Host_Entry;
   --  Host entry of an IP name or a dotted form..

   function Address_Of (Something : String) return Address;
   --  Address of an IP name or a dotted form.

   function Host_Name return String;
   --  Return the name of the current host.

   function Name_Of (Something : String) return String;
   --  Return the official name of an IP name or a dotted form.

   function To_In_Addr (Addr : Address) return Thin.In_Addr;
   --  Convert an IP address to a In_Addr structure.

   function To_Address (Addr : Thin.In_Addr) return Address;
   --  Convert a In_Addr structure to an IP address.

   function Any_Address return Address;
   --  Return the value of inaddr_any.

end Onions.Naming;