Package RASCAL.DynamicArea

Description	Thin binding to OS_DynamicArea.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
RASCAL.Utility
RASCAL.Memory
System
Ada.Strings.Unbounded

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Dynamic_Area_No_Buffer		2#000010000#	constant
Dynamic_Area_No_Cache		2#000100000#	constant
Dynamic_Area_Double_Mapped		2#001000000#	constant
Dynamic_Area_No_Drag		2#010000000#	constant
Dynamic_Area_Physical_Pages		2#100000000#	constant
Default_Flags		Dynamic_Area_No_Cache + Dynamic_Area_No_Buffer + Dynamic_Area_No_Drag	constant
Default_Max_Size		32 * 1024 * 1024	constant
OS_DynamicArea		16#66#	constant
OS_ChangeDynamicArea		16#2A#	constant
OS_ReadDynamicArea		16#5C#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Dynamic_Area_Type	private
Dynamic_Area_Ptr	access Dynamic_Area_Type
DA_List_Type	array (Natural) of Dynamic_Area_Type

Exceptions
unable_to_delete_dynamic_area
unable_to_resize_dynamic_area
nonexisting_dynamic_area

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Create	procedure
This creates a new dynamic area.

*Parameter name*	*Type*	*Mode*	*Default*
Area	Dynamic_Area_Type	in out
Name	String	in
Start_Size	Integer	in	0
Max_Size	Integer	in	32 * 1024 * 1024
Flags	Integer	in	Default_Flags

Remove	procedure
Removes a dynamic area.

*Parameter name*	*Type*	*Mode*	*Default*
Area	Dynamic_Area_Type	in

Resize	procedure
Lets you enlarge or shrink the dynamic area.

*Parameter name*	*Type*	*Mode*	*Default*
Area	Dynamic_Area_Type	in out
Change	Integer	in

Enumerate	function
*Return*	Integer

*Parameter name*	*Type*	*Mode*	*Default*
area	Integer	in

Read	procedure

*Parameter name*	*Type*	*Mode*	*Default*
Area_nr	Integer	in
Base	Address	out
Current_Size	Integer	out
Max_Size	Integer	out

Read_Detailed	procedure

*Parameter name*	*Type*	*Mode*	*Default*
Area_Nr	Integer	in
Current_Size	Integer	out
Base	Address	out
Flags	Integer	out
Max_Size	Integer	out
Name	Unbounded_String	out

Exists	function
*Return*	Boolean
Returns true if there is a dynamic area with this name.

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

Exists	function
*Return*	Boolean
Returns true if there is an area with that area nr.

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

Find_Nr	function
*Return*	Integer
Searches for a DA with the given name and returns the area nr. Raises nonexisting_dynamic_area exception.

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

Get_Nr_Of_DAs	function
*Return*	Natural
Returns how many dynamic areas currently exist.

Get_DA_List	function
*Return*	DA_List_Type
Returns an array containg detailed information about every existing dynamic area.

Get_Nr	function
*Return*	Integer
Returns the area nr of the dynamic area.

*Parameter name*	*Type*	*Mode*	*Default*
Area	Dynamic_Area_Type	in

Get_Max_Size	function
*Return*	Integer
Returns the max size of the dynamic area.

*Parameter name*	*Type*	*Mode*	*Default*
Area	Dynamic_Area_Type	in

Get_Current_Size	function
*Return*	integer
Returns the current size of the dynamic area.

*Parameter name*	*Type*	*Mode*	*Default*
Area	Dynamic_Area_Type	in

Get_Flags	function
*Return*	integer
Returns the flag word of the dynamic area.

*Parameter name*	*Type*	*Mode*	*Default*
Area	Dynamic_Area_Type	in

Get_Base	function
*Return*	Address
Returns the base addresse of the dynamic area.

*Parameter name*	*Type*	*Mode*	*Default*
Area	Dynamic_Area_Type	in