"

 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

			      wordStartCol wordStartLine wordEndCol wordEndLine

			      selectionFgColor selectionBgColor

			      fileBox searchBox lineNumberBox

			      selectStyle 

			      directoryForFileDialog

			      contentsWasSaved'

       classVariableNames:'DefaultFont

			   DefaultViewBackground

			   DefaultSelectionForegroundColor

			   DefaultSelectionBackgroundColor

			   MatchDelayTime'

       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.

"

!

version

    ^ '$Header: /cvs/stx/stx/libwidg/TextView.st,v 1.29 1995-11-24 12:56:21 cg Exp $'

!

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.

    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

      clickStartCol           <Number>                temporary

      clickLine               <Number>                temporary

      clickCol                <Number>                temporary

      clickCount              <Number>                temporary

      selectionFgColor        <Color>                 color used to draw selections

      selectionBgColor        <Color>                 color used to draw selections

      fileBox                 <FileSelectionBox>      box for save

      searchBox               <EnterBox2>             box to enter searchpattern

      lineNumberBox           <EnterBox>              box to enter linenumber

      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

"

! !

!TextView class methodsFor:'startup'!

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:(Form fromFile:'Editor.xbm' resolution:100).

    frame := HVScrollableView 

		for:self 

		miniScrollerH:true miniScrollerV:false

		in:top.

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

    ^ frame scrolledView

!

open

    "start an empty TextView"

    ^ self openWith:nil

!

openWith:aString

    "start a textView with aString as initial contents"

    |top textView|

    textView := self setupEmpty.

    top := textView topView.

    aString notNil ifTrue:[

	textView contents:aString

    ].

    top open.

    ^ textView

    "

     TextView openWith:'some text'

     EditTextView openWith:'some text'

    "

!

openOn:aFileName

    "start a textView on a file"

    |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)

	]

    ].

    top open.

    ^ textView

    "

     TextView openOn:'../doc/info.doc'

     EditTextView openOn:'../doc/info.doc'

    "

! !

!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'!

updateStyleCache

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

    DefaultSelectionForegroundColor := StyleSheet colorAt:'textSelectionForegroundColor'.

    DefaultSelectionBackgroundColor := StyleSheet colorAt:'textSelectionBackgroundColor'.

    DefaultFont := StyleSheet fontAt:'textViewFont'.

    MatchDelayTime := 0.6

! !

!TextView methodsFor:'initialize & release'!

initialize

    super initialize.

    contentsWasSaved := false.

    "

     initialize menu to be provided and performed by myself.

     This allows textViews without a model to provide a

     reasonable menu AND allows models to provide their own menu.

    "

    menuHolder := menuPerformer := self.

    menuMsg := #editMenu

!

initStyle

    super initStyle.

    DefaultFont notNil ifTrue:[

	font := DefaultFont on:device

    ].

    viewBackground := DefaultViewBackground.

    selectionFgColor := DefaultSelectionForegroundColor.

    selectionFgColor isNil ifTrue:[selectionFgColor := bgColor].

    selectionBgColor := DefaultSelectionBackgroundColor.

    selectionBgColor isNil ifTrue:[

	device hasColors ifTrue:[

	    DefaultSelectionForegroundColor isNil ifTrue:[

		selectionFgColor := fgColor

	    ].

	    selectionBgColor := Color green

	] ifFalse:[

	    device hasGreyscales ifTrue:[

		DefaultSelectionForegroundColor isNil ifTrue:[

		    selectionFgColor := fgColor

		].

		selectionBgColor := Color grey

	    ] ifFalse:[

		selectionBgColor := fgColor

	    ]

	]

    ].

!

destroy

    fileBox notNil ifTrue:[

	fileBox destroy.

	fileBox := nil

    ].

    searchBox notNil ifTrue:[

	searchBox destroy.

	searchBox := nil

    ].

    lineNumberBox notNil ifTrue:[

	lineNumberBox destroy.

	lineNumberBox := nil

    ].

    super destroy

! !

!TextView methodsFor:'accessing-mvc'!

on:aModel aspect:aspectSym list:listSym change:changeSym menu:menuSym initialSelection:initial

    "ST-80 compatibility"

    aspectSym notNil ifTrue:[aspectMsg := aspectSym. listMsg := aspectSym].

    changeSym notNil ifTrue:[changeMsg := changeSym].

    listSym notNil ifTrue:[listMsg := listSym].

    menuSym notNil ifTrue:[menuMsg := menuSym].

"/    initial notNil ifTrue:[initialSelectionMsg := initial].

    self model:aModel.

    listMsg notNil ifTrue:[

	self getListFromModel

    ].

!

model:aModel

    "when my model is set, and I am the menuPerformer/menuHolder,

     reset holder to the model. This is a compatibility kludge,

     since typically, ST-80 code expects the model to provide a menu

     and the view to perform it.

     Those apps which want the TextView to provide the menu have to reset

     this by sending menuHolder: (again)"

    super model:aModel.

    (menuPerformer == self and:[menuHolder == self]) ifTrue:[

	menuHolder := model

    ]

! !

!TextView methodsFor:'accessing'!

selectionForegroundColor:color1 backgroundColor:color2

    "set both selection-foreground and cursor background colors"

    selectionFgColor := color1 on:device.

    selectionBgColor := color2 on:device.

    shown ifTrue:[

	self redraw

    ]

!

setList:something

    "set the displayed contents (a collection of strings)

     without redraw.

     Redefined since changing contents implies deselect"

    self unselect.

    super setList:something

!

list:something

    "set the displayed contents (a collection of strings)

     with redraw.

     Redefined since changing contents implies deselect"

    self unselect.

    super list:something

!

characterAtLine:lineNr col:colNr

    "return the character at physical line/col -

     return space if nothing is there"

    |line|

    list notNil ifTrue:[

	line := self listAt:lineNr.

	line notNil ifTrue:[

	    (line size >= colNr) ifTrue:[

		^ line at:colNr

	    ]

	]

    ].

    ^ Character space

!

characterPositionOfSelection

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

    selectionStartLine isNil ifTrue:[^ 1].

    ^ self characterPositionOfLine:selectionStartLine

			       col:selectionStartCol

!

directoryForFileDialog:aDirectory

    "define the directory to use for save-box"

    directoryForFileDialog := aDirectory

!

contentsWasSaved

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

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

    ^ contentsWasSaved

!

fromFile:aFileName

    "take contents from a named file"

    self directoryForFileDialog:(OperatingSystem directoryNameOf:aFileName).

    self contents:(FileStream oldFileNamed:aFileName) contents

! !

!TextView methodsFor:'private'!

fileOutContentsOn:aStream

    "save contents on a stream, replacing leading spaces by tab-characters."

    self fileOutContentsOn:aStream compressTabs:true

!

fileOutContentsOn:aStream compressTabs:compressTabs

    "save contents on a stream. If compressTabs is true,

     leading spaces will be replaced by tab-characters in the output."

    |startNr nLines string|

    "on some systems, writing linewise is very slow (via NFS)

     therefore we convert to a string and write it in big chunks.

     To avoid creating huge strings, we do it in blocks of 1000 lines,

     limiting temporary string creation to about 50-80k.

    "

    startNr := 1.

    nLines := list size.

    [startNr <= nLines] whileTrue:[

	string := list asStringWithCRsFrom:startNr 

					to:((startNr + 1000) min:nLines)

			      compressTabs:compressTabs.

	aStream nextPutAll:string.

	startNr := startNr + 1000 + 1.

    ].

"/  "the old (obsolete) code:"

"/

"/    list do:[:aLine |

"/      aLine notNil ifTrue:[

"/        aStream nextPutAll:aLine.

"/      ].

"/      aStream cr

"/  ]

!

widthForScrollBetween:firstLine and:lastLine

    "return the width in pixels for a scroll between firstLine and lastLine"

    selectionStartLine notNil ifTrue:[

	(lastLine < selectionStartLine) ifFalse:[

	    (firstLine > selectionEndLine) ifFalse:[

		^ width

	    ]

	]

    ].

    ^ super widthForScrollBetween:firstLine and:lastLine

!

scrollSelectUp

    "auto scroll action; scroll and reinstall timed-block"

    |prevStartLine|

    "just to make certain ..."

    selectionStartLine isNil ifTrue:[^ self].

    self scrollUp.

    "make new selection immediately visible"

    prevStartLine := selectionStartLine.

    selectionStartLine := firstLineShown.

    selectionStartCol := 1.

    selectionStartLine to:prevStartLine do:[:lineNr |

	self redrawLine:lineNr

    ].

    Processor addTimedBlock:autoScrollBlock afterSeconds:autoScrollDeltaT.

!

scrollSelectDown

    "auto scroll action; scroll and reinstall timed-block"

    |prevEndLine|

    "just to make certain ..."

    selectionEndLine isNil ifTrue:[^ self].

    self scrollDown.

    "make new selection immediately visible"

    prevEndLine := selectionEndLine.

    selectionEndLine := firstLineShown + nFullLinesShown.

    selectionEndCol := 0.

    prevEndLine to:selectionEndLine do:[:lineNr |

	self redrawLine:lineNr

    ].

    Processor addTimedBlock:autoScrollBlock afterSeconds:autoScrollDeltaT.

!

stopScrollSelect

    "stop auto scroll; deinstall timed-block"

    autoScrollBlock notNil ifTrue:[

	Processor removeTimedBlock:autoScrollBlock.

	self compressMotionEvents:true.

	autoScrollBlock := nil.

	autoScrollDeltaT := nil

    ]

!

scrollSelectLeft

    "auto scroll action; scroll and reinstall timed-block"

    |prevStartLine|

    "just to make certain ..."

    selectionStartLine isNil ifTrue:[^ self].

    selectionStartCol isNil ifTrue:[^ self].

    "make new selection immediately visible"

    prevStartLine := selectionStartLine.

    selectionStartCol := selectionStartCol - 1 max:1.

    self scrollLeft.

    Processor addTimedBlock:autoScrollBlock afterSeconds:autoScrollDeltaT.

!

scrollSelectRight

    "auto scroll action; scroll and reinstall timed-block"

    |prevEndCol|

    "just to make certain ..."

    selectionEndCol isNil ifTrue:[^ self].

    prevEndCol := selectionEndCol.

    selectionEndCol := selectionEndCol + 1.

    self scrollRight.

    Processor addTimedBlock:autoScrollBlock afterSeconds:autoScrollDeltaT.

! !

!TextView methodsFor:'menu actions'!

editMenu

    |labels selectors m|

    labels := #(

			'copy'

			'-'

			'font ...'

			'-'

			'search ...'

			'goto ...'

			'-'

			'save as ...'