"

 Copyright (c) 2007-2010 Jan Vrany, SWING Research Group, Czech Technical University in Prague

 Copyright (c) 2009-2010 eXept Software AG

 Copyright (c) 2022 LabWare

 Permission is hereby granted, free of charge, to any person

 obtaining a copy of this software and associated documentation

 files (the 'Software'), to deal in the Software without

 restriction, including without limitation the rights to use,

 copy, modify, merge, publish, distribute, sublicense, and/or sell

 copies of the Software, and to permit persons to whom the

 Software is furnished to do so, subject to the following

 conditions:

 The above copyright notice and this permission notice shall be

 included in all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 OTHER DEALINGS IN THE SOFTWARE.

"

"{ Package: 'stx:libtool' }"

"{ NameSpace: Tools }"

BrowserList subclass:#LintRuleList

	instanceVariableNames:'listHolder filterHolder modeHolder listSelection listView

		initialSelectionHolder'

	classVariableNames:'LastNameFilter'

	poolDictionaries:''

	category:'Interface-Lint'

!

HierarchicalItem subclass:#ListEntry

	instanceVariableNames:'x rule application'

	classVariableNames:''

	poolDictionaries:''

	privateIn:LintRuleList

!

!LintRuleList class methodsFor:'documentation'!

copyright

"

 Copyright (c) 2007-2010 Jan Vrany, SWING Research Group, Czech Technical University in Prague

 Copyright (c) 2009-2010 eXept Software AG

 Copyright (c) 2022 LabWare

 Permission is hereby granted, free of charge, to any person

 obtaining a copy of this software and associated documentation

 files (the 'Software'), to deal in the Software without

 restriction, including without limitation the rights to use,

 copy, modify, merge, publish, distribute, sublicense, and/or sell

 copies of the Software, and to permit persons to whom the

 Software is furnished to do so, subject to the following

 conditions:

 The above copyright notice and this permission notice shall be

 included in all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 OTHER DEALINGS IN THE SOFTWARE.

"

!

documentation

"

    Embeddable list to display a set of SmallLint rules.

    (this is embedded in the browser when showing lint check outcomes)

    Supports 3 modes (controlled by modeHolder)

        #display            - only display given set of rules.

        #displaySelection   - display set of rules and indicate which one is selected

                              by check mark. Does NOT ALLOW to change selection

                              (add remove tools)

        #select             - display set of rules and DO ALLOW to change the selection

                              (add / remove rules) by clicking to check icon     

    [author:]

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

    [instance variables:]

    [class variables:]

    [see also:]

"

!

examples

"

  Starting the application:

                                                                [exBegin]

    Tools::LintRuleList open

                                                                [exEnd]

  more examples to be added:

                                                                [exBegin]

    ... add code fragment for 

    ... executable example here ...

                                                                [exEnd]

"

! !

!LintRuleList class methodsFor:'interface specs'!

windowSpec

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the UIPainter may not be able to read the specification."

    "

     UIPainter new openOnClass:Tools::LintRuleList andSelector:#windowSpec

     Tools::LintRuleList new openInterface:#windowSpec

     Tools::LintRuleList open

    "

    <resource: #canvas>

    ^ 

    #(FullSpec

       name: windowSpec

       window: 

      (WindowSpec

         label: 'SmallLintRuleList'

         name: 'SmallLintRuleList'

         min: (Point 10 10)

         bounds: (Rectangle 0 0 300 300)

       )

       component: 

      (SpecCollection

         collection: (

          (InputFieldSpec

             name: 'RuleFilter'

             layout: (LayoutFrame 0 0 0 0 0 1 28 0)

             model: filterHolder

             immediateAccept: true

             acceptOnReturn: true

             acceptOnTab: true

             acceptOnPointerLeave: true

             emptyFieldReplacementText: 'Search pattern, prefix with # to match rule tags'

           )

          (SelectionInListModelViewSpec

             name: 'RuleList'

             layout: (LayoutFrame 0 0 28 0 0 1 0 1)

             model: listSelection

             menu: menuHolder

             hasHorizontalScrollBar: true

             hasVerticalScrollBar: true

             listModel: listHolder

             multipleSelectOk: true

             useIndex: false

             highlightMode: line

             postBuildCallback: postBuildList:

           )

          )

       )

     )

    "Modified: / 26-07-2022 / 11:47:26 / Jan Vrany <jan.vrany@labware.com>"

! !

!LintRuleList class methodsFor:'menu specs'!

menu

    "This resource specification was automatically generated

     by the MenuEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the MenuEditor may not be able to read the specification."

    "

     MenuEditor new openOnClass:Tools::LintRuleList andSelector:#menu

     (Menu new fromLiteralArrayEncoding:(Tools::LintRuleList menu)) startUp

    "

    <resource: #menu>

    ^ 

     #(Menu

        (

         (MenuItem

            label: 'Run this Rule Again'

            itemValue: runRuleAgain

          )

         (MenuItem

            label: '-'

          )

         (MenuItem

            label: 'Inspect Rule'

            itemValue: menuInspectRule

          )

         (MenuItem

            label: 'Browse Rule Class'

            itemValue: menuBrowseRuleClass

          )

         )

        nil

        nil

      )

! !

!LintRuleList class methodsFor:'plugIn spec'!

aspectSelectors

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

    "Do not manually edit this. If it is corrupted,

     the UIPainter may not be able to read the specification."

    "Return a description of exported aspects;

     these can be connected to aspects of an embedding application

     (if this app is embedded in a subCanvas)."

    ^ #(

        #environmentHolder

        #inGeneratorHolder

        #listSelection

        #modeHolder

        #outGeneratorHolder

        #selectionHolder

      ).

! !

!LintRuleList methodsFor:'accessing'!

mode

    ^self modeHolder value

    "Created: / 25-08-2010 / 11:33:51 / Jan Vrany <enter your email here>"

!

selection

    | sel |

    sel := self selectionHolder value.

    sel ifNil:[sel := Set new].

    ^sel

    "Created: / 25-08-2010 / 13:26:58 / Jan Vrany <enter your email here>"

!

selection: aCollectionOrNil

    | sel |

    sel := aCollectionOrNil 

                ifNil:[Set new]

                ifNotNil:[aCollectionOrNil asSet].

    self selectionHolder value: sel.

    "Created: / 25-08-2010 / 13:28:43 / Jan Vrany <enter your email here>"

    "Modified: / 25-08-2010 / 15:29:35 / Jan Vrany <enter your email here>"

    "Modified: / 27-02-2013 / 23:33:36 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!LintRuleList methodsFor:'aspects'!

filterHolder

    "return/create the 'filterHolder' value holder (automatically generated)"

    filterHolder isNil ifTrue:[

        filterHolder := LastNameFilter asValue.

        filterHolder addDependent:self.

    ].

    ^ filterHolder

!

filterHolder:something

    "set the 'filterHolder' value holder (automatically generated)"

    |oldValue newValue|

    filterHolder notNil ifTrue:[

        oldValue := filterHolder value.

        filterHolder removeDependent:self.

    ].

    filterHolder := something.

    filterHolder notNil ifTrue:[

        filterHolder addDependent:self.

    ].

    newValue := filterHolder value.

    oldValue ~~ newValue ifTrue:[

        self update:#value with:newValue from:filterHolder.

    ].

!

listHolder

    "return/create the 'ruleList' value holder (automatically generated)"

    listHolder isNil ifTrue:[

        listHolder := ValueHolder new.

    ].

    ^ listHolder

!

listSelection

    "return/create the 'listSelection' value holder (automatically generated)"

    listSelection isNil ifTrue:[

        listSelection := ValueHolder new.

        listSelection addDependent:self.

    ].

    ^ listSelection

!

listSelection:something

    "set the 'listSelection' value holder (automatically generated)"

    |oldValue newValue|

    listSelection notNil ifTrue:[

        oldValue := listSelection value.

        listSelection removeDependent:self.

    ].

    listSelection := something.

    listSelection notNil ifTrue:[

        listSelection addDependent:self.

    ].

    newValue := listSelection value.

    oldValue ~~ newValue ifTrue:[

        self update:#value with:newValue from:listSelection.

    ].

!

modeHolder

    "the mode - can run in select or in display modes.

     select is to choose a set of rules;

     display for presentation of results (in a browser).

     See documentation for details"

    modeHolder isNil ifTrue:[

        modeHolder := ValueHolder with: #display

    ].

    ^modeHolder

    "Modified: / 15-04-2010 / 20:56:36 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

modeHolder:aValueModel

    "the mode - can run in select or in display modes.

     select is to choose a set of rules;

     display for presentation of results (in a browser).

     See documentation for details"

    modeHolder := aValueModel.

!

selectedLintRules

    ^ self selectionHolder

    "Created: / 02-02-2010 / 20:43:39 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

selectedLintRules: anObject

    ^ self selectionHolder: anObject

    "Created: / 02-02-2010 / 20:43:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!LintRuleList methodsFor:'change & update'!

delayedUpdate:something with:aParameter from:changedObject

    "Invoked when an object that I depend upon sends a change notification."

    changedObject == filterHolder ifTrue:[

       LastNameFilter := filterHolder value.

        self updateList.

        ^ self.

    ].

    (changedObject == listSelection) ifTrue:[

        listValid ifFalse:[

            self updateList.

        ].

        ^ self selectionChanged

    ].

    (changedObject == selectionHolder) ifTrue:[

        listView notNil ifTrue:[

            listView invalidate

        ].

        ^self.            

    ].

    super delayedUpdate:something with:aParameter from:changedObject

    "Created: / 26-08-2010 / 11:43:33 / Jan Vrany <enter your email here>"

    "Modified: / 27-02-2013 / 23:40:02 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

enqueueDelayedUpdateList

    super enqueueDelayedUpdateList

!

selectionChanged

    | selection newSelection |

    super selectionChanged.

    self mode == #display ifTrue:[

        selection := self listSelection value.

        selection isEmptyOrNil ifTrue:[

            newSelection := selection

        ] ifFalse:[

            newSelection := selection collect:[:entry|entry rule]

        ].                                 

        self selectionHolder value: newSelection.

"/        listView invalidate

    ].

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

    "Modified: / 17-10-2014 / 00:01:21 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!LintRuleList methodsFor:'event processing'!

buttonPress:button x:x y:y view:aView

    | itemIndex item |

    (button == 1 and:[self modeHolder value == #select]) ifFalse:[

        ^ aView buttonPress:button x:x y:y

    ].

    itemIndex := aView yVisibleToLineNr:y.

    itemIndex isNil ifTrue:[^self].

    itemIndex == 0 ifTrue:[^self].

    itemIndex > aView list size ifTrue:[^self].

    item := aView list at: itemIndex.

    ((aView left + x) between: (item x) and: (item x + 16))

        ifFalse:[^aView buttonPress:button x:x y:y].

    item checked: item checked not.

    aView invalidate

    "Created: / 08-12-2009 / 14:12:38 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 13-10-2014 / 18:38:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

handlesButtonPress:button inView:aView

    ^ listView == aView

        and:[ button == 1 

        and:[ self modeHolder value == #select ] ]

    "Created: / 08-12-2009 / 14:08:49 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 27-11-2014 / 09:18:42 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!LintRuleList methodsFor:'generators'!

makeGenerator

    self modeHolder value == #display ifTrue:[

        ^ Iterator 

            on: [:whatToDo|

                self listSelection value ? #() do:[:each|

                    "/ classes removed (in the meanwhile), but still referenced by name in the lintResults

                    "/ may lead to nil being enumerated here...

                    each failedClasses nonNilElementsDo:whatToDo

                ]

            ]

    ].

    ^ Iterator 

        on: [:whatToDo|

            self selection do:[:rule| whatToDo value: rule]

        ].

    "Modified: / 16-04-2010 / 12:13:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 25-08-2010 / 13:39:51 / Jan Vrany <enter your email here>"

! !

!LintRuleList methodsFor:'hooks'!

commonPostOpen

    super commonPostOpen.

    self updateOutputGenerator.

    "Created: / 16-04-2010 / 11:53:34 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

postBuildList: aView

    listView := aView scrolledView.

    listView delegate: self.