gui.py

import configparser
import re
import sys
from subprocess import call
from PyQt5 import QtGui, QtCore
from PyQt5.QtCore import pyqtRemoveInputHook, QRect
from PyQt5.QtWidgets import (QPushButton, QCheckBox, QWidget, QVBoxLayout, QLabel, QGroupBox,
    QHBoxLayout, QLineEdit, QRadioButton, QGridLayout, QComboBox, QFileDialog, QApplication,
    QTabWidget, QInputDialog, QScrollArea, QMessageBox, QButtonGroup, QFormLayout)

import options
import randomizer

print('Loading Complete! Any errors shown here should be reported to Green Knight')

if sys.version_info[0] < 3:
    raise Exception('Python 3 or a more recent version is required. Report this to Green Knight')

# Extended QButton widget to hold flag value - NOT USED PRESENTLY
class FlagButton(QPushButton):
    def __init__(self, text, value):
        super(FlagButton, self).__init__()
        self.setText(text)
        self.value = value

# Extended QCheckBox widget to hold flag value - CURRENTLY USED
class FlagCheckBox(QWidget):
    def __init__(self, text, value, description):
        super().__init__()
        layout = QHBoxLayout()
        self._checkbox = QCheckBox()
        self._checkbox.setText(text)
        self._checkbox.value = value
        self._checkbox.setStyleSheet('min-width: 100px;')
        self._label = QLabel(description)
        self._label.setWordWrap(True)
        self._label.setAlignment(QtCore.Qt.AlignLeft)
        self._label.setStyleSheet('min-width: 400px')
        layout.addWidget(self._checkbox)
        layout.addWidget(self._label)
        layout.addStretch()
        layout.setContentsMargins(4, 4, 4, 4)
        self.setLayout(layout)

    @property
    def clicked(self):
        return self._checkbox.clicked


    @property
    def value(self):
        return self._checkbox.value

    @property
    def isChecked(self):
        return self._checkbox.isChecked

    def setChecked(self, value: bool):
        self._checkbox.setChecked(value)

class Window(QWidget):

    def __init__(self):
        super().__init__()

        # window geometry data
        self.title = 'Beyond Chaos EX Randomizer'
        self.left = 200
        self.top = 200
        self.width = 740
        self.height = 800

        # values to be sent to randomizer
        self.romText = ''
        self.version = '5'
        self.mode = 'normal' # default
        self.seed = ''
        self.flags = ''

        # dictionaries to hold flag data
        self.aesthetic = {}
        self.experimental = {}
        self.gamebreaking = {}
        self.major = {}
        self.makeover ={}
        self.minor = {}
        self.simple = {}
        self.dictionaries = [self.simple, self.aesthetic, self.major,
                             self.minor, self.experimental, self.gamebreaking]

        # dictionary? of saved presets
        self.savedPresets = {}

        # ui elements
        self.flagString = QLineEdit()
        self.comboBox = QComboBox()
        self.tab1 = QWidget()
        self.tab2 = QWidget()
        self.tab3 = QWidget()
        self.tab4 = QWidget()
        self.tab5 = QWidget()
        self.tab6 = QWidget()
        self.middleLeftGroupBox = QGroupBox()
        self.tablist = [self.tab1, self.tab2, self.tab3, self.tab4, self.tab5, self.tab6]

        # ----------- Begin buiding program/window ------------------------------

        # pull data from files
        self.initCodes()
        self.compilePresets()

        # create window using geometry data
        self.InitWindow()

        self.romInput.setText(self.romText)
        self.updateDictionaries()
        self.updateFlagString()
        self.updateFlagCheckboxes()
        self.updateMakeoverRadios()

    def InitWindow(self):
        self.setWindowTitle(self.title)
        self.setGeometry(self.left, self.top, self.width, self.height)

        # build the UI
        self.CreateLayout()

        # show program onscreen
        self.show()

    def CreateLayout(self):
        # Primary Vertical Box Layout
        vbox = QVBoxLayout()

        titleLabel = QLabel('Beyond Chaos EX Randomizer (v5.0.0)')
        font = QtGui.QFont('Arial', 24, QtGui.QFont.Black)
        titleLabel.setFont(font)
        titleLabel.setAlignment(QtCore.Qt.AlignCenter)
        vbox.addWidget(titleLabel)


        vbox.addLayout(self.GroupBoxOneLayout()) # Adding first/top groupbox to the layout
        vbox.addLayout(self.GroupBoxTwoLayout()) # Adding second/middle groupbox
        vbox.addLayout(self.GroupBoxThreeLayout()) # Adding third/bottom groupbox

        self.setLayout(vbox)

    # Top groupbox consisting of ROM selection, and Seed number input
    def GroupBoxOneLayout(self):
        TopHBox = QHBoxLayout()

        romLabel = QLabel('ROM:')
        TopHBox.addWidget(romLabel)
        self.romInput = QLineEdit()
        self.romInput.setPlaceholderText('Required - Will save to presets')
        self.romInput.setReadOnly(True)
        TopHBox.addWidget(self.romInput)

        browseButton = QPushButton('Browse')
        browseButton.clicked.connect(lambda: self.openFileChooser())
        TopHBox.addWidget(browseButton)
        seedLabel = QLabel('Seed:')
        TopHBox.addWidget(seedLabel)
        self.seedInput = QLineEdit()
        self.seedInput.setPlaceholderText('Optional - WILL NOT SAVE TO PRESETS!')
        TopHBox.addWidget(self.seedInput)

        return TopHBox


    # Middle groupbox of sub-groupboxes. Consists of left section (game mode selection)
    #   and right section (flag selection -> tab-sorted)
    def GroupBoxTwoLayout(self):
        middleHBox = QHBoxLayout()

        # ------------ Part one (left side) of middle section - Mode radio buttons -------

        self.middleLeftGroupBox.setTitle('Select Mode')
        midLeftVBox = QVBoxLayout()

        radioButton = QRadioButton('Normal (Default)')
        radioButton.setToolTip('Play through the normal story')
        radioButton.setChecked(True)
        radioButton.mode = 'normal'
        radioButton.clicked.connect(lambda: self.updateRadioSelection('normal'))
        midLeftVBox.addWidget(radioButton)

        radioButton = QRadioButton('Ancient Cave')
        radioButton.setToolTip('Play though a long randomized dungeon')
        radioButton.mode = 'ancientcave'
        radioButton.clicked.connect(lambda: self.updateRadioSelection('ancientcave'))
        midLeftVBox.addWidget(radioButton)

        radioButton = QRadioButton('Speed Cave')
        radioButton.setToolTip('Play through a medium-sized randomized dungeon')
        radioButton.mode = 'speedcave'
        radioButton.clicked.connect(lambda: self.updateRadioSelection('speedcave'))
        midLeftVBox.addWidget(radioButton)

        radioButton = QRadioButton('Race Cave')
        radioButton.setToolTip('Play through a short randomized dungeon')
        radioButton.mode = 'racecave'
        radioButton.clicked.connect(lambda: self.updateRadioSelection('racecave'))
        midLeftVBox.addWidget(radioButton)

        radioButton = QRadioButton('Kefka@Narshe')
        radioButton.setToolTip('Play the normal story up to Kefka at Narshe, '
                               'with extra wackiness. Intended for racing.')
        radioButton.mode = 'katn'
        radioButton.clicked.connect(lambda: self.updateRadioSelection('katn'))
        midLeftVBox.addWidget(radioButton)

        radioButton = QRadioButton('Dragon Hunt')
        radioButton.setToolTip('Kill all 8 dragons in the World of Ruin. Intended for racing.')
        radioButton.mode = 'dragonhunt'
        radioButton.clicked.connect(lambda: self.updateRadioSelection('dragonhunt'))
        midLeftVBox.addWidget(radioButton)

        self.middleLeftGroupBox.setLayout(midLeftVBox)
        # ------------- Part one (left side) end ----------------------------------------------

        # ------------- Part two (right side) of middle section - Flag tabs -----------------
        middleRightGroupBox = QGroupBox('Flag Selection')
        tabVBoxLayout = QVBoxLayout()
        tabs = QTabWidget()
        tabNames = ['Simple', 'Aesthetic', 'Major', 'Minor', 'Experimental', 'Gamebreaking']

        ############## Only checkboxes, no inline description ###############

        # # loop to add tab objects to 'tabs' TabWidget
        #
        # for tabObj, name in zip(self.tablist, tabNames):
        #     tabs.addTab(tabObj, name)
        #
        # for t, d in zip(self.tablist, self.dictionaries):
        #     flagGrid = QGridLayout()
        #     count = 0
        #     for flagname, flagdesc in d.items():
        #         cbox = FlagCheckBox(flagname, flagname)
        #         cbox.setCheckable(True)
        #         if flagdesc['checked']:
        #             cbox.isChecked = True
        #         cbox.setToolTip(flagdesc['explanation'])
        #         cbox.clicked.connect(lambda checked : self.flagButtonClicked())
        #         flagGrid.addWidget(cbox, count / 3, count % 3)
        #         count += 1
        #     t.setLayout(flagGrid)


        ############## Checkboxes and inline descriptions #####################
        tags = sorted(options.makeover_tags)

        makeover_group = QGroupBox()
        makeover_layout = QFormLayout()
        
        groups=dict()
        for tag in tags:

            h = QHBoxLayout()
            groups[tag] = QButtonGroup(makeover_group)
            groups[tag].setExclusive(True)
            for level in ['none', 'less', 'normal', 'more', 'only']:
                radioButton = QRadioButton(f'{level}')
                radioButton.setObjectName(f'{level}{tag}')

                radioButton.setChecked(level == 'normal' if tag != 'soup' else level =='only' )
                radioButton.clicked.connect(lambda checked, tag=tag, level=level: self.updateMakeoverTag(tag, level))
                h.addWidget(radioButton)
                groups[tag].addButton(radioButton)

            makeover_layout.addRow(tag, h)
        makeover_group.setLayout(makeover_layout)
        makeover_group.setStyleSheet('max-width: 500px')


        # loop to add tab objects to 'tabs' TabWidget
        for t, d, names in zip(self.tablist, self.dictionaries, tabNames):
            tabObj = QScrollArea()
            tabs.addTab(tabObj, names)
            tablayout = QVBoxLayout()
            for flagname, flagdesc in d.items():
                cbox = FlagCheckBox(flagname, flagname, flagdesc['explanation'])
                tablayout.addWidget(cbox)
                #cbox.setCheckable(True)
                #cbox.setToolTip(flagdesc['explanation'])
                cbox.clicked.connect(lambda checked: self.flagButtonClicked())
            if names == 'Aesthetic':
                tablayout.addWidget(makeover_group)
            t.setLayout(tablayout)
            tablayout.addStretch(1)
            tablayout.setSpacing(0)
            tabObj.setWidgetResizable(True)
            tabObj.setWidget(t)

        tabVBoxLayout.addWidget(tabs)
        #----------- tabs done ----------------------------

        # this is the line in the layout that displays the string of selected flags
        #   and the button to save those flags
        widgetV = QWidget()
        widgetVBoxLayout = QVBoxLayout()
        widgetV.setLayout(widgetVBoxLayout)

        widgetVBoxLayout.addWidget(QLabel('Text-string of selected flags:'))

        self.flagString.setReadOnly(True)
        self.flagString.setStyleSheet('background:lightgrey;')
        widgetVBoxLayout.addWidget(self.flagString)

        saveButton = QPushButton('Save flags selection')
        saveButton.clicked.connect(lambda: self.saveSeed())
        widgetVBoxLayout.addWidget(saveButton)

        # This part makes a group box and adds the selected-flags display
        #   and a button to clear the UI
        flagTextHBox = QHBoxLayout()
        flagTextHBox.addWidget(widgetV)
        clearUiButton = QPushButton('Reset')
        clearUiButton.setStyleSheet('font-size:12px; height:60px')
        clearUiButton.clicked.connect(lambda: self.clearUI())
        flagTextHBox.addWidget(clearUiButton)

        tabVBoxLayout.addLayout(flagTextHBox)
        middleRightGroupBox.setLayout(tabVBoxLayout)
        # ------------- Part two (right) end ---------------------------------------


        # add widgets to HBoxLayout and assign to middle groupbox layout
        middleHBox.addWidget(self.middleLeftGroupBox)
        middleHBox.addWidget(middleRightGroupBox)

        return middleHBox


    # Bottom groupbox consisting of saved seeds selection box, and button to generate seed
    def GroupBoxThreeLayout(self):
        bottomHBox = QHBoxLayout()

        bottomHBox.addWidget(QLabel('Saved flag selection: '))

        self.comboBox.addItem('Select a preset')
        for string in self.savedPresets:
            self.comboBox.addItem(string)
        self.comboBox.currentTextChanged.connect(lambda: self.updatePresetDropdown())
        bottomHBox.addWidget(self.comboBox)


        deleteButton = QPushButton('Delete selection')
        deleteButton.clicked.connect(lambda: self.deleteSeed())
        bottomHBox.addWidget(deleteButton)

        bottomHBox.addStretch(1)

        generateButton = QPushButton('Generate Seed')
        generateButton.setStyleSheet('font:bold; font-size:18px; height:48px; width:150px')
        generateButton.clicked.connect(lambda: self.generateSeed())
        bottomHBox.addWidget(generateButton)

        return bottomHBox

    # --------------------------------------------------------------------------------
    # -------------- NO MORE LAYOUT DESIGN PAST THIS POINT ---------------------------
    # --------------------------------------------------------------------------------

    # (At startup) Opens reads code flags/descriptions and
    #   puts data into separate dictionaries
    def initCodes(self):
        for code in options.NORMAL_CODES + options.MAKEOVER_MODIFIER_CODES:
            if code.category == 'aesthetic':
                d = self.aesthetic
            elif code.category == 'experimental':
                d = self.experimental
            elif code.category == 'gamebreaking':
                d = self.gamebreaking
            elif code.category == 'major':
                d = self.major
            elif code.category == 'minor':
                d = self.minor
            elif code.category == 'makeover':
                continue
            else:
                print(f'Code {code.name} does not have a valid category.')
                continue

            d[code.name] = {'explanation': code.long_description, 'checked': False}

        self.makeover = {tag: 'normal' if tag != 'soup' else 'only' for tag in options.makeover_tags}

        for flag in sorted(options.ALL_FLAGS):
            self.simple[flag.name] = {'explanation': flag.description, 'checked': True}


    # opens input dialog to get a name to assign a desired seed flagset, then saves flags and selected mode to the cfg file
    def saveSeed(self):
        text, okPressed = QInputDialog.getText(self, 'Save Seed', 'Enter a name for this flagset', QLineEdit.Normal, '')
        if okPressed and text != '':
            self.savedPresets[text] = f'{self.version}.{self.mode}.{self.flags}.'
            config = configparser.ConfigParser()
            config.read('bcex.cfg')
            config['presets'] = self.savedPresets
            with open('bcex.cfg', 'w') as cfg_file:
                config.write(cfg_file)
            self.comboBox.addItem(text) # update drop-down list with new preset
            index = self.comboBox.findText(text)
            self.comboBox.setCurrentIndex(index)


    # delete preset. Dialog box confirms users choice to delete. check is done to ensure file
    #   exists before deletion is attempted.
    def deleteSeed(self):
        seed = self.comboBox.currentText()

        if not seed == 'Select a preset':
            response = QMessageBox.question(self, 'Delete confimation', f"Do you want to delete '{seed}'?",
                                            QMessageBox.Yes | QMessageBox.No, QMessageBox.No)
            if response == QMessageBox.Yes:
                del self.savedPresets[seed]
                self.comboBox.removeItem(self.comboBox.findText(seed))


    # when preset is selected from dropdown list, load the data into dictionaries
    #   and set the UI to reflect the settings stored in the preset.
    # if the only saved preset is deleted, or user selects initial value of
    #   'Select a preset' then the UI is reset (mainly to avoid runtime errors)
    def updatePresetDropdown(self):
        if self.comboBox.currentIndex() != 0: # text = 'Select a preset'
            selectedPreset = self.comboBox.currentText()
            self.loadPreset(selectedPreset)
        else:
            self.clearUI()


    # clear/reset UI and clear window object variables. Then reset data dictionaries
    #   to the default state of unset/unchecked flags and mode
    def clearUI(self):
        self.mode = 'normal'
        self.seed = ''
        self.flags = ''
        self.seedInput.setText(self.seed)
        self.flagString.setText(self.flags)

        for i in self.middleLeftGroupBox.findChildren((QRadioButton)):
            if i.mode == 'normal':
                i.setProperty('checked', True)
                break

        self.comboBox.setCurrentIndex(0)

        self.initCodes()
        self.updateDictionaries()
        self.updateFlagString()
        self.updateFlagCheckboxes()
        self.updateMakeoverRadios()


    # when flag UI button is checked, update corresponding dictionary values
    def flagButtonClicked(self):
        for t, d in zip(self.tablist, self.dictionaries):
            children = t.findChildren(FlagCheckBox)
            for c in children:
                if c.isChecked():
                    d[c.value]['checked'] = True
                else:
                    d[c.value]['checked'] = False

        self.enableMakeoverOptions(self.aesthetic['makeover']['checked'])
        self.updateDictionaries()
        self.updateFlagString()

    def updateMakeoverTag(self, tag, level):
        self.makeover[tag] = level
        self.updateFlagString()

    # Opens file dialog to select rom file and assigns it to value in parent/Window class
    def openFileChooser(self):
        file_path = QFileDialog.getOpenFileName(self, 'Open File', './',
                                                filter='ROMs (*.smc *.sfc *.fig);;All Files(*.*)')

        # display file location in text input field
        self.romInput.setText(str(file_path[0]))


    def compilePresets(self):
        config = configparser.ConfigParser()
        config.read('bcex.cfg')

        self.romText = config.get('ROM', 'path', fallback='')

        if 'presets' in config:
            self.savedPresets = config['presets']
        if 'speeddial' in config:
            for k, v in config['speeddial'].items():
                if 'speeddial_{k}' not in self.savedPresets:
                    self.savedPresets[f'speeddial_{k}'] = f'5.normal.{v}.'
        self.savedPresets['recommended new player preset'] = '5.normal.-dfklu partyparty makeover johnnydmad lovesoup.'

    # Reads dictionary data from text file and populates class dictionaries
    def loadPreset(self, flagdict):
        parts = self.savedPresets[flagdict].split('.')
        try:
            unused_version = parts[0]
            mode = parts[1]
            flagstring = parts[2]
        except KeyError:
            QMessageBox.about(self, 'Error', 'Invalid preset!')
            self.savedPresets.remove(flagdict)
            return

        flags, codes = options.read_options_from_string(flagstring, mode)

        for d in self.dictionaries:
            for flagdesc in d.values():
                flagdesc['checked'] = False

        for flag in flags:
            self.simple[flag.name]['checked'] = True

        for tag in self.makeover.keys():
            self.makeover[tag] = 'normal' if tag != 'soup' else 'only'

        reverse_tag_levels = {'no': 'none', 'hate': 'less', 'like': 'more', 'love': 'only'}
        for code in codes:
            print(code)
            if code.category == 'aesthetic':
                d = self.aesthetic
            elif code.category == 'experimental':
                d = self.experimental
            elif code.category == 'gamebreaking':
                d = self.gamebreaking
            elif code.category == 'major':
                d = self.major
            elif code.category == 'minor':
                d = self.minor
            elif code.category == 'makeover':
                m = re.match(r'(no|hate|like|love)(\w+)', code.name)
                self.makeover[m.group(2)] = reverse_tag_levels.get(m.group(1), 'normal')
                continue
            else:
                print(f'Code {code.name} does not have a valid category.')
                continue

            d[code.name]['checked'] = True

        self.mode = mode

        # update 'dictionaries' list with updated/populated data dictionaries
        self.updateDictionaries()

        # call functions to update UI based upon preset data loaded from file
        self.updateFlagString()
        self.updateFlagCheckboxes()
        self.updateMakeoverRadios()
        self.updateModeSelection()

    # Get seed generation parameters from UI to prepare for seed generation
    # This will show a confirmation dialog, and call the local randomizer.py file
    #   and pass arguments to it
    def generateSeed(self):

        self.romText = self.romInput.text()
        if self.romText == '':  # Checks if user ROM is blank
            QMessageBox.about(self, 'Error', 'You need to select a FFVI rom!')
        else:
            self.seed = self.seedInput.text()

            displaySeed = self.seed
            if self.seed == '':
                displaySeed = '(none)' # pretty-printing :)

            flags = (self.flags).strip().replace(' ', '\n----') # more pretty-printing

            # This makes the flag string more readable in the confirm dialog
            message = ((f'Rom: {self.romText}\n'
                        f'Seed: {displaySeed}\n'
                        f'Mode: {self.mode}\n'
                        f'Flags: \n----{flags}\n'
                        f'(Hyphens are not actually used in seed generation)'))
            messBox = QMessageBox.question(self, 'Confirm Seed Generation?', message, QMessageBox.Yes| QMessageBox.Cancel)
            if messBox == 16384:  # User selects confirm/accept/yes option
                finalFlags = self.flags.replace(' ', '')
                bundle = f'{self.version}.{self.mode}.{finalFlags}.{self.seed}'
                # remove spam if the randomizer asks for input
                # TODO: guify that stuff
                # Hash check can be moved out to when you pick the file.
                # If you delete the file between picking it and running, just spit out an error, no need to prompt.
                # Randomboost could send a signal ask for a number or whatever, but maybe it's better to just remove it or pick a fixed number?
                QtCore.pyqtRemoveInputHook()
                # TODO: put this in a new thread
                try:
                    result_file = randomizer.randomize(args=['gui.py', self.romText, bundle, 'test'])
                #call(['py', 'randomizer.py', self.romText, bundle, 'test'])
                # Running the randomizer twice in one session doesn't work because of global state.
                # Exit so people don't try it.
                # TODO: fix global state then remove this
                except Exception as e:
                    QMessageBox.critical(self, 'Error creating ROM', str(e), QMessageBox.Ok)
                else:
                    QMessageBox.information(self, 'Successfully created ROM', f'Result file: {result_file}', QMessageBox.Ok)
                sys.exit()

    # read each dictionary and update text field showing flag codes based upon
    #    flags denoted as 'True'
    def updateFlagString(self):
        temp = []
        space = False
        for d in self.dictionaries:
            for flagname, flagdesc in d.items():
                if flagdesc['checked']:
                    temp.append(flagname)

        if self.aesthetic['makeover']['checked']:
            tag_levels = {'none': 'no', 'less': 'hate', 'more': 'like', 'only': 'love'}
            for tag, level in self.makeover.items():
                if level != 'normal':
                    temp .append(f'{tag_levels[level]}{tag}')
        self.flags = ' '.join(temp)
        self.flagString.setText(self.flags)

    # read through dictionaries and set flag checkboxes as 'checked'
    def updateFlagCheckboxes(self):
        for t, d in zip(self.tablist, self.dictionaries):
            # create a list of all checkbox objects from the current QTabWidget
            children = t.findChildren(FlagCheckBox)

            # enumerate checkbox objects and set them to 'checked' if corresponding
            #   flag value is true
            for c in children:
                value = c.value
                #print(value + str(d[value]['checked']))
                if d[value]['checked']:
                    c.setChecked(True)
                else:
                    c.setChecked(False)
        self.enableMakeoverOptions(self.aesthetic['makeover']['checked'])

    def enableMakeoverOptions(self, enable):
        tab = self.tablist[1]  # this sucks
        for radio in tab.findChildren(QRadioButton):
            radio.setEnabled(enable)
        for checkbox in tab.findChildren(FlagCheckBox):
            if checkbox.value in ['novanilla', 'frenchvanilla', 'cloneparty']:
                checkbox.setEnabled(enable)

    def updateMakeoverRadios(self):
        tab = self.tablist[1]  # this sucks

        for tag in options.makeover_tags:
            level = self.makeover[tag]
            radio = tab.findChild(QRadioButton, f'{level}{tag}')
            radio.setChecked(True)


    # when radio button is checked, update the main class variable
    def updateRadioSelection(self, mode):
        self.mode = mode

    # enumerate radio button objects and set them to the currently set mode variable
    def updateModeSelection(self):
        for i in self.middleLeftGroupBox.findChildren((QRadioButton)):
            if i.mode == self.mode:
                i.setProperty('checked', True)
                break

    # update list variable with data from currently loaded dictionaries
    def updateDictionaries(self):
        self.dictionaries = [self.simple, self.aesthetic, self.major,
                             self.minor, self.experimental, self.gamebreaking]



if __name__ == '__main__':
    App = QApplication(sys.argv)
    window = Window()
    sys.exit(App.exec())