gcc/ada/s-ficobl.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --              S Y S T E M . F I L E _ C O N T R O L _ B L O C K           --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --            Copyright (C) 1992-2009, Free Software Foundation, Inc.       --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  17 --                                                                          --
  18 -- As a special exception under Section 7 of GPL version 3, you are granted --
  19 -- additional permissions described in the GCC Runtime Library Exception,   --
  20 -- version 3.1, as published by the Free Software Foundation.               --
  21 --                                                                          --
  22 -- You should have received a copy of the GNU General Public License and    --
  23 -- a copy of the GCC Runtime Library Exception along with this program;     --
  24 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  25 -- <http://www.gnu.org/licenses/>.                                          --
  26 --                                                                          --
  27 -- GNAT was originally developed  by the GNAT team at  New York University. --
  28 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  29 --                                                                          --
  30 ------------------------------------------------------------------------------
  31
  32 --  This package contains the declaration of the basic file control block
  33 --  shared between Text_IO, Sequential_IO, Direct_IO and Streams.Stream_IO.
  34 --  The actual control blocks are derived from this block by extension. The
  35 --  control block is itself derived from Ada.Streams.Root_Stream_Type which
  36 --  facilitates implementation of Stream_IO.Stream and Text_Streams.Stream.
  37
  38 with Ada.Streams;
  39 with Interfaces.C_Streams;
  40 with System.CRTL;
  41
  42 package System.File_Control_Block is
  43
  44    ----------------------------
  45    -- Ada File Control Block --
  46    ----------------------------
  47
  48    --  The Ada file control block is an abstract extension of the root
  49    --  stream type. This allows a file to be treated directly as a stream
  50    --  for the purposes of Stream_IO, or stream operations on a text file.
  51    --  The individual I/O packages extend this type with package specific
  52    --  fields to create the concrete types to which the routines in this
  53    --  package can be applied.
  54
  55    --  The type File_Type in the individual packages is an access to the
  56    --  extended file control block. The value is null if the file is not
  57    --  open, and a pointer to the control block if the file is open.
  58
  59    type Pstring is access all String;
  60    --  Used to hold name and form strings
  61
  62    type File_Mode is (In_File, Inout_File, Out_File, Append_File);
  63    --  File mode (union of file modes permitted by individual packages,
  64    --  the types File_Mode in the individual packages are declared to
  65    --  allow easy conversion to and from this general type.
  66
  67    type Shared_Status_Type is (Yes, No, None);
  68    --  This type is used to define the sharing status of a file. The default
  69    --  setting of None is used if no "shared=xxx" appears in the form string
  70    --  when a file is created or opened. For a file with Shared_Status set to
  71    --  None, Use_Error will be raised if any other file is opened or created
  72    --  with the same full name. Yes/No are set in response to the presence
  73    --  of "shared=yes" or "shared=no" in the form string. In either case it
  74    --  is permissible to have multiple files opened with the same full name.
  75    --  All files opened simultaneously with "shared=yes" will share the same
  76    --  stream with the semantics specified in the RM for file sharing. All
  77    --  files opened with "shared=no" will have their own stream.
  78
  79    type AFCB is tagged;
  80    type AFCB_Ptr is access all AFCB'Class;
  81
  82    type AFCB is abstract new Ada.Streams.Root_Stream_Type with record
  83
  84       Stream : Interfaces.C_Streams.FILEs;
  85       --  The file descriptor
  86
  87       Name : Pstring;
  88       --  A pointer to the file name. The file name is null for temporary
  89       --  files, and also for standard files (stdin, stdout, stderr). The
  90       --  name is always null-terminated if it is non-null.
  91
  92       Encoding : System.CRTL.Filename_Encoding;
  93       --  Encoding used to specified the filename
  94
  95       Form : Pstring;
  96       --  A pointer to the form string. This is the string used in the
  97       --  fopen call, and must be supplied by the caller (there are no
  98       --  defaults at this level). The string is always null-terminated.
  99
 100       Mode : File_Mode;
 101       --  The file mode. No checks are made that the mode is consistent
 102       --  with the form used to fopen the file.
 103
 104       Is_Regular_File : Boolean;
 105       --  A flag indicating if the file is a regular file
 106
 107       Is_Temporary_File : Boolean;
 108       --  A flag set only for temporary files (i.e. files created using the
 109       --  Create function with a null name parameter, using tmpfile). This
 110       --  is currently not used since temporary files are deleted by the
 111       --  operating system, but it is set properly in case some systems
 112       --  need this information in the future.
 113
 114       Is_System_File : Boolean;
 115       --  A flag set only for system files (stdin, stdout, stderr)
 116
 117       Is_Text_File : Boolean;
 118       --  A flag set if the file was opened in text mode
 119
 120       Shared_Status : Shared_Status_Type;
 121       --  Indicates sharing status of file, see description of type above
 122
 123       Access_Method : Character;
 124       --  Set to 'Q', 'S', 'T, 'D' for Sequential_IO, Stream_IO, Text_IO
 125       --  Direct_IO file (used to validate file sharing request).
 126
 127       Next : AFCB_Ptr;
 128       Prev : AFCB_Ptr;
 129       --  All open files are kept on a doubly linked chain, with these
 130       --  pointers used to maintain the next and previous pointers.
 131
 132    end record;
 133
 134    ----------------------------------
 135    -- Primitive Operations of AFCB --
 136    ----------------------------------
 137
 138    --  Note that we inherit the abstract operations Read and Write from
 139    --  the base type. These must be overridden by the individual file
 140    --  access methods to provide Stream Read/Write access.
 141
 142    function AFCB_Allocate (Control_Block : AFCB) return AFCB_Ptr is abstract;
 143    --  Given a control block, allocate space for a control block of the same
 144    --  type on the heap, and return the pointer to this allocated block. Note
 145    --  that the argument Control_Block is not used other than as the argument
 146    --  that controls which version of AFCB_Allocate is called.
 147
 148    procedure AFCB_Close (File : not null access AFCB) is abstract;
 149    --  Performs any specialized close actions on a file before the file is
 150    --  actually closed at the system level. This is called by Close, and
 151    --  the reason we need the primitive operation is for the automatic
 152    --  close operations done as part of finalization.
 153
 154    procedure AFCB_Free (File : not null access AFCB) is abstract;
 155    --  Frees the AFCB referenced by the given parameter. It is not necessary
 156    --  to free the strings referenced by the Form and Name fields, but if the
 157    --  extension has any other heap objects, they must be freed as well. This
 158    --  procedure must be overridden by each individual file package.
 159
 160 end System.File_Control_Block;