DIRECTORYBasics USING [Comparison],PrincOps USING [zLI1, zLI0, zBNDCK],Rope USING [ActionType, Compare, Equal, Find, Map, Match, SkipOver, SkipTo, ROPE, Text];RefText: CEDAR DEFINITIONS IMPORTS Rope = BEGINROPE: TYPE = Rope.ROPE;MaxLen: NAT = NAT.LAST;New: PROC [nChars: NAT] RETURNS [REF TEXT];ObtainScratch: PROC [nChars: NAT] RETURNS [REF TEXT];line: NAT = 100;page: NAT = 512;Error: ERROR [ec: ErrorCode];ErrorCode: TYPE = { clientModifiedReleasedText };ReleaseScratch: PROC [t: REF TEXT];Append: PROC [to: REF TEXT, from: REF READONLY TEXT, start: NAT _ 0, len: NAT _ MaxLen]RETURNS [REF TEXT];AppendTextRope: PROC [to: REF TEXT, from: Rope.Text, start: NAT _ 0, len: NAT _ MaxLen]RETURNS [REF TEXT] = INLINE {RETURN[Append[to, TrustTextRopeAsText[from], start, len]];};AppendRope: PROC [to: REF TEXT, from: ROPE, start: NAT _ 0, len: NAT _ MaxLen]RETURNS [REF TEXT];AppendChar: PROC [to: REF TEXT, from: CHAR] RETURNS [REF TEXT];InlineAppendChar: PROC [to: REF TEXT, from: CHAR] RETURNS [REF TEXT] = INLINE {IF to.length >= to.maxLength THEN RETURN [AppendChar[to, from]];to[to.length] _ from;to.length _ to.length + 1;RETURN [to];};ReserveChars: PROC [to: REF TEXT, nChars: NAT] RETURNS [REF TEXT];InlineReserveChars: PROC [to: REF TEXT, nChars: NAT] RETURNS [REF TEXT] = INLINE {IF LOOPHOLE[to.maxLength, INTEGER]-LOOPHOLE[nChars, INTEGER] <LOOPHOLE[to.length, INTEGER] THEN RETURN [ReserveChars[to, nChars]];RETURN [to];};Compare: PROC[s1, s2: REF READONLY TEXT, case: BOOL _ TRUE]RETURNS [Basics.Comparison] = INLINE {RETURN [Rope.Compare[TrustTextAsRope[s1], TrustTextAsRope[s2], case]]};Equal: PROC[s1, s2: REF READONLY TEXT, case: BOOL _ TRUE] RETURNS [BOOL] = INLINE {RETURN [Rope.Equal[TrustTextAsRope[s1], TrustTextAsRope[s2], case]]}; Fetch: PROC[base: REF READONLY TEXT, index: NAT] RETURNS [CHAR] = INLINE {IF base = NIL OR index > base.length THEN BoundsFault[];RETURN [base[index]]};Find: PROC[s1, s2: REF READONLY TEXT, pos1: NAT _ 0, case: BOOL _ TRUE]RETURNS [INTEGER] = INLINE {RETURN [Rope.Find[TrustTextAsRope[s1], TrustTextAsRope[s2], pos1, case]]}; Length: PROC [base: REF READONLY TEXT] RETURNS [NAT] = INLINE {RETURN [IF base =  NIL THEN 0 ELSE base.length]};Map: PROC[s: REF READONLY TEXT, start: NAT _ 0, len: NAT _ MaxLen, action: ActionType]RETURNS [quit: BOOL] = INLINE {RETURN [Rope.Map[TrustTextAsRope[s], start, len, action]]};ActionType: TYPE = PROC [CHAR] RETURNS [BOOL];Match: PROC[pattern, object: REF READONLY TEXT, case: BOOL _ TRUE]RETURNS [BOOL] = INLINE {RETURN [Rope.Match[TrustTextAsRope[pattern], TrustTextAsRope[object], case]]};SkipTo: PROC[s: REF READONLY TEXT, pos: NAT _ 0, skip: REF READONLY TEXT]RETURNS [NAT] = INLINE {RETURN [Rope.SkipTo[TrustTextAsRope[s], pos, TrustTextAsRope[skip]]]}; SkipOver: PROC[s: REF READONLY TEXT, pos: NAT _ 0, skip: REF READONLY TEXT]RETURNS [NAT] = INLINE {RETURN [Rope.SkipOver[TrustTextAsRope[s], pos, TrustTextAsRope[skip]]]};TrustTextAsRope: PROC [text: REF READONLY TEXT] RETURNS [Rope.Text] = INLINE {TRUSTED {RETURN [LOOPHOLE[text]]}};TrustTextRopeAsText: PROC [rope: Rope.Text] RETURNS [REF READONLY TEXT] = INLINE {TRUSTED {RETURN [LOOPHOLE[rope]]}};BoundsFault: PROC = TRUSTED MACHINE CODE {PrincOps.zLI1; PrincOps.zLI0; PrincOps.zBNDCK};END.  ║  RefText.mesaThis interface contains procedures for manipulating mutable garbage-collected strings (REF TEXT).  It is largely parallel to the Rope interface.Last edited by:MBrown on September 16, 1983 2:52 pmPaul Rovner on August 8, 1983 11:48 amRuss Atkinson on August 26, 1982 5:35 pmThis interface includes some simple procedures for REF TEXT.  As much as possible the operations are parallel to the Rope interface's operations on ROPE.When reading from a REF TEXT, the package treats NIL and "" equivalently (Length[NIL] = 0, Fetch[NIL, 0] raises BoundsFault).  But Appending to a NIL REF TEXT raises PointerFault.Only the New operation below allocates collectable storage.  If you are doing large numbers of REF TEXT allocations, maybe you should be using ROPE.In a "piece" defined by [s: REF TEXT, start: NAT, len: NAT], len is interpreted as follows:IF start > s.length THEN BoundsFault ELSE len _ MIN[len, s.length-start].The resulting len value is called the "effective len" below.A boolean "case" parameter should be understood to mean "case significant".If case, upper case characters are treated as distinct from lower case characters.If ~case, upper case characters are converted to lower case before comparison.Creating TEXTAllocates a TEXT with length = 0, maxLength = nChars, and returns a REF to it.Some programs allocate and discard TEXT frequently.  To improve the performance of these programs, the RefText package manages a small pool of "scratch" TEXTs.  The expected usage of this pool is for a client to get a scratch TEXT using the ObtainScratch procedure, manipulate this TEXT for awhile, and then return it to the pool using ReleaseScratch.  A client who retains a REF to a scratch TEXT after releasing it is not playing by the rules (the same TEXT will surely be handed out to someone else), but this is still "safe" in the Cedar sense (the storage invariants are not compromised by the error).! Error [clientModifiedReleasedText]Returns a REF to a TEXT from with length = 0, maxLength >= nChars.  This TEXT is generally obtained from a pool of TEXTs.A call to ObtainScratch is less expensive than New, but ObtainScratch should only be called with the expectation of calling ReleaseScratch (below) later on the resulting TEXT.  (It is ok for a client to occasionally "forget" to release a TEXT obtained with this procedure, so for instance there is no need to call ReleaseScratch in UNWIND catch phrases unless UNWIND is expected most of the time!)Raises Error [clientModifiedReleasedText] if the TEXT it wanted to return has been tampered with (in a detectable way) since it was released with ReleaseScratch; this indicates that some client is not playing by the rules. Caller asserts that it has no further interest in the TEXT pointed to by t.Noop if t was not obtained from scratch pool.Writing TEXT! PointerFault (if to = NIL)! BoundsFault (if to.length > to.maxLength or length of result text would exceed MaxLen)! PointerFault (if to = NIL)! BoundsFault (if to.length > to.maxLength or length of result text would exceed MaxLen)! PointerFault (if to = NIL)! BoundsFault (if to.length > to.maxLength or length of result text would exceed MaxLen)! PointerFault (if to = NIL)! BoundsFault (if to.length > to.maxLength or length of result text would exceed MaxLen)! PointerFault (if to = NIL)! BoundsFault (if to.length > to.maxLength or length of result text would exceed MaxLen)! PointerFault (if to = NIL)! BoundsFault (if length of result text would exceed MaxLen)The client wishes to append nChars characters to the REF TEXT to without overflowing it.  The result text t satisfies (1) Compare[to, t] = $equal, and (2) to.maxLength >= to.length + nChars.! PointerFault (if to = NIL)! BoundsFault (if length of result text would exceed MaxLen)Reading TEXTreturns lexicographic comparison of the REF TEXT contentscase => case of characters is significantreturns s1 = s2 (true iff s1 and s2 contain same sequence of characters,modulo the case parameter)! BoundsFault (if base = NIL or index > base.length)fetches indexed character from given REF TEXT.returns position in s1 where s2 occurs (starts looking at pos1)does NOT do *-matching (use Match below for this)returns -1 if not found (including pos1 >= Length[s1])returns the length of the REF TEXT (0 if NIL).! BoundsFault (if start > s.length)Applies the action to each char in the given piece of s, in ascending order, until action[char] = TRUE or no more chars.Returns TRUE iff stopped by action[char] = TRUE.Returns TRUE iff object matches the pattern, where the pattern may contain * to indicate that 0 or more characters will match.If case is true, then case matters. Examine s[pos .. s.length), and return the lowest index in this range such that s[i] is contained in the "skip" string.  If no such character exists, return s.length.Examine s[pos .. s.length), and return the lowest index in this range such that s[i] is NOT contained in the skip string.  If no such character exists, return s.length.Miscellaneousit is sometimes OK to treat a REF TEXT as a ROPEyou will be surprised only when looking at the type at runtime OR when you alter the textit is sometimes OK to treat a Rope.Text as a REF TEXT.you must promise not to modify it! Э╩  Ш headЪЬЩbodyЪЬW╧kЬ1ЩРЪЬЩJЪЬ$Щ$JЪЬ&Щ&JЪЬ(Щ(ЧЧЧШ ЪЭ	Ш	JЪЬЭЬШJЪЬ	ЭЬШ$ЪЬЭЬBЭЬШXJШ ЧЧЧЪ	╨blЬЭЬЭЬЭЬЭШ/JЪЭЬЭЬЭЬШЧШ JЪЬ3ЭЬYЭЬЩЩJШ JЪЬЭЬЭЬЭЬЭЬ.ЭЬЭЬЩ│JШ JЪЬ_ЭЬ(ЭЬЩФJШ JЪЬЭЬ7Щ[JЪЬIЩIJЪЬ<Щ<JШ JЪЬKЩKJЪЬRЩRJЪЬNЩNJШ JЪЬЭЬЭЬШJШ JЩ JЪЬ	ЭЩJШ unitЪ╧nЬЭЬ
ЭЬЭЬЭЬЭЬШ+JЪЬЭЬ>ЩNЧJЩ JЪЬ#ЭЬrЭЬEЭЬ4ЭЬZЭЬЭЬ:ЭЬУЩ▐ЪЯЬЭЬ
ЭЬЭЬЭЬЭЬШ5JЪЬ$Щ$JЪ	Ь
ЭЬЭЬ2ЭЬ&ЭЬЩyJЪ	ЬкЭЬ@ЭЬZЭЬЭЬЩНJЪЬ1ЭЬкЩ▀MЪЬЭЬШJЪЬЭЬШЧMЪЬЭЬШJЪЬЭЬ"Ш1ЪЯЬЭЬЭЬЭЬШ#JЪЬ6ЭЬЩKJЩ-JШ ЧJЩ JЪЬЭЩJШ ЪЯЬЭЬШJЪЬЭЬЭЬЭЬЭЬЭЬ	ЭЬЭЬ
ШIJЪЭЬЭЬЭЬШJЪЬЩJЪЬXЩXЧЪЯЬЭЬШJЪ	ЬЭЬЭЬЭЬЭЬ
ШAJЪЭЬЭЬЭЬЭЬШJЪЬЩJЪЬXЩXJЪЭЬ4Ш:JШЧЪЯ
ЬЭЬШJЪЬЭЬЭЬЭЬ	ЭЬЭЬ
Ш<JЪЭЬЭЬЭЬЭШJЪЬЩJЪЬXЩXЧЪЯ
ЬЭЬЭЬЭЬЭЬЭЬЭЬЭЬЭШ?JЪЬЩJЪЬXЩXЧЪЯЬЭЬЭЬЭЬЭЬЭЬЭЬЭЬЭЬШOJЪЬЩJЪЬXЩXJЪЭЬЭЬЭЬШ@JШJШJЪЭЬШJЪЬШЧЪЯЬЭЬЭЬЭЬ
ЭЬЭЬЭЬЭЬЭШBJЪЬЩJЪЬ<Щ<JЪЬ5ЭЬЭЬБЩ╛ЧЪЯЬЭЬЭЬЭЬ
ЭЬЭЬЭЬЭЬЭЬШRJЪЬЩJЪЬ<Щ<Ъ
ЭЬЭЬЭЬЭЬ	ЭЬШ>JЪЭЬЭЬЭЬШDЧJЪЭЬШJЪЬШЧJЩ JЪЬЭЩЪЯЬЭШJЪЬ	ЭЬЭЬЭЬЭЬЭЬШ.JЪЭЬЭЬШ&JЪЬ(ЭЬ	Щ9JЪЬ)Щ)JЪЭЬAШGЧЪЯЬЭШJЪЬ	ЭЬЭЬЭЬЭЬЭЬЭЬЭЬЭЬШHJЪЬHЩHJЪЬЩJЪЭЬ@ШFЧЪЯЬЭШJЪЬЭЬЭЬЭЬ	ЭЬЭЬЭЬЭЬШ?JЪЬ4Щ4JЪЬ%ЭЬЩ.JЪЭЬЭЬЭЬЭЬШ8JЪЭЬШЧЪЯЬЭШ
JЪЬ	ЭЬЭЬЭЬЭЬЭЬЭЬШ=JЪЭЬЭЬЭЬШJЪЬ?Щ?JЪЬ1Щ1JЪЬ6Щ6JЪЭЬEШKЧЪЯЬЭЬЭЬЭЬЭЬЭЬЭЬЭЬШ?JЪЬЭЬЩ.JЪ
ЭЬЭЬ	ЭЬЭЬЭЬШ1ЧЪЯЬЭШ	JЪЬЭЬЭЬЭЬ	ЭЬЭЬШMJЪЭЬЭЬЭЬШJЪЬ#Щ#JЪЬxЩxJЪЬ0Щ0JЪЭЬ5Ш;JЪЯ
ЬЭЬЭЬЭЬЭЬЭЬШ.ЧЪЯЬЭШJЪЬЭЬЭЬЭЬЭЬЭЬШ7JЪЭЬЭЬЭЬШJЪЬ~Щ~JЪЬ$Щ$JЪЭЬHШNЧЪЯЬЭШJЪЬЭЬЭЬЭЬЭЬЭЬЭЬЭЬШ=JЪЭЬЭЬЭЬШJЪЬжЩжJЪЭЬAШGЧЪЯЬЭШJЪЬЭЬЭЬЭЬЭЬЭЬЭЬЭЬШ=JЪЭЬЭЬЭЬШJЪЬиЩиJЪЭЬBШHЧJЩ JЩЪЯЬЭЬЭЬЭЬЭЬЭЬЭЬШNJЪЭЬЭЬЭЬ
Ш#JЪЬЭЬЭЩ0JЪЬYЩYЧЪЯЬЭЬЭЬЭЬЭЬЭЬЭЬШRJЪЭЬЭЬЭЬ
Ш#JЪЬ-ЭЬЩ6JЩ"ЧЪ
ЯЬЭЬЭЬЭЬЭЬШ*JЪЬ/Ш/JШ ЧJЪЭЬШJШ JШ ЧЧ ЕЧ    
  *C  