aboutsummaryrefslogtreecommitdiffstats
path: root/src/grt/grt-files_operations.ads
blob: c8c7d9d9aacbc27d03fbd8d414c0ed826a32bc72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
--  GHDL Run Time (GRT) -  VHDL files subprograms.
--  Copyright (C) 2002 - 2014 Tristan Gingold
--
--  This program 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 program 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 program.  If not, see <gnu.org/licenses>.
--
--  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.

with Interfaces;

with Grt.Types; use Grt.Types;
with Grt.Stdio;

package Grt.Files_Operations is
   type Ghdl_File_Index is new Interfaces.Integer_32;

   --  File open mode.
   Read_Mode   : constant Ghdl_I32 := 0;
   Write_Mode  : constant Ghdl_I32 := 1;
   Append_Mode : constant Ghdl_I32 := 2;

   --  file_open_status.
   Open_Ok      : constant Ghdl_I32 := 0;
   Status_Error : constant Ghdl_I32 := 1;
   Name_Error   : constant Ghdl_I32 := 2;
   Mode_Error   : constant Ghdl_I32 := 3;

   type Op_Status is
     (
      Op_Ok,

      --  Correspond to file_open_status.
      Op_Status_Error,
      Op_Name_Error,
      Op_Mode_Error,

      --  For endfile: end of file reached (as if endfile returns True).
      Op_End_Of_File,

      --  Failed to call ungetc in endfile.
      Op_Ungetc_Error,

      --  Operation on a non-open file.
      Op_Not_Open,

      --  Try to read from a write-only file.
      Op_Read_Write_File,

      --  Try to write to a read-only file.
      Op_Write_Read_File,

      --  Internal error: incorrect file index.
      Op_Bad_Index,

      --  Internal error: binary operation on text file, or text operation
      --  on binary file.
      Op_Bad_Mode,

      --  Internal error: destroy a file that is still open.
      Op_Not_Closed,

      --  System error during write.
      Op_Write_Error,

      --  System error during read.
      Op_Read_Error,

      --  System error during close.
      Op_Close_Error,

      --  Incorrect file name (too long).
      Op_Filename_Error,

      --  Incorrect file type.
      Op_Signature_Error

     );

   --  General files.
   procedure Ghdl_File_Endfile
     (File : Ghdl_File_Index; Status : out Op_Status);

   --  Elaboration.
   function Ghdl_Text_File_Elaborate return Ghdl_File_Index;
   function Ghdl_File_Elaborate (Sig : Ghdl_C_String) return Ghdl_File_Index;

   --  Finalization.
   procedure Ghdl_Text_File_Finalize
     (File : Ghdl_File_Index; Status : out Op_Status);
   procedure Ghdl_File_Finalize
     (File : Ghdl_File_Index; Status : out Op_Status);

   --  Subprograms.
   procedure Ghdl_Text_File_Open (File : Ghdl_File_Index;
                                  Mode : Ghdl_I32;
                                  Name : Ghdl_C_String;
                                  Status : out Op_Status);
   procedure Ghdl_File_Open (File : Ghdl_File_Index;
                             Mode : Ghdl_I32;
                             Name : Ghdl_C_String;
                             Status : out Op_Status);

   procedure Ghdl_Text_Write (File : Ghdl_File_Index;
                              Str : Std_String_Ptr;
                              Status : out Op_Status);
   procedure Ghdl_Write_Scalar (File : Ghdl_File_Index;
                                Ptr : Ghdl_Ptr;
                                Length : Ghdl_Index_Type;
                                Status : out Op_Status);

   procedure Ghdl_Read_Scalar (File : Ghdl_File_Index;
                               Ptr : Ghdl_Ptr;
                               Length : Ghdl_Index_Type;
                               Status : out Op_Status);

   procedure Ghdl_Text_Read_Length (File : Ghdl_File_Index;
                                    Str : Std_String_Ptr;
                                    Status : out Op_Status;
                                    Length : out Std_Integer);

   procedure Ghdl_Untruncated_Text_Read (File : Ghdl_File_Index;
                                         Buf : Ghdl_C_String;
                                         Len : in out Std_Integer;
                                         Status : out Op_Status);

   procedure Ghdl_Text_File_Close (File : Ghdl_File_Index;
                                   Status : out Op_Status);
   procedure Ghdl_File_Close (File : Ghdl_File_Index;
                              Status : out Op_Status);

   procedure Ghdl_File_Flush (File : Ghdl_File_Index; Status : out Op_Status);

   type Open_Handler_Acc is access function
     (Name : Ghdl_C_String; Mode : Ghdl_C_String) return Grt.Stdio.FILEs;

   --  Like fopen(3)
   function Simple_Open (Name : Ghdl_C_String; Mode : Ghdl_C_String)
                        return Grt.Stdio.FILEs;

   --  Function called to open a file.  This hook can be used to search a file
   --  on a path.
   Open_Handler : Open_Handler_Acc := Simple_Open'Access;
end Grt.Files_Operations;