1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME COMPONENTS --
5 -- A D A . T E X T _ I O --
9 -- Copyright (C) 1992-2005, Free Software Foundation, Inc. --
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 2, 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. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 ------------------------------------------------------------------------------
34 with Ada
.Streams
; use Ada
.Streams
;
35 with Interfaces
.C_Streams
; use Interfaces
.C_Streams
;
39 with Unchecked_Conversion
;
40 with Unchecked_Deallocation
;
42 pragma Elaborate_All
(System
.File_IO
);
43 -- Needed because of calls to Chain_File in package body elaboration
45 package body Ada
.Text_IO
is
47 package FIO
renames System
.File_IO
;
49 subtype AP
is FCB
.AFCB_Ptr
;
51 function To_FCB
is new Unchecked_Conversion
(File_Mode
, FCB
.File_Mode
);
52 function To_TIO
is new Unchecked_Conversion
(FCB
.File_Mode
, File_Mode
);
53 use type FCB
.File_Mode
;
55 use type System
.CRTL
.size_t
;
61 function AFCB_Allocate
(Control_Block
: Text_AFCB
) return FCB
.AFCB_Ptr
is
62 pragma Unreferenced
(Control_Block
);
71 procedure AFCB_Close
(File
: access Text_AFCB
) is
73 -- If the file being closed is one of the current files, then close
74 -- the corresponding current file. It is not clear that this action
75 -- is required (RM A.10.3(23)) but it seems reasonable, and besides
76 -- ACVC test CE3208A expects this behavior.
78 if File_Type
(File
) = Current_In
then
80 elsif File_Type
(File
) = Current_Out
then
82 elsif File_Type
(File
) = Current_Err
then
86 Terminate_Line
(File_Type
(File
));
93 procedure AFCB_Free
(File
: access Text_AFCB
) is
94 type FCB_Ptr
is access all Text_AFCB
;
95 FT
: FCB_Ptr
:= FCB_Ptr
(File
);
97 procedure Free
is new Unchecked_Deallocation
(Text_AFCB
, FCB_Ptr
);
107 procedure Close
(File
: in out File_Type
) is
109 FIO
.Close
(AP
(File
));
116 -- Note: we assume that it is impossible in practice for the column
117 -- to exceed the value of Count'Last, i.e. no check is required for
118 -- overflow raising layout error.
120 function Col
(File
: File_Type
) return Positive_Count
is
122 FIO
.Check_File_Open
(AP
(File
));
126 function Col
return Positive_Count
is
128 return Col
(Current_Out
);
136 (File
: in out File_Type
;
137 Mode
: File_Mode
:= Out_File
;
141 Dummy_File_Control_Block
: Text_AFCB
;
142 pragma Warnings
(Off
, Dummy_File_Control_Block
);
143 -- Yes, we know this is never assigned a value, only the tag
144 -- is used for dispatching purposes, so that's expected.
147 FIO
.Open
(File_Ptr
=> AP
(File
),
148 Dummy_FCB
=> Dummy_File_Control_Block
,
149 Mode
=> To_FCB
(Mode
),
163 function Current_Error
return File_Type
is
168 function Current_Error
return File_Access
is
170 return Current_Err
.Self
'Access;
177 function Current_Input
return File_Type
is
182 function Current_Input
return File_Access
is
184 return Current_In
.Self
'Access;
191 function Current_Output
return File_Type
is
196 function Current_Output
return File_Access
is
198 return Current_Out
.Self
'Access;
205 procedure Delete
(File
: in out File_Type
) is
207 FIO
.Delete
(AP
(File
));
214 function End_Of_File
(File
: File_Type
) return Boolean is
218 FIO
.Check_Read_Status
(AP
(File
));
220 if File
.Before_LM
then
222 if File
.Before_LM_PM
then
223 return Nextc
(File
) = EOF
;
237 File
.Before_LM
:= True;
241 -- Here we are just past the line mark with Before_LM set so that we
242 -- do not have to try to back up past the LM, thus avoiding the need
243 -- to back up more than one character.
250 elsif ch
= PM
and then File
.Is_Regular_File
then
251 File
.Before_LM_PM
:= True;
252 return Nextc
(File
) = EOF
;
254 -- Here if neither EOF nor PM followed end of line
263 function End_Of_File
return Boolean is
265 return End_Of_File
(Current_In
);
272 function End_Of_Line
(File
: File_Type
) return Boolean is
276 FIO
.Check_Read_Status
(AP
(File
));
278 if File
.Before_LM
then
294 function End_Of_Line
return Boolean is
296 return End_Of_Line
(Current_In
);
303 function End_Of_Page
(File
: File_Type
) return Boolean is
307 FIO
.Check_Read_Status
(AP
(File
));
309 if not File
.Is_Regular_File
then
312 elsif File
.Before_LM
then
313 if File
.Before_LM_PM
then
328 File
.Before_LM
:= True;
332 -- Here we are just past the line mark with Before_LM set so that we
333 -- do not have to try to back up past the LM, thus avoiding the need
334 -- to back up more than one character.
338 return ch
= PM
or else ch
= EOF
;
341 function End_Of_Page
return Boolean is
343 return End_Of_Page
(Current_In
);
350 function EOF_Char
return Integer is
359 procedure Flush
(File
: File_Type
) is
361 FIO
.Flush
(AP
(File
));
373 function Form
(File
: File_Type
) return String is
375 return FIO
.Form
(AP
(File
));
384 Item
: out Character)
389 FIO
.Check_Read_Status
(AP
(File
));
391 if File
.Before_LM
then
392 File
.Before_LM
:= False;
395 if File
.Before_LM_PM
then
397 File
.Page
:= File
.Page
+ 1;
398 File
.Before_LM_PM
:= False;
400 File
.Line
:= File
.Line
+ 1;
411 File
.Line
:= File
.Line
+ 1;
414 elsif ch
= PM
and then File
.Is_Regular_File
then
415 File
.Page
:= File
.Page
+ 1;
419 Item
:= Character'Val (ch
);
420 File
.Col
:= File
.Col
+ 1;
426 procedure Get
(Item
: out Character) is
428 Get
(Current_In
, Item
);
439 FIO
.Check_Read_Status
(AP
(File
));
441 if File
.Before_LM
then
442 File
.Before_LM
:= False;
443 File
.Before_LM_PM
:= False;
446 if File
.Before_LM_PM
then
448 File
.Page
:= File
.Page
+ 1;
449 File
.Before_LM_PM
:= False;
452 File
.Line
:= File
.Line
+ 1;
457 while J
<= Item
'Last loop
464 File
.Line
:= File
.Line
+ 1;
467 elsif ch
= PM
and then File
.Is_Regular_File
then
468 File
.Page
:= File
.Page
+ 1;
472 Item
(J
) := Character'Val (ch
);
474 File
.Col
:= File
.Col
+ 1;
479 procedure Get
(Item
: out String) is
481 Get
(Current_In
, Item
);
488 -- More work required here ???
490 procedure Get_Immediate
492 Item
: out Character)
497 procedure getc_immediate
500 end_of_file
: out int
);
501 pragma Import
(C
, getc_immediate
, "getc_immediate");
504 FIO
.Check_Read_Status
(AP
(File
));
506 if File
.Before_LM
then
507 File
.Before_LM
:= False;
508 File
.Before_LM_PM
:= False;
512 getc_immediate
(File
.Stream
, ch
, end_of_file
);
514 if ferror
(File
.Stream
) /= 0 then
516 elsif end_of_file
/= 0 then
521 Item
:= Character'Val (ch
);
524 procedure Get_Immediate
525 (Item
: out Character)
528 Get_Immediate
(Current_In
, Item
);
531 procedure Get_Immediate
533 Item
: out Character;
534 Available
: out Boolean)
540 procedure getc_immediate_nowait
543 end_of_file
: out int
;
545 pragma Import
(C
, getc_immediate_nowait
, "getc_immediate_nowait");
548 FIO
.Check_Read_Status
(AP
(File
));
550 -- If we are logically before an end of line, but physically after it,
551 -- then we just return the end of line character, no I/O is necessary.
553 if File
.Before_LM
then
554 File
.Before_LM
:= False;
555 File
.Before_LM_PM
:= False;
558 Item
:= Character'Val (LM
);
560 -- Normal case where a read operation is required
563 getc_immediate_nowait
(File
.Stream
, ch
, end_of_file
, avail
);
565 if ferror
(File
.Stream
) /= 0 then
568 elsif end_of_file
/= 0 then
577 Item
:= Character'Val (ch
);
583 procedure Get_Immediate
584 (Item
: out Character;
585 Available
: out Boolean)
588 Get_Immediate
(Current_In
, Item
, Available
);
603 FIO
.Check_Read_Status
(AP
(File
));
604 Last
:= Item
'First - 1;
606 -- Immediate exit for null string, this is a case in which we do not
607 -- need to test for end of file and we do not skip a line mark under
608 -- any circumstances.
610 if Last
>= Item
'Last then
614 -- Here we have at least one character, if we are immediately before
615 -- a line mark, then we will just skip past it storing no characters.
617 if File
.Before_LM
then
618 File
.Before_LM
:= False;
619 File
.Before_LM_PM
:= False;
621 -- Otherwise we need to read some characters
626 -- If we are at the end of file now, it means we are trying to
627 -- skip a file terminator and we raise End_Error (RM A.10.7(20))
633 -- Loop through characters. Don't bother if we hit a page mark,
634 -- since in normal files, page marks can only follow line marks
635 -- in any case and we only promise to treat the page nonsense
636 -- correctly in the absense of such rogue page marks.
639 -- Exit the loop if read is terminated by encountering line mark
643 -- Otherwise store the character, note that we know that ch is
644 -- something other than LM or EOF. It could possibly be a page
645 -- mark if there is a stray page mark in the middle of a line,
646 -- but this is not an official page mark in any case, since
647 -- official page marks can only follow a line mark. The whole
648 -- page business is pretty much nonsense anyway, so we do not
649 -- want to waste time trying to make sense out of non-standard
650 -- page marks in the file! This means that the behavior of
651 -- Get_Line is different from repeated Get of a character, but
652 -- that's too bad. We only promise that page numbers etc make
653 -- sense if the file is formatted in a standard manner.
655 -- Note: we do not adjust the column number because it is quicker
656 -- to adjust it once at the end of the operation than incrementing
657 -- it each time around the loop.
660 Item
(Last
) := Character'Val (ch
);
662 -- All done if the string is full, this is the case in which
663 -- we do not skip the following line mark. We need to adjust
664 -- the column number in this case.
666 if Last
= Item
'Last then
667 File
.Col
:= File
.Col
+ Count
(Item
'Length);
671 -- Otherwise read next character. We also exit from the loop if
672 -- we read an end of file. This is the case where the last line
673 -- is not terminated with a line mark, and we consider that there
674 -- is an implied line mark in this case (this is a non-standard
675 -- file, but it is nice to treat it reasonably).
682 -- We have skipped past, but not stored, a line mark. Skip following
683 -- page mark if one follows, but do not do this for a non-regular
684 -- file (since otherwise we get annoying wait for an extra character)
686 File
.Line
:= File
.Line
+ 1;
689 if File
.Before_LM_PM
then
691 File
.Before_LM_PM
:= False;
692 File
.Page
:= File
.Page
+ 1;
694 elsif File
.Is_Regular_File
then
697 if ch
= PM
and then File
.Is_Regular_File
then
699 File
.Page
:= File
.Page
+ 1;
711 Get_Line
(Current_In
, Item
, Last
);
714 function Get_Line
(File
: File_Type
) return String is
715 Buffer
: String (1 .. 500);
718 function Get_Rest
(S
: String) return String;
719 -- This is a recursive function that reads the rest of the line and
720 -- returns it. S is the part read so far.
726 function Get_Rest
(S
: String) return String is
728 -- Each time we allocate a buffer the same size as what we have
729 -- read so far. This limits us to a logarithmic number of calls
730 -- to Get_Rest and also ensures only a linear use of stack space.
732 Buffer
: String (1 .. S
'Length);
736 Get_Line
(File
, Buffer
, Last
);
739 R
: constant String := S
& Buffer
(1 .. Last
);
741 if Last
< Buffer
'Last then
749 -- Start of processing for Get_Line
752 Get_Line
(File
, Buffer
, Last
);
754 if Last
< Buffer
'Last then
755 return Buffer
(1 .. Last
);
757 return Get_Rest
(Buffer
(1 .. Last
));
761 function Get_Line
return String is
763 return Get_Line
(Current_In
);
770 function Getc
(File
: File_Type
) return int
is
774 ch
:= fgetc
(File
.Stream
);
776 if ch
= EOF
and then ferror
(File
.Stream
) /= 0 then
787 function Is_Open
(File
: File_Type
) return Boolean is
789 return FIO
.Is_Open
(AP
(File
));
796 -- Note: we assume that it is impossible in practice for the line
797 -- to exceed the value of Count'Last, i.e. no check is required for
798 -- overflow raising layout error.
800 function Line
(File
: File_Type
) return Positive_Count
is
802 FIO
.Check_File_Open
(AP
(File
));
806 function Line
return Positive_Count
is
808 return Line
(Current_Out
);
815 function Line_Length
(File
: File_Type
) return Count
is
817 FIO
.Check_Write_Status
(AP
(File
));
818 return File
.Line_Length
;
821 function Line_Length
return Count
is
823 return Line_Length
(Current_Out
);
832 Item
: out Character;
833 End_Of_Line
: out Boolean)
838 FIO
.Check_Read_Status
(AP
(File
));
840 if File
.Before_LM
then
849 or else (ch
= PM
and then File
.Is_Regular_File
)
854 End_Of_Line
:= False;
855 Item
:= Character'Val (ch
);
861 (Item
: out Character;
862 End_Of_Line
: out Boolean)
865 Look_Ahead
(Current_In
, Item
, End_Of_Line
);
872 function Mode
(File
: File_Type
) return File_Mode
is
874 return To_TIO
(FIO
.Mode
(AP
(File
)));
881 function Name
(File
: File_Type
) return String is
883 return FIO
.Name
(AP
(File
));
892 Spacing
: Positive_Count
:= 1)
895 -- Raise Constraint_Error if out of range value. The reason for this
896 -- explicit test is that we don't want junk values around, even if
897 -- checks are off in the caller.
899 if not Spacing
'Valid then
900 raise Constraint_Error
;
903 FIO
.Check_Write_Status
(AP
(File
));
905 for K
in 1 .. Spacing
loop
907 File
.Line
:= File
.Line
+ 1;
909 if File
.Page_Length
/= 0
910 and then File
.Line
> File
.Page_Length
914 File
.Page
:= File
.Page
+ 1;
921 procedure New_Line
(Spacing
: Positive_Count
:= 1) is
923 New_Line
(Current_Out
, Spacing
);
930 procedure New_Page
(File
: File_Type
) is
932 FIO
.Check_Write_Status
(AP
(File
));
934 if File
.Col
/= 1 or else File
.Line
= 1 then
939 File
.Page
:= File
.Page
+ 1;
944 procedure New_Page
is
946 New_Page
(Current_Out
);
953 function Nextc
(File
: File_Type
) return int
is
957 ch
:= fgetc
(File
.Stream
);
960 if ferror
(File
.Stream
) /= 0 then
965 if ungetc
(ch
, File
.Stream
) = EOF
then
978 (File
: in out File_Type
;
983 Dummy_File_Control_Block
: Text_AFCB
;
984 pragma Warnings
(Off
, Dummy_File_Control_Block
);
985 -- Yes, we know this is never assigned a value, only the tag
986 -- is used for dispatching purposes, so that's expected.
989 FIO
.Open
(File_Ptr
=> AP
(File
),
990 Dummy_FCB
=> Dummy_File_Control_Block
,
991 Mode
=> To_FCB
(Mode
),
1005 -- Note: we assume that it is impossible in practice for the page
1006 -- to exceed the value of Count'Last, i.e. no check is required for
1007 -- overflow raising layout error.
1009 function Page
(File
: File_Type
) return Positive_Count
is
1011 FIO
.Check_File_Open
(AP
(File
));
1015 function Page
return Positive_Count
is
1017 return Page
(Current_Out
);
1024 function Page_Length
(File
: File_Type
) return Count
is
1026 FIO
.Check_Write_Status
(AP
(File
));
1027 return File
.Page_Length
;
1030 function Page_Length
return Count
is
1032 return Page_Length
(Current_Out
);
1044 FIO
.Check_Write_Status
(AP
(File
));
1046 if File
.Line_Length
/= 0 and then File
.Col
> File
.Line_Length
then
1050 if fputc
(Character'Pos (Item
), File
.Stream
) = EOF
then
1054 File
.Col
:= File
.Col
+ 1;
1057 procedure Put
(Item
: Character) is
1059 FIO
.Check_Write_Status
(AP
(Current_Out
));
1061 if Current_Out
.Line_Length
/= 0
1062 and then Current_Out
.Col
> Current_Out
.Line_Length
1064 New_Line
(Current_Out
);
1067 if fputc
(Character'Pos (Item
), Current_Out
.Stream
) = EOF
then
1071 Current_Out
.Col
:= Current_Out
.Col
+ 1;
1083 FIO
.Check_Write_Status
(AP
(File
));
1085 if Item
'Length > 0 then
1087 -- If we have bounded lines, then do things character by
1088 -- character (this seems a rare case anyway!)
1090 if File
.Line_Length
/= 0 then
1091 for J
in Item
'Range loop
1092 Put
(File
, Item
(J
));
1095 -- Otherwise we can output the entire string at once. Note that if
1096 -- there are LF or FF characters in the string, we do not bother to
1097 -- count them as line or page terminators.
1100 FIO
.Write_Buf
(AP
(File
), Item
'Address, Item
'Length);
1101 File
.Col
:= File
.Col
+ Item
'Length;
1106 procedure Put
(Item
: String) is
1108 Put
(Current_Out
, Item
);
1119 Ilen
: Natural := Item
'Length;
1120 Istart
: Natural := Item
'First;
1123 FIO
.Check_Write_Status
(AP
(File
));
1125 -- If we have bounded lines, then just do a put and a new line. In
1126 -- this case we will end up doing things character by character in
1127 -- any case, and it is a rare situation.
1129 if File
.Line_Length
/= 0 then
1135 -- We setup a single string that has the necessary terminators and
1136 -- then write it with a single call. The reason for doing this is
1137 -- that it gives better behavior for the use of Put_Line in multi-
1138 -- tasking programs, since often the OS will treat the entire put
1139 -- operation as an atomic operation.
1141 -- We only do this if the message is 512 characters or less in length,
1142 -- since otherwise Put_Line would use an unbounded amount of stack
1143 -- space and could cause undetected stack overflow. If we have a
1144 -- longer string, then output the first part separately to avoid this.
1147 FIO
.Write_Buf
(AP
(File
), Item
'Address, size_t
(Ilen
- 512));
1148 Istart
:= Istart
+ Ilen
- 512;
1152 -- Now prepare the string with its terminator
1155 Buffer
: String (1 .. Ilen
+ 2);
1159 Buffer
(1 .. Ilen
) := Item
(Istart
.. Item
'Last);
1160 Buffer
(Ilen
+ 1) := Character'Val (LM
);
1162 if File
.Page_Length
/= 0
1163 and then File
.Line
> File
.Page_Length
1165 Buffer
(Ilen
+ 2) := Character'Val (PM
);
1166 Plen
:= size_t
(Ilen
) + 2;
1168 File
.Page
:= File
.Page
+ 1;
1171 Plen
:= size_t
(Ilen
) + 1;
1172 File
.Line
:= File
.Line
+ 1;
1175 FIO
.Write_Buf
(AP
(File
), Buffer
'Address, Plen
);
1181 procedure Put_Line
(Item
: String) is
1183 Put_Line
(Current_Out
, Item
);
1190 procedure Putc
(ch
: int
; File
: File_Type
) is
1192 if fputc
(ch
, File
.Stream
) = EOF
then
1201 -- This is the primitive Stream Read routine, used when a Text_IO file
1202 -- is treated directly as a stream using Text_IO.Streams.Stream.
1205 (File
: in out Text_AFCB
;
1206 Item
: out Stream_Element_Array
;
1207 Last
: out Stream_Element_Offset
)
1210 pragma Warnings
(Off
, Discard_ch
);
1213 if File
.Mode
/= FCB
.In_File
then
1217 -- Deal with case where our logical and physical position do not match
1218 -- because of being after an LM or LM-PM sequence when in fact we are
1219 -- logically positioned before it.
1221 if File
.Before_LM
then
1223 -- If we are before a PM, then it is possible for a stream read
1224 -- to leave us after the LM and before the PM, which is a bit
1225 -- odd. The easiest way to deal with this is to unget the PM,
1226 -- so we are indeed positioned between the characters. This way
1227 -- further stream read operations will work correctly, and the
1228 -- effect on text processing is a little weird, but what can
1229 -- be expected if stream and text input are mixed this way?
1231 if File
.Before_LM_PM
then
1232 Discard_ch
:= ungetc
(PM
, File
.Stream
);
1233 File
.Before_LM_PM
:= False;
1236 File
.Before_LM
:= False;
1238 Item
(Item
'First) := Stream_Element
(Character'Pos (ASCII
.LF
));
1240 if Item
'Length = 1 then
1246 Stream_Element_Offset
1247 (fread
(buffer
=> Item
'Address,
1248 index
=> size_t
(Item
'First + 1),
1250 count
=> Item
'Length - 1,
1251 stream
=> File
.Stream
));
1257 -- Now we do the read. Since this is a text file, it is normally in
1258 -- text mode, but stream data must be read in binary mode, so we
1259 -- temporarily set binary mode for the read, resetting it after.
1260 -- These calls have no effect in a system (like Unix) where there is
1261 -- no distinction between text and binary files.
1263 set_binary_mode
(fileno
(File
.Stream
));
1267 Stream_Element_Offset
1268 (fread
(Item
'Address, 1, Item
'Length, File
.Stream
)) - 1;
1270 if Last
< Item
'Last then
1271 if ferror
(File
.Stream
) /= 0 then
1276 set_text_mode
(fileno
(File
.Stream
));
1284 (File
: in out File_Type
;
1288 -- Don't allow change of mode for current file (RM A.10.2(5))
1290 if (File
= Current_In
or else
1291 File
= Current_Out
or else
1292 File
= Current_Error
)
1293 and then To_FCB
(Mode
) /= File
.Mode
1298 Terminate_Line
(File
);
1299 FIO
.Reset
(AP
(File
), To_FCB
(Mode
));
1303 File
.Line_Length
:= 0;
1304 File
.Page_Length
:= 0;
1305 File
.Before_LM
:= False;
1306 File
.Before_LM_PM
:= False;
1309 procedure Reset
(File
: in out File_Type
) is
1311 Terminate_Line
(File
);
1312 FIO
.Reset
(AP
(File
));
1316 File
.Line_Length
:= 0;
1317 File
.Page_Length
:= 0;
1318 File
.Before_LM
:= False;
1319 File
.Before_LM_PM
:= False;
1328 To
: Positive_Count
)
1333 -- Raise Constraint_Error if out of range value. The reason for this
1334 -- explicit test is that we don't want junk values around, even if
1335 -- checks are off in the caller.
1337 if not To
'Valid then
1338 raise Constraint_Error
;
1341 FIO
.Check_File_Open
(AP
(File
));
1345 if Mode
(File
) >= Out_File
then
1347 -- Error if we attempt to set Col to a value greater than the
1348 -- maximum permissible line length.
1350 if File
.Line_Length
/= 0 and then To
> File
.Line_Length
then
1354 -- If we are behind current position, then go to start of new line
1356 if To
< File
.Col
then
1360 -- Loop to output blanks till we are at the required column
1362 while File
.Col
< To
loop
1369 -- If we are logically before a LM, but physically after it, the
1370 -- file position still reflects the position before the LM, so eat
1371 -- it now and adjust the file position appropriately.
1373 if File
.Before_LM
then
1374 File
.Before_LM
:= False;
1375 File
.Before_LM_PM
:= False;
1376 File
.Line
:= File
.Line
+ 1;
1380 -- Loop reading characters till we get one at the required Col value
1383 -- Read next character. The reason we have to read ahead is to
1384 -- skip formatting characters, the effect of Set_Col is to set
1385 -- us to a real character with the right Col value, and format
1386 -- characters don't count.
1390 -- Error if we hit an end of file
1395 -- If line mark, eat it and adjust file position
1398 File
.Line
:= File
.Line
+ 1;
1401 -- If recognized page mark, eat it, and adjust file position
1403 elsif ch
= PM
and then File
.Is_Regular_File
then
1404 File
.Page
:= File
.Page
+ 1;
1408 -- Otherwise this is the character we are looking for, so put it
1409 -- back in the input stream (we have not adjusted the file
1410 -- position yet, so everything is set right after this ungetc).
1412 elsif To
= File
.Col
then
1416 -- Keep skipping characters if we are not there yet, updating the
1417 -- file position past the skipped character.
1420 File
.Col
:= File
.Col
+ 1;
1426 procedure Set_Col
(To
: Positive_Count
) is
1428 Set_Col
(Current_Out
, To
);
1435 procedure Set_Error
(File
: File_Type
) is
1437 FIO
.Check_Write_Status
(AP
(File
));
1438 Current_Err
:= File
;
1445 procedure Set_Input
(File
: File_Type
) is
1447 FIO
.Check_Read_Status
(AP
(File
));
1457 To
: Positive_Count
)
1460 -- Raise Constraint_Error if out of range value. The reason for this
1461 -- explicit test is that we don't want junk values around, even if
1462 -- checks are off in the caller.
1464 if not To
'Valid then
1465 raise Constraint_Error
;
1468 FIO
.Check_File_Open
(AP
(File
));
1470 if To
= File
.Line
then
1474 if Mode
(File
) >= Out_File
then
1475 if File
.Page_Length
/= 0 and then To
> File
.Page_Length
then
1479 if To
< File
.Line
then
1483 while File
.Line
< To
loop
1488 while To
/= File
.Line
loop
1494 procedure Set_Line
(To
: Positive_Count
) is
1496 Set_Line
(Current_Out
, To
);
1499 ---------------------
1500 -- Set_Line_Length --
1501 ---------------------
1503 procedure Set_Line_Length
(File
: File_Type
; To
: Count
) is
1505 -- Raise Constraint_Error if out of range value. The reason for this
1506 -- explicit test is that we don't want junk values around, even if
1507 -- checks are off in the caller.
1509 if not To
'Valid then
1510 raise Constraint_Error
;
1513 FIO
.Check_Write_Status
(AP
(File
));
1514 File
.Line_Length
:= To
;
1515 end Set_Line_Length
;
1517 procedure Set_Line_Length
(To
: Count
) is
1519 Set_Line_Length
(Current_Out
, To
);
1520 end Set_Line_Length
;
1526 procedure Set_Output
(File
: File_Type
) is
1528 FIO
.Check_Write_Status
(AP
(File
));
1529 Current_Out
:= File
;
1532 ---------------------
1533 -- Set_Page_Length --
1534 ---------------------
1536 procedure Set_Page_Length
(File
: File_Type
; To
: Count
) is
1538 -- Raise Constraint_Error if out of range value. The reason for this
1539 -- explicit test is that we don't want junk values around, even if
1540 -- checks are off in the caller.
1542 if not To
'Valid then
1543 raise Constraint_Error
;
1546 FIO
.Check_Write_Status
(AP
(File
));
1547 File
.Page_Length
:= To
;
1548 end Set_Page_Length
;
1550 procedure Set_Page_Length
(To
: Count
) is
1552 Set_Page_Length
(Current_Out
, To
);
1553 end Set_Page_Length
;
1561 Spacing
: Positive_Count
:= 1)
1566 -- Raise Constraint_Error if out of range value. The reason for this
1567 -- explicit test is that we don't want junk values around, even if
1568 -- checks are off in the caller.
1570 if not Spacing
'Valid then
1571 raise Constraint_Error
;
1574 FIO
.Check_Read_Status
(AP
(File
));
1576 for L
in 1 .. Spacing
loop
1577 if File
.Before_LM
then
1578 File
.Before_LM
:= False;
1579 File
.Before_LM_PM
:= False;
1584 -- If at end of file now, then immediately raise End_Error. Note
1585 -- that we can never be positioned between a line mark and a page
1586 -- mark, so if we are at the end of file, we cannot logically be
1587 -- before the implicit page mark that is at the end of the file.
1589 -- For the same reason, we do not need an explicit check for a
1590 -- page mark. If there is a FF in the middle of a line, the file
1591 -- is not in canonical format and we do not care about the page
1592 -- numbers for files other than ones in canonical format.
1598 -- If not at end of file, then loop till we get to an LM or EOF.
1599 -- The latter case happens only in non-canonical files where the
1600 -- last line is not terminated by LM, but we don't want to blow
1601 -- up for such files, so we assume an implicit LM in this case.
1604 exit when ch
= LM
or ch
= EOF
;
1609 -- We have got past a line mark, now, for a regular file only,
1610 -- see if a page mark immediately follows this line mark and
1611 -- if so, skip past the page mark as well. We do not do this
1612 -- for non-regular files, since it would cause an undesirable
1613 -- wait for an additional character.
1616 File
.Line
:= File
.Line
+ 1;
1618 if File
.Before_LM_PM
then
1619 File
.Page
:= File
.Page
+ 1;
1621 File
.Before_LM_PM
:= False;
1623 elsif File
.Is_Regular_File
then
1626 -- Page mark can be explicit, or implied at the end of the file
1628 if (ch
= PM
or else ch
= EOF
)
1629 and then File
.Is_Regular_File
1631 File
.Page
:= File
.Page
+ 1;
1641 procedure Skip_Line
(Spacing
: Positive_Count
:= 1) is
1643 Skip_Line
(Current_In
, Spacing
);
1650 procedure Skip_Page
(File
: File_Type
) is
1654 FIO
.Check_Read_Status
(AP
(File
));
1656 -- If at page mark already, just skip it
1658 if File
.Before_LM_PM
then
1659 File
.Before_LM
:= False;
1660 File
.Before_LM_PM
:= False;
1661 File
.Page
:= File
.Page
+ 1;
1667 -- This is a bit tricky, if we are logically before an LM then
1668 -- it is not an error if we are at an end of file now, since we
1669 -- are not really at it.
1671 if File
.Before_LM
then
1672 File
.Before_LM
:= False;
1673 File
.Before_LM_PM
:= False;
1676 -- Otherwise we do raise End_Error if we are at the end of file now
1686 -- Now we can just rumble along to the next page mark, or to the
1687 -- end of file, if that comes first. The latter case happens when
1688 -- the page mark is implied at the end of file.
1692 or else (ch
= PM
and then File
.Is_Regular_File
);
1696 File
.Page
:= File
.Page
+ 1;
1701 procedure Skip_Page
is
1703 Skip_Page
(Current_In
);
1706 --------------------
1707 -- Standard_Error --
1708 --------------------
1710 function Standard_Error
return File_Type
is
1712 return Standard_Err
;
1715 function Standard_Error
return File_Access
is
1717 return Standard_Err
'Access;
1720 --------------------
1721 -- Standard_Input --
1722 --------------------
1724 function Standard_Input
return File_Type
is
1729 function Standard_Input
return File_Access
is
1731 return Standard_In
'Access;
1734 ---------------------
1735 -- Standard_Output --
1736 ---------------------
1738 function Standard_Output
return File_Type
is
1740 return Standard_Out
;
1741 end Standard_Output
;
1743 function Standard_Output
return File_Access
is
1745 return Standard_Out
'Access;
1746 end Standard_Output
;
1748 --------------------
1749 -- Terminate_Line --
1750 --------------------
1752 procedure Terminate_Line
(File
: File_Type
) is
1754 FIO
.Check_File_Open
(AP
(File
));
1756 -- For file other than In_File, test for needing to terminate last line
1758 if Mode
(File
) /= In_File
then
1760 -- If not at start of line definition need new line
1762 if File
.Col
/= 1 then
1765 -- For files other than standard error and standard output, we
1766 -- make sure that an empty file has a single line feed, so that
1767 -- it is properly formatted. We avoid this for the standard files
1768 -- because it is too much of a nuisance to have these odd line
1769 -- feeds when nothing has been written to the file.
1771 -- We also avoid this for files opened in append mode, in
1772 -- accordance with (RM A.8.2(10))
1774 elsif (File
/= Standard_Err
and then File
/= Standard_Out
)
1775 and then (File
.Line
= 1 and then File
.Page
= 1)
1776 and then Mode
(File
) = Out_File
1787 procedure Ungetc
(ch
: int
; File
: File_Type
) is
1790 if ungetc
(ch
, File
.Stream
) = EOF
then
1800 -- This is the primitive Stream Write routine, used when a Text_IO file
1801 -- is treated directly as a stream using Text_IO.Streams.Stream.
1804 (File
: in out Text_AFCB
;
1805 Item
: Stream_Element_Array
)
1808 function Has_Translated_Characters
return Boolean;
1809 -- return True if Item array contains a character which will be
1810 -- translated under the text file mode. There is only one such
1811 -- character under DOS based systems which is character 10.
1813 text_translation_required
: Boolean;
1814 pragma Import
(C
, text_translation_required
,
1815 "__gnat_text_translation_required");
1817 Siz
: constant size_t
:= Item
'Length;
1819 function Has_Translated_Characters
return Boolean is
1821 for K
in Item
'Range loop
1822 if Item
(K
) = 10 then
1827 end Has_Translated_Characters
;
1829 Needs_Binary_Write
: constant Boolean :=
1830 text_translation_required
and then Has_Translated_Characters
;
1833 if File
.Mode
= FCB
.In_File
then
1837 -- Now we do the write. Since this is a text file, it is normally in
1838 -- text mode, but stream data must be written in binary mode, so we
1839 -- temporarily set binary mode for the write, resetting it after. This
1840 -- is done only if needed (i.e. there is some characters in Item which
1841 -- needs to be written using the binary mode).
1842 -- These calls have no effect in a system (like Unix) where there is
1843 -- no distinction between text and binary files.
1845 -- Since the character translation is done at the time the buffer is
1846 -- written (this is true under Windows) we first flush current buffer
1847 -- with text mode if needed.
1849 if Needs_Binary_Write
then
1851 if fflush
(File
.Stream
) = -1 then
1855 set_binary_mode
(fileno
(File
.Stream
));
1858 if fwrite
(Item
'Address, 1, Siz
, File
.Stream
) /= Siz
then
1862 -- At this point we need to flush the buffer using the binary mode then
1863 -- we reset to text mode.
1865 if Needs_Binary_Write
then
1867 if fflush
(File
.Stream
) = -1 then
1871 set_text_mode
(fileno
(File
.Stream
));
1875 -- Use "preallocated" strings to avoid calling "new" during the
1876 -- elaboration of the run time. This is needed in the tasking case to
1877 -- avoid calling Task_Lock too early. A filename is expected to end with a
1878 -- null character in the runtime, here the null characters are added just
1879 -- to have a correct filename length.
1881 Err_Name
: aliased String := "*stderr" & ASCII
.Nul
;
1882 In_Name
: aliased String := "*stdin" & ASCII
.Nul
;
1883 Out_Name
: aliased String := "*stdout" & ASCII
.Nul
;
1885 -------------------------------
1886 -- Initialize Standard Files --
1887 -------------------------------
1889 -- Note: the names in these files are bogus, and probably it would be
1890 -- better for these files to have no names, but the ACVC test insist!
1891 -- We use names that are bound to fail in open etc.
1893 Standard_Err
.Stream
:= stderr
;
1894 Standard_Err
.Name
:= Err_Name
'Access;
1895 Standard_Err
.Form
:= Null_Str
'Unrestricted_Access;
1896 Standard_Err
.Mode
:= FCB
.Out_File
;
1897 Standard_Err
.Is_Regular_File
:= is_regular_file
(fileno
(stderr
)) /= 0;
1898 Standard_Err
.Is_Temporary_File
:= False;
1899 Standard_Err
.Is_System_File
:= True;
1900 Standard_Err
.Is_Text_File
:= True;
1901 Standard_Err
.Access_Method
:= 'T';
1902 Standard_Err
.Self
:= Standard_Err
;
1904 Standard_In
.Stream
:= stdin
;
1905 Standard_In
.Name
:= In_Name
'Access;
1906 Standard_In
.Form
:= Null_Str
'Unrestricted_Access;
1907 Standard_In
.Mode
:= FCB
.In_File
;
1908 Standard_In
.Is_Regular_File
:= is_regular_file
(fileno
(stdin
)) /= 0;
1909 Standard_In
.Is_Temporary_File
:= False;
1910 Standard_In
.Is_System_File
:= True;
1911 Standard_In
.Is_Text_File
:= True;
1912 Standard_In
.Access_Method
:= 'T';
1913 Standard_In
.Self
:= Standard_In
;
1915 Standard_Out
.Stream
:= stdout
;
1916 Standard_Out
.Name
:= Out_Name
'Access;
1917 Standard_Out
.Form
:= Null_Str
'Unrestricted_Access;
1918 Standard_Out
.Mode
:= FCB
.Out_File
;
1919 Standard_Out
.Is_Regular_File
:= is_regular_file
(fileno
(stdout
)) /= 0;
1920 Standard_Out
.Is_Temporary_File
:= False;
1921 Standard_Out
.Is_System_File
:= True;
1922 Standard_Out
.Is_Text_File
:= True;
1923 Standard_Out
.Access_Method
:= 'T';
1924 Standard_Out
.Self
:= Standard_Out
;
1926 FIO
.Chain_File
(AP
(Standard_In
));
1927 FIO
.Chain_File
(AP
(Standard_Out
));
1928 FIO
.Chain_File
(AP
(Standard_Err
));
1930 FIO
.Make_Unbuffered
(AP
(Standard_Out
));
1931 FIO
.Make_Unbuffered
(AP
(Standard_Err
));