Package RASCAL.FileInternal

Description	Reading and Writing from/to file.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
RASCAL.Utility
System
Ada.Strings.Unbounded
System.Unsigned_Types
Ada.Finalization

Use clauses
RASCAL.Utility
System
Ada.Strings.Unbounded
System.Unsigned_Types

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
UString_Ptr	access UString
File_Access_Type	(Read, Write, ReadWrite)
Line_List_Type	array (Natural) of unbounded_string
Real_FileHandle_Type	System.Unsigned_Types.Unsigned
FileHandle_Type	new Ada.Finalization.Limited_Controlled with private

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Is_EOF	function
*Return*	boolean
Returns true if end of file has been reached.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in

Get_Extent	function
*Return*	natural
Returns the extent of the file. That is NOT the same as the filesize.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in

Goto_Start	procedure
Goto start of file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in

Goto_End	procedure
Goto end of file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in

Get_Ptr	function
*Return*	Integer
Returns file index.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in

Set_Ptr	procedure
Sets file index to 'ptr'

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in
Ptr	integer	in

Get_Byte	function
*Return*	Integer
Read a single byte from file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in

Put_Byte	procedure
Writes a single byte to file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in
Byte	Integer	in

Skip_Bytes	procedure
Move a Nr of bytes forward in file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in
Nr	Integer	in

Get_Bytes	procedure
Reads a number (Length) of bytes from file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in
Buffer	Address	in
Length	Integer	in

Put_Bytes	procedure
Writes a number (Length) of bytes to files.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in
Buffer	Address	in
Length	Integer	in

Put_String	procedure
Writes a string (Line) to file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in
Line	String	in
Attach_LF	Boolean	in	true

Skip_EmptyLines	procedure
Moves filepointer to beginning of next line containing other characters than space.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in

Read_Line	function
*Return*	String
Reads a line from file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in
Trim	boolean	in	false

Get_Lines	function
*Return*	integer
Returns the number of lines in file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in
Trim	boolean	in	true

Ensure_Size	procedure
Ensures that the size of the 'File' is not less than 'Size'. Note that the extent is not changed.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in
Size	Integer	in

Load_File	procedure
Loads file into 'Buffer'.

*Parameter name*	*Type*	*Mode*	*Default*
FileName	String	in
Buffer	Address	in

Save_File	procedure
Saves 'Buffer' to file.

*Parameter name*	*Type*	*Mode*	*Default*
FileName	String	in
Buffer	Address	in
Bufferend	Address	in
FileType	Integer	in

Get_Real_FileHandle	function
*Return*	Real_FileHandle_Type
Returns internal filehandle.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in

Close	procedure
Close file.

*Parameter name*	*Type*	*Mode*	*Default*
File	FileHandle_Type	in