EcuZoneComboBox.py

"""
   EcuZoneComboBox.py

   Copyright (C) 2024 - 2025 Marc Postema (mpostema09 -at- gmail.com)

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; either version 2
   of the License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
   Or, point your browser to http://www.gnu.org/copyleft/gpl.html
"""

from PySide6.QtGui import QKeyEvent, QAction, QIcon, QPalette
from PySide6.QtCore import Qt, Slot, QEvent, QSize, QPoint
from PySide6.QtWidgets import QComboBox, QMenu

from i18n import i18n
import PyPSADiagGUI

class EcuZoneComboBox(QComboBox):
    """
    """
    initialValue = 0
    newValue = 0
    style = ""
    zoneObject = {}
    itemReadOnly = False
    def __init__(self, parent, zoneObject: dict, readOnly: bool):
        super(EcuZoneComboBox, self).__init__(parent)
        self.setStyleSheet("combobox-popup: 3;")
        self.setFocusPolicy(Qt.StrongFocus)
        self.itemReadOnly = readOnly
        self.zoneObject = zoneObject
        # Fill Combo Box
        for paramObject in self.zoneObject["params"]:
            name = i18n().tr(paramObject["name"])
            if "mask" in paramObject:
                # Store as string with "b:" prefix to avoid Qt int64 overflow
                self.addItem(name, "b:" + paramObject["mask"])
            else:
                # Store as string with "h:" prefix for hex values
                self.addItem(name, "h:" + paramObject["value"])
        self.setCurrentIndex(0)

        # Notify changes, to change color if changed
        self.currentIndexChanged.connect(self.indexChanged)

        # Make Undo possible
        self.setContextMenuPolicy(Qt.CustomContextMenu)
        self.customContextMenuRequested.connect(self.contextMenu)

        # Save current style-sheet
        self.style = self.styleSheet()

    @Slot()
    def indexChanged(self, index):
        if index != self.newValue:
            self.newValue = index

        if self.newValue == self.initialValue:
            self.setStyleSheet(self.style)
        else:
            self.setStyleSheet("combobox-popup: 3; background-color: rgb(42, 130, 218)")

    @Slot()
    def contextMenu(self, pos: QPoint):
        contextMenu = QMenu(self)
        undoIcon = QIcon.fromTheme(QIcon.ThemeIcon.EditUndo)
        undoAction = QAction(undoIcon, i18n().tr("&Undo"), contextMenu)
        contextMenu.addAction(undoAction)

        action = contextMenu.exec_(self.mapToGlobal(pos))
        if action == undoAction:
            self.setCurrentIndex(self.initialValue)

    def getItemDataAsInt(self, index: int) -> int:
        """Convert stored string data back to integer"""
        data = self.itemData(index)
        if isinstance(data, str):
            if data.startswith("b:"):
                return int(data[2:], 2)
            elif data.startswith("h:"):
                return int(data[2:], 16)
        return int(data)

    def event(self, event: QEvent):
        if event.type() == QEvent.KeyPress:
            keyEvent = QKeyEvent(event)
            # When ESC -> Clear focus
            if keyEvent.key() == Qt.Key_Escape:
                # @TODO: Maybe give option to undo changes?
                self.clearFocus()
                return True
        return super().event(event)

    # Prevent scrolling without focus
    def wheelEvent(self, e):
        if self.hasFocus():
            super().wheelEvent(e);

    def getDescriptionName(self):
        return self.zoneObject["name"]

    def getCorrespondingByte(self):
        return self.zoneObject["byte"]

    def getCorrespondingByteSize(self):
        if "mask" in self.zoneObject:
            bits = int(self.zoneObject["mask"], 2).bit_length()
            # round up to the nearest bit
            return (bits + 7) // 8
        return 1

    def setCurrentIndex(self, val):
        self.initialValue = val;
        super().setCurrentIndex(val)

    def isComboBoxChanged(self, virginWrite: bool):
        return self.isEnabled() and not(self.itemReadOnly) and self.initialValue != self.currentIndex()

    def getValuesAsCSV(self):
        value = "Disabled"
        if self.isEnabled():
            index = self.currentIndex()
            value = "%0.2X" % self.getItemDataAsInt(index)
        return value

    def clearZoneValue(self):
        self.initialValue = 0
        self.setCurrentIndex(0)

    def getZoneAndHex(self, virginWrite: bool):
        value = "None"
        if self.isComboBoxChanged(virginWrite):
            index = self.currentIndex()
            value = "%0.2X" % self.getItemDataAsInt(index)
        return value

    def update(self, byte: str):
        index = self.currentIndex()
        mask = int(self.zoneObject["mask"], 2)
        value = (int(byte, 16) & ~mask) | self.getItemDataAsInt(index)
        size = self.getCorrespondingByteSize() * 2
        byte = f"%0.{size}X" % value
        return byte

    def changeZoneOption(self, data: str, valueType: str):
        value = int(data, 16)
        if "mask" in self.zoneObject:
            byteData = []
            for i in range(0, len(data), 2):
                byteData.append(data[i:i + 2])

            # Is this option used for this Zone (NAC/RCC JSON Files)
            if "zoneLength" in self.zoneObject:
                zoneLength = self.zoneObject["zoneLength"]
                if isinstance(zoneLength, list):
                    if len(byteData) not in zoneLength:
                        return 2
                else:
                    if zoneLength != len(byteData):
                        return 2

            byteNr = self.zoneObject["byte"]
            mask = int(self.zoneObject["mask"], 2)
            size = self.getCorrespondingByteSize()

            # Integrity wrong, size does not match
            if (byteNr + size) > len(byteData):
                return 1

            currByteData = byteData[byteNr : byteNr + size]
            currData = ""
            for i in range(len(currByteData)):
                currData += currByteData[i]

            value = int(currData, 16) & mask
        else:
            print(" No mask")
            print("  Obj   : " + str(self.zoneObject))

        # Find the Option (byte) from the ComboBox
        foundMatch = False
        for i in range(self.count()):
            if self.getItemDataAsInt(i) == value:
                self.setCurrentIndex(i)
                foundMatch = True
                break

        # Did we find item, else add it to combobox
        if foundMatch == False:
            print("** Add missing combobox item " + "0x%0.2X" % value + " **")
            self.addItem("** 0x%0.2X" % value, "h:%X" % value)
            self.setCurrentIndex(self.count() - 1)

        return 0