"

 COPYRIGHT (c) 1996-2011 by Claus Gittinger

 New code and modifications done at SWING Research Group [1]:

 COPYRIGHT (c) 2010-2011 by Jan Vrany, Jan Kurs and Marcel Hlopko

                            SWING Research Group, Czech Technical University in Prague

 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.

 [1] Code written at SWING Research Group contains a signature

     of one of the above copright owners. For exact set of such code,

     see the differences between this version and version stx:libjava

     as of 1.9.2010

"

"{ Package: 'stx:libjava/tools' }"

Object subclass:#JavaSourceHighlighter

	instanceVariableNames:'preferences cachedStringEmphasis cachedStringColor sourceText

		sourceIndex'

	classVariableNames:'FormattedSourceCache'

	poolDictionaries:''

	category:'Languages-Java-Tools-Source'

!

JavaParseNodeBuilder subclass:#Builder

	instanceVariableNames:'highlighter'

	classVariableNames:''

	poolDictionaries:''

	privateIn:JavaSourceHighlighter

!

JavaParser subclass:#Parser

	instanceVariableNames:'stream'

	classVariableNames:''

	poolDictionaries:''

	privateIn:JavaSourceHighlighter

!

JavaScanner subclass:#Scanner

	classVariableNames:''

	poolDictionaries:''

	privateIn:JavaSourceHighlighter

!

!JavaSourceHighlighter class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1996-2011 by Claus Gittinger

 New code and modifications done at SWING Research Group [1]:

 COPYRIGHT (c) 2010-2011 by Jan Vrany, Jan Kurs and Marcel Hlopko

                            SWING Research Group, Czech Technical University in Prague

 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.

 [1] Code written at SWING Research Group contains a signature

     of one of the above copright owners. For exact set of such code,

     see the differences between this version and version stx:libjava

     as of 1.9.2010

"

!

documentation

"

    A syntax highligter for Java. This highlighter is SmallSense-aware and

    supports incremental highlighting.

    [author:]

        Jan Vrany <jan.vrany@fit.cvut.cz>

    [instance variables:]

    [class variables:]

    [see also:]

"

! !

!JavaSourceHighlighter class methodsFor:'formatting'!

formatClass: javaClass

    ^self new formatClassDefinition: javaClass source in: javaClass

    "Created: / 15-12-2011 / 21:54:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatClassDefinition:source in:class

    ^self new formatClassDefinition:source in:class

    "Created: / 04-08-2011 / 23:44:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatClassDefinition:source in:class elementsInto: elements

    ^self new formatClassDefinition:source in:class elementsInto: elements

    "Created: / 04-08-2011 / 23:44:13 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatClassDefinition:newCode line: ln number: lnr in:cls

    ^self new formatClassDefinition:newCode line: ln number: lnr in:cls.

    "Created: / 04-08-2013 / 00:25:17 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatExpression:source in:class

    ^self new formatExpression:source in:class

    "Created: / 04-08-2011 / 23:45:01 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatExpression:source in:class elementsInto: elements

    ^self new formatExpression:source in:class elementsInto: elements

    "Created: / 04-08-2011 / 23:43:40 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatMethod:mth source:source in:class

    ^self formatMethod: mth source: source in: class using: UserPreferences current

    "Created: / 11-02-2012 / 18:18:32 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatMethod:mth source:source in:class using: preferences

    ^self new formatMethod:mth source:source in:class using: preferences

    "Created: / 04-08-2011 / 23:45:10 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatMethod:mth source:source in:class using: preferences elementsInto: elements

    ^self new formatMethod:mth source:source in:class using: preferences elementsInto: elements

    "Created: / 04-08-2011 / 23:42:54 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatMethod:mthd source:newCode line: ln number: lnr in:cls using:syntaxPreferences

    ^ self new formatMethod:mthd source:newCode line: ln number: lnr in:cls using:syntaxPreferences

    "Created: / 04-08-2013 / 00:26:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaSourceHighlighter methodsFor:'formatting'!

formatClassDefinition:source in:class

    ^ self format: source kind: #start in: class

    "Created: / 04-08-2011 / 23:44:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatClassDefinition:source in:class elementsInto: els

    sourceIndex := els.

    ^self formatClassDefinition:source in:class

    "Created: / 04-08-2011 / 23:44:13 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatClassDefinition:newCode line: line number: lnr in:cls

    | scanner |

    line isEmptyOrNil ifTrue:[ ^  nil ].

    sourceText := line asText.

    preferences isNil ifTrue:[

        preferences := UserPreferences current.

    ]. 

    scanner := Scanner for: line asString.

    scanner highlighter: self.

    [

        [ scanner nextToken ~~ #EOF ] whileTrue.

    ] on: Error do:[

    ].

        ^ sourceText

    "Created: / 04-08-2013 / 00:25:38 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatExpression:source in:class

"/    self breakPoint:#jv.

    ^source.

    ^ self format: source kind: #'K_EXPRESSION' in: class

    "Created: / 04-08-2011 / 23:45:01 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatExpression:source in:class elementsInto: els

    sourceIndex := els.

    ^self formatExpression:source in:class

    "Created: / 04-08-2011 / 23:43:40 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatMethod:mth source:source in:class using: prefs

    preferences := prefs.

    ^ self format: source kind: #start in: class

    "Created: / 04-08-2011 / 23:45:10 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatMethod:mth source:source in:class using: prefs elementsInto: els

    preferences := prefs.

    sourceIndex := els.

    ^self formatMethod:mth source:source in:class using: prefs

    "Created: / 04-08-2011 / 23:42:54 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

formatMethod:mthd source:newCode line: line number: lnr in:cls using:syntaxPreferences

    | scanner |

    line isEmptyOrNil ifTrue:[ ^  nil ].

    sourceText := line asText.

    preferences := syntaxPreferences.

    preferences isNil ifTrue:[

        preferences := UserPreferences current.

    ]. 

    scanner := Scanner for: line asString.

    scanner highlighter: self.

    [

        [ scanner nextToken ~~ #EOF ] whileTrue.

    ] on: Error do:[

    ].

    ^ sourceText

    "Created: / 04-08-2013 / 00:26:16 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaSourceHighlighter methodsFor:'formatting - private'!

format: source kind: kind in: class

    | scanner parser builder cacheIt document tree |

    "Optimization - if full class source is to be formatted,

     consult cache - when browsing the code or debugging, very 

     often same same source is to be highlighted"

    preferences isNil ifTrue:[

        preferences := UserPreferences current.

    ].

    cacheIt := kind == #start and: [class notNil].

    cacheIt ifTrue:[

        document := JavaSourceDocument cachedDocumentFor: class.

        document notNil ifTrue:[

            (document sourceText notNil and:[document sourceText string = source]) ifTrue:[

                document sourceText copy.

            ].

        ].

        document := JavaSourceDocument for: class.

    ].

    source isText ifTrue:[

        sourceText := source copy

    ] ifFalse:[

        sourceText := source asText.

    ].

    scanner := Scanner for: source.  

    builder := Builder new.

    builder highlighter: self.

    scanner highlighter: self.

    parser := Parser newStartingAt: kind.

    parser builder: builder.

    parser stream: scanner.

    tree := parser parse: scanner.

    ^ cacheIt ifTrue:[

        document sourceText: sourceText.

        document sourceIndex: sourceIndex.

        document sourceTree: tree.

        JavaSourceDocument cachedDocumentFor: class put: document.

        sourceText copy

    ] ifFalse:[

        sourceText

    ]

    "Created: / 17-03-2012 / 14:02:24 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 30-08-2013 / 01:53:09 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaSourceHighlighter methodsFor:'syntax detection'!

markArgumentIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences argumentIdentifierEmphasis) color:(preferences argumentIdentifierColor)

!

markBadIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences badIdentifierEmphasis) 

        color:(preferences badIdentifierColor)

!

markClassVariableIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences classVariableIdentifierEmphasis) color:(preferences classVariableIdentifierColor)

    "Modified: / 31.3.1998 / 18:02:14 / cg"

!

markCommentFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences commentEmphasis) color:(preferences commentColor)

!

markConstantFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences constantEmphasis) color:(preferences constantColor)

!

markFrom:pos1 to:pos2 withEmphasis:fontEmp color:clrIn

    |e p2 clr|

    clr := clrIn onDevice:Screen current.

    clr = Color black ifTrue:[

        e := fontEmp

    ] ifFalse:[

        fontEmp isNil ifTrue:[

            e := (#color->clr)

        ] ifFalse:[

            e := Text addEmphasis:fontEmp to:(#color->clr).

        ]

    ].

    (p2 := pos2) isNil ifTrue:[

        p2 := sourceText size

    ] ifFalse:[

        p2 := p2 min:sourceText size

    ].

    sourceText emphasizeFrom:pos1 to:p2 with:e

    "Created: / 31.3.1998 / 13:26:53 / cg"

    "Modified: / 1.4.1998 / 12:51:56 / cg"

!

markFunctionNameFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences methodSelectorEmphasis) color:(preferences methodSelectorColor)

!

markGlobalClassIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences globalClassIdentifierEmphasis) color:(preferences globalClassIdentifierColor)

    "Modified: / 31.3.1998 / 18:02:14 / cg"

    "Created: / 4.3.1999 / 12:53:02 / cg"

!

markGlobalIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences globalIdentifierEmphasis) color:(preferences globalIdentifierColor)

    "Modified: / 31.3.1998 / 18:02:14 / cg"

!

markIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences identifierEmphasis) color:(preferences identifierColor)

!

markInstVarIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences instVarIdentifierEmphasis) color:(preferences instVarIdentifierColor)

    "Created: / 16.4.1998 / 18:35:40 / cg"

    "Modified: / 16.4.1998 / 18:37:30 / cg"

!

markKeyword:kw from:pos1 to:pos2

    |em clr|

    ( #( 'if' 'else'

         'while'

         'for'

         'do'

         'return'

         'continue'

         'break'

    ) includes:kw) ifTrue:[

        em := preferences controlFlowSelectorEmphasis. 

        clr := preferences controlFlowSelectorColor.

    ] ifFalse:[

        em := preferences jsKeywordEmphasis.

        clr := preferences jsKeywordColor.

    ].

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:em color:clr

    "Modified: / 19-05-2010 / 15:07:59 / cg"

    "Modified: / 07-08-2013 / 00:28:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

markLocalIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences localIdentifierEmphasis) color:(preferences localIdentifierColor)

!

markProblem: problem from:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences badIdentifierEmphasis) 

        color:(preferences badIdentifierColor)

    "Created: / 15-04-2013 / 22:23:30 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

markSelector:selectorString from:pos1 to:pos2 

    | fg em |

    fg := preferences selectorColor.

    em := preferences selectorEmphasis.

    self

        markFrom:pos1 to:pos2 

        withEmphasis:em color:fg

    "Modified: / 04-10-2011 / 19:48:48 / cg"

    "Modified: / 17-03-2012 / 13:26:38 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Created: / 17-03-2012 / 19:12:20 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

markSelector:selectorString from:pos1 to:pos2 receiverNode:aReceiverNodeOrNil numArgs:numArgs

    |fg selectorSymbol check ok rec em currentEnvironment currentSuperclasses currentSubclasses classToCompileFor fullSelectorCheck|

    fg := preferences selectorColor.

    em := preferences selectorEmphasis.

"/    (currentEnvironment notNil

"/    and:[ (((currentEnvironment _localVariables ? #()) contains:[:local | local name = selectorString]) 

"/          or:[((currentEnvironment _argVariables ? #()) contains:[:local | local name = selectorString])])

"/    ])

"/    ifTrue:[

"/        "/ a local call

"/    ] ifFalse:[

"/        selectorSymbol := (self translatedSmalltalkSelectorFor:selectorString numArgs:numArgs) asSymbolIfInterned.

"/        selectorSymbol isNil ifTrue:[

"/            fg := Color red.

"/        ] ifFalse:[

"/            fullSelectorCheck == true ifTrue:[

"/                aReceiverNodeOrNil notNil ifTrue:[

"/                    check := [:cls | (cls includesSelector:selectorSymbol)

"/                                     or:[cls class includesSelector:selectorSymbol]].

"/

"/                    ok := false.

"/

"/                    "/ limit search if possible

"/                    (classToCompileFor notNil

"/                     and:[aReceiverNodeOrNil isSelf or:[aReceiverNodeOrNil isSuper]]) ifTrue:[

"/                        currentSuperclasses isNil ifTrue:[

"/                            currentSuperclasses := classToCompileFor withAllSuperclasses.

"/                        ].

"/                        ok := currentSuperclasses contains:check.

"/                        (ok not and:[aReceiverNodeOrNil isSelf]) ifTrue:[

"/                            currentSubclasses isNil ifTrue:[

"/                                currentSubclasses := classToCompileFor allSubclasses.

"/                            ].

"/                            ok := currentSubclasses contains:check.

"/                        ].

"/                    ] ifFalse:[

"/                        aReceiverNodeOrNil isConstant ifTrue:[

"/                            ok := aReceiverNodeOrNil evaluate class withAllSuperclasses contains:check.

"/                        ] ifFalse:[

"/                            (aReceiverNodeOrNil isGlobal 

"/                            and:[(rec := aReceiverNodeOrNil evaluate) isBehavior]) ifTrue:[