"

 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.

"

"{ Package: 'stx:libwidg' }"

"{ NameSpace: Smalltalk }"

TextView subclass:#EditTextView

	instanceVariableNames:'cursorLine cursorVisibleLine cursorCol cursorShown

		prevCursorState readOnly modifiedChannel fixedSize exceptionBlock

		cursorFgColor cursorBgColor cursorNoFocusFgColor cursorType

		cursorTypeNoFocus typeOfSelection lastAction replacing

		showMatchingParenthesis hasKeyboardFocus acceptAction lockUpdates

		tabMeansNextField autoIndent insertMode editMode trimBlankLines

		wordWrap replacementWordSelectStyle acceptChannel acceptEnabled

		st80Mode disableIfInvisible cursorMovementWhenUpdating learnMode

		learnedMacro cursorLineHolder cursorColHolder tabRequiresControl

		undoSupport lastStringFromReplaceForNextSearch

		lastReplacementInfo completionSupport codeAspectHolder'

	classVariableNames:'DefaultCursorForegroundColor DefaultCursorBackgroundColor

		DefaultCursorType DefaultCursorNoFocusForegroundColor

		DefaultCursorTypeNoFocus LastColumnNumberForSort Macros'

	poolDictionaries:''

	category:'Views-Text'

!

Object subclass:#EditAction

	instanceVariableNames:'userFriendlyInfo'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditAction subclass:#DeleteRange

	instanceVariableNames:'line1 col1 line2 col2'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditAction subclass:#DeleteCharacters

	instanceVariableNames:'line col1 col2'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

Object subclass:#EditMode

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditMode subclass:#InsertAndSelectMode

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView::EditMode

!

EditTextView::EditMode subclass:#InsertMode

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView::EditMode

!

EditTextView::EditMode subclass:#OverwriteMode

	instanceVariableNames:''

	classVariableNames:'InsertMode OverwriteMode InsertAndSelectMode'

	poolDictionaries:''

	privateIn:EditTextView::EditMode

!

Query subclass:#ExecutingMacroQuery

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

Object subclass:#LastReplacementInfo

	instanceVariableNames:'lastReplacement lastStringToReplace lastReplaceWasMatch

		lastReplaceIgnoredCase stillCollectingInput previousReplacements'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditAction subclass:#PasteString

	instanceVariableNames:'line col string selected'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditAction subclass:#ReplaceCharacter

	instanceVariableNames:'line col character'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditAction subclass:#ReplaceCharacters

	instanceVariableNames:'line col1 col2 characters'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditAction subclass:#ReplaceContents

	instanceVariableNames:'text'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditAction subclass:#ReplaceLine

	instanceVariableNames:'line text'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditAction subclass:#ReplaceLines

	instanceVariableNames:'line text'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

EditTextView::EditAction subclass:#RestoreSelectionAndCursor

	instanceVariableNames:'cursorLine cursorCol selectionStartLine selectionStartCol

		selectionEndLine selectionEndCol'

	classVariableNames:''

	poolDictionaries:''

	privateIn:EditTextView

!

!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 both changeMsg and acceptAction)

    Please read the historic notice in the ListView class.

    [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

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

        modifiedChannel         <ValueHolder>   holding true, if text has been modified.

                                                cleared on accept.

        acceptChannel           <ValueHolder>   holding true, if text has been accepted.

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

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

                                                if it returns true, the modification will be done anyway.

                                                if it returns anything else, the modification is not done.

        cursorFgColor           <Color>         color used for cursor drawing

        cursorBgColor           <Color>         color used for cursor drawing

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

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

                                                (vertical bar at insertion point)

                                                and #caret (caret below insertion-point).

                                                see cursorType: for an up-to-date list.

        cursorTypeNoFocus       <Symbol>        like above, if view has no focus

                                                nil means: hide the cursor.

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

                                                (not yet fully implemented)

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

                                                this affects the next keyPress: if #paste it does not

                                                replace; otherwise it replaces the selection.

        lastCut                 <String>        last cut or replaced string

        lastReplacementInfo     <LastReplacementInfo>        holds the information about the last replace action

                                                             lastStringToReplace is the string to be replaced by lastReplacement

                                                             lastReplacement is the string to replace lastStringToReplace

        lastStringFromReplaceForNextSearch   <String>        string to be taken be the next search action 

                                                             (cleared after a new selection)

        replacing               <Boolean>       true if entered characters replace last selection

        showMatchingParenthesis <Boolean>       if true, shows matching parenthesis

                                                when entering one; this is the default.

        hasKeyboardFocus        <Boolean>       true if this view has the focus

        acceptAction            <Block>         accept action - evaluated passing the contents as

                                                argument

        tabMeansNextField       <Boolean>       if true, Tab is ignored as input and shifts keyboard

                                                focus to the next field. For editTextViews, this is false

                                                by default (i.e. tabs can be entered into the text).

                                                For some subclasses (inputFields), this may be true.

        trimBlankLines          <Boolean>       if true, trailing blanks are

                                                removed when editing.

                                                Also, empty lines are represented as nil in the lines collection.

                                                Default is true.

        wordWrap                <Boolean>       Currently not used.

        lockUpdates             <Boolean>       internal, private

        prevCursorState         <Boolean>       temporary, private

        cursorMovementWhenUpdating

                                <Symbol>        defines where the cursor is to be positioned if the

                                                model changes its value by some outside activity

                                                (i.e. not by user input into the field).

                                                Can be one of:

                                                    #keep / nil     -> stay where it was

                                                    #endOfText      -> cursor to the end

                                                    #endOfLine      -> stay in the line, but move to end

                                                    #beginOfText    -> cursor to the beginning

                                                    #beginOfLine    -> stay in the line, but move to begin

                                                The default is #beginOfText

        dropTarget              <DropTarget|nil> drop operation descriptor or nil (drop disabled)

    userPreference values:

        userPreferences.st80EditMode

                                <Boolean>       if true, cursor positioning is

                                                done as in vi or ST80; i.e.

                                                wysiwyg mode is somewhat relaxed,

                                                in that the cursor cannot be

                                                positioned behind a lines end.

                                                This is not yet completely implemented.

    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

        textCursorNoFocusForegroundColor

                                  <Color>          cursor fg color if no focus; default: cursor fg color

        textCursorType            <Symbol>         cursor type; default:  #block

    [author:]

        Claus Gittinger

    [see also:]

        CodeView Workspace TextView ListView

        EditField

"

!

examples

"

  non MVC operation:

    basic setup:

                                                                        [exBegin]

        |top textView|

        top := StandardSystemView new.

        top extent:300@200.

        textView := EditTextView new.

        textView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

        top addSubView:textView.

        textView contents:('/etc/hosts' asFilename contentsOfEntireFile).

        top open.

                                                                        [exEnd]

    with vertical scrollbar:

                                                                        [exBegin]

        |top scrollView textView|

        top := StandardSystemView new.

        top extent:300@200.

        scrollView := ScrollableView for:EditTextView.

        textView := scrollView scrolledView.

        scrollView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

        top addSubView:scrollView.

        textView contents:('/etc/hosts' asFilename contentsOfEntireFile).

        top open.

                                                                        [exEnd]

    with horizontal & vertical scrollbars:

                                                                        [exBegin]

        |top scrollView textView|

        top := StandardSystemView new.

        top extent:300@200.

        scrollView := HVScrollableView for:EditTextView.

        textView := scrollView scrolledView.

        scrollView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

        top addSubView:scrollView.

        textView contents:('/etc/hosts' asFilename contentsOfEntireFile).

        top open.

                                                                        [exEnd]

    set the action for accept:

                                                                        [exBegin]

        |top textView|

        top := StandardSystemView new.

        top extent:300@200.

        textView := EditTextView new.

        textView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

        top addSubView:textView.

        textView contents:('/etc/hosts' asFilename contentsOfEntireFile).

        textView acceptAction:[:contents |

                                Transcript showCR:'will not overwrite the file with:'.

                                Transcript showCR:contents asString

                              ].

        top open.

                                                                        [exEnd]

    non-string (text) items:

                                                                        [exBegin]

        |top textView list|

        list := '/etc/hosts' asFilename contentsOfEntireFile asStringCollection.

        1 to:list size by:2 do:[:nr |

            list at:nr put:(Text string:(list at:nr)

                                 emphasis:(Array with:#bold with:(#color->Color red)))

        ].

        top := StandardSystemView new.

        top extent:300@200.

        textView := EditTextView new.

        textView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

        top addSubView:textView.

        textView contents:list.

        top open.

                                                                        [exEnd]

  MVC operation:

    (the examples model here is a plug simulating a real model;

     real world applications would not use a plug ..)

                                                                        [exBegin]

        |top textView model|

        model := Plug new.

        model respondTo:#accepted:

                   with:[:newContents |

                                Transcript showCR:'will not overwrite the file with:'.

                                Transcript showCR:newContents asString

                        ].

        model respondTo:#getList

                   with:['/etc/hosts' asFilename contentsOfEntireFile].

        top := StandardSystemView new.

        top extent:300@200.

        textView := EditTextView new.

        textView origin:0.0 @ 0.0 corner:1.0 @ 1.0.

        top addSubView:textView.

        textView listMessage:#getList;

                 model:model;

                 changeMessage:#accepted:;

                 aspect:#list.

        top open.

                                                                        [exEnd]

    two textViews on the same model:

                                                                        [exBegin]

        |top1 textView1 top2 textView2 model currentContents|

        model := Plug new.

        model respondTo:#accepted:

                   with:[:newContents |

                                Transcript showCR:'accepted:'.

                                Transcript showCR:newContents asString.

                                currentContents := newContents.

                                model changed:#contents

                        ].

        model respondTo:#getList

                   with:[Transcript showCR:'query'.

                         currentContents].

        top1 := StandardSystemView new.

        top1 extent:300@200.

        textView1 := EditTextView new.

        textView1 origin:0.0 @ 0.0 corner:1.0 @ 1.0.

        top1 addSubView:textView1.

        textView1 listMessage:#getList;

                  model:model;

                  aspect:#contents;

                  changeMessage:#accepted:.

        top1 open.

        top2 := StandardSystemView new.

        top2 extent:300@200.

        textView2 := EditTextView new.

        textView2 origin:0.0 @ 0.0 corner:1.0 @ 1.0.

        top2 addSubView:textView2.

        textView2 listMessage:#getList;

                  model:model;

                  aspect:#contents;

                  changeMessage:#accepted:.

        top2 open.

                                                                        [exEnd]

"

!

selection_and_cursor_movement

"

Changes done to implement 'standard' behaviour (that's how vast majority of widgets used in todays desktops behaves)

as opposed to 'traditional' which is what how it was in St/X 'ever since'

* Numerous off-by-one bugs

* Extending selection by dragging:

  Scenario:

    1. Select & drag to expand beggining of the selection (i.e., drag from 'end' to 'beggining'

    2. Stop dragging

    3. Press Shift-Left / Shift-Right (to refine selection)