some fixes to gap-buffer

db4
Alex Chapman 2008-01-26 01:21:04 +11:00
parent 6b8e8ac697
commit 9301d62795
7 changed files with 419 additions and 0 deletions

View File

@ -0,0 +1,14 @@
USING: kernel gap-buffer.cursortree tools.test sequences trees arrays strings ;
[ t ] [ "this is a test string" <cursortree> 0 <left-cursor> at-beginning? ] unit-test
[ t ] [ "this is a test string" <cursortree> dup length <left-cursor> at-end? ] unit-test
[ 3 ] [ "this is a test string" <cursortree> 3 <left-cursor> cursor-pos ] unit-test
[ CHAR: i ] [ "this is a test string" <cursortree> 3 <left-cursor> element< ] unit-test
[ CHAR: s ] [ "this is a test string" <cursortree> 3 <left-cursor> element> ] unit-test
[ t ] [ "this is a test string" <cursortree> 3 <left-cursor> CHAR: a over set-element< CHAR: t over set-element> cursor-tree "that is a test string" sequence= ] unit-test
[ t ] [ "this is a test string" <cursortree> 3 <left-cursor> 8 over set-cursor-pos dup 1array swap cursor-tree cursortree-cursors tree-values sequence= ] unit-test
[ "this is no longer a test string" ] [ "this is a test string" <cursortree> 8 <left-cursor> "no longer " over insert cursor-tree >string ] unit-test
[ "refactor" ] [ "factor" <cursortree> 0 <left-cursor> CHAR: e over insert CHAR: r over insert cursor-tree >string ] unit-test
[ "refactor" ] [ "factor" <cursortree> 0 <right-cursor> CHAR: r over insert CHAR: e over insert cursor-tree >string ] unit-test
[ "this a test string" 5 ] [ "this is a test string" <cursortree> 5 <right-cursor> dup delete> dup delete> dup delete> dup cursor-tree >string swap cursor-pos ] unit-test
[ "this a test string" 5 ] [ "this is a test string" <cursortree> 8 <right-cursor> dup delete< dup delete< dup delete< dup cursor-tree >string swap cursor-pos ] unit-test

View File

@ -0,0 +1,91 @@
! Copyright (C) 2007 Alex Chapman All Rights Reserved.
! See http://factorcode.org/license.txt for BSD license.
USING: assocs kernel gap-buffer generic trees trees.avl math sequences quotations ;
IN: gap-buffer.cursortree
TUPLE: cursortree cursors ;
: <cursortree> ( seq -- cursortree )
<gb> cursortree construct-empty tuck set-delegate <avl>
over set-cursortree-cursors ;
GENERIC: cursortree-gb ( cursortree -- gb )
M: cursortree cursortree-gb ( cursortree -- gb ) delegate ;
GENERIC: set-cursortree-gb ( gb cursortree -- )
M: cursortree set-cursortree-gb ( gb cursortree -- ) set-delegate ;
TUPLE: cursor i tree ;
TUPLE: left-cursor ;
TUPLE: right-cursor ;
: cursor-index ( cursor -- i ) cursor-i ; inline
: add-cursor ( cursortree cursor -- ) dup cursor-index rot avl-insert ;
: remove-cursor ( cursortree cursor -- )
cursor-index swap delete-at ;
! dup [ eq? ] curry swap cursor-index rot cursortree-cursors tree-delete-if ;
: set-cursor-index ( index cursor -- )
dup cursor-tree over remove-cursor tuck set-cursor-i
dup cursor-tree cursortree-cursors swap add-cursor ;
GENERIC: cursor-pos ( cursor -- n )
GENERIC: set-cursor-pos ( n cursor -- )
M: left-cursor cursor-pos ( cursor -- n ) [ cursor-i 1+ ] keep cursor-tree index>position ;
M: right-cursor cursor-pos ( cursor -- n ) [ cursor-i ] keep cursor-tree index>position ;
M: left-cursor set-cursor-pos ( n cursor -- ) >r 1- r> [ cursor-tree position>index ] keep set-cursor-index ;
M: right-cursor set-cursor-pos ( n cursor -- ) [ cursor-tree position>index ] keep set-cursor-index ;
: <cursor> ( cursortree -- cursor )
cursor construct-empty tuck set-cursor-tree ;
: make-cursor ( cursortree pos cursor -- cursor )
>r swap <cursor> r> tuck set-delegate tuck set-cursor-pos ;
: <left-cursor> ( cursortree pos -- left-cursor )
left-cursor construct-empty make-cursor ;
: <right-cursor> ( cursortree pos -- right-cursor )
right-cursor construct-empty make-cursor ;
: cursor-positions ( cursortree -- seq )
cursortree-cursors tree-values [ cursor-pos ] map ;
M: cursortree move-gap ( n cursortree -- )
#! Get the position of each cursor before the move, then re-set the
#! position afterwards. This will update any changed cursor indices.
dup cursor-positions >r tuck cursortree-gb move-gap
cursortree-cursors tree-values r> swap [ set-cursor-pos ] 2each ;
: element@< ( cursor -- pos cursortree ) [ cursor-pos 1- ] keep cursor-tree ;
: element@> ( cursor -- pos cursortree ) [ cursor-pos ] keep cursor-tree ;
: at-beginning? ( cursor -- ? ) cursor-pos 0 = ;
: at-end? ( cursor -- ? ) element@> length = ;
: insert ( obj cursor -- ) element@> insert* ;
: element< ( cursor -- elem ) element@< nth ;
: element> ( cursor -- elem ) element@> nth ;
: set-element< ( elem cursor -- ) element@< set-nth ;
: set-element> ( elem cursor -- ) element@> set-nth ;
GENERIC: fix-cursor ( cursortree cursor -- )
M: left-cursor fix-cursor ( cursortree cursor -- )
>r gb-gap-start 1- r> set-cursor-index ;
M: right-cursor fix-cursor ( cursortree cursor -- )
>r gb-gap-end r> set-cursor-index ;
: fix-cursors ( old-gap-end cursortree -- )
tuck cursortree-cursors tree-get-all [ fix-cursor ] curry* each ;
M: cursortree delete* ( pos cursortree -- )
tuck move-gap dup gb-gap-end swap dup (delete*) fix-cursors ;
: delete< ( cursor -- ) element@< delete* ;
: delete> ( cursor -- ) element@> delete* ;

View File

@ -0,0 +1 @@
Collection of 'cursors' representing locations in a gap buffer

View File

@ -0,0 +1,40 @@
USING: kernel sequences tools.test gap-buffer strings math ;
! test copy-elements
[ { 0 3 4 3 4 5 } ] [ { 0 1 2 3 4 5 } dup >r -2 3 5 r> copy-elements ] unit-test
[ { 0 1 2 1 2 5 } ] [ { 0 1 2 3 4 5 } dup >r 2 2 0 r> copy-elements ] unit-test
[ "01234567856" ] [ "01234567890" dup >r 4 6 4 r> copy-elements ] unit-test
! test sequence protocol (like, length, nth, set-nth)
[ "gap buffers are cool" ] [ "gap buffers are cool" <gb> "" like ] unit-test
! test move-gap-back-inside
[ t f ] [ 5 "0123456" <gb> move-gap-forward? >r move-gap-back-inside? 2nip r> ] unit-test
[ "0123456" ] [ "0123456" <gb> 5 over move-gap >string ] unit-test
! test move-gap-forward-inside
[ t ] [ "I once ate a spaniel" <gb> 15 over move-gap 17 swap move-gap-forward-inside? 2nip ] unit-test
[ "I once ate a spaniel" ] [ "I once ate a spaniel" <gb> 15 over move-gap 17 over move-gap >string ] unit-test
! test move-gap-back-around
[ f f ] [ 2 "terriers are ok too" <gb> move-gap-forward? >r move-gap-back-inside? 2nip r> ] unit-test
[ "terriers are ok too" ] [ "terriers are ok too" <gb> 2 over move-gap >string ] unit-test
! test move-gap-forward-around
[ f t ] [ "god is nam's best friend" <gb> 2 over move-gap 22 over position>index swap move-gap-forward? >r move-gap-forward-inside? 2nip r> ] unit-test
[ "god is nam's best friend" ] [ "god is nam's best friend" <gb> 2 over move-gap 22 over move-gap >string ] unit-test
! test changing buffer contents
[ "factory" ] [ "factor" <gb> CHAR: y 6 pick insert* >string ] unit-test
! test inserting multiple elements in different places. buffer should grow
[ "refractory" ] [ "factor" <gb> CHAR: y 6 pick insert* "re" 0 pick insert* CHAR: r 3 pick insert* >string ] unit-test
! test deleting elements. buffer should shrink
[ "for" ] [ "factor" <gb> 3 [ 1 over delete* ] times >string ] unit-test
! more testing of nth and set-nth
[ "raptor" ] [ "factor" <gb> CHAR: p 2 pick set-nth 5 over nth 0 pick set-nth >string ] unit-test
! test stack/queue operations
[ "slaughter" ] [ "laughter" <gb> CHAR: s over push-start >string ] unit-test
[ "pantonio" ] [ "pant" <gb> "onio" over push-end >string ] unit-test
[ CHAR: f "actor" ] [ "factor" <gb> dup pop-start swap >string ] unit-test
[ CHAR: s "pant" ] [ "pants" <gb> dup pop-end swap >string ] unit-test
[ "end this is the " ] [ "this is the end " <gb> 4 over rotate >string ] unit-test
[ "your jedi training is finished " ] [ "finished your jedi training is " <gb> -9 over rotate >string ] unit-test

View File

@ -0,0 +1,271 @@
! Copyright (C) 2007 Alex Chapman All Rights Reserved.
! See http://factorcode.org/license.txt for BSD license.
!
! gap buffer -- largely influenced by Strandh and Villeneuve's Flexichain
! for a good introduction see:
! http://p-cos.net/lisp-ecoop/submissions/StrandhVilleneuveMoore.pdf
USING: kernel arrays sequences sequences.private circular math math.functions generic ;
IN: gap-buffer
! gap-start -- the first element of the gap
! gap-end -- the first element after the gap
! expand-factor -- should be > 1
! min-size -- < 5 is not sensible
TUPLE: gb
gap-start
gap-end
expand-factor
min-size ;
GENERIC: gb-seq ( gb -- seq )
GENERIC: set-gb-seq ( seq gb -- )
M: gb gb-seq ( gb -- seq ) delegate ;
M: gb set-gb-seq ( seq gb -- ) set-delegate ;
: required-space ( n gb -- n )
tuck gb-expand-factor * ceiling >fixnum swap gb-min-size max ;
: <gb> ( seq -- gb )
gb construct-empty
5 over set-gb-min-size
1.5 over set-gb-expand-factor
[ >r length r> set-gb-gap-start ] 2keep
[ swap length over required-space swap set-gb-gap-end ] 2keep
[
over length over required-space rot { } like resize-array <circular> swap set-gb-seq
] keep ;
M: gb like ( seq gb -- seq ) drop <gb> ;
: gap-length ( gb -- n ) [ gb-gap-end ] keep gb-gap-start - ;
: buffer-length ( gb -- n ) gb-seq length ;
M: gb length ( gb -- n ) [ buffer-length ] keep gap-length - ;
: position>index ( pos gb -- i )
2dup gb-gap-start >= [
gap-length +
] [ drop ] if ;
: index>position ( i gb -- pos )
2dup gb-gap-end >= [
gap-length -
] [ drop ] if ;
M: gb virtual@ ( n gb -- n seq ) [ position>index ] keep gb-seq ;
M: gb nth ( n gb -- elt ) bounds-check virtual@ nth-unsafe ;
M: gb nth-unsafe ( n gb -- elt ) virtual@ nth-unsafe ;
M: gb set-nth ( elt n seq -- ) bounds-check virtual@ set-nth-unsafe ;
M: gb set-nth-unsafe ( elt n seq -- ) virtual@ set-nth-unsafe ;
M: gb virtual-seq gb-seq ;
INSTANCE: gb virtual-sequence
! ------------- moving the gap -------------------------------
: (copy-element) ( to start seq -- ) tuck nth -rot set-nth ;
: copy-element ( dst start seq -- ) >r [ + ] keep r> (copy-element) ;
: copy-elements-back ( dst start seq n -- )
dup 0 > [
>r [ copy-element ] 3keep >r 1+ r> r> 1- copy-elements-back
] [ 3drop drop ] if ;
: copy-elements-forward ( dst start seq n -- )
dup 0 > [
>r [ copy-element ] 3keep >r 1- r> r> 1- copy-elements-forward
] [ 3drop drop ] if ;
: copy-elements ( dst start end seq -- )
pick pick > [
>r dupd - r> swap copy-elements-forward
] [
>r over - r> swap copy-elements-back
] if ;
! the gap can be moved either forward or back. Moving the gap 'inside' means
! moving elements across the gap. Moving the gap 'around' means changing the
! start of the circular buffer to avoid moving as many elements.
! We decide which method (inside or around) to pick based on the number of
! elements that will need to be moved. We always try to move as few elements as
! possible.
: move-gap? ( i gb -- i gb ? ) 2dup gb-gap-end = not ;
: move-gap-forward? ( i gb -- i gb ? ) 2dup gb-gap-start >= ;
: move-gap-back-inside? ( i gb -- i gb ? )
#! is it cheaper to move the gap inside than around?
2dup [ gb-gap-start swap 2 * - ] keep [ buffer-length ] keep gb-gap-end - <= ;
: move-gap-forward-inside? ( i gb -- i gb ? )
#! is it cheaper to move the gap inside than around?
2dup [ gb-gap-end >r 2 * r> - ] keep [ gb-gap-start ] keep buffer-length + <= ;
: move-gap-forward-inside ( i gb -- )
[ dup gap-length neg swap gb-gap-end rot ] keep gb-seq copy-elements ;
: move-gap-back-inside ( i gb -- )
[ dup gap-length swap gb-gap-start 1- rot 1- ] keep gb-seq copy-elements ;
: move-gap-forward-around ( i gb -- )
0 over move-gap-back-inside [
dup buffer-length [
swap gap-length - neg swap
] keep
] keep [
gb-seq copy-elements
] keep dup gap-length swap gb-seq change-circular-start ;
: move-gap-back-around ( i gb -- )
dup buffer-length over move-gap-forward-inside [
length swap -1
] keep [
gb-seq copy-elements
] keep dup length swap gb-seq change-circular-start ;
: move-gap-forward ( i gb -- )
move-gap-forward-inside? [
move-gap-forward-inside
] [
move-gap-forward-around
] if ;
: move-gap-back ( i gb -- )
move-gap-back-inside? [
move-gap-back-inside
] [
move-gap-back-around
] if ;
: (move-gap) ( i gb -- )
move-gap? [
move-gap-forward? [
move-gap-forward
] [
move-gap-back
] if
] [ 2drop ] if ;
: fix-gap ( n gb -- )
2dup [ gap-length + ] keep set-gb-gap-end set-gb-gap-start ;
GENERIC: move-gap ( n gb -- )
M: gb move-gap ( n gb -- ) 2dup [ position>index ] keep (move-gap) fix-gap ;
! ------------ resizing -------------------------------------
: enough-room? ( n gb -- ? )
#! is there enough room to add 'n' elements to gb?
tuck length + swap buffer-length <= ;
: set-new-gap-end ( array gb -- )
[ buffer-length swap length swap - ] keep
[ gb-gap-end + ] keep set-gb-gap-end ;
: after-gap ( gb -- gb )
dup gb-seq swap gb-gap-end tail ;
: before-gap ( gb -- gb )
dup gb-gap-start head ;
: copy-after-gap ( array gb -- )
#! copy everything after the gap in 'gb' into the end of 'array',
#! and change 'gb's gap-end to reflect the gap-end in 'array'
dup after-gap >r 2dup set-new-gap-end gb-gap-end swap r> -rot copy ;
: copy-before-gap ( array gb -- )
#! copy everything before the gap in 'gb' into the start of 'array'
before-gap 0 rot copy ; ! gap start doesn't change
: resize-buffer ( gb new-size -- )
f <array> swap 2dup copy-before-gap 2dup copy-after-gap
>r <circular> r> set-gb-seq ;
: decrease-buffer-size ( gb -- )
#! the gap is too big, so resize to something sensible
dup length over required-space resize-buffer ;
: increase-buffer-size ( n gb -- )
#! increase the buffer to fit at least 'n' more elements
tuck length + over required-space resize-buffer ;
: gb-too-big? ( gb -- ? )
dup buffer-length over gb-min-size > [
dup length over buffer-length rot gb-expand-factor sq / <
] [ drop f ] if ;
: ?decrease ( gb -- )
dup gb-too-big? [
decrease-buffer-size
] [ drop ] if ;
: ensure-room ( n gb -- )
#! ensure that ther will be enough room for 'n' more elements
2dup enough-room? [ 2drop ] [
increase-buffer-size
] if ;
! ------- editing operations ---------------
GENERIC# insert* 2 ( seq position gb -- )
: prepare-insert ( seq position gb -- seq gb )
tuck move-gap over length over ensure-room ;
: insert-elements ( seq gb -- )
dup gb-gap-start swap gb-seq copy ;
: increment-gap-start ( gb n -- )
over gb-gap-start + swap set-gb-gap-start ;
! generic dispatch identifies numbers as sequences before numbers...
! M: number insert* ( elem position gb -- ) >r >r 1array r> r> insert* ;
: number-insert ( num position gb -- ) >r >r 1array r> r> insert* ;
M: sequence insert* ( seq position gb -- )
pick number? [
number-insert
] [
prepare-insert [ insert-elements ] 2keep swap length increment-gap-start
] if ;
: (delete*) ( gb -- )
dup gb-gap-end 1+ over set-gb-gap-end ?decrease ;
GENERIC: delete* ( pos gb -- )
M: gb delete* ( position gb -- )
tuck move-gap (delete*) ;
! -------- stack/queue operations -----------
: push-start ( obj gb -- ) 0 swap insert* ;
: push-end ( obj gb -- ) [ length ] keep insert* ;
: pop-elem ( position gb -- elem ) [ nth ] 2keep delete* ;
: pop-start ( gb -- elem ) 0 swap pop-elem ;
: pop-end ( gb -- elem ) [ length 1- ] keep pop-elem ;
: rotate ( n gb -- )
dup length 1 > [
swap dup 0 > [
[ dup [ pop-end ] keep push-start ]
] [
neg [ dup [ pop-start ] keep push-end ]
] if times drop
] [ 2drop ] if ;

View File

@ -0,0 +1 @@
Gap buffer data structure

View File

@ -0,0 +1 @@
collections sequences