Package RASCAL.Heap

Description	Thick binding to the Flex shifting heap.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
Ada.Strings.Fixed
System
Ada.Finalization
RASCAL.OS
Kernel

Use clauses
Ada.Strings.Fixed
System
RASCAL.OS

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Heap_Block_Type	private
Heap_Block_Pointer	access all Heap_Block_Type

Exceptions
Unable_To_Extend_Block
Unable_To_Allocate_Block

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Set_Name	procedure
The name of the dynamic area used for the heap.

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

Set_MaxSize	procedure
This sets the max size of the dynamic area used for the heap. If the value is 0 the WimpSlot will be used instead of a dynamic area.

*Parameter name*	*Type*	*Mode*	*Default*
Extent	Natural	in	0

Set_MessagesFile	procedure
This sets the messages file from which error messages will be read. Otherwise default (UK) messages will be used.

*Parameter name*	*Type*	*Mode*	*Default*
Messages	Messages_Handle_Type	in

Get_Address	function
*Return*	Address
Returns the address of the block.

*Parameter name*	*Type*	*Mode*	*Default*
The	Heap_Block_Type	in

Get_Size	function
*Return*	Integer
Returns the size of the block.

*Parameter name*	*Type*	*Mode*	*Default*
The	Heap_Block_Type	in

Extend	procedure
Extends the block to the new size.

*Parameter name*	*Type*	*Mode*	*Default*
The	Heap_Block_Type	in out
New_Size	Natural	in

Mid_Extend	procedure
Extends or truncates block, at any point.

*Parameter name*	*Type*	*Mode*	*Default*
The	Heap_Block_Type	in out
Location	Integer	in
Extent	Integer	in

Re_Anchor	procedure
Move the anchor of an allocated block.

*Parameter name*	*Type*	*Mode*	*Default*
The	Heap_Block_Type	in out
To	Heap_Block_Type	in out

Set_Budge	procedure
Set whether to move the flex store when the runtime needs to extend the heap.

*Parameter name*	*Type*	*Mode*	*Default*
Budge	Boolean	in

Save_HeapInfo	procedure
Appends information about the flex heap to the passed file.

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

Compact	function
*Return*	Boolean
Compacts the flex heap. Returns 'true' if compaction is complete.

Set_Deferred_Compaction	procedure
Sets whether flex should compact its heap on every flex_free or on flex_alloc and flex_compact, flex_budge and flex_extend.

*Parameter name*	*Type*	*Mode*	*Default*
The	Heap_Block_Type	in out
Defer	Boolean	in

Free	procedure
Deallocates the block.

*Parameter name*	*Type*	*Mode*	*Default*
The	Heap_Block_Type	in out