Package RASCAL.FilerAction

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

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
RASCAL.OS

Use clauses
RASCAL.OS

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Verbose	FilerAction_Option_Type	1
Confirm	FilerAction_Option_Type	2
Force	FilerAction_Option_Type	4
Newer	FilerAction_Option_Type	8
Recurse	FilerAction_Option_Type	16
Confirm_Delete	FilerAction_Option_Type	32
Faster	FilerAction_Option_Type	64

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Filer_Control_Action_Type	(Acknowledge, Verbose_On, Verbose_Off)
FilerAction_Operation_Type	(Copy, Rename, Delete, Set_Access, Set_Type, Count, Move, Copy_Local, Stamp, Find)
Message_FilerOpenDir_Pointer	access Message_FilerOpenDir
Message_FilerCloseDir_Pointer	access Message_FilerCloseDir
Message_FilerOpenDirAt_Pointer	access Message_FilerOpenDirAt
Message_FilerSelectionDirectory_Pointer	access Message_FilerSelectionDirectory
Message_FilerAddSelection_Pointer	access Message_FilerAddSelection
Message_FilerAction_Pointer	access Message_FilerAction
Message_FilerControlAction_Pointer	access Message_FilerControlAction
Message_FilerSelection_Pointer	access Message_FilerSelection
FilerAction_Option_Type	integer

Message_FilerOpenDir	record
This message should be broadcast to instruct the filer to open a directory. Filing system modules use Service_StartFiler to record the Filer's task handle and hence do not use a broadcast message.
*Component*	*Type*	*Default*
Name	Char_Array (1..208)
Flag	Integer
FS_Number	Integer
Header	Message_Event_Header

AMEL_Message_FilerOpenDir	abstract tagged record
inheritance from	Message_EventListener (Message_Event_FilerOpenDir)
*Component*	*Type*	*Default*
Event	Message_FilerOpenDir_Pointer

Message_FilerCloseDir	record
All directories starting with given name wil be closed.
*Component*	*Type*	*Default*
Name	Char_Array (1..208)
Flag	Integer
FS_Number	Integer
Header	Message_Event_Header

AMEL_Message_FilerCloseDir	abstract tagged record
inheritance from	Message_EventListener (Message_Event_FilerCloseDir)
*Component*	*Type*	*Default*
Event	Message_FilerCloseDir_Pointer

Message_FilerOpenDirAt	record
This message is similar to Message_FilerOpenDir, but allows the position and mode of the viewer to be specified.
*Component*	*Type*	*Default*
Name	Char_Array (1..200)
View_Mode	Integer
Height	Integer
Width	Integer
Y_Position	Integer
X_Position	Integer
Flag	Integer
FS_Number	Integer
Header	Message_Event_Header

AMEL_Message_FilerOpenDirAt	abstract tagged record
inheritance from	Message_EventListener (Message_Event_FilerOpenDirAt)
*Component*	*Type*	*Default*
Event	Message_FilerOpenDirAt_Pointer

Message_FilerSelectionDirectory	record
Sending this message to a Filer_Action task sets the directory to act on, and clears the list of leafnames.
*Component*	*Type*	*Default*
Name	Char_Array (1..208)
Header	Message_Event_Header

AMEL_Message_FilerSelectionDirectory	abstract tagged record
inheritance from	Message_EventListener (Message_Event_FilerSelectionDirectory)
*Component*	*Type*	*Default*
Event	Message_FilerSelectionDirectory_Pointer

Message_FilerAddSelection	record
Sending this message to a Filer_Action task adds the leafnames to the task's list of leafnames to act upon. The leafnames are for files in the directory which has already been specified with Message_FilerSelectionDirectory. {fCode}Name_List{f} is a null terminated space seperated list of leafnames.
*Component*	*Type*	*Default*
Name_List	Char_Array (1..208)
Header	Message_Event_Header

AMEL_Message_FilerAddSelection	abstract tagged record
inheritance from	Message_EventListener (Message_Event_FilerAddSelection)
*Component*	*Type*	*Default*
Event	Message_FilerAddSelection_Pointer

Message_FilerAction	record
Sending this message to a Filer_Action task both specifies and starts the operation to perform on the list of leafnames sent with Message_FilerAddSelection.
*Component*	*Type*	*Default*
Data	Integer
Options	Integer
Operation	FilerAction_Operation_Type
Header	Message_Event_Header

AMEL_Message_FilerAction	abstract tagged record
inheritance from	Message_EventListener (Message_Event_FilerAction)
*Component*	*Type*	*Default*
Event	Message_FilerAction_Pointer

Message_FilerControlAction	record
Sending this message to a Filer_Action task performs various controls. 'Acknowledge' can be used to see if the task is still busy.
*Component*	*Type*	*Default*
Control	Filer_Control_Action_Type
Header	Message_Event_Header

AMEL_Message_FilerControlAction	abstract tagged record
inheritance from	Message_EventListener (Message_Event_FilerControlAction)
*Component*	*Type*	*Default*
Event	Message_FilerControlAction_Pointer

Message_FilerSelection	record
This message is sent from the filer to an application when a selection has been dragged, just before the application recieves the multiple DataLoad messages.
*Component*	*Type*	*Default*
end_Row	Integer
End_Column	Integer
Start_Row	Integer
Start_Column	Integer
View_Mode	Integer
Height	Integer
Width	Integer
BoundingBox_Y1	Integer
BoundingBox_X1	Integer
BoundingBox_Y0	Integer
BoundingBox_X0	Integer
Header	Message_Event_Header

AMEL_Message_FilerSelection	abstract tagged record
inheritance from	Message_EventListener (Message_Event_FilerSelection)
*Component*	*Type*	*Default*
Event	Message_FilerSelection_Pointer

Pragmas
Convention	(C, Message_FilerOpenDir)
Convention	(C, Message_FilerCloseDir)
Convention	(C, Message_FilerOpenDirAt)
Convention	(C, Message_FilerSelectionDirectory)
Convention	(C, Message_FilerAddSelection)
Convention	(C, Message_FilerAction)
Convention	(C, Message_FilerControlAction)
Convention	(C, Message_FilerSelection)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Set_Selection_Directory	procedure

*Parameter name*	*Type*	*Mode*	*Default*
Block	Wimp_Block_Type	in out
Path	string	in

Send_Selected_Directory	procedure
This sends Message_FilerSelectionDirectory to the Filer_Action task.

*Parameter name*	*Type*	*Mode*	*Default*
Directory	string	in
Task_Handle	integer	in

Send_Selected_File	procedure
Each filename has to be separated by a single space - {/}e.g.{/} '{fCode}File1 File2 File3{f}'. This buffers filenames until it fills a message block, at which point it sends them to the Filer_Action task using Message_FilerAddSelection. To start the operation see FilerAction_SendStartOperation (which will first send any remaining buffered names to the task).

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

Send_Start_Operation	procedure
This SWI sends any remaining leafnames with Message_FilerAddSelection, then starts the selected operation by constructing and sending Message_FilerAction. Reason dependent data is always a pointer, even for word sized data. Usually the data is a destination pathname.

*Parameter name*	*Type*	*Mode*	*Default*
Path	string	in
Operation	FilerAction_Operation_Type	in
Task_Handle	integer	in
Options	FilerAction_Option_Type	in	Verbose