Skip to content

Commit

Permalink
<update>[OglClassMenuHandler]: <Final update for dunder methods>
Browse files Browse the repository at this point in the history 
[
* Update demo class creation for differentiation
* Lots of DRY code
]

[#93]
  • Loading branch information
Humberto Sanchez II committed Jan 14, 2024
1 parent ec6a1f6 commit bb32212
Show file tree
Hide file tree
Showing 2 changed files with 140 additions and 60 deletions.
198 changes: 139 additions & 59 deletions src/ogl/ui/OglClassMenuHandler.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
from pyutmodelv2.PyutClass import PyutClass

from pyutmodelv2.enumerations.PyutDisplayParameters import PyutDisplayParameters
from pyutmodelv2.enumerations.PyutDisplayMethods import PyutDisplayMethods

if TYPE_CHECKING:
from ogl.OglClass import OglClass
Expand All @@ -33,21 +34,23 @@

# Menu IDs
[
MENU_TOGGLE_STEREOTYPE,
MENU_TOGGLE_FIELDS,
MENU_TOGGLE_METHODS,
MENU_TOGGLE_METHOD_PARAMETERS,
MENU_TOGGLE_CONSTRUCTOR,
MENU_FIT_FIELDS,
MENU_CUT_SHAPE,
MENU_IMPLEMENT_INTERFACE
] = OglUtils.assignID(8)

HELP_STEREOTYPE: str = 'Set stereotype display on or off'
HELP_FIELDS: str = 'Set fields display on or off'
HELP_METHODS: str = 'Set methods display on or off'
HELP_PARAMETERS: str = 'Set parameter display Unspecified, On or Off'
HELP_CONSTRUCTOR: str = 'Set constructor display Unspecified, On or Off'
ID_TOGGLE_STEREOTYPE,
ID_TOGGLE_FIELDS,
ID_TOGGLE_METHODS,
ID_TOGGLE_METHOD_PARAMETERS,
ID_TOGGLE_CONSTRUCTOR,
ID_TOGGLE_DUNDER_METHODS,
ID_AUTO_SIZE,
ID_CUT_SHAPE,
ID_IMPLEMENT_INTERFACE
] = OglUtils.assignID(9)

HELP_STEREOTYPE: str = 'Set stereotype display on or off'
HELP_FIELDS: str = 'Set fields display on or off'
HELP_METHODS: str = 'Set methods display on or off'
HELP_PARAMETERS: str = 'Set parameter display Unspecified, On or Off'
HELP_CONSTRUCTOR: str = 'Set constructor display Unspecified, On or Off'
HELP_DUNDER_METHODS: str = 'Set dunder method display Unspecified, On or Off'


@dataclass
Expand All @@ -64,12 +67,13 @@ def __init__(self, oglClass: 'OglClass', eventEngine: IOglEventEngine):
self._oglClass: 'OglClass' = oglClass
self._eventEngine: IOglEventEngine = eventEngine

self._contextMenu: Menu = cast(Menu, None)
self._toggleStereotype: MenuItem = cast(MenuItem, None)
self._toggleFields: MenuItem = cast(MenuItem, None)
self._toggleMethods: MenuItem = cast(MenuItem, None)
self._toggleParameters: MenuItem = cast(MenuItem, None)
self._toggleConstructor: MenuItem = cast(MenuItem, None)
self._contextMenu: Menu = cast(Menu, None)
self._toggleStereotype: MenuItem = cast(MenuItem, None)
self._toggleFields: MenuItem = cast(MenuItem, None)
self._toggleMethods: MenuItem = cast(MenuItem, None)
self._toggleParameters: MenuItem = cast(MenuItem, None)
self._toggleConstructor: MenuItem = cast(MenuItem, None)
self._toggleDunderMethods: MenuItem = cast(MenuItem, None)

self._createContextMenu()

Expand All @@ -83,37 +87,38 @@ def popupMenu(self, event: MouseEvent):
y: int = event.GetY()
self.logger.debug(f'OglClassMenuHandler - x,y: {x},{y}')

# TODO: Cheater, cheater pumpkin eater; Have to fix this
# noinspection PyProtectedMember
frame = self._oglClass._diagram.GetPanel()
frame = self._oglClass.GetDiagram().GetPanel()
frame.PopupMenu(self._contextMenu, x, y)

def _createContextMenu(self):

menu: Menu = Menu()

self._toggleStereotype = menu.Append(id=MENU_TOGGLE_STEREOTYPE, item="Toggle stereotype display", helpString=HELP_STEREOTYPE, kind=ITEM_CHECK)
self._toggleFields = menu.Append(id=MENU_TOGGLE_FIELDS, item="Toggle fields display", helpString=HELP_FIELDS, kind=ITEM_CHECK)
self._toggleMethods = menu.Append(id=MENU_TOGGLE_METHODS, item="Toggle methods display", helpString=HELP_METHODS, kind=ITEM_CHECK)
self._toggleParameters = menu.Append(id=MENU_TOGGLE_METHOD_PARAMETERS, item=" ", helpString=HELP_PARAMETERS, kind=ITEM_NORMAL)
self._toggleConstructor = menu.Append(id=MENU_TOGGLE_CONSTRUCTOR, item=" ", helpString=HELP_CONSTRUCTOR, kind=ITEM_NORMAL)
self._toggleStereotype = menu.Append(id=ID_TOGGLE_STEREOTYPE, item="Toggle stereotype display", helpString=HELP_STEREOTYPE, kind=ITEM_CHECK)
self._toggleFields = menu.Append(id=ID_TOGGLE_FIELDS, item="Toggle fields display", helpString=HELP_FIELDS, kind=ITEM_CHECK)
self._toggleMethods = menu.Append(id=ID_TOGGLE_METHODS, item="Toggle methods display", helpString=HELP_METHODS, kind=ITEM_CHECK)
self._toggleParameters = menu.Append(id=ID_TOGGLE_METHOD_PARAMETERS, item=" ", helpString=HELP_PARAMETERS, kind=ITEM_NORMAL)
self._toggleConstructor = menu.Append(id=ID_TOGGLE_CONSTRUCTOR, item=" ", helpString=HELP_CONSTRUCTOR, kind=ITEM_NORMAL)
self._toggleDunderMethods = menu.Append(id=ID_TOGGLE_DUNDER_METHODS, item=" ", helpString=HELP_DUNDER_METHODS, kind=ITEM_NORMAL)

menu.Append(MENU_FIT_FIELDS, 'Fit Fields', 'Fit to see all class fields')
menu.Append(MENU_CUT_SHAPE, 'Cut shape', 'Cut this shape')
menu.Append(MENU_IMPLEMENT_INTERFACE, 'Implement Interface', 'Use Existing interface or create new one')
menu.Append(ID_AUTO_SIZE, 'Auto Size', 'Resize to see the entire class')
menu.Append(ID_CUT_SHAPE, 'Cut shape', 'Cut this shape')
menu.Append(ID_IMPLEMENT_INTERFACE, 'Implement Interface', 'Use Existing interface or create new one')

# Callbacks
menu.Bind(EVT_MENU, self.OnMenuClick, id=MENU_TOGGLE_STEREOTYPE)
menu.Bind(EVT_MENU, self.OnMenuClick, id=MENU_TOGGLE_FIELDS)
menu.Bind(EVT_MENU, self.OnMenuClick, id=MENU_TOGGLE_METHODS)
menu.Bind(EVT_MENU, self.OnMenuClick, id=MENU_FIT_FIELDS)
menu.Bind(EVT_MENU, self.OnMenuClick, id=MENU_CUT_SHAPE)
menu.Bind(EVT_MENU, self.OnMenuClick, id=MENU_IMPLEMENT_INTERFACE)
menu.Bind(EVT_MENU, self.onDisplayParametersClick, id=MENU_TOGGLE_METHOD_PARAMETERS)
menu.Bind(EVT_MENU, self._onMenuClick, id=ID_TOGGLE_STEREOTYPE)
menu.Bind(EVT_MENU, self._onMenuClick, id=ID_TOGGLE_FIELDS)
menu.Bind(EVT_MENU, self._onMenuClick, id=ID_TOGGLE_METHODS)
menu.Bind(EVT_MENU, self._onMenuClick, id=ID_AUTO_SIZE)
menu.Bind(EVT_MENU, self._onMenuClick, id=ID_CUT_SHAPE)
menu.Bind(EVT_MENU, self._onMenuClick, id=ID_IMPLEMENT_INTERFACE)
menu.Bind(EVT_MENU, self._onDisplayParametersClick, id=ID_TOGGLE_METHOD_PARAMETERS)
menu.Bind(EVT_MENU, self._onDisplayConstructorClick, id=ID_TOGGLE_CONSTRUCTOR)
menu.Bind(EVT_MENU, self._onDisplayDunderMethodsClick, id=ID_TOGGLE_DUNDER_METHODS)

self._contextMenu = menu

def OnMenuClick(self, event: CommandEvent):
def _onMenuClick(self, event: CommandEvent):
"""
Callback for the popup menu on the class
Expand All @@ -123,26 +128,26 @@ def OnMenuClick(self, event: CommandEvent):
pyutClass: PyutClass = cast(PyutClass, self._oglClass.pyutObject)
eventId: int = event.GetId()

if eventId == MENU_TOGGLE_STEREOTYPE:
if eventId == ID_TOGGLE_STEREOTYPE:
pyutClass.displayStereoType = not pyutClass.displayStereoType
self._oglClass.autoResize()
elif eventId == MENU_TOGGLE_METHODS:
elif eventId == ID_TOGGLE_METHODS:
pyutClass.showMethods = not pyutClass.showMethods # flip it!! too cute
self._oglClass.autoResize()
elif eventId == MENU_TOGGLE_FIELDS:
elif eventId == ID_TOGGLE_FIELDS:
pyutClass.showFields = not pyutClass.showFields # flip it!! too cute
self._oglClass.autoResize()
elif eventId == MENU_FIT_FIELDS:
elif eventId == ID_AUTO_SIZE:
self._oglClass.autoResize()
elif eventId == MENU_CUT_SHAPE:
elif eventId == ID_CUT_SHAPE:
self._eventEngine.sendEvent(OglEventType.CutOglClass, shapeToCut=self._oglClass)
elif eventId == MENU_IMPLEMENT_INTERFACE:
elif eventId == ID_IMPLEMENT_INTERFACE:
self._eventEngine.sendEvent(OglEventType.RequestLollipopLocation, requestShape=self._oglClass)
else:
event.Skip()

# noinspection PyUnusedLocal
def onDisplayParametersClick(self, event: CommandEvent):
def _onDisplayParametersClick(self, event: CommandEvent):
"""
This menu item has its own handler because this option is tri-state
Expand All @@ -154,17 +159,44 @@ def onDisplayParametersClick(self, event: CommandEvent):
"""
pyutClass: PyutClass = cast(PyutClass, self._oglClass.pyutObject)
displayParameters: PyutDisplayParameters = pyutClass.displayParameters
self.logger.debug(f'Current: {displayParameters=}')

if displayParameters == PyutDisplayParameters.UNSPECIFIED:
pyutClass.displayParameters = PyutDisplayParameters.WITH_PARAMETERS
elif displayParameters == PyutDisplayParameters.WITH_PARAMETERS:
pyutClass.displayParameters = PyutDisplayParameters.WITHOUT_PARAMETERS
elif displayParameters == PyutDisplayParameters.WITHOUT_PARAMETERS:
pyutClass.displayParameters = PyutDisplayParameters.UNSPECIFIED
else:
assert False, 'Unknown display type'
self.logger.warning(f'New: {pyutClass.displayParameters=}')
self.logger.debug(f'{displayParameters=}')

match displayParameters:
case PyutDisplayParameters.UNSPECIFIED:
pyutClass.displayParameters = PyutDisplayParameters.WITH_PARAMETERS
case PyutDisplayParameters.WITH_PARAMETERS:
pyutClass.displayParameters = PyutDisplayParameters.WITHOUT_PARAMETERS
case PyutDisplayParameters.WITHOUT_PARAMETERS:
pyutClass.displayParameters = PyutDisplayParameters.UNSPECIFIED
case _:
assert False, 'Unknown display type'

self.logger.debug(f'{pyutClass.displayParameters=}')

# noinspection PyUnusedLocal
def _onDisplayConstructorClick(self, event: CommandEvent):
"""
Args:
event:
"""
pyutClass: PyutClass = cast(PyutClass, self._oglClass.pyutObject)
displayConstructor: PyutDisplayMethods = pyutClass.displayConstructor

pyutClass.displayConstructor = self._nextDisplayValue(pyutDisplayValue=displayConstructor)

# noinspection PyUnusedLocal
def _onDisplayDunderMethodsClick(self, event: CommandEvent):
"""
Args:
event:
"""
pyutClass: PyutClass = cast(PyutClass, self._oglClass.pyutObject)
displayDunderMethods: PyutDisplayMethods = pyutClass.displayDunderMethods

pyutClass.displayDunderMethods = self._nextDisplayValue(pyutDisplayValue=displayDunderMethods)
self.logger.debug(f'{displayDunderMethods=}')

def _setMenuItemValues(self, pyutClass: PyutClass):

Expand All @@ -173,6 +205,8 @@ def _setMenuItemValues(self, pyutClass: PyutClass):
self._toggleMethods.Check(pyutClass.showMethods)

self._setTheTriStateDisplayParametersMenuItem(pyutClass=pyutClass)
self._setTheTriStateDisplayConstructorMenuItem(pyutClass=pyutClass)
self._setTheTriStateDisplayDunderMethodsMenuItem(pyutClass=pyutClass)

def _setTheTriStateDisplayParametersMenuItem(self, pyutClass: PyutClass):

Expand All @@ -187,8 +221,54 @@ def _setTheTriStateDisplayParametersMenuItem(self, pyutClass: PyutClass):
case PyutDisplayParameters.WITHOUT_PARAMETERS:
triStateData = TriStateData(bitMap=OglConstants.doNotDisplayIcon(), menuText='Do Not Display Parameters')
case _:
self.logger.warning(f'Unknown Parameter DisplayType: {displayParameters}')
self.logger.warning(f'Unknown Parameter Display type: {displayParameters}')
assert False, 'Developer error'

itemToggleParameters.SetBitmap(triStateData.bitMap)
itemToggleParameters.SetItemLabel(triStateData.menuText)

def _setTheTriStateDisplayConstructorMenuItem(self, pyutClass: PyutClass):

displayConstructor: PyutDisplayMethods = pyutClass.displayConstructor
itemToggleConstructor: MenuItem = self._toggleConstructor

triStateData: TriStateData = self._getTriStateData(pyutDisplayValue=displayConstructor, displayName='Constructor')

itemToggleConstructor.SetBitmap(triStateData.bitMap)
itemToggleConstructor.SetItemLabel(triStateData.menuText)

def _setTheTriStateDisplayDunderMethodsMenuItem(self, pyutClass: PyutClass):

displayDunderMethods: PyutDisplayMethods = pyutClass.displayDunderMethods
itemToggleConstructor: MenuItem = self._toggleDunderMethods

triStateData: TriStateData = self._getTriStateData(pyutDisplayValue=displayDunderMethods, displayName='Dunder Methods')

itemToggleConstructor.SetBitmap(triStateData.bitMap)
itemToggleConstructor.SetItemLabel(triStateData.menuText)

def _getTriStateData(self, pyutDisplayValue: PyutDisplayMethods, displayName: str) -> TriStateData:

match pyutDisplayValue:

case PyutDisplayMethods.UNSPECIFIED:
return TriStateData(bitMap=OglConstants.unspecifiedDisplayIcon(), menuText=f'Unspecified {displayName} Display')
case PyutDisplayMethods.DISPLAY:
return TriStateData(bitMap=OglConstants.displayIcon(), menuText=f'Display {displayName}')
case PyutDisplayMethods.DO_NOT_DISPLAY:
return TriStateData(bitMap=OglConstants.doNotDisplayIcon(), menuText=f'Do Not Display {displayName}')
case _:
self.logger.warning(f'Unknown Method Display type: {pyutDisplayValue}')
assert False, 'Developer error'

def _nextDisplayValue(self, pyutDisplayValue: PyutDisplayMethods) -> PyutDisplayMethods:

match pyutDisplayValue:
case PyutDisplayMethods.UNSPECIFIED:
return PyutDisplayMethods.DISPLAY
case PyutDisplayMethods.DISPLAY:
return PyutDisplayMethods.DO_NOT_DISPLAY
case PyutDisplayMethods.DO_NOT_DISPLAY:
return PyutDisplayMethods.UNSPECIFIED
case _:
assert False, "Unknown method display type"
2 changes: 1 addition & 1 deletion tests/demo/DemoOglElements.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ def _displayOglClass(self):
pyutClass.methods = PyutMethods([constructorMethod, pyutMethod, dunderStrMethod])

classDimensions: OglDimensions = self._oglPreferences.classDimensions
oglClass: OglClass = OglClass(pyutClass, w=classDimensions.width, h=classDimensions.height)
oglClass: OglClass = OglClass(pyutClass, w=classDimensions.width + 85, h=classDimensions.height + 15)

self._addToDiagram(oglObject=oglClass)

Expand Down

0 comments on commit bb32212

Please sign in to comment.