1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # This file is free software, which comes along with NIT. This software is
4 # distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
5 # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
6 # PARTICULAR PURPOSE. You can modify it if you want, provided this header
7 # is kept unaltered, and a notification of the changes is added.
8 # You are allowed to redistribute it and sell it, alone or as a part of
11 # Nit implementation of the Ropes (see Ropes : An Alternative to Strings,
12 # SOFTWARE - PRACTICE AND EXPERIENCE, VOL. 25(12), 1315 - 1330 (DECEMBER 1995)
13 # Hans. J Boehm, Russ Atkinson and Michael Plass)
15 # A rope is a kind of string but instead of being flat, it relies on a binary tree structure to store data.
20 # Used when searching for a particular node
21 # Returns the path to the node from the root of the rope
22 # Also, the node and the offset for seeked position in the rope
28 # Stack of the nodes traversed, and the path used
29 var stack
: List[PathElement]
32 # An element for a Path, has the concat node and whether or not
33 # left or right child was visited.
34 private class PathElement
37 # Was the left child visited ?
39 # Was the right child visited ?
44 private abstract class RopeNode
49 # Node that represents a concatenation between two nodes (of any RopeNode type)
53 # Left child of the node
54 var _left
: nullable RopeNode = null
55 # Right child of the node
56 var _right
: nullable RopeNode = null
58 fun left
: nullable RopeNode do return _left
59 fun right
: nullable RopeNode do return _right
61 fun left
=(l
: RopeNode)
65 if _right
!= null then length
+= _right
.length
68 fun right
=(r
: RopeNode)
72 if _left
!= null then length
+= _left
.length
76 # Leaf of a Rope, contains a FlatString
80 # Encapsulated FlatString in the leaf node
83 init(val
: FlatString) do
90 # Basic structure, binary tree with a root node.
92 # Also shared services by subsequent implementations.
96 # Root node, entry point of a Rope.
97 private var root
: RopeNode
102 # Creates a new Rope with `s` as root
103 init from
(s
: String) do
104 if s
isa RopeString then root
= s
.root
else root
= new Leaf(s
.as(FlatString))
107 private init from_root
(r
: RopeNode)
112 redef fun length
do return root
.length
114 # Iterator on the nodes of the rope, in forward postfix order
115 private fun postfix
(from
: Int): Postfix do return new Postfix.from
(self, from
)
117 # Path to the Leaf for `position`
118 private fun node_at
(position
: Int): Path
120 assert position
>= 0 and position
< length
121 return get_node_from
(root
.as(not null), 0, position
, new List[PathElement])
124 # Builds the path to Leaf at position `seek_pos`
125 private fun get_node_from
(node
: RopeNode, curr_pos
: Int, seek_pos
: Int, stack
: List[PathElement]): Path
128 if node
isa Leaf then return new Path(node
, seek_pos
- curr_pos
, stack
)
129 node
= node
.as(Concat)
131 if node
.left
!= null then
132 var next_pos
= curr_pos
+ node
.left
.length
133 stack
.add
(new PathElement(node
))
134 if next_pos
> seek_pos
then
135 stack
.last
.left
= true
136 return get_node_from
(node
.left
.as(not null), curr_pos
, seek_pos
, stack
)
138 stack
.last
.right
= true
139 return get_node_from
(node
.right
.as(not null), next_pos
, seek_pos
, stack
)
141 var vis
= new PathElement(node
)
144 return get_node_from
(node
.right
.as(not null), curr_pos
, seek_pos
, stack
)
150 # Rope that cannot be modified
155 redef fun to_s
do return self
157 # Inserts a String `str` at position `pos`
158 fun insert_at
(str
: String, pos
: Int): RopeString
160 if str
.length
== 0 then return self
161 if self.length
== 0 then return new RopeString.from
(str
)
163 assert pos
>= 0 and pos
<= length
165 if pos
== length
then return append
(str
).as(RopeString)
167 var path
= node_at
(pos
)
169 var last_concat
= new Concat
171 if path
.offset
== 0 then
172 last_concat
.right
= path
.leaf
173 if str
isa FlatString then last_concat
.left
= new Leaf(str
) else last_concat
.left
= str
.as(RopeString).root
174 else if path
.offset
== path
.leaf
.length
then
175 if str
isa FlatString then last_concat
.right
= new Leaf(str
) else last_concat
.right
= str
.as(RopeString).root
176 last_concat
.left
= path
.leaf
178 var s
= path
.leaf
.str
179 var l_half
= s
.substring
(0, s
.length
- path
.offset
)
180 var r_half
= s
.substring_from
(s
.length
- path
.offset
)
182 cct
.right
= new Leaf(r_half
)
183 last_concat
.left
= new Leaf(l_half
)
184 if str
isa FlatString then last_concat
.right
= new Leaf(str
) else last_concat
.right
= str
.as(RopeString).root
185 cct
.left
= last_concat
189 for i
in path
.stack
.reverse_iterator
do
192 nod
.right
= i
.node
.right
.as(not null)
193 nod
.left
= last_concat
195 nod
.left
= i
.node
.left
.as(not null)
196 nod
.right
= last_concat
201 return new RopeString.from_root
(last_concat
)
204 # Adds `s` at the end of self
205 fun append
(s
: String): String
207 if self.is_empty
then return s
208 return new RopeString.from_root
(append_to_path
(root
,s
))
211 # Builds a new path from root to the rightmost node with s appended
212 private fun append_to_path
(node
: RopeNode, s
: String): RopeNode
215 if node
isa Leaf then
217 if s
isa FlatString then cct
.right
= new Leaf(s
) else cct
.right
= s
.as(RopeString).root
218 else if node
isa Concat then
219 var right
= node
.right
220 if node
.left
!= null then cct
.left
= node
.left
.as(not null)
221 if right
== null then
222 if s
isa FlatString then cct
.right
= new Leaf(s
) else cct
.right
= s
.as(RopeString).root
224 cct
.right
= append_to_path
(right
, s
)
232 # var rope = new RopeString.from("abcd")
233 # assert rope.substring(1, 2) == "bc"
234 # assert rope.substring(-1, 2) == "a"
235 # assert rope.substring(1, 0) == ""
236 # assert rope.substring(2, 5) == "cd"
238 redef fun substring
(pos
, len
)
245 if pos
+ len
> length
then len
= length
- pos
247 if len
<= 0 then return new RopeString.from
("")
249 var path
= node_at
(pos
)
252 var offset
= path
.offset
254 if path
.leaf
.str
.length
- offset
> len
then lf
= new Leaf(lf
.str
.substring
(offset
,len
)) else lf
= new Leaf(lf
.str
.substring_from
(offset
))
256 var nod
: RopeNode = lf
258 for i
in path
.stack
.reverse_iterator
do
259 if i
.right
then continue
263 if r
!= null then tmp
.right
= r
267 var ret
= new RopeString
270 path
= ret
.node_at
(len-1
)
273 nod
= new Leaf(path
.leaf
.str
.substring
(0, offset
+1))
275 for i
in path
.stack
.reverse_iterator
do
276 if i
.left
then continue
280 if l
!= null then tmp
.left
= l
290 # Used to iterate on a Rope
291 private class IteratorElement
302 # The node being visited
304 # If the node has a left child, was it visited ?
306 # If the node has a right child, was it visited ?
308 # Was the current node visited ?
312 # Simple Postfix iterator on the nodes of a Rope
313 private class Postfix
314 super IndexedIterator[RopeNode]
316 # Target Rope to iterate on
319 # Current position in Rope
323 var stack
= new List[IteratorElement]
325 init from
(tgt
: Rope, pos
: Int)
329 if pos
< 0 or pos
>= tgt
.length
then return
330 var path
= tgt
.node_at
(pos
)
331 self.pos
-= path
.offset
332 for i
in path
.stack
do
333 var item
= new IteratorElement(i
.node
)
335 if i
.right
then item
.right
= true
338 var item
= new IteratorElement(path
.leaf
)
346 return stack
.last
.node
349 redef fun is_ok
do return not stack
.is_empty
351 redef fun index
do return pos
354 if stack
.is_empty
then return
355 if pos
> target
.length-1
then
361 if lst
.node
isa Leaf then
362 pos
+= lst
.node
.length
371 if nod
isa Concat and nod
.left
!= null then
372 stack
.push
(new IteratorElement(nod
.left
.as(not null)))
377 if not lst
.right
then
380 if nod
isa Concat and nod
.right
!= null then
381 stack
.push
(new IteratorElement(nod
.right
.as(not null)))