1 ------------------------------------------------------------------------------
3 -- GNAT RUNTIME COMPONENTS --
5 -- A D A . T E X T _ I O --
9 -- Copyright (C) 1992-2004 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, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, 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
);
72 procedure AFCB_Close
(File
: access Text_AFCB
) is
74 -- If the file being closed is one of the current files, then close
75 -- the corresponding current file. It is not clear that this action
76 -- is required (RM A.10.3(23)) but it seems reasonable, and besides
77 -- ACVC test CE3208A expects this behavior.
79 if File_Type
(File
) = Current_In
then
81 elsif File_Type
(File
) = Current_Out
then
83 elsif File_Type
(File
) = Current_Err
then
87 Terminate_Line
(File_Type
(File
));
94 procedure AFCB_Free
(File
: access Text_AFCB
) is
95 type FCB_Ptr
is access all Text_AFCB
;
96 FT
: FCB_Ptr
:= FCB_Ptr
(File
);
98 procedure Free
is new Unchecked_Deallocation
(Text_AFCB
, FCB_Ptr
);
108 procedure Close
(File
: in out File_Type
) is
110 FIO
.Close
(AP
(File
));
117 -- Note: we assume that it is impossible in practice for the column
118 -- to exceed the value of Count'Last, i.e. no check is required for
119 -- overflow raising layout error.
121 function Col
(File
: in File_Type
) return Positive_Count
is
123 FIO
.Check_File_Open
(AP
(File
));
127 function Col
return Positive_Count
is
129 return Col
(Current_Out
);
137 (File
: in out File_Type
;
138 Mode
: in File_Mode
:= Out_File
;
139 Name
: in String := "";
140 Form
: in String := "")
142 Dummy_File_Control_Block
: Text_AFCB
;
143 pragma Warnings
(Off
, Dummy_File_Control_Block
);
144 -- Yes, we know this is never assigned a value, only the tag
145 -- is used for dispatching purposes, so that's expected.
148 FIO
.Open
(File_Ptr
=> AP
(File
),
149 Dummy_FCB
=> Dummy_File_Control_Block
,
150 Mode
=> To_FCB
(Mode
),
164 function Current_Error
return File_Type
is
169 function Current_Error
return File_Access
is
171 return Current_Err
.Self
'Access;
178 function Current_Input
return File_Type
is
183 function Current_Input
return File_Access
is
185 return Current_In
.Self
'Access;
192 function Current_Output
return File_Type
is
197 function Current_Output
return File_Access
is
199 return Current_Out
.Self
'Access;
206 procedure Delete
(File
: in out File_Type
) is
208 FIO
.Delete
(AP
(File
));
215 function End_Of_File
(File
: in File_Type
) return Boolean is
219 FIO
.Check_Read_Status
(AP
(File
));
221 if File
.Before_LM
then
223 if File
.Before_LM_PM
then
224 return Nextc
(File
) = EOF
;
238 File
.Before_LM
:= True;
242 -- Here we are just past the line mark with Before_LM set so that we
243 -- do not have to try to back up past the LM, thus avoiding the need
244 -- to back up more than one character.
251 elsif ch
= PM
and then File
.Is_Regular_File
then
252 File
.Before_LM_PM
:= True;
253 return Nextc
(File
) = EOF
;
255 -- Here if neither EOF nor PM followed end of line
264 function End_Of_File
return Boolean is
266 return End_Of_File
(Current_In
);
273 function End_Of_Line
(File
: in File_Type
) return Boolean is
277 FIO
.Check_Read_Status
(AP
(File
));
279 if File
.Before_LM
then
295 function End_Of_Line
return Boolean is
297 return End_Of_Line
(Current_In
);
304 function End_Of_Page
(File
: in File_Type
) return Boolean is
308 FIO
.Check_Read_Status
(AP
(File
));
310 if not File
.Is_Regular_File
then
313 elsif File
.Before_LM
then
314 if File
.Before_LM_PM
then
329 File
.Before_LM
:= True;
333 -- Here we are just past the line mark with Before_LM set so that we
334 -- do not have to try to back up past the LM, thus avoiding the need
335 -- to back up more than one character.
339 return ch
= PM
or else ch
= EOF
;
342 function End_Of_Page
return Boolean is
344 return End_Of_Page
(Current_In
);
351 function EOF_Char
return Integer is
360 procedure Flush
(File
: in File_Type
) is
362 FIO
.Flush
(AP
(File
));
374 function Form
(File
: in File_Type
) return String is
376 return FIO
.Form
(AP
(File
));
384 (File
: in File_Type
;
385 Item
: out Character)
390 FIO
.Check_Read_Status
(AP
(File
));
392 if File
.Before_LM
then
393 File
.Before_LM
:= False;
396 if File
.Before_LM_PM
then
398 File
.Page
:= File
.Page
+ 1;
399 File
.Before_LM_PM
:= False;
401 File
.Line
:= File
.Line
+ 1;
412 File
.Line
:= File
.Line
+ 1;
415 elsif ch
= PM
and then File
.Is_Regular_File
then
416 File
.Page
:= File
.Page
+ 1;
420 Item
:= Character'Val (ch
);
421 File
.Col
:= File
.Col
+ 1;
427 procedure Get
(Item
: out Character) is
429 Get
(Current_In
, Item
);
433 (File
: in File_Type
;
440 FIO
.Check_Read_Status
(AP
(File
));
442 if File
.Before_LM
then
443 File
.Before_LM
:= False;
444 File
.Before_LM_PM
:= False;
447 if File
.Before_LM_PM
then
449 File
.Page
:= File
.Page
+ 1;
450 File
.Before_LM_PM
:= False;
453 File
.Line
:= File
.Line
+ 1;
458 while J
<= Item
'Last loop
465 File
.Line
:= File
.Line
+ 1;
468 elsif ch
= PM
and then File
.Is_Regular_File
then
469 File
.Page
:= File
.Page
+ 1;
473 Item
(J
) := Character'Val (ch
);
475 File
.Col
:= File
.Col
+ 1;
480 procedure Get
(Item
: out String) is
482 Get
(Current_In
, Item
);
489 -- More work required here ???
491 procedure Get_Immediate
492 (File
: in File_Type
;
493 Item
: out Character)
498 procedure getc_immediate
501 end_of_file
: out int
);
502 pragma Import
(C
, getc_immediate
, "getc_immediate");
505 FIO
.Check_Read_Status
(AP
(File
));
507 if File
.Before_LM
then
508 File
.Before_LM
:= False;
509 File
.Before_LM_PM
:= False;
513 getc_immediate
(File
.Stream
, ch
, end_of_file
);
515 if ferror
(File
.Stream
) /= 0 then
517 elsif end_of_file
/= 0 then
522 Item
:= Character'Val (ch
);
525 procedure Get_Immediate
526 (Item
: out Character)
529 Get_Immediate
(Current_In
, Item
);
532 procedure Get_Immediate
533 (File
: in File_Type
;
534 Item
: out Character;
535 Available
: out Boolean)
541 procedure getc_immediate_nowait
544 end_of_file
: out int
;
546 pragma Import
(C
, getc_immediate_nowait
, "getc_immediate_nowait");
549 FIO
.Check_Read_Status
(AP
(File
));
551 -- If we are logically before an end of line, but physically after it,
552 -- then we just return the end of line character, no I/O is necessary.
554 if File
.Before_LM
then
555 File
.Before_LM
:= False;
556 File
.Before_LM_PM
:= False;
559 Item
:= Character'Val (LM
);
561 -- Normal case where a read operation is required
564 getc_immediate_nowait
(File
.Stream
, ch
, end_of_file
, avail
);
566 if ferror
(File
.Stream
) /= 0 then
569 elsif end_of_file
/= 0 then
578 Item
:= Character'Val (ch
);
584 procedure Get_Immediate
585 (Item
: out Character;
586 Available
: out Boolean)
589 Get_Immediate
(Current_In
, Item
, Available
);
597 (File
: in File_Type
;
604 FIO
.Check_Read_Status
(AP
(File
));
605 Last
:= Item
'First - 1;
607 -- Immediate exit for null string, this is a case in which we do not
608 -- need to test for end of file and we do not skip a line mark under
609 -- any circumstances.
611 if Last
>= Item
'Last then
615 -- Here we have at least one character, if we are immediately before
616 -- a line mark, then we will just skip past it storing no characters.
618 if File
.Before_LM
then
619 File
.Before_LM
:= False;
620 File
.Before_LM_PM
:= False;
622 -- Otherwise we need to read some characters
627 -- If we are at the end of file now, it means we are trying to
628 -- skip a file terminator and we raise End_Error (RM A.10.7(20))
634 -- Loop through characters. Don't bother if we hit a page mark,
635 -- since in normal files, page marks can only follow line marks
636 -- in any case and we only promise to treat the page nonsense
637 -- correctly in the absense of such rogue page marks.
640 -- Exit the loop if read is terminated by encountering line mark
644 -- Otherwise store the character, note that we know that ch is
645 -- something other than LM or EOF. It could possibly be a page
646 -- mark if there is a stray page mark in the middle of a line,
647 -- but this is not an official page mark in any case, since
648 -- official page marks can only follow a line mark. The whole
649 -- page business is pretty much nonsense anyway, so we do not
650 -- want to waste time trying to make sense out of non-standard
651 -- page marks in the file! This means that the behavior of
652 -- Get_Line is different from repeated Get of a character, but
653 -- that's too bad. We only promise that page numbers etc make
654 -- sense if the file is formatted in a standard manner.
656 -- Note: we do not adjust the column number because it is quicker
657 -- to adjust it once at the end of the operation than incrementing
658 -- it each time around the loop.
661 Item
(Last
) := Character'Val (ch
);
663 -- All done if the string is full, this is the case in which
664 -- we do not skip the following line mark. We need to adjust
665 -- the column number in this case.
667 if Last
= Item
'Last then
668 File
.Col
:= File
.Col
+ Count
(Item
'Length);
672 -- Otherwise read next character. We also exit from the loop if
673 -- we read an end of file. This is the case where the last line
674 -- is not terminated with a line mark, and we consider that there
675 -- is an implied line mark in this case (this is a non-standard
676 -- file, but it is nice to treat it reasonably).
683 -- We have skipped past, but not stored, a line mark. Skip following
684 -- page mark if one follows, but do not do this for a non-regular
685 -- file (since otherwise we get annoying wait for an extra character)
687 File
.Line
:= File
.Line
+ 1;
690 if File
.Before_LM_PM
then
692 File
.Before_LM_PM
:= False;
693 File
.Page
:= File
.Page
+ 1;
695 elsif File
.Is_Regular_File
then
698 if ch
= PM
and then File
.Is_Regular_File
then
700 File
.Page
:= File
.Page
+ 1;
712 Get_Line
(Current_In
, Item
, Last
);
719 function Getc
(File
: File_Type
) return int
is
723 ch
:= fgetc
(File
.Stream
);
725 if ch
= EOF
and then ferror
(File
.Stream
) /= 0 then
736 function Is_Open
(File
: in File_Type
) return Boolean is
738 return FIO
.Is_Open
(AP
(File
));
745 -- Note: we assume that it is impossible in practice for the line
746 -- to exceed the value of Count'Last, i.e. no check is required for
747 -- overflow raising layout error.
749 function Line
(File
: in File_Type
) return Positive_Count
is
751 FIO
.Check_File_Open
(AP
(File
));
755 function Line
return Positive_Count
is
757 return Line
(Current_Out
);
764 function Line_Length
(File
: in File_Type
) return Count
is
766 FIO
.Check_Write_Status
(AP
(File
));
767 return File
.Line_Length
;
770 function Line_Length
return Count
is
772 return Line_Length
(Current_Out
);
780 (File
: in File_Type
;
781 Item
: out Character;
782 End_Of_Line
: out Boolean)
787 FIO
.Check_Read_Status
(AP
(File
));
789 if File
.Before_LM
then
798 or else (ch
= PM
and then File
.Is_Regular_File
)
803 End_Of_Line
:= False;
804 Item
:= Character'Val (ch
);
810 (Item
: out Character;
811 End_Of_Line
: out Boolean)
814 Look_Ahead
(Current_In
, Item
, End_Of_Line
);
821 function Mode
(File
: in File_Type
) return File_Mode
is
823 return To_TIO
(FIO
.Mode
(AP
(File
)));
830 function Name
(File
: in File_Type
) return String is
832 return FIO
.Name
(AP
(File
));
840 (File
: in File_Type
;
841 Spacing
: in Positive_Count
:= 1)
844 -- Raise Constraint_Error if out of range value. The reason for this
845 -- explicit test is that we don't want junk values around, even if
846 -- checks are off in the caller.
848 if Spacing
not in Positive_Count
then
849 raise Constraint_Error
;
852 FIO
.Check_Write_Status
(AP
(File
));
854 for K
in 1 .. Spacing
loop
856 File
.Line
:= File
.Line
+ 1;
858 if File
.Page_Length
/= 0
859 and then File
.Line
> File
.Page_Length
863 File
.Page
:= File
.Page
+ 1;
870 procedure New_Line
(Spacing
: in Positive_Count
:= 1) is
872 New_Line
(Current_Out
, Spacing
);
879 procedure New_Page
(File
: in File_Type
) is
881 FIO
.Check_Write_Status
(AP
(File
));
883 if File
.Col
/= 1 or else File
.Line
= 1 then
888 File
.Page
:= File
.Page
+ 1;
893 procedure New_Page
is
895 New_Page
(Current_Out
);
902 function Nextc
(File
: File_Type
) return int
is
906 ch
:= fgetc
(File
.Stream
);
909 if ferror
(File
.Stream
) /= 0 then
914 if ungetc
(ch
, File
.Stream
) = EOF
then
927 (File
: in out File_Type
;
930 Form
: in String := "")
932 Dummy_File_Control_Block
: Text_AFCB
;
933 pragma Warnings
(Off
, Dummy_File_Control_Block
);
934 -- Yes, we know this is never assigned a value, only the tag
935 -- is used for dispatching purposes, so that's expected.
938 FIO
.Open
(File_Ptr
=> AP
(File
),
939 Dummy_FCB
=> Dummy_File_Control_Block
,
940 Mode
=> To_FCB
(Mode
),
954 -- Note: we assume that it is impossible in practice for the page
955 -- to exceed the value of Count'Last, i.e. no check is required for
956 -- overflow raising layout error.
958 function Page
(File
: in File_Type
) return Positive_Count
is
960 FIO
.Check_File_Open
(AP
(File
));
964 function Page
return Positive_Count
is
966 return Page
(Current_Out
);
973 function Page_Length
(File
: in File_Type
) return Count
is
975 FIO
.Check_Write_Status
(AP
(File
));
976 return File
.Page_Length
;
979 function Page_Length
return Count
is
981 return Page_Length
(Current_Out
);
989 (File
: in File_Type
;
993 FIO
.Check_Write_Status
(AP
(File
));
995 if File
.Line_Length
/= 0 and then File
.Col
> File
.Line_Length
then
999 if fputc
(Character'Pos (Item
), File
.Stream
) = EOF
then
1003 File
.Col
:= File
.Col
+ 1;
1006 procedure Put
(Item
: in Character) is
1008 FIO
.Check_Write_Status
(AP
(Current_Out
));
1010 if Current_Out
.Line_Length
/= 0
1011 and then Current_Out
.Col
> Current_Out
.Line_Length
1013 New_Line
(Current_Out
);
1016 if fputc
(Character'Pos (Item
), Current_Out
.Stream
) = EOF
then
1020 Current_Out
.Col
:= Current_Out
.Col
+ 1;
1028 (File
: in File_Type
;
1032 FIO
.Check_Write_Status
(AP
(File
));
1034 if Item
'Length > 0 then
1036 -- If we have bounded lines, then do things character by
1037 -- character (this seems a rare case anyway!)
1039 if File
.Line_Length
/= 0 then
1040 for J
in Item
'Range loop
1041 Put
(File
, Item
(J
));
1044 -- Otherwise we can output the entire string at once. Note that if
1045 -- there are LF or FF characters in the string, we do not bother to
1046 -- count them as line or page terminators.
1049 FIO
.Write_Buf
(AP
(File
), Item
'Address, Item
'Length);
1050 File
.Col
:= File
.Col
+ Item
'Length;
1055 procedure Put
(Item
: in String) is
1057 Put
(Current_Out
, Item
);
1065 (File
: in File_Type
;
1068 Ilen
: Natural := Item
'Length;
1069 Istart
: Natural := Item
'First;
1072 FIO
.Check_Write_Status
(AP
(File
));
1074 -- If we have bounded lines, then just do a put and a new line. In
1075 -- this case we will end up doing things character by character in
1076 -- any case, and it is a rare situation.
1078 if File
.Line_Length
/= 0 then
1084 -- We setup a single string that has the necessary terminators and
1085 -- then write it with a single call. The reason for doing this is
1086 -- that it gives better behavior for the use of Put_Line in multi-
1087 -- tasking programs, since often the OS will treat the entire put
1088 -- operation as an atomic operation.
1090 -- We only do this if the message is 512 characters or less in length,
1091 -- since otherwise Put_Line would use an unbounded amount of stack
1092 -- space and could cause undetected stack overflow. If we have a
1093 -- longer string, then output the first part separately to avoid this.
1096 FIO
.Write_Buf
(AP
(File
), Item
'Address, size_t
(Ilen
- 512));
1097 Istart
:= Istart
+ Ilen
- 512;
1101 -- Now prepare the string with its terminator
1104 Buffer
: String (1 .. Ilen
+ 2);
1108 Buffer
(1 .. Ilen
) := Item
(Istart
.. Item
'Last);
1109 Buffer
(Ilen
+ 1) := Character'Val (LM
);
1111 if File
.Page_Length
/= 0
1112 and then File
.Line
> File
.Page_Length
1114 Buffer
(Ilen
+ 2) := Character'Val (PM
);
1115 Plen
:= size_t
(Ilen
) + 2;
1117 File
.Page
:= File
.Page
+ 1;
1120 Plen
:= size_t
(Ilen
) + 1;
1121 File
.Line
:= File
.Line
+ 1;
1124 FIO
.Write_Buf
(AP
(File
), Buffer
'Address, Plen
);
1130 procedure Put_Line
(Item
: in String) is
1132 Put_Line
(Current_Out
, Item
);
1139 procedure Putc
(ch
: int
; File
: File_Type
) is
1141 if fputc
(ch
, File
.Stream
) = EOF
then
1150 -- This is the primitive Stream Read routine, used when a Text_IO file
1151 -- is treated directly as a stream using Text_IO.Streams.Stream.
1154 (File
: in out Text_AFCB
;
1155 Item
: out Stream_Element_Array
;
1156 Last
: out Stream_Element_Offset
)
1159 pragma Warnings
(Off
, Discard_ch
);
1162 if File
.Mode
/= FCB
.In_File
then
1166 -- Deal with case where our logical and physical position do not match
1167 -- because of being after an LM or LM-PM sequence when in fact we are
1168 -- logically positioned before it.
1170 if File
.Before_LM
then
1172 -- If we are before a PM, then it is possible for a stream read
1173 -- to leave us after the LM and before the PM, which is a bit
1174 -- odd. The easiest way to deal with this is to unget the PM,
1175 -- so we are indeed positioned between the characters. This way
1176 -- further stream read operations will work correctly, and the
1177 -- effect on text processing is a little weird, but what can
1178 -- be expected if stream and text input are mixed this way?
1180 if File
.Before_LM_PM
then
1181 Discard_ch
:= ungetc
(PM
, File
.Stream
);
1182 File
.Before_LM_PM
:= False;
1185 File
.Before_LM
:= False;
1187 Item
(Item
'First) := Stream_Element
(Character'Pos (ASCII
.LF
));
1189 if Item
'Length = 1 then
1195 Stream_Element_Offset
1196 (fread
(buffer
=> Item
'Address,
1197 index
=> size_t
(Item
'First + 1),
1199 count
=> Item
'Length - 1,
1200 stream
=> File
.Stream
));
1206 -- Now we do the read. Since this is a text file, it is normally in
1207 -- text mode, but stream data must be read in binary mode, so we
1208 -- temporarily set binary mode for the read, resetting it after.
1209 -- These calls have no effect in a system (like Unix) where there is
1210 -- no distinction between text and binary files.
1212 set_binary_mode
(fileno
(File
.Stream
));
1216 Stream_Element_Offset
1217 (fread
(Item
'Address, 1, Item
'Length, File
.Stream
)) - 1;
1219 if Last
< Item
'Last then
1220 if ferror
(File
.Stream
) /= 0 then
1225 set_text_mode
(fileno
(File
.Stream
));
1233 (File
: in out File_Type
;
1234 Mode
: in File_Mode
)
1237 -- Don't allow change of mode for current file (RM A.10.2(5))
1239 if (File
= Current_In
or else
1240 File
= Current_Out
or else
1241 File
= Current_Error
)
1242 and then To_FCB
(Mode
) /= File
.Mode
1247 Terminate_Line
(File
);
1248 FIO
.Reset
(AP
(File
), To_FCB
(Mode
));
1252 File
.Line_Length
:= 0;
1253 File
.Page_Length
:= 0;
1254 File
.Before_LM
:= False;
1255 File
.Before_LM_PM
:= False;
1258 procedure Reset
(File
: in out File_Type
) is
1260 Terminate_Line
(File
);
1261 FIO
.Reset
(AP
(File
));
1265 File
.Line_Length
:= 0;
1266 File
.Page_Length
:= 0;
1267 File
.Before_LM
:= False;
1268 File
.Before_LM_PM
:= False;
1276 (File
: in File_Type
;
1277 To
: in Positive_Count
)
1282 -- Raise Constraint_Error if out of range value. The reason for this
1283 -- explicit test is that we don't want junk values around, even if
1284 -- checks are off in the caller.
1286 if To
not in Positive_Count
then
1287 raise Constraint_Error
;
1290 FIO
.Check_File_Open
(AP
(File
));
1292 if To
= File
.Col
then
1296 if Mode
(File
) >= Out_File
then
1297 if File
.Line_Length
/= 0 and then To
> File
.Line_Length
then
1301 if To
< File
.Col
then
1305 while File
.Col
< To
loop
1317 File
.Line
:= File
.Line
+ 1;
1320 elsif ch
= PM
and then File
.Is_Regular_File
then
1321 File
.Page
:= File
.Page
+ 1;
1325 elsif To
= File
.Col
then
1330 File
.Col
:= File
.Col
+ 1;
1336 procedure Set_Col
(To
: in Positive_Count
) is
1338 Set_Col
(Current_Out
, To
);
1345 procedure Set_Error
(File
: in File_Type
) is
1347 FIO
.Check_Write_Status
(AP
(File
));
1348 Current_Err
:= File
;
1355 procedure Set_Input
(File
: in File_Type
) is
1357 FIO
.Check_Read_Status
(AP
(File
));
1366 (File
: in File_Type
;
1367 To
: in Positive_Count
)
1370 -- Raise Constraint_Error if out of range value. The reason for this
1371 -- explicit test is that we don't want junk values around, even if
1372 -- checks are off in the caller.
1374 if To
not in Positive_Count
then
1375 raise Constraint_Error
;
1378 FIO
.Check_File_Open
(AP
(File
));
1380 if To
= File
.Line
then
1384 if Mode
(File
) >= Out_File
then
1385 if File
.Page_Length
/= 0 and then To
> File
.Page_Length
then
1389 if To
< File
.Line
then
1393 while File
.Line
< To
loop
1398 while To
/= File
.Line
loop
1404 procedure Set_Line
(To
: in Positive_Count
) is
1406 Set_Line
(Current_Out
, To
);
1409 ---------------------
1410 -- Set_Line_Length --
1411 ---------------------
1413 procedure Set_Line_Length
(File
: in File_Type
; To
: in Count
) is
1415 -- Raise Constraint_Error if out of range value. The reason for this
1416 -- explicit test is that we don't want junk values around, even if
1417 -- checks are off in the caller.
1419 if To
not in Count
then
1420 raise Constraint_Error
;
1423 FIO
.Check_Write_Status
(AP
(File
));
1424 File
.Line_Length
:= To
;
1425 end Set_Line_Length
;
1427 procedure Set_Line_Length
(To
: in Count
) is
1429 Set_Line_Length
(Current_Out
, To
);
1430 end Set_Line_Length
;
1436 procedure Set_Output
(File
: in File_Type
) is
1438 FIO
.Check_Write_Status
(AP
(File
));
1439 Current_Out
:= File
;
1442 ---------------------
1443 -- Set_Page_Length --
1444 ---------------------
1446 procedure Set_Page_Length
(File
: in File_Type
; To
: in Count
) is
1448 -- Raise Constraint_Error if out of range value. The reason for this
1449 -- explicit test is that we don't want junk values around, even if
1450 -- checks are off in the caller.
1452 if To
not in Count
then
1453 raise Constraint_Error
;
1456 FIO
.Check_Write_Status
(AP
(File
));
1457 File
.Page_Length
:= To
;
1458 end Set_Page_Length
;
1460 procedure Set_Page_Length
(To
: in Count
) is
1462 Set_Page_Length
(Current_Out
, To
);
1463 end Set_Page_Length
;
1470 (File
: in File_Type
;
1471 Spacing
: in Positive_Count
:= 1)
1476 -- Raise Constraint_Error if out of range value. The reason for this
1477 -- explicit test is that we don't want junk values around, even if
1478 -- checks are off in the caller.
1480 if Spacing
not in Positive_Count
then
1481 raise Constraint_Error
;
1484 FIO
.Check_Read_Status
(AP
(File
));
1486 for L
in 1 .. Spacing
loop
1487 if File
.Before_LM
then
1488 File
.Before_LM
:= False;
1489 File
.Before_LM_PM
:= False;
1494 -- If at end of file now, then immediately raise End_Error. Note
1495 -- that we can never be positioned between a line mark and a page
1496 -- mark, so if we are at the end of file, we cannot logically be
1497 -- before the implicit page mark that is at the end of the file.
1499 -- For the same reason, we do not need an explicit check for a
1500 -- page mark. If there is a FF in the middle of a line, the file
1501 -- is not in canonical format and we do not care about the page
1502 -- numbers for files other than ones in canonical format.
1508 -- If not at end of file, then loop till we get to an LM or EOF.
1509 -- The latter case happens only in non-canonical files where the
1510 -- last line is not terminated by LM, but we don't want to blow
1511 -- up for such files, so we assume an implicit LM in this case.
1514 exit when ch
= LM
or ch
= EOF
;
1519 -- We have got past a line mark, now, for a regular file only,
1520 -- see if a page mark immediately follows this line mark and
1521 -- if so, skip past the page mark as well. We do not do this
1522 -- for non-regular files, since it would cause an undesirable
1523 -- wait for an additional character.
1526 File
.Line
:= File
.Line
+ 1;
1528 if File
.Before_LM_PM
then
1529 File
.Page
:= File
.Page
+ 1;
1531 File
.Before_LM_PM
:= False;
1533 elsif File
.Is_Regular_File
then
1536 -- Page mark can be explicit, or implied at the end of the file
1538 if (ch
= PM
or else ch
= EOF
)
1539 and then File
.Is_Regular_File
1541 File
.Page
:= File
.Page
+ 1;
1551 procedure Skip_Line
(Spacing
: in Positive_Count
:= 1) is
1553 Skip_Line
(Current_In
, Spacing
);
1560 procedure Skip_Page
(File
: in File_Type
) is
1564 FIO
.Check_Read_Status
(AP
(File
));
1566 -- If at page mark already, just skip it
1568 if File
.Before_LM_PM
then
1569 File
.Before_LM
:= False;
1570 File
.Before_LM_PM
:= False;
1571 File
.Page
:= File
.Page
+ 1;
1577 -- This is a bit tricky, if we are logically before an LM then
1578 -- it is not an error if we are at an end of file now, since we
1579 -- are not really at it.
1581 if File
.Before_LM
then
1582 File
.Before_LM
:= False;
1583 File
.Before_LM_PM
:= False;
1586 -- Otherwise we do raise End_Error if we are at the end of file now
1596 -- Now we can just rumble along to the next page mark, or to the
1597 -- end of file, if that comes first. The latter case happens when
1598 -- the page mark is implied at the end of file.
1602 or else (ch
= PM
and then File
.Is_Regular_File
);
1606 File
.Page
:= File
.Page
+ 1;
1611 procedure Skip_Page
is
1613 Skip_Page
(Current_In
);
1616 --------------------
1617 -- Standard_Error --
1618 --------------------
1620 function Standard_Error
return File_Type
is
1622 return Standard_Err
;
1625 function Standard_Error
return File_Access
is
1627 return Standard_Err
'Access;
1630 --------------------
1631 -- Standard_Input --
1632 --------------------
1634 function Standard_Input
return File_Type
is
1639 function Standard_Input
return File_Access
is
1641 return Standard_In
'Access;
1644 ---------------------
1645 -- Standard_Output --
1646 ---------------------
1648 function Standard_Output
return File_Type
is
1650 return Standard_Out
;
1651 end Standard_Output
;
1653 function Standard_Output
return File_Access
is
1655 return Standard_Out
'Access;
1656 end Standard_Output
;
1658 --------------------
1659 -- Terminate_Line --
1660 --------------------
1662 procedure Terminate_Line
(File
: File_Type
) is
1664 FIO
.Check_File_Open
(AP
(File
));
1666 -- For file other than In_File, test for needing to terminate last line
1668 if Mode
(File
) /= In_File
then
1670 -- If not at start of line definition need new line
1672 if File
.Col
/= 1 then
1675 -- For files other than standard error and standard output, we
1676 -- make sure that an empty file has a single line feed, so that
1677 -- it is properly formatted. We avoid this for the standard files
1678 -- because it is too much of a nuisance to have these odd line
1679 -- feeds when nothing has been written to the file.
1681 -- We also avoid this for files opened in append mode, in
1682 -- accordance with (RM A.8.2(10))
1684 elsif (File
/= Standard_Err
and then File
/= Standard_Out
)
1685 and then (File
.Line
= 1 and then File
.Page
= 1)
1686 and then Mode
(File
) = Out_File
1697 procedure Ungetc
(ch
: int
; File
: File_Type
) is
1700 if ungetc
(ch
, File
.Stream
) = EOF
then
1710 -- This is the primitive Stream Write routine, used when a Text_IO file
1711 -- is treated directly as a stream using Text_IO.Streams.Stream.
1714 (File
: in out Text_AFCB
;
1715 Item
: in Stream_Element_Array
)
1718 function Has_Translated_Characters
return Boolean;
1719 -- return True if Item array contains a character which will be
1720 -- translated under the text file mode. There is only one such
1721 -- character under DOS based systems which is character 10.
1723 text_translation_required
: Boolean;
1724 pragma Import
(C
, text_translation_required
,
1725 "__gnat_text_translation_required");
1727 Siz
: constant size_t
:= Item
'Length;
1729 function Has_Translated_Characters
return Boolean is
1731 for K
in Item
'Range loop
1732 if Item
(K
) = 10 then
1737 end Has_Translated_Characters
;
1739 Needs_Binary_Write
: constant Boolean :=
1740 text_translation_required
and then Has_Translated_Characters
;
1743 if File
.Mode
= FCB
.In_File
then
1747 -- Now we do the write. Since this is a text file, it is normally in
1748 -- text mode, but stream data must be written in binary mode, so we
1749 -- temporarily set binary mode for the write, resetting it after. This
1750 -- is done only if needed (i.e. there is some characters in Item which
1751 -- needs to be written using the binary mode).
1752 -- These calls have no effect in a system (like Unix) where there is
1753 -- no distinction between text and binary files.
1755 -- Since the character translation is done at the time the buffer is
1756 -- written (this is true under Windows) we first flush current buffer
1757 -- with text mode if needed.
1759 if Needs_Binary_Write
then
1761 if fflush
(File
.Stream
) = -1 then
1765 set_binary_mode
(fileno
(File
.Stream
));
1768 if fwrite
(Item
'Address, 1, Siz
, File
.Stream
) /= Siz
then
1772 -- At this point we need to flush the buffer using the binary mode then
1773 -- we reset to text mode.
1775 if Needs_Binary_Write
then
1777 if fflush
(File
.Stream
) = -1 then
1781 set_text_mode
(fileno
(File
.Stream
));
1785 -- Use "preallocated" strings to avoid calling "new" during the
1786 -- elaboration of the run time. This is needed in the tasking case to
1787 -- avoid calling Task_Lock too early. A filename is expected to end with a
1788 -- null character in the runtime, here the null characters are added just
1789 -- to have a correct filename length.
1791 Err_Name
: aliased String := "*stderr" & ASCII
.Nul
;
1792 In_Name
: aliased String := "*stdin" & ASCII
.Nul
;
1793 Out_Name
: aliased String := "*stdout" & ASCII
.Nul
;
1795 -------------------------------
1796 -- Initialize Standard Files --
1797 -------------------------------
1799 -- Note: the names in these files are bogus, and probably it would be
1800 -- better for these files to have no names, but the ACVC test insist!
1801 -- We use names that are bound to fail in open etc.
1803 Standard_Err
.Stream
:= stderr
;
1804 Standard_Err
.Name
:= Err_Name
'Access;
1805 Standard_Err
.Form
:= Null_Str
'Unrestricted_Access;
1806 Standard_Err
.Mode
:= FCB
.Out_File
;
1807 Standard_Err
.Is_Regular_File
:= is_regular_file
(fileno
(stderr
)) /= 0;
1808 Standard_Err
.Is_Temporary_File
:= False;
1809 Standard_Err
.Is_System_File
:= True;
1810 Standard_Err
.Is_Text_File
:= True;
1811 Standard_Err
.Access_Method
:= 'T';
1812 Standard_Err
.Self
:= Standard_Err
;
1814 Standard_In
.Stream
:= stdin
;
1815 Standard_In
.Name
:= In_Name
'Access;
1816 Standard_In
.Form
:= Null_Str
'Unrestricted_Access;
1817 Standard_In
.Mode
:= FCB
.In_File
;
1818 Standard_In
.Is_Regular_File
:= is_regular_file
(fileno
(stdin
)) /= 0;
1819 Standard_In
.Is_Temporary_File
:= False;
1820 Standard_In
.Is_System_File
:= True;
1821 Standard_In
.Is_Text_File
:= True;
1822 Standard_In
.Access_Method
:= 'T';
1823 Standard_In
.Self
:= Standard_In
;
1825 Standard_Out
.Stream
:= stdout
;
1826 Standard_Out
.Name
:= Out_Name
'Access;
1827 Standard_Out
.Form
:= Null_Str
'Unrestricted_Access;
1828 Standard_Out
.Mode
:= FCB
.Out_File
;
1829 Standard_Out
.Is_Regular_File
:= is_regular_file
(fileno
(stdout
)) /= 0;
1830 Standard_Out
.Is_Temporary_File
:= False;
1831 Standard_Out
.Is_System_File
:= True;
1832 Standard_Out
.Is_Text_File
:= True;
1833 Standard_Out
.Access_Method
:= 'T';
1834 Standard_Out
.Self
:= Standard_Out
;
1836 FIO
.Chain_File
(AP
(Standard_In
));
1837 FIO
.Chain_File
(AP
(Standard_Out
));
1838 FIO
.Chain_File
(AP
(Standard_Err
));
1840 FIO
.Make_Unbuffered
(AP
(Standard_Out
));
1841 FIO
.Make_Unbuffered
(AP
(Standard_Err
));