--|
--|Item: Ada PCTE Binding
--|$Revision: 0.2 $
--|$State: Prototype $
--|
--|The Version Description Document (VDD) included with this release provides
--|detailed information regarding the condition of the software.  The "User 
--|Feedback" section of the VDD describes how to obtain additional information.
--|
--|Distribution Statement "A", per DoD Directive 5230.24
--|Authorized for public release; distribution is unlimited.
--|
--|Copyright (c) 1992, Paramax Systems Corporation, Reston, Virginia 
--|Copyright is assigned to the U.S. Government, upon delivery thereto, 
--|in accordance with the DFAR Special Works Clause.
--|
--|Developed by:  Paramax Systems Corporation,
--|
--|This software, developed under the Software Technology for Adaptable,
--|Reliable Systems (STARS) program, is approved for release under 
--|Distribution "A" of the Scientific and Technical Information Program 
--|Classification Scheme (DoD Directive 5230.24) unless otherwise indicated.  
--|Sponsored by the U.S. Defense Advanced Research Projects Agency (DARPA) 
--|under contract F19628-88-D-0031, the STARS program is supported by the 
--|military services, SEI, and MITRE, with the U.S. Air Force as the executive 
--|contracting agent.
--|
--|Permission to use, copy, modify, and comment on this software and its
--|documentation for purposes stated under Distribution "A" and without fee
--|is hereby granted, provided that this notice appears in each whole or
--|partial copy.  This software retains Contractor indemnification to
--|the Government regarding copyrights pursuant to the above referenced
--|STARS contract.  The Government disclaims all responsibility against
--|liability, including costs and expenses for violation of proprietary
--|rights, or copyrights arising out of the creation or use of this
--|software.
--|
--|In addition, the Government, Paramax, and its subcontractors disclaim all 
--|warranties with regard to this software, including all implied warranties 
--|of merchantability and fitness, and in no event shall the Government, 
--|Paramax, or its subcontractor(s) be liable for any special, indirect or 
--|consequential damages or any damages whatsoever resulting from the loss of 
--|use, data, or profits, whether in action of contract, negligence or other 
--|tortious action, arising in connection with the use or performance of this 
--|software.
--|
--|$Log $
--|
--                         Version Information
--                         ^^^^^^^^^^^^^^^^^^^
--
-- PCTE - Ada Language Interface.
-- Version: 0.2.
-- Release Date: November 30, 1992.
-- Compiled under SUN OS 4.1.2 using SunAda 1.0
--
--
--                         General Information
--                         ^^^^^^^^^^^^^^^^^^^
--
-- This is an alpha release of the Paramax STARS Ada binding to Emeraude's
-- PCTE 1.5 using the ECMA PCTE Ada binding specifications.  The binding
-- is incomplete in this release.  See the Version Description Document
-- provided with this alpha release for information on which interfaces
-- have been implemented.  It is expected that future releases will
-- expand the number of interfaces implemented.  The interfaces defined
-- herein are subject to change.
--
-- For further information, contact the authors:
--
--
--                   Robert Smith
--                   Paramax Systems Corp.
--                   Valley Forge Labs
--                   70 E. Swedesford Road
--                   Paoli, PA. 19301
--                   smith@prc.unisys.com (current)
--                   smith@vfl.paramax.com (future)
--                   +1 215 648-2402
--
--                   Michael Horton
--                   Paramax Systems Corp.
--                   Valley Forge Labs
--                   70 E. Swedesford Road
--                   Paoli, PA. 19301
--                   horton@prc.unisys.com (current)
--                   horton@vfl.paramax.com (future)
--                   +1 215 648-2527
--
--
with io_exceptions;
package pcte_text_io is

   type file_type is limited private;

   type file_mode is (in_file, out_file);

   type count is range 0 .. integer'last;
   subtype positive_count is count range 1 .. count'last;
   unbounded : constant count := 0; -- line and page length

   subtype field is integer range 0 .. integer'last;
   subtype number_base is integer range 2 .. 16;

   --type type_set is (lower_case, upper_case);

   -- file management

   procedure create (
      file : in out file_type;
      mode : in file_mode := out_file;
      name : in string := "";
      form : in string := "");

   procedure open (
      file : in out file_type;
      mode : in file_mode;
      name : in string;
      form : in string := "");

   procedure close (file : in out file_type);

   procedure delete(file : in out file_type);

   procedure reset (
      file : in out file_type;
      mode : in file_mode);

   procedure reset (file : in out file_type);

   function mode (file : in file_type) return file_mode;

   function name (file : in file_type) return string;

   function is_open(file : in file_type) return boolean;

   -- control of default input and output files

   procedure set_input (file : in file_type);

   procedure set_output (file : in file_type);

   function standard_input return file_type;

   function standard_output return file_type;

   function standard_error return file_type;

   function current_input return file_type;

   function current_output return file_type;

   -- specification of line and page lengths

   --procedure set_line_length (file : in file_type; to : in count);
   --procedure set_line_length (to : in count);

   --procedure set_page_length (file : in file_type; to : in count);
   --procedure set_page_length (to : in count);

   --function line_length(file : in file_type) return count;
   --function line_length  return count;

   --function page_length(file : in file_type) return count;
   --function page_length  return count;

   -- column, line, and page control

   procedure new_line (
      file    : in file_type;
      spacing : in positive_count  := 1);

   procedure new_line (spacing : in positive_count := 1);

   procedure skip_line (
      file    : in file_type;
      spacing : in positive_count := 1);

   procedure skip_line (spacing : in positive_count := 1);

   function end_of_line(file: in file_type) return boolean;
   function end_of_line  return boolean;

   --procedure new_page    (file: in file_type);
   --procedure new_page;

   --procedure skip_page   (file: in file_type);
   --procedure skip_page;

   --function end_of_page(file: in file_type) return boolean;
   --function end_of_page  return boolean;

   function end_of_file (file : in file_type) return boolean;

   function end_of_file return boolean;

   procedure set_col (
      file : in file_type;
      to   : in positive_count);

   procedure set_col (to : in positive_count);

   --procedure set_line    (file : in file_type; to : in positive_count);
   --procedure set_line    (to : in positive_count);

   --function col  (file : in file_type) return positive_count;
   --function col  return positive_count;

   --function line (file : in file_type) return positive_count;
   --function line return positive_count;

   --function page (file : in file_type) return positive_count;
   --function page return positive_count;

   -- character input-output

   procedure get (
      file : in file_type;
      item : out character);

   procedure get (item :  out character);

   procedure put (
      file : in file_type;
      item : in character);

   procedure put (item : in character);

   -- string input-output

   procedure get (
      file : in file_type;
      item : out string);

   procedure get (item :  out string);

   procedure put (
      file : in file_type;
      item : in string);

   procedure put (item : in string);

   procedure get_line (
      file : in file_type;
      item : out string;
      last : out natural);

   procedure get_line (
      item : out string;
      last : out natural);

   procedure put_line (
      file : in file_type;
      item : in string);

   procedure put_line (item : in string);

   -- generic package for input-output of integer types

   generic
      type num is range <>;

   package integer_io is

      default_width :  field := num'width;
      default_base :   number_base := 10;


      procedure get (
         file  : in file_type;
         item  :  out num;
         width : in field := 0);

      procedure get (
         item  :  out num;
         width : in field := 0);

      procedure put (
         file  : in file_type;
         item  : in num;
         width : in field := default_width;
         base  : in number_base := default_base);

      procedure put (
         item : in num;
         width : in field  := default_width;
         base : in number_base := default_base);

      procedure get (
         from : in string;
         item : out num;
         last : out positive);

      procedure put (
         to   : out string;
         item : in num;
         base : in number_base := default_base);

   end integer_io;


   -- exceptions

   status_error : exception renames io_exceptions.status_error;
   mode_error   : exception renames io_exceptions.mode_error;
   name_error   : exception renames io_exceptions.name_error;
   use_error    : exception renames io_exceptions.use_error;
   device_error : exception renames io_exceptions.device_error;
   end_error    : exception renames io_exceptions.end_error;
   data_error   : exception renames io_exceptions.data_error;
   layout_error : exception renames io_exceptions.layout_error;

private

    type file_type_rec;
    type file_type is access file_type_rec;

end pcte_text_io;