"

jv:libgdbs - GNU Debugger Interface Library

Copyright (C) 2015-now Jan Vrany

Copyright (C) 2020-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: 'jv:vdb' }"

"{ NameSpace: Smalltalk }"

VDBAbstractTreeApplication subclass:#VDBInstructionListApplication

	instanceVariableNames:'instructionListHolder instructionBasicBlocks

		instructionBasicBlocksAnalyzerJob selectedInstructionHolder

		selectedInstructionBranchTargetAddress

		selectedInstructionBasicBlock disassemblableHolder frameHolder

		canExecStepOverInstructionHolder canExecStepIntoInstructionHolder

		canExecBackOverInstructionHolder canExecBackIntoInstructionHolder'

	classVariableNames:'InstructionListCache InstructionBasicBlocksCache'

	poolDictionaries:''

	category:'VDB-UI-Others'

!

!VDBInstructionListApplication class methodsFor:'documentation'!

copyright

"

jv:libgdbs - GNU Debugger Interface Library

Copyright (C) 2015-now Jan Vrany

Copyright (C) 2020-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.

"

! !

!VDBInstructionListApplication class methodsFor:'initialization'!

initialize

    "Invoked at system start or when the class is dynamically loaded."

    "/ please change as required (and remove this comment)

    InstructionListCache := CacheDictionary new: 8.

    InstructionBasicBlocksCache := CacheDictionary new: 8.

! !

!VDBInstructionListApplication class methodsFor:'accessing'!

defaultWindowTitle

    ^ self resources string:'Assembly'

    "Created: / 22-06-2018 / 12:25:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBInstructionListApplication class methodsFor:'menu specs'!

contextMenu

    "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:VDBInstructionListApplication andSelector:#contextMenu

     (Menu new fromLiteralArrayEncoding:(VDBInstructionListApplication contextMenu)) startUp

    "

    <resource: #menu>

    ^ 

     #(Menu

        (

         (MenuItem

            label: 'Context Menu Slice'

            isVisible: true

            submenuChannel: contextMenuApplSlice

            isMenuSlice: true

          )

         (MenuItem

            label: 'Item Menu Slice'

            isVisible: true

            submenuChannel: contextMenuItemSlice

            isMenuSlice: true

          )

         (MenuItem

            label: 'Copy Menu Slice'

            isVisible: true

            submenuChannel: contextMenuCopySlice

            isMenuSlice: true

          )

         (MenuItem

            label: '-'

            isVisible: true

          )

         (MenuItem

            label: 'Inspect Menu Slice'

            isVisible: true

            submenuChannel: contextMenuInspectSlice

            isMenuSlice: true

          )

         (MenuItem

            label: '-'

          )

         (MenuItem

            label: 'Pin Menu'

            itemValue: doPinMenuAs:item:

            isVisible: true

            labelImage: (ResourceRetriever VDBIconLibrary pin 'Pin Menu')

            argument: 'Disassembly Actions'

          )

         )

        nil

        nil

      )

    "Modified: / 01-09-2018 / 14:55:49 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

contextMenuApplSlice

    "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:VDBInstructionListApplication andSelector:#contextMenuApplSlice

     (Menu new fromLiteralArrayEncoding:(VDBInstructionListApplication contextMenuApplSlice)) startUp

    "

    <resource: #menu>

    ^ 

     #(Menu

        (

         (MenuItem

            enabled: canShowCurrentHolder

            label: 'Show Current Instruction'

            itemValue: doShowCurrent

            isVisible: true

          )

         (MenuItem

            enabled: canShowBranchTargetHolder

            label: 'Show Branch Traget'

            itemValue: doShowBranchTarget

            isVisible: true

          )

         (MenuItem

            enabled: canShowSelectionHolder

            label: 'Show Selection'

            itemValue: doShowSelection

            isVisible: true

          )

         (MenuItem

            label: '-'

            isVisible: true

          )

         (MenuItem

            enabled: canExecStepOverInstructionHolder         

            label: 'Step Over'

            itemValue: doExecStepOverInstruction

            isVisible: true

            labelImage: (ResourceRetriever VDBIconLibrary actionStepOver6x16 'Step Over One Instruction')

          )

         (MenuItem

            enabled: canExecStepIntoInstructionHolder

            label: 'Step Into'

            itemValue: doExecStepIntoInstruction

            isVisible: true

            labelImage: (ResourceRetriever VDBIconLibrary actionStepInto6x16 'Step Into One Instruction')

          )

         (MenuItem

            label: '-'

            isVisible: true

          )

         (MenuItem

             enabled: canExecBackOverInstructionHolder

            label: 'Back Over'

            itemValue: doExecBackOverInstruction

            isVisible: true

          )

         (MenuItem

            enabled: canExecBackIntoInstructionHolder

            label: 'Back Into'

            itemValue: doExecBackIntoInstruction

            isVisible: true

          )

         (MenuItem

            label: '-'

            isVisible: true

          )

         )

        nil

        nil

      )

    "Modified: / 01-09-2018 / 22:02:42 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBInstructionListApplication 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)."

    ^ #(

        #debuggerHolder

        #disassemblableHolder 

        #frameHolder

      ).

    "Created: / 20-10-2019 / 23:35:35 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBInstructionListApplication class methodsFor:'utilities'!

instructions: aCollection title: aString

    ^ self new  

        instructionList: aCollection;

        title: aString;

        yourself

    "Created: / 26-06-2018 / 11:03:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBInstructionListApplication methodsFor:'accessing'!

disassemblable

    ^ self disassemblableHolder value

    "Created: / 10-06-2019 / 10:06:17 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

disassemblable: anObject

    self disassemblableHolder value: anObject

    "Created: / 10-06-2019 / 10:06:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

frame

    ^ self frameHolder value

    "Created: / 10-06-2019 / 12:44:27 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

frame: aGDBFrame

    ^ self frameHolder value: aGDBFrame

    "Created: / 10-06-2019 / 12:44:34 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

instructionList

    ^ self instructionListHolder value

    "Created: / 07-08-2018 / 13:27:50 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

instructionList: aCollection

    self instructionListHolder value: aCollection

    "Created: / 22-06-2018 / 12:48:35 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBInstructionListApplication methodsFor:'aspects'!

backgroundColorFor: aVDBPresenter

    <resource: #style (#'instructionListApplication.currentInstructionBackgroundColor'

                       #'instructionListApplication.branchTargetBackgroundColor'

                       #'instructionListApplication.currentBasicBlockBackgroundColor'

                       #'instructionListApplication.successor1BasicBlockBackgroundColor'

                       #'instructionListApplication.successor2BasicBlockBackgroundColor'

                      )>

    (self frame notNil and:[aVDBPresenter isInstructionPresenter]) ifTrue:[ 

        (frameHolder value notNil and:[frameHolder value address == aVDBPresenter address]) ifTrue:[ 

            ^ self styleSheet colorAt: 'instructionListApplication.currentInstructionBackgroundColor' default:[ Color green ].

        ].

    ].

    selectedInstructionBranchTargetAddress notNil ifTrue:[ 

        aVDBPresenter isInstructionPresenter ifTrue:[ 

            aVDBPresenter instruction address = selectedInstructionBranchTargetAddress ifTrue:[ 

                ^ self styleSheet colorAt: 'instructionListApplication.branchTargetBackgroundColor' default:[ Color blue lighter lighter ]

            ].

        ].

        selectedInstructionBasicBlock notNil ifTrue:[ 

            | successor2 |

            successor2 := selectedInstructionBasicBlock successor2.

            (successor2 notNil and:[ successor2 includesAddress: aVDBPresenter address] ) ifTrue:[

                ^ self styleSheet colorAt: 'instructionListApplication.successor2BasicBlockBackgroundColor' default:[ Color blue lighter lighter lighter ]

            ].

        ].

    ].

    selectedInstructionBasicBlock notNil ifTrue:[ 

        (selectedInstructionBasicBlock includesAddress: aVDBPresenter address) ifTrue:[ 

            ^ self styleSheet colorAt: 'instructionListApplication.currentBasicBlockBackgroundColor' default:[ Color yellow lighter lighter ].

        ].

    ].

    "

    VDBInstructionListApplication flushDefaultStyleSheet; defaultStyleSheet

    "

    ^ nil

    "Created: / 26-06-2018 / 11:26:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 21-10-2019 / 01:10:45 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (comment): / 29-10-2021 / 12:07:31 / Jan Vrany <jan.vrany@labware.com>"

!

disassemblableHolder

    disassemblableHolder isNil ifTrue:[

        disassemblableHolder := ValueHolder new.

        disassemblableHolder addDependent:self.

    ].

    ^ disassemblableHolder

    "Created: / 10-06-2019 / 10:03:38 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

disassemblableHolder:something

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

    |oldValue newValue|

    disassemblableHolder notNil ifTrue:[

        oldValue := disassemblableHolder value.

        disassemblableHolder removeDependent:self.

    ].

    disassemblableHolder := something.

    disassemblableHolder notNil ifTrue:[

        disassemblableHolder addDependent:self.

    ].

    newValue := disassemblableHolder value.

    oldValue ~~ newValue ifTrue:[

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

    ].

    "Created: / 10-06-2019 / 10:03:44 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

foregroundColorFor: aVDBAbstractPresenter

    ^ aVDBAbstractPresenter isInstructionsAndSourcePresenter 

        ifTrue:[ Color gray ]

        ifFalse:[ nil ]

    "Created: / 26-06-2018 / 13:07:12 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

frameHolder

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

    frameHolder isNil ifTrue:[

        frameHolder := ValueHolder new.

        frameHolder addDependent:self.

    ].

    ^ frameHolder

!

frameHolder:something

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

    |oldValue newValue|

    frameHolder notNil ifTrue:[

        oldValue := frameHolder value.

        frameHolder removeDependent:self.

    ].

    frameHolder := something.

    frameHolder notNil ifTrue:[

        frameHolder addDependent:self.

    ].

    newValue := frameHolder value.

    oldValue ~~ newValue ifTrue:[

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

    ].

!

instructionListHolder

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

    instructionListHolder isNil ifTrue:[

        instructionListHolder := ValueHolder new.

        instructionListHolder addDependent:self.

    ].

    ^ instructionListHolder

!

instructionListHolder:valueModel

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

    |oldValue newValue|

    instructionListHolder notNil ifTrue:[

        oldValue := instructionListHolder value.

        instructionListHolder removeDependent:self.

    ].

    instructionListHolder := valueModel.

    instructionListHolder notNil ifTrue:[

        instructionListHolder addDependent:self.

    ].

    newValue := instructionListHolder value.

    oldValue ~~ newValue ifTrue:[

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

    ].

!

selectedInstructionHolder

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

    selectedInstructionHolder isNil ifTrue:[

        selectedInstructionHolder := ValueHolder new.

        selectedInstructionHolder addDependent:self.

    ].

    ^ selectedInstructionHolder

!

selectedInstructionHolder:valueModel

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

    |oldValue newValue|

    selectedInstructionHolder notNil ifTrue:[

        oldValue := selectedInstructionHolder value.

        selectedInstructionHolder removeDependent:self.

    ].

    selectedInstructionHolder := valueModel.

    selectedInstructionHolder notNil ifTrue:[

        selectedInstructionHolder addDependent:self.

    ].

    newValue := selectedInstructionHolder value.

    oldValue ~~ newValue ifTrue:[

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

    ].

! !

!VDBInstructionListApplication methodsFor:'change & update'!

enqueueDelayedUpdateBasicBlocks

    self enqueueMessage: #delayedUpdateBasicBlocks

    "Created: / 26-06-2018 / 12:20:20 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 18-02-2019 / 10:23:43 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

enqueueDelayedUpdateButtonEnablements

    self enqueueMessage: #delayedUpdateButtonEnablements

    "Created: / 03-10-2018 / 12:12:43 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 18-02-2019 / 10:23:46 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

update:aspect with:param from:sender

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