ui/src/xvbt/XScrollQueue.i3


Copyright (C) 1994, Digital Equipment Corp.
 by Steve Glassman, Mark Manasse and Greg Nelson 
<*PRAGMA LL*>

INTERFACE XScrollQueue;         (* = RingBuffer(XScrollQElt) *)
IMPORT PaintPrivate;

TYPE
  T = RECORD
        lo, hi: CARDINAL                            := 0;
        buff  : REF ARRAY OF PaintPrivate.ScrollRec := NIL
      END;
buff[lo..hi-1] circularly are the active entries; lo = hi => the queue is empty; lo # hi => buff # NIL.

CONST Empty = T{0, 0, NIL};

<*INLINE*> PROCEDURE IsEmpty (READONLY rb: T): BOOLEAN;
Return whether rb is empty.

PROCEDURE Insert (VAR rb: T; READONLY e: PaintPrivate.ScrollRec);
Insert e into rb, extending rb if necessary.

EXCEPTION Exhausted;

PROCEDURE Remove (VAR rb: T): PaintPrivate.ScrollRec RAISES {Exhausted};
Raise the exception if br is empty, else remove the oldest element of rb and return it.

END XScrollQueue.