[@DEFINITION MODULE Sample Collection? ("A-Type");

(* Example library for a collection using operator bindings *)

TYPE Sample Collection? = OPAQUE;

TYPE Sample Collection? = OPAQUE ("A-Type");

TYPE Key Type? IS CARDINAL; (* arbitrary type *)

TYPE Value Type? = ARRAY 255 OF CHAR; (* arbitrary type *)

TYPE Value Type? = ARRAY 255 OF CHAR;

TYPE Key Type? IS CARDINAL;

TYPE Key Type? = CARDINAL;

(* key and value type *)

TYPE Key Type? = SET OF 4; (* 32 bit keys *)

TYPE Value Type? IS REAL;

CONST [NIL] nullKey = 0;

(* mutators *)

(* counter *)

PROCEDURE [COUNT] entryCount ( dict : Sample Collection? ) : LONGCARD; (* Returns the number of entries stored in dict *)

PROCEDURE [.] valueForKey ( dict : Sample Collection?; key : Key Type?; VAR found : BOOLEAN ) : Value Type?; (* Searches for key in dict, if found passes TRUE in found and returns its value, otherwise passes FALSE *)

PROCEDURE [.] retrieveValue ( dict : Sample Collection?; key : Key Type?; VAR value : Value Type? ) : BOOLEAN;

PROCEDURE [.] valueForKey ( dict : Sample Collection?; key : Key Type?; VAR value : Value Type? ) : BOOLEAN; (* Searches for key in dict, passes its value back in value and returns TRUE if found, otherwise returns FALSE *)

PROCEDURE [-] removeValue ( dict : Sample Collection?; key : Key Type? );

PROCEDURE [!] removeValue ( dict : Sample Collection?; key : Key Type? ); (* Removes the entry whose key is key from dict *)

(* null key *)

CONST [NIL] nullKey = NIL;

   If the null key is passed in then the first key/value pair is passed back in key and value.
   If no successor key is found then the null key is passed back in key and value is undefined. *)

   If the invalid key is passed in then the first key/value pair is passed back in key and value.

   If the invalid passed in for key then the first key/value pair is passed back in key and value.
   If no successor key is found then the invalid key is passed back in key and value is undefined. *)

   If no successor key is found then the empty string is passed back in key and value is undefined. *)

(* Sample Collection Type *)

(* allocator *)

(* accessor *)

(* mutator *)

(* membership test *)

(* iterator *)

(* counter *)

(* destructor *)

PROCEDURE [.] valueForKey ( dict : Sample Collection?; key : Key Type? ) : Value Type?;

PROCEDURE [!] storeValue ( dict : Sample Collection?; key : Key Type?; value : Value Type? );

PROCEDURE [IN] keyExists ( dict : Sample Collection?; key : Key Type? ) : BOOLEAN;

PROCEDURE [FOR] nextEntry ( dict : Sample Collection?; VAR key : Key Type?; VAR value : Value Type? );

(* Finds the successor key of key and passes its key/value pair back in key and value.

   If no successor key is found then the empty string is passed back in key and no value is passed in value. *)

PROCEDURE [FOR] nextEntry ( dict : Sample Collection?; VAR key : ARRAY OF CHAR; VAR value : Value Type? ); (* Finds the successor key of key and passes its key/value pair back in key and value..

   If the empty string is passed in for key then the first key/value pair is passed back in key and value.
   If no successor key is present in dict then the empty string is passed back in key and no value is passed in value *)

   If the empty string is passed in for key then the first key is passed back and its value returned.
   If no successor key is present in dict then the empty string is passed back and NIL is returned *)

    If no successor key is present in dict then the empty string is passed back and NIL is returned *)

(* Finds the successor key of key, passes the successor key back in key and returns its value.

    If the empty string is passed in for key then the first key is passed back and its value returned.
    If no successor key is present then the empty string is passed back and NIL is returned *)

PROCEDURE [FOR] nextEntry ( dict : Sample Collection?; VAR key : ARRAY OF CHAR ) : Value Type?; (* Finds the successor key of key, passes the successor key back in key and returns its value. If the empty string is passed

    in for key then the first key is passed back and its value returned.
    If no successor key is present then the empty string is passed back  *)

(* Returns the value of the first entry of dict if key is the empty string, otherwise returns the

   value of the entry whose key is following key. Returns NIL if key represents the last entry in dict. *)

   the entry whose key is following key. Returns NIL if key represents the last entry in dict. *)

(* Returns the value of the first entry of dict if key is the empty string, otherwise returns the value of

   the entry whose key is following key. Returns NIL if key is the last key in dict. *)

PROCEDURE [NEW] new ( VAR dict : Sample Collection? ); (* Allocates a new collection and passes a reference to it back in dict *)

(* Returns the value stored for key in dict, returns NIL if no key is not present in dict *)

(* Stores value for key in dict, overwrites the previous value if key is already present in dict *)

(* Returns TRUE if key is present in dict, otherwise returns FALSE *)

PROCEDURE [FOR] nextEntry ( dict : Sample Collection?; key : ARRAY OF CHAR ) : Value Type?; (* Returns the first entry of dict if key is the empty string, otherwise returns the entry following key *)

(* Returns the number of entries stored in dict *)

PROCEDURE [DISPOSE] dispose ( VAR dict : Sample Collection? ); (* Deallocates dict and passes NIL back in dict *)

DEFINITION MODULE SampleCollection;

TYPE SampleCollection = OPAQUE;

PROCEDURE [NEW] new ( dict : SampleCollection );

PROCEDURE [.] valueForKey ( dict : SampleCollection; key : ARRAY OF CHAR ) : ValueType;

PROCEDURE [!] storeValue ( dict : SampleCollection; key : ARRAY OF CHAR; value : ValueType );

PROCEDURE [IN] keyExists ( dict : SampleCollection; key : ARRAY OF CHAR ) : BOOLEAN;

PROCEDURE [COUNT] entryCount ( dict : SampleCollection ) : LONGCARD;

PROCEDURE [DISPOSE] dispose ( dict : SampleCollection );

END SampleCollection.