

DIRECTORY
Basics USING [Comparison],
Rope USING [MaxLen, ROPE];

RopeReader: CEDAR DEFINITIONS ~ BEGIN


ROPE: TYPE ~ Rope.ROPE;
MaxLen: INT ~ Rope.MaxLen;

Ref: TYPE ~ REF Body;
Body: TYPE ~ PRIVATE RECORD [
text: REF TEXT м, -- text buffer (must not be NIL)
current: NAT м 0, -- index in text of current character (next to be returned by Get)
rope: ROPE м NIL, -- rope that we are reading
index: INT м 0, -- index in rope of text[0]
charForEndOfRope: BOOLEAN м FALSE,
endChar: CHAR м 0C -- char to return when reach end of rope
];

ReadOffEnd: ERROR;
Create: PROC[size: NAT м 0] RETURNS [Ref];

GetRope: PROC [reader: Ref] RETURNS [rope: ROPE]
~ INLINE { RETURN [reader.rope] };

GetIndex: PROC [reader: Ref] RETURNS [index: INT]
~ INLINE { RETURN [reader.index+reader.current] };

Position: PROC [reader: Ref] RETURNS [rope: ROPE, index: INT]
~ INLINE { RETURN [rope: GetRope[reader], index: GetIndex[reader]] };

SetPosition: PROC [reader: Ref, rope: ROPE, index: INT м 0]
~ INLINE {
IF GetRope[reader]=rope AND GetIndex[reader]=index THEN RETURN;
reader.rope м rope; reader.current м 0; reader.text.length м 0; reader.index м index;
};

SetIndex: PROC [reader: Ref, index: INT м 0]
~ INLINE {
IF reader.index+reader.current # index THEN
{reader.current м 0; reader.text.length м 0; reader.index м index}
};

BackupIndex: PROC [reader: Ref, amount: INT]
~ INLINE { SetIndex[reader, GetIndex[reader]-amount] };

BumpIndex: PROC [reader: Ref, amount: INT]
~ INLINE { SetIndex[reader, GetIndex[reader]+amount] };

GetEndChar: PROC [reader: Ref] RETURNS [endChar: CHAR]
~ INLINE { RETURN [reader.endChar] };

CharForEndOfRope: PROC [reader: Ref] RETURNS [BOOLEAN]
~ INLINE { RETURN [reader.charForEndOfRope] };

SetCharForEndOfRope: PROC [reader: Ref, char: CHAR]
~ INLINE { reader.endChar м char; reader.charForEndOfRope м TRUE };

ClearCharForEndOfRope: PROC [reader: Ref]
~ INLINE { reader.charForEndOfRope м FALSE };

Mode: PRIVATE TYPE ~ {get, backwards, peek, peekbackwards};
ReadChar: PRIVATE PROC [reader: Ref, mode: Mode] RETURNS [CHAR];

Get: PROC [reader: Ref] RETURNS [CHAR]
~ INLINE {
text: REF TEXT ~ reader.text;
i: NAT ~ reader.current;
IF i<text.length THEN { reader.current м i+1; RETURN[text[i]] }
ELSE RETURN[ReadChar[reader, $get]];
};

Backwards: PROC [reader: Ref] RETURNS [CHAR]
~ INLINE {
i: NAT ~ reader.current;
IF i>0 THEN RETURN[reader.text[reader.current м i-1]]
ELSE RETURN[ReadChar[reader, $backwards]]
};

Peek: PROC [reader: Ref] RETURNS [CHAR]
~ INLINE {
text: REF TEXT ~ reader.text;
i: NAT ~ reader.current;
IF i<text.length THEN RETURN[text[i]]
ELSE RETURN[ReadChar[reader, $peek]]
};

PeekBackwards: PROC [reader: Ref] RETURNS [CHAR]
~ INLINE {
i: NAT ~ reader.current;
IF i>0 THEN RETURN[reader.text[i-1]]
ELSE RETURN[ReadChar[reader, $peekbackwards]]
};
Equal: PROC [r1, r2: ROPE, rdr1, rdr2: Ref м NIL] RETURNS [BOOLEAN]
 ~ INLINE { RETURN [EqSubstrs[r1, r2, 0, 0, MaxLen, rdr1, rdr2]] };

EqSubstrs: PROC [r1, r2: ROPE, start1, start2, len: INT, rdr1, rdr2: Ref м NIL] RETURNS [BOOL];

Compare: PROC [r1,r2: ROPE, rdr1,rdr2: Ref м NIL, case: BOOLEAN м TRUE] RETURNS [Basics.Comparison]
~ INLINE {RETURN [CompareSubstrs[r1,r2,0,MaxLen,0,MaxLen,rdr1,rdr2,case]] };

CompareSubstrs: PROC [r1, r2: ROPE, start1, len1, start2, len2: INT, rdr1, rdr2: Ref м NIL, case: BOOL м TRUE] RETURNS [Basics.Comparison];

GetRopeReader: PROC RETURNS [reader: Ref];

FreeRopeReader: PROC [reader: Ref];

SetDefaultSize: PROC[size: NAT];
END.

     
RopeReader.mesa
Copyright ╙ 1985, 1986, 1988, 1991 by Xerox Corporation.  All rights reserved.
written by Bill Paxton,  January 1981
last edit by Paxton, September 13, 1982 9:33 am
last edit by McGregor, June 10, 1982 2:30 pm
last edit by Maxwell, January 5, 1983 8:36 am
last edit by Russ Atkinson, July 22, 1983 9:33 am
last edit by Doug Wyatt, November 4, 1988 3:27:02 pm PST
Plass, September 24, 1991 11:53 am PDT
RopeReader provides fast inline access to characters in ropes
designed for speed in reading a sequence of characters, either forwards or backwards
Overview
create a reader by RopeReader.Create
reader: RopeReader.Ref _ RopeReader.Create[];
position it where you want to read by SetPosition
RopeReader.SetPosition[reader,rope,index];
where rope is to the one to read from, and index is the initial position for the reader
you can reposition a reader at any time
read its position in any of the following ways:
[rope,index] _ RopeReader.Position[reader];
rope _ RopeReader.GetRope[reader];
index _ RopeReader.GetIndex[reader];
to read in ascending order (left to right)
initialize position at index of first character to be read
for example, use 0 to start at beginning of rope
then call Get which reads to the right and increments the position
char _ RopeReader.Get[reader];
to read in descending order (right to left)
initialize position after first character to be read
for example, use size of rope to start at end
then call Backwards which reads to the left and decrements the position
char _ RopeReader.Backwards[reader];
can also get a character without changing the reader position
to look at the next character that Get would return, call Peek
char _ RopeReader.Peek[reader];
to look at what Backwards would return, call PeekBackwards
char _ RopeReader.PeekBackwards[reader];
can intermix reading or peeking to left and right
don't need to reinitialize the reader to change direction
if read off either end of rope, you can choose either to get an error or a client-specified character
there are equality and comparison routines that use readers for efficiency
Equal, EqSubstr, EqSubstrs
Compare, CompareSubstr, CompareSubstrs
operations are also provided to read a block of characters
destination given by either a REF TEXT or a REF chars array
can read either forward or backwards from source
Declarations
if true, return endChar; else give ERROR ReadOffEnd 
Operations
Creates a rope reader with a text buffer of the given size; if size=0, uses default.
Returns the current end char.
This will be returned rather than giving ReadOffEnd error if CharForEndOfRope is true.
get character, then increment reader location
decrement reader location, then get character
get character without incrementing reader location
like Backwards, but doesn't change position
Rope comparison operations that make use of readers for efficiency.
uses readers rdr1 and rdr2 to read ropes r1 and r2 to test for equality
uses readers rdr1 and rdr2 to read ropes r1 and r2 to test for equality
returns TRUE if r1 starting at start1 is same as
len chars of r2 starting at start2
returns FALSE if not enough chars available in either rope
i.e., if start1+len > size[r1] or start2+len > size[r2]
if rdr1 or rdr2 is NIL, gets own readers from cache
uses readers rdr1 and rdr2 to compare ropes r1 and r2
returns less for r1 < r2; equal for r1 = r2; and greater for r1 > r2
if ~case then all characters forced lowercase for comparison
uses readers rdr1 and rdr2 to compare substrings of ropes r1 and r2
if rdr1 or rdr2 is NIL, gets own readers from cache
Scratch pool
The next routines provide a small cache of rope readers 
to avoid creating a lot of garbage readers
don't use these unless you are certain to free the reader at most once
ok not to free it, but don't free it more than once
Sets the default buffer size used by Create and readers in the cache.

Plass, March 1, 1985 11:47:10 am PST
Cleanup for Cedar 6.0
removed CharsArray stuff, and AppendToString, GetString, BackwardsGetString, AppendToText, GetText, BackwardsGetText (use Rope.AppendChars instead)., Peek, DIRECTORY, ROPE


Э╩  ХNewlineDelimiter
Ц(cedarcode) styleЩ Ъ╧cЩIcodeЪЬ
╧eЬCЩNJЪЭ%Щ%JЪЭ/Щ/JЪЭ,Щ,JЪЬ-Щ-JЪЬ1Щ1JЪЬ8Щ8KЩ&ЧKШ ЪЭ=Щ=JЪЭTЩTKШ ЧЪ╧k	Ш	KЪЬЯЬШKЪЬЯЬ
ЯЬШKШ Чlead2Ъ╨ln
ЬЯЬЯЬЯШ%head2ЩЪЭ$Щ$JЪЭ-Щ-KШ ЧЪЭ1Щ1JЪЭ*Щ*JЪЭWЩWJЪЭ'Щ'KШ ЧЪЭ/Щ/JЪЭ+Щ+JЪЭ"Щ"JЪЭ$Щ$KШ ЧЪЭ*Щ*ЪЭ:Щ:JЪЭ0Щ0ЧЪЭBЩBJЪЭЩKШ ЧЧЪЭ+Щ+ЪЭ4Щ4JЪЭ-Щ-ЧЪЭGЩGJЪЭ$Щ$KШ ЧЧЪЭ=Щ=ЪЭ>Щ>JЪЭЩЧЪЭ:Щ:JЪЭ(Щ(KШ ЧЧЪЭ1Щ1JЪЭ9Щ9KШ ЧЪЭeЩeKШ ЧЪЭJЩJJЪЭЩJЪЭ&Щ&KШ ЧЪЭ:Щ:JЪЭ;Щ;JЪЭ0Щ0ЧЧЧЪЭЩKЪЯЬЯЬЯЬШKЪЬЯЬШKШ KЪЬЯЬЯЬШЪЬЯЬЯЬЯЬШKЪЬЯЬЯЬЭ Ш2KЪЬ	ЯЬЭBШTKЪЬЯЬЯЬЭШ-KЪЬЯЬЭШ+ЪЬЯЬЯЬШ"JЪЭ4Щ4ЧKЪЬ	ЯЬЭ(Ш;KШЧKШ KЪЬЯЬШЧЪЭ
Щ
Ъ╧nЬЯЬЯЬЯЬШ*JЩTЧKШ ЪбЬЯЬЯЬЯЬШ0KЪЬЯЬЯЬШ"KШ ЧЪбЬЯЬЯЬ	ЯЬШ1KЪЬЯЬЯЬ!Ш2KШ ЧЪ
бЬЯЬЯЬЯЬ	ЯЬШ=KЪЬЯЬЯЬ4ШEKШ ЧЪбЬЯЬЯЬ	ЯЬШ;KЪЬЯЬШ
KЪЯЬЯЬЯЬЯЬШ?KЪЬUШUШKШ ЧЧЪбЬЯЬЯЬШ,KЪЬЯЬШ
ЪЯЬ%ЯШ+KЪЬBШBЧЪЬШKШ ЧЧЪбЬЯЬЯЬШ,KЪЬЯЬ/Ш7KШ ЧЪб	ЬЯЬЯЬШ*KЪЬЯЬ/Ш7KШ ЧЪб
ЬЯЬЯЬЯЬШ6KЪЬЯЬЯЬШ%JЪЬЩJЪЬVЩVKШ ЧЪбЬЯЬЯЬЯЬШ6KЪЬЯЬЯЬШ.KШ ЧЪбЬЯЬЯЬШ3KЪЬЯЬ4ЯЬШCKШ ЧЪбЬЯЬШ)KЪЬЯЬЯЬШ-KШ ЧKЪЬЯЬЯЬ)Ш;KЪ
бЬЯЬЯЬЯЬЯЬШ@KШ ЪбЬЯЬЯЬЯЬШ&KЪЬЯЬШ
JЪЭ-Щ-KЪЬЯЬЯЬШKЪЬЯЬШKЪЯЬЯЬЯЬШ?KЪЯЬЯЬШ$KШKШ ЧЪб	ЬЯЬЯЬЯЬШ,KЪЬЯЬШ
JЪЭ-Щ-KЪЬЯЬШKЪЯЬЯЬЯЬ#Ш5KЪЯЬЯЬШ)KШKШ ЧЪбЬЯЬЯЬЯЬШ'KЪЬЯЬШ
JЪЭ2Щ2KЪЬЯЬЯЬШKЪЬЯЬШKЪЯЬЯЬЯЬ	Ш%KЪЯЬЯЬШ$KШKШ ЧЪбЬЯЬЯЬЯЬШ0KЪЬЯЬШ
JЪЭ+Щ+KЪЬЯЬШKЪЯЬЯЬЯЬШ$KЪЯЬЯЬ"Ш-KШЧЧЪЭCЩCЪбЬЯЬ
ЯЬЯЬЯЬЯЬШCJЪЭGЩGKЪЬЯЬЯЬ1ШCKШ ЧЪб	ЬЯЬ
ЯЬЯЬЯЬЯЬЯЬШ_JЪЭGЩGЪЭ0Щ0JЪЭ"Щ"ЧЪЭ:Щ:JЪЭ7Щ7ЧJЪЭ3Щ3KШ ЧЪбЬЯЬ	ЯЬЯЬЯЬЯЬЯЬШcJЪЭ5Щ5JЪЭЬЭЬЭЩDJЪЭ<Щ<KЪЬЯЬЯЬ<ШLKШ ЧХStartOfExpansion[]ЪбЬЯЬ
ЯЬЯЬЯЬЯЬЯЬЯЬШЛJЪЭCЩCJЪЭ3Щ3ЧЧЪЭЩЪЭ8Щ8JЪЭ*Щ*JЪЭFЩFJЪЭ3Щ3KШ ЧKЪбЬЯЬЯЬШ*KШ KЪбЬЯЬШ#KШ ЪбЬЯЬЯЬШ JЩEJЩ ЧLЪЯЬШЧKШ Щ$KЩKЪЬФ╧rЩлЧKЩ KЩ KЩ KЩ KЩ Ч ЕЧ    Ц  %║  