"

 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.

"

ListView subclass:#TextView

	instanceVariableNames:'selectionStartLine selectionStartCol selectionEndLine

		selectionEndCol clickStartLine clickStartCol clickLine clickCol

		clickCount expandingTop wordStartCol wordStartLine wordEndCol

		wordEndLine selectionFgColor selectionBgColor selectStyle

		directoryForFileDialog defaultFileNameForFileDialog

		contentsWasSaved'

	classVariableNames:'DefaultViewBackground DefaultSelectionForegroundColor

		DefaultSelectionBackgroundColor MatchDelayTime

		WordSelectCatchesBlanks'

	poolDictionaries:''

	category:'Views-Text'

!

!TextView 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 readOnly text - this class adds selections to a simple list.

    The text is not editable and there is no cursor.

    Use TextViews for readonly text, EditTextView for editable text.

    Please read the historic notice in the ListView class.

    [Instance variables:]

      selectionStartLine      <Number>                the line of the selection start (or nil)

      selectionStartCol       <Number>                the col of the selection start

      selectionEndLine        <Number>                the line of the selection end

      selectionEndCol         <Number>                the col of the selection end

      clickStartLine          <Number>                temporary - remember where select operation started

      clickStartCol           <Number>                temporary

      clickLine               <Number>                temporary

      clickCol                <Number>                temporary

      clickCount              <Number>                temporary

      expandingTop            <Boolean>               temporary - for expandSelection

      selectionFgColor        <Color>                 color used to draw selections

      selectionBgColor        <Color>                 color used to draw selections

      selectStyle             <Symbol>                how words are selected

      directoryForFileDialog  <nil|pathName>          directory where save dialog should start

      contentsWasSaved        <Boolean>               set to true, whenever saved in a file

    [StyleSheet parameters:]

      textViewBackground                 defaults to viewBackground

      textSelectionForegroundColor       defaults to textBackgroundColor

      textSelectionBackgroundColor       defaults to textForegroundColor

      textViewFont                       defaults to textFont

    [author:]

        Claus Gittinger

    [see also:]

        EditTextView CodeView Workspace

"

!

examples

"

    although textViews (and instances of subclasses) are mostly used

    as components (in the fileBrowser, the browser, the launcher etc.),

    they may also be opened as a textEditor;

    open a (readonly) textView on some information text:

                                                        [exBegin]

        TextView 

            openWith:'read this' 

            title:'demonstration'

                                                        [exEnd]

    the same, but open it modal:

                                                        [exBegin]

        TextView 

            openModalWith:'read this first' 

            title:'demonstration'

                                                        [exEnd]

    open it modal (but editable) on some text:

    (must accept before closing)

    This is somewhat kludgy - when closed, the view has already

    nilled its link to the model. Therefore, the accept must be

    done 'manually' below.

    However, usually an applicationModel is installed as the

    editor-topViews application. This would get a closeRequest,

    where it could handle things.

                                                        [exBegin]

        |m textView|

        m := 'read this first' asValue.

        textView := EditTextView openModalOnModel:m.

        textView modified ifTrue:[

            (self confirm:'text was not accepted - do it now ?')

            ifTrue:[

                m value:textView contents

            ]

        ].

        Transcript showCR:m value.

                                                        [exEnd]

    open a textEditor on some file:

                                                        [exBegin]

        EditTextView openOn:'Makefile'

                                                        [exEnd]

"

! !

!TextView class methodsFor:'instance creation'!

on:aModel aspect:aspect change:change menu:menu initialSelection:initial

    "for ST-80 compatibility"

    ^ (self new) 

	on:aModel 

	aspect:aspect

	list:aspect

	change:change 

	menu:menu

	initialSelection:initial

! !

!TextView class methodsFor:'defaults'!

defaultIcon

    "return the icon if started as a topView"

    ^ Image fromFile:'bitmaps/Editor.xbm' resolution:100

    "Created: 1.1.1970 / 14:12:18 / cg"

!

defaultMenuMessage

    "This message is the default yo be sent to the menuHolder to get a menu"

    ^ #editMenu

    "Created: 3.1.1997 / 01:52:21 / stefan"

!

updateStyleCache

    "extract values from the styleSheet and cache them in class variables"

    <resource: #style (#textViewBackground

                       #textSelectionForegroundColor #textSelectionBackgroundColor

                       #textViewFont #textWordSelectCatchesBlanks)>

    DefaultViewBackground := StyleSheet colorAt:'textViewBackground' default:White.

    DefaultSelectionForegroundColor := StyleSheet colorAt:'textSelectionForegroundColor'.

    DefaultSelectionBackgroundColor := StyleSheet colorAt:'textSelectionBackgroundColor'.

    DefaultFont := StyleSheet fontAt:'textViewFont'.

    MatchDelayTime := 0.6.

    WordSelectCatchesBlanks := StyleSheet at:'textWordSelectCatchesBlanks' default:false.

    "Modified: 18.3.1996 / 17:32:07 / cg"

! !

!TextView class methodsFor:'startup'!

open

    "start an empty TextView"

    ^ self openWith:nil

!

openModalOnModel:aModel

    "start a textView on a model; return the textView"

    |textView|

    textView := self setupForModel:aModel.

    textView topView openModal.

    ^ textView

    "Created: 14.2.1997 / 15:24:12 / cg"

!

openModalWith:aString

    "start a textView with aString as initial contents"

    ^ self openModalWith:aString title:nil 

    "

     TextView openModalWith:'some text'

     EditTextView openModalWith:'some text'

    "

    "Created: 14.2.1997 / 15:19:04 / cg"

!

openModalWith:aString title:aTitle

    "start a textView with aString as initial contents. Return the textView."

    |textView|

    textView := self setupWith:aString title:aTitle.

    textView topView openModal.

    ^ textView

    "

     TextView openModalWith:'some text' title:'testing'

     EditTextView openModalWith:'some text' title:'testing'

    "

    "Modified: 9.9.1996 / 19:32:29 / cg"

    "Created: 14.2.1997 / 15:19:18 / cg"

!

openOn:aFileName

    "start a textView on a file; return the textView"

    |textView|

    textView := self setupForFile:aFileName.

    textView topView open.

    ^ textView

    "

     TextView openOn:'../../doc/overview.doc'

     EditTextView openOn:'../../doc/overview.doc'

    "

    "Modified: 14.2.1997 / 15:21:51 / cg"

!

openOnModel:aModel

    "start a textView on a model; return the textView"

    |textView|

    textView := self setupForModel:aModel.

    textView topView open.

    ^ textView

    "Created: 14.2.1997 / 15:23:36 / cg"

!

openWith:aString

    "start a textView with aString as initial contents"

    ^ self openWith:aString title:nil 

    "

     TextView openWith:'some text'

     EditTextView openWith:'some text'

    "

    "Created: 10.12.1995 / 17:41:32 / cg"

!

openWith:aString title:aTitle

    "start a textView with aString as initial contents. Return the textView."

    |textView|

    textView := self setupWith:aString title:aTitle.

    textView topView open.

    ^ textView

    "

     TextView openWith:'some text' title:'testing'

     EditTextView openWith:'some text' title:'testing'

    "

    "Created: 10.12.1995 / 17:40:02 / cg"

    "Modified: 9.9.1996 / 19:32:29 / cg"

!

setupEmpty

    "create a textview in a topview, with horizontal and

     vertical scrollbars - a helper for #startWith: and #startOn:"

    |top frame label|

    label := 'unnamed'.

    top := StandardSystemView label:label icon:self defaultIcon.

    frame := HVScrollableView 

                for:self 

                miniScrollerH:true miniScrollerV:false

                in:top.

    frame origin:(0.0 @ 0.0) corner:(1.0 @ 1.0).

    ^ frame scrolledView

    "Modified: 23.5.1965 / 14:12:32 / cg"

!

setupForFile:aFileName

    "setup a textView on a file; return the textView"

    |top textView stream|

    textView := self setupEmpty.

    top := textView topView.

    aFileName notNil ifTrue:[

        top label:(OperatingSystem baseNameOf:aFileName).

        stream := aFileName asFilename readStream.

        stream notNil ifTrue:[

            textView contents:(stream contents)

        ]

    ].

    ^ textView

    "Created: 14.2.1997 / 15:21:43 / cg"

!

setupForModel:aModel

    "setup a textView on a model; return the textView"

    |top textView|

    textView := self setupEmpty.

    textView model:aModel.

    top := textView topView.

    ^ textView

    "Created: 14.2.1997 / 15:22:42 / cg"

!

setupWith:aString title:aTitle

    "setup a textView with aString as initial contents in a topView"

    |top textView|

    textView := self setupEmpty.

    top := textView topView.

    aTitle notNil ifTrue:[top label:aTitle].

    aString notNil ifTrue:[

        textView contents:aString

    ].

    ^ textView

    "Created: 9.9.1996 / 19:31:22 / cg"

! !

!TextView methodsFor:'accessing'!

characterPositionOfSelection

    "return the character index of the first character in the selection"

    selectionStartLine isNil ifTrue:[^ 1].

    ^ self characterPositionOfLine:selectionStartLine

			       col:selectionStartCol

!

contentsWasSaved

    "return true, if the contents was saved (by a save action),

     false if not (or was modified again after the last save)."

    ^ contentsWasSaved

!

defaultFileNameForFileDialog:aBaseName

    "define the default fileName to use for the save-box"

    defaultFileNameForFileDialog := aBaseName

    "Created: 13.2.1997 / 18:29:53 / cg"

!

directoryForFileDialog:aDirectory

    "define the default directory to use for save-box"

    directoryForFileDialog := aDirectory

    "Modified: 13.2.1997 / 18:30:01 / cg"

! !

!TextView methodsFor:'accessing-contents'!

fromFile:aFileName

    "take contents from a named file"

    self directoryForFileDialog:(OperatingSystem directoryNameOf:aFileName).

    self contents:(FileStream oldFileNamed:aFileName) contents

!

list:something

    "set the displayed contents (a collection of strings)

     with redraw.

     Redefined since changing the contents implies deselect"

    self unselect.

    super list:something

    "Modified: 29.4.1996 / 12:13:24 / cg"

!

setList:something

    "set the displayed contents (a collection of strings)

     without redraw.

     Redefined since changing contents implies deselect"

    self unselect.

    super setList:something

!

wordAtLine:selectLine col:selectCol do:aFiveArgBlock

    "find word boundaries, evaluate the block argument with those.

     A helper for nextWord and selectWord functions."

    |beginCol endCol endLine thisCharacter flag|

    flag := #word.

    beginCol := selectCol.

    endCol := selectCol.

    endLine := selectLine.

    thisCharacter := self characterAtLine:selectLine col:beginCol.

    beginCol := self findBeginOfWordAtLine:selectLine col:selectCol.

    endCol := self findEndOfWordAtLine:selectLine col:selectCol.

    endCol == 0 ifTrue:[

        endLine := selectLine + 1

    ].

    "is the initial acharacter within a word ?"

    (wordCheck value:thisCharacter) ifTrue:[

        "

         try to catch a blank ...

        "

        WordSelectCatchesBlanks ifTrue:[

            ((beginCol == 1)

            or:[(self characterAtLine:selectLine col:(beginCol - 1))

                 ~~ Character space]) ifTrue:[

                ((self characterAtLine:selectLine col:(endCol + 1))

                  == Character space) ifTrue:[

                    endCol := endCol + 1.

                    flag := #wordRight

                ]

            ] ifFalse:[

                beginCol := beginCol - 1.

                flag := #wordLeft

            ].

        ].

    ].

    aFiveArgBlock value:selectLine 

                  value:beginCol 

                  value:endLine 

                  value:endCol

                  value:flag

    "Modified: 18.3.1996 / 17:31:04 / cg"

! !

!TextView methodsFor:'accessing-look'!

selectionForegroundColor:color1 backgroundColor:color2

    "set both the selection-foreground and cursor background colors.

     The default is defined by the styleSheet; 

     typically black-on-green for color displays and white-on-black for b&w displays."