Package RASCAL.FileExternal

Description	External file handling.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
Ada.Strings.Unbounded
System.Unsigned_Types
System
RASCAL.Time
RASCAL.Utility
RASCAL.OS

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Attribute_Owner_Read	System.Unsigned_Types.Unsigned	2#1#	constant
Attribute_Owner_Write	System.Unsigned_Types.Unsigned	2#10#	constant
Attribute_Locked	System.Unsigned_Types.Unsigned	2#1000#	constant
Attribute_Public_Read	System.Unsigned_Types.Unsigned	2#10000#	constant
Attribute_Public_Write	System.Unsigned_Types.Unsigned	2#100000#	constant
Attribure_Hidden	System.Unsigned_Types.Unsigned	2#1000000#	constant
Attribute_Application	System.Unsigned_Types.Unsigned	2#10000000#	constant
Copy_Option_Recurse	System.Unsigned_Types.Unsigned	2#1#	constant
Copy_Option_Force	System.Unsigned_Types.Unsigned	2#10#	constant
Copy_Option_Given_Times	System.Unsigned_Types.Unsigned	2#100#	constant
Copy_Option_Confirm	System.Unsigned_Types.Unsigned	2#1000#	constant
Copy_Option_Verbose	System.Unsigned_Types.Unsigned	2#10000#	constant
Copy_Option_Quick	System.Unsigned_Types.Unsigned	2#100000#	constant
Copy_Option_Prompt	System.Unsigned_Types.Unsigned	2#1000000#	constant
Copy_Option_Delete	System.Unsigned_Types.Unsigned	2#10000000#	constant
Copy_Option_PrintProgress	System.Unsigned_Types.Unsigned	2#100000000#	constant
Copy_Option_Access	System.Unsigned_Types.Unsigned	2#1000000000#	constant
Copy_Option_Stamp	System.Unsigned_Types.Unsigned	2#10000000000#	constant
Copy_Option_StructureOnly	System.Unsigned_Types.Unsigned	2#100000000000#	constant
Copy_Option_Newer	System.Unsigned_Types.Unsigned	2#1000000000000#	constant
Copy_Option_UseDescriptor	System.Unsigned_Types.Unsigned	2#10000000000000#	constant
Copy_Option_LookFirst	System.Unsigned_Types.Unsigned	2#100000000000000#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
File_Object_Type	(Not_Found, File_Object, Dir, Image)
Directory_Type	array (natural) of UString
Directory_Pointer	access Directory_Type

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Close_AllInPath	procedure
Closes all files in path.

*Parameter name*	*Type*	*Mode*	*Default*
path	String	in

Get_UnUsedFileName	function
*Return*	String
Find a filename which has not been used yet in 'path'. Returns only name not path.

*Parameter name*	*Type*	*Mode*	*Default*
Path	String	in

Exists	function
*Return*	boolean
Returns true if the object, pointed to by 'Filename', exists.

*Parameter name*	*Type*	*Mode*	*Default*
Filename	string	in

Is_Valid	function
*Return*	Boolean
Is the path valid for writing to ?

*Parameter name*	*Type*	*Mode*	*Default*
Path	String	in
FileSize	Natural	in

Delete_File	procedure
Deletes the file pointed to by 'Filename'.

*Parameter name*	*Type*	*Mode*	*Default*
Filename	string	in

Rename	procedure
Rename file.

*Parameter name*	*Type*	*Mode*	*Default*
Source	string	in
Target	string	in

Copy	procedure
Copies an object from 'Source' to 'Target'.

*Parameter name*	*Type*	*Mode*	*Default*
Source	string	in
Target	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Move	procedure
Moves an object from 'Source' to 'Target'.

*Parameter name*	*Type*	*Mode*	*Default*
Source	string	in
Target	string	in
Flags	System.Unsigned_Types.Unsigned	in	Copy_Option_Delete

Wipe	procedure
Deletes file/directory.

*Parameter name*	*Type*	*Mode*	*Default*
Path	string	in

Create_File	procedure
Creates a file at 'Filename'.

*Parameter name*	*Type*	*Mode*	*Default*
Filename	string	in
Length	integer	in	0
Filetype	integer	in	16#FFD#

Create_Directory	procedure
Creates a directory at 'Dirname'. It is not an error if the directory already exists.

*Parameter name*	*Type*	*Mode*	*Default*
Dirname	string	in

Get_FileNames	function
*Return*	string
Returns a string containing a commaseperated list of the names of all files in 'Path'.

*Parameter name*	*Type*	*Mode*	*Default*
Path	string	in

Get_DirectoryList	function
*Return*	Directory_Pointer
Returns an array of names of the files in 'Path'.

*Parameter name*	*Type*	*Mode*	*Default*
Path	String	in

Read_Dir	procedure
Enumerates through the files in 'Path'. Multiple files are read with each call and the information is written into the supplied buffer.

*Parameter name*	*Type*	*Mode*	*Default*
Path	String	in
Index	Integer	in out
ObjectsRead	Natural	out
Buffer	Address	in
BufferSize	Positive	in	8192
Match	string	in	"*"

Nr_Of_Files	function
*Return*	integer
Returns the number of files in 'Path'.

*Parameter name*	*Type*	*Mode*	*Default*
Path	string	in

Get_DirectoryEntry	procedure
Enumerates through the files in 'Directory', while providing extensive information on every file found.

*Parameter name*	*Type*	*Mode*	*Default*
Directory	string	in
Index	Integer	in out
Itemname	Unbounded_String	out
Loadadr	Integer	out
Execadr	Integer	out
Length	Integer	out
Attributes	Integer	out
Itemtype	Integer	out
Match	String	in	"*"

Get_DirectoryEntries	procedure
Enumerates through the files in 'Directory', while providing extensive information on every file found. Multiple files are read with each call and the information is written into the supplied buffer.

*Parameter name*	*Type*	*Mode*	*Default*
Path	String	in
Index	Integer	in out
ObjectsRead	Natural	out
Buffer	Address	in
BufferSize	Positive	in	8192
Match	string	in	"*"

Get_FileInformation	procedure
Returns information regarding the file 'Filename'.

*Parameter name*	*Type*	*Mode*	*Default*
Filepath	string	in
Loadadr	integer	out
Execadr	integer	out
Length	integer	out
Attributes	integer	out
Itemtype	File_Object_Type	out

Set_FileType	procedure
Sets the filetype if 'Filename'.

*Parameter name*	*Type*	*Mode*	*Default*
Filename	string	in
Filetype	integer	in

Get_FileType	function
*Return*	integer
Finds the filetype of 'Filename'.

*Parameter name*	*Type*	*Mode*	*Default*
Filename	string	in

Get_ObjectType	function
*Return*	File_Object_Type
Finds the object type of 'Filename'.

*Parameter name*	*Type*	*Mode*	*Default*
Filename	string	in

Filetype_To_Hex	function
*Return*	string

*Parameter name*	*Type*	*Mode*	*Default*
Loadadr	integer	in

Filetype_To_Number	function
*Return*	Integer

*Parameter name*	*Type*	*Mode*	*Default*
FileType	String	in

Get_Size	function
*Return*	integer
Finds the size of 'Filename'.

*Parameter name*	*Type*	*Mode*	*Default*
Filename	string	in

Get_DirectoryStamp	procedure
Finds the stamp of 'Directory'.

*Parameter name*	*Type*	*Mode*	*Default*
Directory	string	in
Loadadr	integer	out
Execadr	integer	out

Get_Attributes	function
*Return*	integer
Returns the attributes of 'Path'.

*Parameter name*	*Type*	*Mode*	*Default*
Path	string	in

Set_Attributes	procedure
Sets the attributes of 'Path'.

*Parameter name*	*Type*	*Mode*	*Default*
Path	string	in
Attributes	integer	in

Get_Stamp	function
*Return*	UTC_Pointer
Returns the stamp of the file pointed to by 'Path'.

*Parameter name*	*Type*	*Mode*	*Default*
Path	String	in