home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gnat-2.06-src.tgz / tar.out / fsf / gnat / ada / i-cstrea.ads < prev    next >
Text File  |  1996-09-28  |  11KB  |  297 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                 I N T E R F A C E S . C _ S T R E A M S                  --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.8 $                              --
  10. --                                                                          --
  11. -- The GNAT library is free software; you can redistribute it and/or modify --
  12. -- it under terms of the GNU Library General Public License as published by --
  13. -- the Free Software  Foundation; either version 2, or (at your option) any --
  14. -- later version.  The GNAT library is distributed in the hope that it will --
  15. -- be useful, but WITHOUT ANY WARRANTY;  without even  the implied warranty --
  16. -- of MERCHANTABILITY  or  FITNESS FOR  A PARTICULAR PURPOSE.  See the  GNU --
  17. -- Library  General  Public  License for  more  details.  You  should  have --
  18. -- received  a copy of the GNU  Library  General Public License  along with --
  19. -- the GNAT library;  see the file  COPYING.LIB.  If not, write to the Free --
  20. -- Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.        --
  21. --                                                                          --
  22. ------------------------------------------------------------------------------
  23.  
  24. --  This package is a thin binding to selected functions in the C
  25. --  library that provide a complete interface for handling C streams.
  26.  
  27. with Unchecked_Conversion;
  28. with System;
  29.  
  30. package Interfaces.C_Streams is
  31.  
  32.    --  Note: the reason we do not use the types that are in Interfaces.C is
  33.    --  that we want to avoid dragging in the code in this unit if possible.
  34.  
  35.    subtype chars is System.Address;
  36.    --  Pointer to null-terminated array of characters
  37.  
  38.    subtype FILEs is System.Address;
  39.    --  Corresponds to the C type FILE*
  40.  
  41.    subtype voids is System.Address;
  42.    --  Corresponds to the C type void*
  43.  
  44.    subtype int  is Integer;
  45.    subtype long is Long_Integer;
  46.  
  47.    --  Note: the above types are subtypes deliberately, and it is part of
  48.    --  this spec that the above correspondences are guaranteed. This means
  49.    --  that it is legitimate to, for example, use Integer instead of int.
  50.    --  We provide these synonyms for clarity, but in some cases it may be
  51.    --  convenient to use the underlying types (for example to avoid an
  52.    --  unnecessary dependency of a spec on the spec of this unit).
  53.  
  54.    type size_t is mod 2 ** Standard'Address_Size;
  55.  
  56.    NULL_Stream : constant FILEs;
  57.    --  Value returned (NULL in C) to indicate an fdopen/fopen/tmpfile error
  58.  
  59.    ----------------------------------
  60.    -- Constants Defined in stdio.h --
  61.    ----------------------------------
  62.  
  63.    EOF : constant int;
  64.    --  Used by a number of routines to indicate error or end of file
  65.  
  66.    IOFBF : constant int;
  67.    IOLBF : constant int;
  68.    IONBF : constant int;
  69.    --  Used to indicate buffering mode for setvbuf call
  70.  
  71.    SEEK_CUR : constant int;
  72.    SEEK_END : constant int;
  73.    SEEK_SET : constant int;
  74.    --  Used to indicate origin for fseek call
  75.  
  76.    function stdin  return FILEs;
  77.    function stdout return FILEs;
  78.    function stderr return FILEs;
  79.    --  Streams associated with standard files
  80.  
  81.    --------------------------
  82.    -- Standard C functions --
  83.    --------------------------
  84.  
  85.    --  The functions selected below are ones that are available in DOS,
  86.    --  OS/2, UNIX and Xenix (but not necessarily in ANSI C). These are
  87.    --  very thin interfaces which copy exactly the C headers. For more
  88.    --  documentation on these functions, see the Microsoft C "Run-Time
  89.    --  Library Reference" (Microsoft Press, 1990, ISBN 1-55615-225-6),
  90.    --  which includes useful information on system compatibility.
  91.  
  92.    procedure clearerr (stream : FILEs);
  93.  
  94.    function fclose (stream : FILEs) return int;
  95.  
  96.    function fdopen (handle : int; mode : chars) return FILEs;
  97.  
  98.    function feof (stream : FILEs) return int;
  99.  
  100.    function ferror (stream : FILEs) return int;
  101.  
  102.    function fflush (stream : FILEs) return int;
  103.  
  104.    function fgetc (stream : FILEs) return int;
  105.  
  106.    function fgets (strng : chars; n : int; stream : FILEs) return chars;
  107.  
  108.    function fileno (stream : FILEs) return int;
  109.  
  110.    function fopen (filename : chars; Mode : chars) return FILEs;
  111.    --  Note: to maintain target independence, use text_translation_required,
  112.    --  a boolean variable defined in a-sysdep.c to deal with the target
  113.    --  dependent text translation requirement. If this variable is set,
  114.    --  then b/t should be appended to the standard mode argument to set
  115.    --  the text translation mode off or on as required.
  116.  
  117.    function fputc (C : int; stream : FILEs) return int;
  118.  
  119.    function fputs (Strng : chars; Stream : FILEs) return int;
  120.  
  121.    function fread
  122.      (buffer : voids;
  123.       size   : size_t;
  124.       count  : size_t;
  125.       stream : FILEs)
  126.       return   size_t;
  127.  
  128.    function freopen
  129.      (filename : chars;
  130.       mode     : chars;
  131.       stream   : FILEs)
  132.       return     FILEs;
  133.  
  134.    function fseek
  135.      (stream : FILEs;
  136.       offset : long;
  137.       origin : int)
  138.       return   int;
  139.  
  140.    function ftell (stream : FILEs) return long;
  141.  
  142.    function fwrite
  143.      (buffer : voids;
  144.       size   : size_t;
  145.       count  : size_t;
  146.       stream : FILEs)
  147.       return   size_t;
  148.  
  149.    function isatty (handle : int) return int;
  150.  
  151.    procedure mktemp (template : chars);
  152.    --  The return value (which is just a pointer to template) is discarded
  153.  
  154.    procedure rewind (stream : FILEs);
  155.  
  156.    function rmtmp return int;
  157.  
  158.    function setvbuf
  159.      (stream : FILEs;
  160.       buffer : chars;
  161.       mode   : int;
  162.       size   : size_t)
  163.       return   int;
  164.  
  165.    function tmpfile return FILEs;
  166.  
  167.    function ungetc (c : int; stream : FILEs) return int;
  168.  
  169.    function unlink (filename : chars) return int;
  170.  
  171.    ---------------------
  172.    -- Extra functions --
  173.    ---------------------
  174.  
  175.    --  These functions supply slightly thicker bindings than those above.
  176.    --  They are derived from functions in the C Run-Time Library, but may
  177.    --  do a bit more work than just directly calling one of the Library
  178.    --  functions.
  179.  
  180.    function is_regular_file (handle : int) return int;
  181.    --  Tests if given handle is for a regular file (result 1) or for
  182.    --  a non-regular file (pipe or device, result 0).
  183.  
  184.    ---------------------------------
  185.    -- Control of Text/Binary Mode --
  186.    ---------------------------------
  187.  
  188.    --  If text_translation_required is true, then the following functions may
  189.    --  be used to dynamically switch a file from binary to text mode or vice
  190.    --  versa. These functions have no effect if text_translation_required is
  191.    --  false (i.e. in normal unix mode). Use fileno to get a stream handle.
  192.  
  193.    procedure set_binary_mode (handle : int);
  194.    procedure set_text_mode   (handle : int);
  195.  
  196.    ----------------------------
  197.    -- Full Path Name support --
  198.    ----------------------------
  199.  
  200.    procedure full_name (nam : chars; buffer : chars);
  201.    --  Given a NUL terminated string representing a file name, returns in
  202.    --  buffer a NUL terminated string representing the full path name for
  203.    --  the file name. On systems where it is relevant the drive is also part
  204.    --  of the full path name. It is the responsibility of the caller to
  205.    --  pass an actual parameter for buffer that is big enough for any full
  206.    --  path name. Use max_path_len given below as the size of buffer.
  207.  
  208.    max_path_len : integer;
  209.    --  Maximum length of an allowable full path name on the system,
  210.    --  including a terminating NUL character.
  211.  
  212. private
  213.    --  The following routines are always functions in C, and thus can be
  214.    --  imported directly into Ada without any intermediate C needed
  215.  
  216.    pragma Import (C, clearerr);
  217.    pragma Import (C, fclose);
  218.    pragma Import (C, fdopen);
  219.    pragma Import (C, fflush);
  220.    pragma Import (C, fgetc);
  221.    pragma Import (C, fgets);
  222.    pragma Import (C, fopen);
  223.    pragma Import (C, fputc);
  224.    pragma Import (C, fputs);
  225.    pragma Import (C, fread);
  226.    pragma Import (C, freopen);
  227.    pragma Import (C, fseek);
  228.    pragma Import (C, ftell);
  229.    pragma Import (C, fwrite);
  230.    pragma Import (C, isatty);
  231.    pragma Import (C, mktemp);
  232.    pragma Import (C, rewind);
  233.    pragma Import (C, rmtmp);
  234.    pragma Import (C, setvbuf);
  235.    pragma Import (C, tmpfile);
  236.    pragma Import (C, ungetc);
  237.    pragma Import (C, unlink);
  238.  
  239.    pragma Import (C, is_regular_file, "is_regular_file_fd");
  240.  
  241.    pragma Import (C, set_binary_mode);
  242.    pragma Import (C, set_text_mode);
  243.  
  244.    pragma Import (C, max_path_len, "max_path_len");
  245.    pragma Import (C, full_name, "full_name");
  246.  
  247.    --  The following may be implemented as macros, and so are supported
  248.    --  via an interface function in the a-stdio.c file.
  249.  
  250.    pragma Import (C, feof,   "feof__");
  251.    pragma Import (C, ferror, "ferror__");
  252.    pragma Import (C, fileno, "fileno__");
  253.  
  254.    --  Constants in stdio are provided via imported variables that are
  255.    --  defined in a-stdio.c using the stdio.h header. It would be cleaner
  256.    --  if we could import constant directly, but GNAT does not support
  257.    --  pragma Import for constants ???
  258.  
  259.    c_constant_EOF      : int;
  260.  
  261.    c_constant_IOFBF    : int;
  262.    c_constant_IOLBF    : int;
  263.    c_constant_IONBF    : int;
  264.  
  265.    c_constant_SEEK_CUR : int;
  266.    c_constant_SEEK_END : int;
  267.    c_constant_SEEK_SET : int;
  268.  
  269.    pragma Import (C, c_constant_EOF);
  270.    pragma Import (C, c_constant_IOFBF);
  271.    pragma Import (C, c_constant_IOLBF);
  272.    pragma Import (C, c_constant_IONBF);
  273.    pragma Import (C, c_constant_SEEK_CUR);
  274.    pragma Import (C, c_constant_SEEK_END);
  275.    pragma Import (C, c_constant_SEEK_SET);
  276.  
  277.    pragma Import (C, stderr, "c_constant_stderr");
  278.    pragma Import (C, stdin,  "c_constant_stdin");
  279.    pragma Import (C, stdout, "c_constant_stdout");
  280.  
  281.    EOF      : constant int := c_constant_EOF;
  282.    IOFBF    : constant int := c_constant_IOFBF;
  283.    IOLBF    : constant int := c_constant_IOLBF;
  284.    IONBF    : constant int := c_constant_IONBF;
  285.    SEEK_CUR : constant int := c_constant_SEEK_CUR;
  286.    SEEK_END : constant int := c_constant_SEEK_END;
  287.    SEEK_SET : constant int := c_constant_SEEK_SET;
  288.  
  289.    type Dummy is access Integer;
  290.    function To_Address is new Unchecked_Conversion (Dummy, System.Address);
  291.    --  Used to concoct the null address below
  292.  
  293.    NULL_Stream : constant FILEs := To_Address (Dummy'(null));
  294.    --  Value returned (NULL in C) to indicate an fdopen/fopen/tmpfile error
  295.  
  296. end Interfaces.C_Streams;
  297.