"

stx:goodies/smallsense - A productivity plugin for Smalltalk/X IDE

Copyright (C) 2013-2014 Jan Vrany

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

"

"{ Package: 'stx:goodies/smallsense' }"

"{ NameSpace: SmallSense }"

Object subclass:#EditSupport

	instanceVariableNames:'service codeView textView backspaceIsUndo completionController

		completionEnvironment snippets ignoreKeystrokes

		ignoreKeystrokesPosition'

	classVariableNames:''

	poolDictionaries:''

	category:'SmallSense-Core-Services'

!

!EditSupport class methodsFor:'documentation'!

copyright

"

stx:goodies/smallsense - A productivity plugin for Smalltalk/X IDE

Copyright (C) 2013-2014 Jan Vrany

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

"

! !

!EditSupport class methodsFor:'instance creation'!

forLanguage: aProgrammingLanguage

    aProgrammingLanguage notNil ifTrue:[

    ].

    ^GenericEditSupport new.

    "Created: / 24-07-2013 / 23:20:31 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 04-10-2013 / 08:41:09 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!EditSupport methodsFor:'accessing'!

codeView

    ^ codeView

    "Created: / 21-01-2014 / 23:13:00 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 03-02-2014 / 23:28:29 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

environment

    "raise an error: this method should be implemented (TODO)"

    ^ service environment

    "Created: / 15-05-2014 / 16:44:24 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

language

    ^ self subclassResponsibility.

    "Created: / 24-07-2013 / 23:44:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

service

    ^ service

!

textView

    ^ textView

    "Created: / 03-02-2014 / 23:28:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!EditSupport methodsFor:'accessing-classes'!

completionControllerClass

    "raise an error: this method should be implemented (TODO)"

    ^ CompletionController

    "Created: / 13-05-2014 / 16:13:13 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

completionEngineClass

     no completion is supported"

    ^ nil

    "Created: / 03-10-2013 / 17:43:47 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

scannerClass

    "Returns a class to use for scanning lines. If nil, scanning is

     not supported and scanLine* methods will return an empty array."

    ^ nil

    "Created: / 22-10-2013 / 00:33:11 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!EditSupport methodsFor:'editing'!

    textView deleteCharAtLine: textView cursorLine col: col

    "Created: / 22-01-2014 / 21:17:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

    textView deleteCharAtLine: line col: col

    "Created: / 22-01-2014 / 21:16:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

    textView completionSupport notNil ifTrue:[

    ].

    textView hasSelection ifTrue:[

    ].

    textView undoableDo:[ aBlock value. ].

    backspaceIsUndo := true.

    "Created: / 17-09-2013 / 23:15:46 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 22-10-2013 / 03:15:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

    self electricInsert:text advanceCursorBy:nil.

    "Created: / 22-10-2013 / 11:08:19 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

    "Created: / 22-10-2013 / 11:56:43 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 19-01-2014 / 20:29:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

    "Insert given stringOrLines. If offsetOrNil is not nil, then

     move cursor by `offsetOrNil` after the **begining** of

     inserted text. If `ignoreKeystrokeSequence` is not nil and not empty, then if

     subsequent key strokes are ignored (i.e, does nothing) if matches

     the given sequence. This is used to avoid duplication if user is not

     aware of electric insertion and types whole text that has been

     (electrically) inserted).

     `stringOrLines` could be either string or collection of strings (lines)

     `offsetOrNil` could be either integer (cursor is then advanced by

     `ignoreKeystrokeSequence` a sequenceable collection of keys (in a form

    | lineOffset  colOffset  newCursorCol  newCursorLine  advanceCursor |

    advanceCursor := false.

    offsetOrNil notNil ifTrue:[

    ].

    ignoreKeystrokeSequence notEmptyOrNil ifTrue:[

    ].

    "Created: / 19-01-2014 / 20:29:00 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 20-01-2014 / 09:24:23 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (format): / 22-01-2014 / 21:13:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

    "Created: / 21-01-2014 / 23:29:57 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

    | indent  lines  autoIndent |

    textView completionSupport notNil ifTrue:[

    ].

    indent := self indentAtCursorLine.

    autoIndent := textView autoIndent.

    textView autoIndent:false.

    [

    ] ensure:[ textView autoIndent:autoIndent ].

    "Created: / 25-07-2013 / 10:41:50 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 22-01-2014 / 21:20:14 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

electricInsertSnippet

    ^ false

    "Created: / 22-10-2013 / 01:54:10 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!EditSupport methodsFor:'event handling'!

keyPress: key x:x y:y in: view

    "Handles an event in given view (a subview of codeView).

     If the method returns true, the event will not be processed

     by the view.

     IMPORTANT: Never ever call `^ super keyPress: key x:x y:y in: view`,

     as keyPresIgnore... advances position and calling keyPressIgnore here

     and calling super would advance it twice!!

     "

    view ~~ textView ifTrue:[ ^ false ].

    (self keyPressIgnored: key) ifTrue:[

    ].

    key == Character space ifTrue:[

    ].

    ^false

    "Created: / 24-07-2013 / 23:31:46 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 17-05-2014 / 21:22:20 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

keyPressIgnored

    "Advance position in keyPressIgnore buffer. Return true if position has been edvanced, false othwrwise"

    ignoreKeystrokes notNil ifTrue:[

    ].

    ^ false.

    "Created: / 11-08-2014 / 14:56:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

keyPressIgnored: key

    ignoreKeystrokes notNil ifTrue:[

    ].

    ^ false.

    "Created: / 20-01-2014 / 09:11:17 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (comment): / 11-08-2014 / 14:54:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

keyPressSpace

    ^ self electricInsertSnippet

    "Created: / 22-10-2013 / 01:43:46 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!EditSupport methodsFor:'initialization'!

initializeCompletion

    | controller |

    ].

    "Created: / 18-05-2014 / 12:40:57 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

initializeForService:aSmallSenseService

    service := aSmallSenseService.

    codeView := aSmallSenseService codeView.

    textView := aSmallSenseService textView.

    backspaceIsUndo := false.

    self initializeCompletion.

    "Created: / 27-09-2013 / 13:19:20 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 03-02-2014 / 23:28:22 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!EditSupport methodsFor:'private'!

indentAtCursorLine

    | line |

    line := service textView listAt: service textView cursorLine.

    ^ line isNil ifTrue:[

    ] ifFalse:[

    ]

    "Created: / 25-07-2013 / 00:13:33 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 25-10-2013 / 18:04:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

wordBeforeCursor

    ^ self wordBeforeCursorConsisitingOfCharactersMatching: [:c | c isAlphaNumeric ].

    "Created: / 27-09-2013 / 15:53:40 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 31-03-2014 / 23:03:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

wordBeforeCursorConsisitingOfCharactersMatching: characterMatchBlock

    |  currentLine wordStart wordEnd |

    currentLine := textView list at: textView cursorLine ifAbsent:[ ^ '' ].

    currentLine isNil ifTrue:[ ^ '' ].

    wordEnd := textView cursorCol - 1.

    wordEnd > currentLine size ifTrue:[ ^ '' ].

    wordEnd ~~ 0 ifTrue:[

    ].

    ^ ''

    "Created: / 31-03-2014 / 23:02:28 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 17-06-2014 / 07:27:14 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!EditSupport methodsFor:'private-scanning'!

    "Scans line at given line number.

     Returns and array of tokens, **excluding** EOF. Each token is represented

     by four subsequent items in the array: token type, token value, start position, end position.

     Thus, returned array size is always multiple of 4."

    ^ self scanLineAt: lineNumber using: self scannerClass

    "Created: / 22-10-2013 / 00:34:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

scanLineAt: lineNumber using: scannerClass

    "Scans line at given line number using given scanner class.

     Returns and array of tokens, **excluding** EOF. Each token is represented

     by four subsequent items in the array: token type, token value, start position, end position.

     Thus, returned array size is always multiple of 4."

    | line scanner token tokenLastEndPosition |

    scannerClass isNil ifTrue:[ ^ #() ].

    line := (service textView listAt: service textView cursorLine).

    line isNil ifTrue:[ ^ #() ].

    scanner := scannerClass for: line string.

    tokenLastEndPosition := 0.

    ^ OrderedCollection streamContents:[:tokens |

    ].

    "Created: / 22-10-2013 / 00:31:02 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 22-10-2013 / 12:01:53 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

scanLineAtCursor

    "Scans current cursor line.

     Returns and array of tokens, **excluding** EOF. Each token is represented

     by four subsequent items in the array: token type, token value, start position, end position.

     Thus, returned array size is always multiple of 4."

    ^ self scanLineAt: service codeView textView cursorLine using: self scannerClass

    "Created: / 22-10-2013 / 00:34:47 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !