"

 COPYRIGHT (c) 1989 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

TextView subclass:#EditTextView

	instanceVariableNames:'cursorLine cursorVisibleLine cursorCol cursorShown

		prevCursorState readOnly modified fixedSize exceptionBlock

		errorMessage cursorFgColor cursorBgColor cursorType undoAction

		typeOfSelection lastString lastReplacement lastAction replacing

		showMatchingParenthesis hasKeyboardFocus acceptAction lockUpdates'

	classVariableNames:'DefaultCursorForegroundColor DefaultCursorBackgroundColor

		DefaultCursorType'

	poolDictionaries:''

	category:'Views-Text'

!

!EditTextView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    a view for editable text - adds editing functionality to TextView

    Also, it adds accept functionality, and defines a new actionBlock: 

      acceptAction to be performed for accept

    If used with a model, this is informed by sending it a changeMsg with

    the current contents as argument.

    (however, it is possible to define moth changeMsg and acceptAction)

    Instance variables:

      cursorLine              <Number>        line where cursor sits (1..)

      cursorVisibleLine       <Number>        visible line where cursor sits (1..nLinesShown)

      cursorCol               <Number>        col where cursor sits (1..)

      cursorShown             <Boolean>       true, if cursor is currently shown

      prevCursorState         <Boolean>       temporary

      readOnly                <Boolean>       true, if text may not be edited

      modified                <Boolean>       true, if text has been modified

      fixedSize               <Boolean>       true, if no lines may be added/removed

      exceptionBlock          <Block>         block to be evaluated when readonly text is about to be modified

      errorMessage            <String>        message text 

      cursorFgColor           <Color>         color used for cursor drawing

      cursorBgColor           <Color>         color used for cursor drawing

      cursorType              <Symbol>        how the cursor is drawn; currently implemented

					      are #block (solid-block cursor), #ibeam

					      (vertical bar at insertion point) 

					      and #caret (caret below insertion-point)

      undoAction              <Block>         block which undoes last cut, paste or replace

      typeOfSelection         <Symbol>        #paste, if selection created by paste, nil otherwise

      lastCut                 <String>        last cut or replaced string

      lastReplacement         <String>        last replacement

      replacing               <Boolean>       true if entered characters replace last selection

      showMatchingParenthesis <Boolean>       if true, shows matching parenthesis

					      when entering one

    used globals:

      DeleteHistory           <Text>          last 1000 lines of deleted text

					      (but only if this variable exists already)

    styleSheet parameters:

      textCursorForegroundColor <Color>       cursor fg color; default: text background

      textCursorBackgroundColor <Color>       cursor bg color; default: text foreground

      textCursorType            <Symbol>      cursor type; default:  #block

"

! !

!EditTextView class methodsFor:'defaults'!

updateStyleCache

    DefaultCursorForegroundColor := StyleSheet colorAt:'textCursorForegroundColor'.

    DefaultCursorBackgroundColor := StyleSheet colorAt:'textCursorBackgroundColor'.

    DefaultCursorType := StyleSheet at:'textCursorType' default:#block.

! !

!EditTextView methodsFor:'ST-80 compatibility editing'!

insertAndSelect:aString at:aCharacterPosition

    "insert a selected string at aCharacterPosition."

    |line col|

    line := self lineOfCharacterPosition:aCharacterPosition.

    col := aCharacterPosition - (self characterPositionOfLine:line col:1) + 1.

    self insertString:aString atLine:line col:col.

    self selectFromLine:line col:col toLine:line col:col + aString size - 1

    "

     |v|

     v := EditTextView new openAndWait.

     v contents:'1234567890\1234567890\1234567890\' withCRs.

     v insertAndSelect:'<- hello there' at:5.

    "

! !

!EditTextView methodsFor:'accessing-behavior'!

acceptAction

    "return the action to be performed on accept (or nil)"

    ^ acceptAction

!

acceptAction:aBlock

    "set the action to be performed on accept"

    acceptAction := aBlock

!

exceptionBlock:aBlock

    "define the action to be triggered when user tries to modify

     readonly text"

    exceptionBlock := aBlock

! !

!EditTextView methodsFor:'accessing-contents'!

characterUnderCursor

    "return the character under the cursor - space if behond line.

     For non-block cursors, this is the character immediately to the right

     of the insertion-bar or caret."

    ^ self characterAtLine:cursorLine col:cursorCol

!

contents

    "return the contents as a String"

    list isNil ifTrue:[^ ''].

    self removeTrailingBlankLines.

    ^ list asStringWithCRs

!

cursorCol

    "return the cursors col (1..).

     This is the absolute col; NOT the visible col"

    ^ cursorCol

!

cursorForegroundColor:color1 backgroundColor:color2

    "set both cursor foreground and cursor background colors"

    |wasOn|

    wasOn := self hideCursor.

    cursorFgColor := color1 on:device.

    cursorBgColor := color2 on:device.

    wasOn ifTrue:[self showCursor]

!

cursorLine

    "return the cursors line (1..). 

     This is the absolute line; NOT the visible line"

    ^ cursorLine

!

fixedSize

    "make the texts size fixed (no lines may be added).

     OBSOLETE: use readOnly"

    readOnly ifFalse:[

	readOnly := true.

	middleButtonMenu notNil ifTrue:[

	    middleButtonMenu disableAll:#(cut paste replace indent)

	]

    ]

!

fromFile:aFileName

    "take contents from a named file"

    self contents:(aFileName asFilename readStream contents)

!

list:something

    "position cursor home when setting contents"

    super list:something.

    self cursorHome

!

modified

    "return true if text was modified"

    ^ modified

!

modified:aBoolean

    "set the modified flag"

    modified := aBoolean

!

readOnly

    "make the text readonly"

    readOnly := true

! !

!EditTextView methodsFor:'change & update '!

accept

    "accept the current contents by executing the accept-action and/or

     changeMessage."

    lockUpdates := true.

     "/

     "/ ST/X way of doing things

     "/ as a historic (and temporary) leftover,

     "/ the block is called with a stringCollection

     "/ - not with the actual string

     "/

     acceptAction notNil ifTrue:[

	 acceptAction value:self list

     ].

     "/

     "/ ST-80 way of doing it

     "/

     self sendChangeMessageWith:self argForChangeMessage.

    lockUpdates := false.

!

argForChangeMessage

    ^ self contents

!

getListFromModel

    "get my contents from the model.

     Redefined to ignore updates resulting from my own change."

    "

     ignore updates from my own change

    "

    lockUpdates ifTrue:[

	lockUpdates := false.

	^ self

    ].

    ^ super getListFromModel

! !

!EditTextView methodsFor:'cursor handling'!

cursorBacktab

    "move cursor to prev tabstop"

    self cursorCol:(self prevTabBefore:cursorCol).

!

cursorCol:newCol

    "move cursor to some column in the current line"

    |wasOn|

    wasOn := self hideCursor.

    cursorCol := newCol.

    self makeCursorVisibleAndShowCursor:wasOn.

!

cursorDown

    "move cursor down; scroll if at end of visible text"

    self cursorDown:1

!

cursorDown:n

    "move cursor down by n lines; scroll if at end of visible text"

    |wasOn nv|

    cursorVisibleLine notNil ifTrue:[

	wasOn := self hideCursor.

	nv := cursorVisibleLine + n - 1.

	(nv >= nFullLinesShown) ifTrue:[

	    self scrollDown:(nv - nFullLinesShown + 1)

	].

	cursorLine := cursorLine + n.

	cursorVisibleLine := self listLineToVisibleLine:cursorLine.

	wasOn ifTrue:[self showCursor].

    ] ifFalse:[

	cursorLine isNil ifTrue:[

	    cursorLine := firstLineShown

	].

	cursorLine := cursorLine + n.

	cursorVisibleLine := self listLineToVisibleLine:cursorLine.

	self makeCursorVisible.

    ].

!

cursorHome

    "Otherwise, scroll to top AND move cursor to first line of text."

    |wasOn|

    wasOn := self hideCursor.

    cursorCol := 1.

    self scrollToTop.

    cursorLine := cursorVisibleLine := 1.

    self makeCursorVisibleAndShowCursor:wasOn.

!

cursorLeft

    "move cursor to left"

    (cursorCol ~~ 1) ifTrue: [

	self cursorCol:(cursorCol - 1)

    ].

!

cursorLine:line col:col

    "this positions onto physical - not visible - line"

    |wasOn|

    wasOn := self hideCursor.

    cursorLine := line.

    cursorVisibleLine := self listLineToVisibleLine:line.

    cursorCol := col.

    (cursorCol < 1) ifTrue:[

	cursorCol := 1

    ].

    self makeCursorVisibleAndShowCursor:wasOn.

!

cursorReturn

    "move cursor to start of next line; scroll if at end of visible text"

    |wasOn|

    self checkForExistingLine:(cursorLine + 1).

    cursorVisibleLine notNil ifTrue:[

	nFullLinesShown notNil ifTrue:[

	    (cursorVisibleLine >= nFullLinesShown) ifTrue:[self scrollDown]

	]

    ].

    wasOn := self hideCursor.

    cursorCol := 1.

    cursorLine := cursorLine + 1.

    cursorVisibleLine := self listLineToVisibleLine:cursorLine.

    self makeCursorVisibleAndShowCursor:wasOn.

!

cursorRight

    "move cursor to right"

    self cursorCol:(cursorCol + 1)

!

cursorTab

    "move cursor to next tabstop"

    self cursorCol:(self nextTabAfter:cursorCol).

!

cursorToBeginOfLine

    "move cursor to start of current line"

    self cursorCol:1

!

cursorToBottom

    "move cursor to last line of text"

    |wasOn newTop|

    wasOn := self hideCursor.

    newTop := list size - nFullLinesShown.

    (newTop < 1) ifTrue:[

	newTop := 1

    ].

    self scrollToLine:newTop.

    cursorCol := 1.

    cursorLine := list size.

    cursorVisibleLine := self listLineToVisibleLine:cursorLine.

    self makeCursorVisibleAndShowCursor:wasOn.

!

cursorToEnd

    "move cursor down below last line of text"

    |wasOn newTop l line|

    l := list size.

    cursorLine >= l ifTrue:[

	line := self listAt:cursorLine.

	(line isNil or:[line isEmpty]) ifTrue:[

	    ^ self

	]

    ].

    wasOn := self hideCursor.

    l := l + 1.

    newTop :=  l - nFullLinesShown.

    (newTop < 1) ifTrue:[

	newTop := 1

    ].

    self scrollToLine:newTop.

    cursorCol := 1.

    cursorLine := l.

    cursorVisibleLine := self listLineToVisibleLine:cursorLine.

    self makeCursorVisibleAndShowCursor:wasOn.

!

cursorToEndOfLine

    "move cursor to end of current line"

    |line newCol|

    list isNil ifTrue:[

	newCol := 1

    ] ifFalse:[

	line := list at:cursorLine.

	newCol := line size + 1

    ].

    self cursorCol:newCol

!

cursorToFirstVisibleLine

    "place cursor into the first visible line; do not scroll."

    self cursorLine:(self visibleLineToAbsoluteLine:1) col:1

!

cursorToLastVisibleLine

    "place cursor into the first visible line; do not scroll."

    self cursorLine:(self visibleLineToAbsoluteLine:nFullLinesShown) col:1

!

cursorToNextWord

    "move the cursor to the beginning of the next word"

    |col line searching|

    (cursorLine > list size) ifTrue:[^ self].

    self wordAtLine:cursorLine col:cursorCol do:[

	:beginLine :beginCol :endLine :endCol :style | 

	line := endLine.

	col := endCol + 1.

	searching := true.

	[searching 

	 and:[(self characterAtLine:line col:col) isSeparator]] whileTrue:[

	    self wordAtLine:line col:col do:[

		:beginLine :beginCol :endLine :endCol :style |

		(line > list size) ifTrue:[

		    "break out"

		    searching := false

		] ifFalse:[

		    line := endLine.

		    col := endCol + 1.

		]

	    ]

	].

	self cursorLine:line col:col

    ]

!

cursorToTop