Modula-2 Reloaded

A Modern Typesafe & Literate Programming Notation

Site Menu

Project

Specification

Implementation

Recommendations

Reference

Needs Updating

Work in Progress

Wastebasket

Wiki Manual

edit SideBar

Spec ⋄ BS 64

BS 64

Spec.BS64 History

Hide minor edits - Show changes to output

2010-05-24 14:56 by benjk -
Changed line 1 from:
[@DEFINITION MODULE BS64 [SetType]; (* Sixty-four six-four *)
to:
[@DEFINITION MODULE BS64 [SetType];
Restore
2010-05-24 14:56 by benjk -
Changed lines 1-4 from:
[@DEFINITION MODULE BS16 [SetType];

(* 16-bit Bitset *)
to:
[@DEFINITION MODULE BS64 [SetType]; (* Sixty-four six-four *)

(* 64-bit Bitset *)
Changed lines 8-9 from:
(* BS16 type *)
to:
(* BS64 type *)
Changed lines 11-15 from:
   BS16 = OPAQUE RECORD
        ARRAY 2 OF OCTET; (* 16 bits *)
    END; (* BS16 *)

to:
   BS64 = OPAQUE RECORD
        ARRAY 8 OF OCTET; (* 64 bits *)
    END; (* BS64 *)

Changed line 18 from:
PROCEDURE [:=] assign ( VAR assignTo : BS16;
to:
PROCEDURE [:=] assign ( VAR assignTo : BS64;
Changed line 20 from:
(* Assigns a variadic list of values of type CARDINAL to BS16 assignTo.
to:
(* Assigns a variadic list of values of type CARDINAL to BS64 assignTo.
Changed lines 26-27 from:
PROCEDURE [.] isElement ( CONST set : BS16; element : CARDINAL ) : BOOLEAN;
(* Returns TRUE if element is an element of BS16 set, otherwise FALSE.
to:
PROCEDURE [.] isElement ( CONST set : BS64; element : CARDINAL ) : BOOLEAN;
(* Returns TRUE if element is an element of BS64 set, otherwise FALSE.
Changed lines 29-31 from:
   for rvalues of type BS16. *)

to:
   for rvalues of type BS64. *)

Changed line 34 from:
PROCEDURE [!] storeValue ( CONST set : BS16;
to:
PROCEDURE [!] storeValue ( CONST set : BS64;
Changed line 37 from:
(* Includes character element in BS16 set if value is TRUE, otherwise
to:
(* Includes character element in BS64 set if value is TRUE, otherwise
Changed lines 39-41 from:
   for lvalues of type BS16. *)

to:
   for lvalues of type BS64. *)

Changed lines 44-48 from:
PROCEDURE [COUNT] elementCount ( CONST set : BS16 ) : CARDINAL;
(* Returns the number of elements in BS16 set. This function is bound
  to pervasive function COUNT for type BS16. *)

to:
PROCEDURE [COUNT] elementCount ( CONST set : BS64 ) : CARDINAL;
(* Returns the number of elements in BS64 set. This function is bound
  to pervasive function COUNT for type BS64. *)

Changed lines 51-67 from:
PROCEDURE [+] union ( CONST set1, set2 : BS16 ) : BS16;
(* Returns the union of BS16 values set1 and set2.
  This function is bound to the + operator for type BS16. *)

PROCEDURE [-] diff ( CONST set1, set2 : BS16 ) : BS16;
(* Returns the set difference of BS16 values set1 and set2.
  This function is bound to the - operator for type BS16. *)

PROCEDURE [*] intersection ( set1, set2 : BS16 ) : BS16;
(* Returns the intersection of BS16 values set1 and set2.
  This function it bound to the * operator for type BS16. *)

PROCEDURE [/] symdiff ( set1, set2 : BS16 ) : BS16;
(* Returns the symmetric set difference of BS16 values set1 and set2.
  This function is bound to the / operator for type BS16. *)

to:
PROCEDURE [+] union ( CONST set1, set2 : BS64 ) : BS64;
(* Returns the union of BS64 values set1 and set2.
  This function is bound to the + operator for type BS64. *)

PROCEDURE [-] diff ( CONST set1, set2 : BS64 ) : BS64;
(* Returns the set difference of BS64 values set1 and set2.
  This function is bound to the - operator for type BS64. *)

PROCEDURE [*] intersection ( set1, set2 : BS64 ) : BS64;
(* Returns the intersection of BS64 values set1 and set2.
  This function it bound to the * operator for type BS64. *)

PROCEDURE [/] symdiff ( set1, set2 : BS64 ) : BS64;
(* Returns the symmetric set difference of BS64 values set1 and set2.
  This function is bound to the / operator for type BS64. *)

Changed lines 70-82 from:
PROCEDURE [=] isEqual ( set1, set2 : BS16 ) : BOOLEAN;
(* Returns TRUE if BS16 values set1 and set2 are equal, otherwise FALSE.
  This function is bound to operators = and # for type BS16. *)

PROCEDURE [<] isSubset ( set1, set2 : BS16 ) : BOOLEAN;
(* Returns TRUE if BS16 set1 is a true subset of set2, otherwise FALSE.
  This function is bound to operators < and >= for type BS16. *)

PROCEDURE [>] isSuperset ( set1, set2 : BS16 ) : BOOLEAN;
(* Returns TRUE if BS16 set1 is a true superset of set2, otherwise FALSE.
  This function is bound to operators > and <= for type BS16. *)

to:
PROCEDURE [=] isEqual ( set1, set2 : BS64 ) : BOOLEAN;
(* Returns TRUE if BS64 values set1 and set2 are equal, otherwise FALSE.
  This function is bound to operators = and # for type BS64. *)

PROCEDURE [<] isSubset ( set1, set2 : BS64 ) : BOOLEAN;
(* Returns TRUE if BS64 set1 is a true subset of set2, otherwise FALSE.
  This function is bound to operators < and >= for type BS64. *)

PROCEDURE [>] isSuperset ( set1, set2 : BS64 ) : BOOLEAN;
(* Returns TRUE if BS64 set1 is a true superset of set2, otherwise FALSE.
  This function is bound to operators > and <= for type BS64. *)

Changed line 85 from:
(* The EBNF for the textual representation of BS16 values is:
to:
(* The EBNF for the textual representation of BS64 values is:
Changed lines 93-96 from:
   The number of bits shown is equal to the bitwidth of the BS16 type. *)

PROCEDURE Read ( infile : File; VAR set : BS16 );
(* Reads the textual representation of a BS16 value from stream infile
to:
   The number of bits shown is equal to the bitwidth of the BS64 type. *)

PROCEDURE Read ( infile : File; VAR set : BS64 );
(* Reads the textual representation of a BS64 value from stream infile
Changed lines 103-105 from:
   procedure is substituted for invocations of READ with a BS16 argument. *)

PROCEDURE Write ( outfile : File; CONST set : BS16 );
to:
   procedure is substituted for invocations of READ with a BS64 argument. *)

PROCEDURE Write ( outfile : File; CONST set : BS64 );
Changed lines 107-108 from:
   procedure is substituted for invocations of WRITE with a BS16 argument.*)
to:
   procedure is substituted for invocations of WRITE with a BS64 argument.*)
Changed lines 111-112 from:
                   items        : VARIADIC OF CONST BS16 );
(* Writes a formatted textual representation of one or more BS16 values to
to:
                   items        : VARIADIC OF CONST BS64 );
(* Writes a formatted textual representation of one or more BS64 values to
Changed lines 115-117 from:
   BS16 arguments. *)

END BS16.@]
to:
   BS64 arguments. *)

END BS64.@]
Restore
2010-05-24 13:00 by benjk -
Added lines 1-117:
[@DEFINITION MODULE BS16 [SetType];

(* 16-bit Bitset *)

FROM FileIO IMPORT File; (* required for IO *)


(* BS16 type *)

TYPE
    BS16 = OPAQUE RECORD
        ARRAY 2 OF OCTET; (* 16 bits *)
    END; (* BS16 *)


(* Literal assignment *)

PROCEDURE [:=] assign ( VAR assignTo : BS16;
                        elements    : VARIADIC OF CARDINAL );
(* Assigns a variadic list of values of type CARDINAL to BS16 assignTo.
  This procedure is bound to the := operator for literal assignment. *)


(* accessor *)

PROCEDURE [.] isElement ( CONST set : BS16; element : CARDINAL ) : BOOLEAN;
(* Returns TRUE if element is an element of BS16 set, otherwise FALSE.
  This function is bound to the array operator [ ] and the IN operator
  for rvalues of type BS16. *)


(* mutator *)

PROCEDURE [!] storeValue ( CONST set : BS16;
                          element  : CARDINAL;
                          value    : BOOLEAN );
(* Includes character element in BS16 set if value is TRUE, otherwise
  removes it from set. This procedure is bound to the array operator [ ]
  for lvalues of type BS16. *)


(* counter *)

PROCEDURE [COUNT] elementCount ( CONST set : BS16 ) : CARDINAL;
(* Returns the number of elements in BS16 set. This function is bound
  to pervasive function COUNT for type BS16. *)


(* Dyadic set operations *)

PROCEDURE [+] union ( CONST set1, set2 : BS16 ) : BS16;
(* Returns the union of BS16 values set1 and set2.
  This function is bound to the + operator for type BS16. *)

PROCEDURE [-] diff ( CONST set1, set2 : BS16 ) : BS16;
(* Returns the set difference of BS16 values set1 and set2.
  This function is bound to the - operator for type BS16. *)

PROCEDURE [*] intersection ( set1, set2 : BS16 ) : BS16;
(* Returns the intersection of BS16 values set1 and set2.
  This function it bound to the * operator for type BS16. *)

PROCEDURE [/] symdiff ( set1, set2 : BS16 ) : BS16;
(* Returns the symmetric set difference of BS16 values set1 and set2.
  This function is bound to the / operator for type BS16. *)


(* Relational operations *)

PROCEDURE [=] isEqual ( set1, set2 : BS16 ) : BOOLEAN;
(* Returns TRUE if BS16 values set1 and set2 are equal, otherwise FALSE.
  This function is bound to operators = and # for type BS16. *)

PROCEDURE [<] isSubset ( set1, set2 : BS16 ) : BOOLEAN;
(* Returns TRUE if BS16 set1 is a true subset of set2, otherwise FALSE.
  This function is bound to operators < and >= for type BS16. *)

PROCEDURE [>] isSuperset ( set1, set2 : BS16 ) : BOOLEAN;
(* Returns TRUE if BS16 set1 is a true superset of set2, otherwise FALSE.
  This function is bound to operators > and <= for type BS16. *)


(* IO operations *)

(* The EBNF for the textual representation of BS16 values is:
    bitsetValue : simpleFormat | compactFormat | bitGroupFormat ;
    simpleFormat : bit+ ;
    compactFormat : base16Digit+ ;
    bitGroupFormat : "{" bit+ ( groupSeparator? bit+ )* "}" ;
    groupSeparator : " " | "." ;
    bit  : "0" | "1" ;
    base16Digit : "0" .. "9" | "A" .. "F" ;
  The number of bits shown is equal to the bitwidth of the BS16 type. *)

PROCEDURE Read ( infile : File; VAR set : BS16 );
(* Reads the textual representation of a BS16 value from stream infile
  - any leading whitespace is skipped
  - any remaining characters that are part of the value being read are
    removed from infile
  - the textual representation of the value read is assigned to set
  - the file status is set to any of:
    success, outOfRange, wrongFormat, endOfLine, or endOfInput. This
  procedure is substituted for invocations of READ with a BS16 argument. *)

PROCEDURE Write ( outfile : File; CONST set : BS16 );
(* Writes the value of CHARSET set in simple format to stream outfile. This
  procedure is substituted for invocations of WRITE with a BS16 argument.*)

PROCEDURE WriteF ( outfile      : File;
                  CONST fmtStr : ARRAY OF CHAR;
                  items        : VARIADIC OF CONST BS16 );
(* Writes a formatted textual representation of one or more BS16 values to
  output stream outfile. The output format is determined by fmtStr. This
  procedure is substituted for invocations of WRITEF with one or more
  BS16 arguments. *)

END BS16.@]
Restore