"

 COPYRIGHT (c) 1998 by eXept Software AG

              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:libcomp' }"

AbstractSyntaxHighlighter subclass:#SyntaxHighlighter

	instanceVariableNames:'currentSuperclasses currentSubclasses

		cachedLocalIdentifierEmphasis cachedLocalIdentifierColor

		cachedStringEmphasis cachedStringColor'

	classVariableNames:''

	poolDictionaries:''

	category:'System-Compiler'

!

!SyntaxHighlighter class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1998 by eXept Software AG

              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

"

    colors a method.

"

! !

!SyntaxHighlighter class methodsFor:'highlighting'!

formatClassDefinition:aString in:aClass

    "format (recolor) a class definition expression in a given class.

     Return the text containing font changes and color information."

    ^ self formatExpression:aString in:aClass

!

formatExpression:aString in:aClass

    "format (recolor) an expression in a given class.

     Return the text containing font changes and color information."

    |parser tree text endPos|

    aString isNil ifTrue:[^ nil].

    parser := self for:(ReadStream on:aString string) in:aClass.

    parser ignoreErrors:true.

    parser ignoreWarnings:true.

    parser sourceText:(text := aString string asText).

    "/ use an array here - this can be changed much faster using #at:put:

    text emphasisCollection:(Array new:aString size).

    parser nextToken.

    tree := parser expression.

    "/ now, convert the emphasis-array to a runArray

    text emphasisCollection:(text emphasis asRunArray).

    tree == #Error ifTrue:[

        "/ mhmh - which is better ...

        "/ alternative1: color rest after error in red

"/        text 

"/            emphasizeFrom:(parser sourceStream position) 

"/            to:text size 

"/            with:(#color->Color red).

        "/ alternative2: take original emphasis for rest

        endPos := parser sourceStream position1Based.

        endPos >= text size ifTrue:[

            ^ text

        ].

        ^ (text copyTo:endPos) , (aString copyFrom:(endPos+1))

        "/ alternative3: no emphasis for rest.

"/        ^ text "/ aString

    ].

    ^ text

    "

     self

        formatExpression:'(1 + 2) max:5' 

        in:UndefinedObject

    "

    "Modified: / 7.4.1998 / 09:57:19 / cg"

    "Created: / 9.4.1998 / 16:57:16 / cg"

!

formatMethod:aString in:aClass

    "format (recolor) a method in a given class.

     Return the text containing font changes and color information."

    ^ self formatMethod:aString in:aClass using:nil

    "

     self

        formatMethod:'foo 

    ^ self bar:''hello''.

    ' , (Character doubleQuote asString) , 'some comment' , (Character doubleQuote asString) , '

'

        in:UndefinedObject

    "

    "Modified: / 23.10.1998 / 22:48:45 / cg"

!

formatMethod:aString in:aClass using:preferencesOrNil

    "format (recolor) a method in a given class.

     Return the text containing font changes and color information."

    |highlighter tree text endPos eColor|

    aString isNil ifTrue:[^ nil].

    Error handle:[:ex |

        ex signal isHandled ifTrue:[

            ex reject.    

        ].

        (self parseErrorSignal handles:ex) ifFalse:[

            "Parse error may happen when re-formatting incomplete code while editing"

            "/ ('SyntaxHighlighter [info]: error during highlight: ' , ex description) infoPrintCR.

            "/ ex suspendedContext fullPrintAll.

        ].

        ^ aString

    ] do:[

        highlighter := self for:(ReadStream on:aString string) in:aClass.

        preferencesOrNil notNil ifTrue:[highlighter preferences:preferencesOrNil].

        "/ highlighter ignoreErrors:true.

        highlighter ignoreWarnings:true.

        highlighter sourceText:(text := aString string asText).

        "/ use an array here - this can be changed much faster using #at:put:

        text emphasisCollection:(Array new:aString size).

        tree := highlighter parseMethod.

        "/ now, convert the emphasis-array to a runArray

        text emphasisCollection:(text emphasis asRunArray).

        tree == #Error ifTrue:[

            eColor := UserPreferences current errorColor.

            eColor notNil ifTrue:[

                "/ mhmh - which is better ...

                "/ alternative1: color rest after error in red

                text 

                    emphasizeFrom:(highlighter sourceStream position1Based) 

                    to:text size 

                    with:(#color->eColor).

            ] ifFalse:[

                "/ alternative2: take original emphasis for rest

                endPos := highlighter sourceStream position1Based.

                endPos >= text size ifTrue:[

                    ^ text

                ].

                ^ (text copyTo:endPos) , (aString copyFrom:(endPos+1))

            ].

            "/ alternative3: no emphasis for rest.

        ].

        ^ text

    ]

    "

     self

        formatMethod:'foo 

    ^ self bar:''hello''.

    ' , (Character doubleQuote asString) , 'some comment' , (Character doubleQuote asString) , '

'

        in:UndefinedObject

    "

    "Modified: / 04-02-2012 / 11:53:16 / cg"

! !

!SyntaxHighlighter methodsFor:'initialization'!

initialize

    super initialize.

    foldConstants := false.

"/    parserFlags allowDollarInIdentifier:true.

    preferences := UserPreferences current.

    fullSelectorCheck := preferences fullSelectorCheck.

    "Created: / 31.3.1998 / 15:12:55 / cg"

    "Modified: / 5.1.1980 / 00:44:03 / cg"

! !

!SyntaxHighlighter methodsFor:'syntax detection'!

markArgumentIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences argumentIdentifierEmphasis) 

        color:(preferences argumentIdentifierColor)

    "Modified: / 31.3.1998 / 18:01:27 / cg"

!

markAssignedClassVariableIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences classVariableIdentifierEmphasis) 

        color:(preferences sideEffectAssignmentColor)

        ifNil:(preferences classVariableIdentifierColor)

        backgroundColor:(preferences sideEffectAssignmentBackgroundColor)

    "Created: / 13-02-2012 / 11:49:59 / cg"

!

markAssignedGlobalIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences globalIdentifierEmphasis) 

        color:(preferences sideEffectAssignmentColor)

        ifNil:(preferences globalIdentifierColor)

        backgroundColor:(preferences sideEffectAssignmentBackgroundColor)

    "Modified: / 31-03-1998 / 18:02:14 / cg"

    "Created: / 13-02-2012 / 11:44:33 / cg"

!

markAssignedInstVarIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences instVarIdentifierEmphasis) 

        color:(preferences sideEffectAssignmentColor)

        ifNil:(preferences instVarIdentifierColor)

        backgroundColor:(preferences sideEffectAssignmentBackgroundColor)

    "Created: / 13-02-2012 / 11:50:19 / cg"

!

markAssignedPoolVariableIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences poolVariableIdentifierEmphasis) 

        color:(preferences sideEffectAssignmentColor)

        ifNil:(preferences poolVariableIdentifierColor)

        backgroundColor:(preferences sideEffectAssignmentBackgroundColor)

    "Created: / 13-02-2012 / 11:49:14 / cg"

!

markAssignedVariable:v from:pos to:endPos

    "support for syntaxColoring"

    |type|

    type := v type.

    (type == #BlockArg

    or:[ type == #MethodArg

    or:[ type == #BlockVariable

    or:[ type == #MethodVariable]]]) ifTrue:[

        self markVariable:v from:pos to:endPos.

        ^ self

    ].

    (type == #GlobalVariable) ifTrue:[

        self markAssignedGlobalIdentifierFrom:pos to:endPos.

        ^ self

    ].

    (type == #PoolVariable) ifTrue:[

        self markAssignedPoolVariableIdentifierFrom:pos to:endPos.

        ^ self

    ].

    (type == #ClassVariable) ifTrue:[

        self markAssignedClassVariableIdentifierFrom:pos to:endPos.

        ^ self

    ].

    (type == #InstanceVariable) ifTrue:[

        self markAssignedInstVarIdentifierFrom:pos to:endPos.

        ^ self

    ].

    self markAssignedIdentifierFrom:pos to:endPos.

    "Created: / 13-02-2012 / 11:42:23 / cg"

!

markBadIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences badIdentifierEmphasis) 

        color:(preferences badIdentifierColor)

!

markBlockFrom:pos1 to:pos2

    "an experiment (which does not look too good, after all):

     the deeper the nesting of the block, the darker the background color."

"/    |level color|

"/

"/    level := currentBlock isNil ifTrue:[1] ifFalse:[currentBlock nestingLevel+1].

"/    level > 5 ifTrue:[

"/        color := Color yellow darkened.

"/    ] ifFalse:[

"/        color := {

"/                    Color yellow lightened lightened.

"/                    Color yellow lightened          .

"/                    Color yellow                    .

"/                    Color yellow slightlyDarkened   .

"/                    Color yellow darkened           .

"/                } at:level.

"/    ].

"/    self 

"/        markFrom:pos1 to:pos2 

"/        withAddedEmphasis:(#backgroundColor->color).

!

markBooleanConstantFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences booleanConstantEmphasis) 

        color:(preferences booleanConstantColor)

    "Created: / 31.3.1998 / 18:09:01 / cg"

    "Modified: / 31.3.1998 / 19:36:44 / cg"

!

markBracketAt:pos

    |level colors clr em|

    preferences emphasizeParenthesisLevel ifFalse:[

        self 

            markFrom:pos to:pos 

            withEmphasis:(preferences bracketEmphasis) 

            color:(preferences bracketColor).

        ^ self

    ].

    level := currentBlock isNil ifTrue:[1] ifFalse:[currentBlock nestingLevel + 2].

    (sourceText at:pos) = $] ifTrue:[

        level := level - 1.

    ].

    colors := Array 

                with:(Color black)

                with:(Color blue)

                with:(Color green blendWith:(Color grey:30))

                with:(Color red blendWith:(Color grey:30))

                with:(Color yellow darkened).

    clr := colors at:((level-1) \\ colors size + 1).

    em := #normal.

    level > 1 ifTrue:[

        em := #bold.

    ].

    self 

        markFrom:pos to:pos 

        withEmphasis:em 

        color:clr

!

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)

    "

     UserPreferences current commentEmphasis

    "

    "Modified: / 31.3.1998 / 18:01:55 / cg"

!

markConstantFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences constantEmphasis) 

        color:(preferences constantColor)

    "Modified: / 31.3.1998 / 18:01:44 / cg"

    "Created: / 31.3.1998 / 18:09:22 / cg"

!

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"

!

markHereFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences hereEmphasis) 

        color:(preferences hereColor)

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

!

markIdentifierFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences identifierEmphasis) 

        color:(preferences identifierColor)

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

    "Created: / 31.3.1998 / 18:04:56 / cg"

!

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"

!

markLocalIdentifierFrom:pos1 to:pos2

    cachedLocalIdentifierEmphasis isNil ifTrue:[

        cachedLocalIdentifierEmphasis := preferences localIdentifierEmphasis.

        cachedLocalIdentifierColor := preferences localIdentifierColor.

    ].

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:cachedLocalIdentifierEmphasis 

        color:cachedLocalIdentifierColor

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

!

markMethodSelectorFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences methodSelectorEmphasis) 

        color:(preferences methodSelectorColor)

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

!

markNumberConstantFrom:pos1 to:pos2

    self 

        markFrom:pos1 to:pos2 

        withEmphasis:(preferences numberConstantEmphasis) 

        color:(preferences numberConstantColor)

    "Modified: / 31.3.1998 / 18:01:44 / cg"

    "Created: / 31.3.1998 / 18:09:22 / cg"

!

markParenthesisAt:pos

    |colors clr em|

    preferences emphasizeParenthesisLevel ifFalse:[^ self].

    colors := Array 

                with:(Color black)

                with:(Color blue)

                with:(Color green blendWith:(Color grey:30))