config.py

# for file mangement and exiting
import os
import sys

# Qt imports
from PyQt5.QtCore import Qt
from PyQt5.QtWidgets import QApplication
from PyQt5.QtWidgets import QMainWindow
from PyQt5.QtWidgets import QWidget
from PyQt5.QtWidgets import QVBoxLayout, QHBoxLayout, QGridLayout
from PyQt5.QtWidgets import QLabel
from PyQt5.QtWidgets import QCheckBox
from PyQt5.QtWidgets import QComboBox
from PyQt5.QtWidgets import QLineEdit
from PyQt5.QtWidgets import QPushButton

# misc
from math import floor

'''
This is the class used for the setting and the corresponding QWidget.
You shouldn't have to edit this class.

Arguments:
	'settingName' is the name of the setting as it appears in the menu
	'settingType' is "check" for a checkbox, "line" for text entry,
		or "dropdown" for a dropdown box.

Optional arguments:
	'tooltip' lets you set the text you see when you hover over the setting
	'dropdownOptions' is a list containing options for the dropdown box
'''
class ConfigSetting(QWidget):
	def __init__(self, settingName, settingType, **kwargs):
		super().__init__()

		self.settingType = settingType

		mainLayout = QHBoxLayout()
		self.setLayout(mainLayout)

		mainLayout.addWidget(QLabel(settingName))

		if settingType == "check":
			self.settingInput = QCheckBox()
			self.settingInput.setChecked(True)
		elif settingType == "line":
			self.settingInput = QLineEdit()
		elif settingType == "dropdown":
			self.settingInput = QComboBox()
			if kwargs.get("dropdownOptions", None):
				for i in kwargs["dropdownOptions"]:
					self.settingInput.addItem(i)
			else:
				print("No options were provided for setting \'" + settingName + "\'")

		mainLayout.addWidget(self.settingInput)

		if kwargs.get("tooltip", None):
			self.setToolTip(kwargs["tooltip"])

	def setSetting(self, setting):
		if self.settingType == "check":
			if setting == "1":
				self.settingInput.setChecked(True)
			elif setting == "0":
				self.settingInput.setChecked(False)
		elif self.settingType == "line":
			self.settingInput.setText(setting)
		elif self.settingType == "dropdown":
			self.settingInput.setCurrentIndex(self.settingInput.findText(setting))

	def getSetting(self):
		if self.settingType == "check":
			if self.settingInput.isChecked():
				return "1"
			else:
				return "0"
		elif self.settingType == "line":
			return self.settingInput.text()
		elif self.settingType == "dropdown":
			return self.settingInput.currentText()

# This is the class for the configuration window
class ConfigWindow(QMainWindow):
	def __init__(self):
		super().__init__()

		# Sets the title
		self.setWindowTitle("smlinux configuration editor")
		mainLayout = QVBoxLayout()
		container = QWidget()
		container.setLayout(mainLayout)
		self.setCentralWidget(container)

		actualSettingsLayout = QGridLayout()
		actualSettingsContainer = QWidget()
		actualSettingsContainer.setLayout(actualSettingsLayout)
		mainLayout.addWidget(actualSettingsContainer)

		# This is the dictionary holding the objects for the different settings.
		# The values are the objects while the keys are the setting names
		# as seen in the config file. This is what you edit to add more settings.
		# Check the comment for "ConfigSetting()" to see the arguments.
		self.configDict = {
			"PRESET": ConfigSetting("Preset", "dropdown", dropdownOptions = [ "UserDefined", "sm64pc", "sm64-port", "sm64-portweb", "sm64dos", "sm64nx", "sm64ex", "sm64exweb", "sm64ex-coop", "androidex", "cheaterex", "render96ex","r96proto","r96master", "r96tester", "sm64-port-android-base"],tooltip="Unless Userdefined, overrides settings including GIT and BRANCH (see FAQ)."),
			"VERSION": ConfigSetting("ROM VERSION", "dropdown", tooltip = "Must correspond to ROM region", dropdownOptions = ["us","jp","eu"]),
			"RENDER_API": ConfigSetting("RENDER_API", "dropdown", tooltip = "Linux and macOS support GL (OpenGL 2.1+) or GL_LEGACY (OpenGL 1.1+).\nD3D11 (DirectX 11) is also offered for Windows.\n(sm64ex-based repos only)", dropdownOptions = ["GL","GL_LEGACY","D3D11"]),
			"SDL_API": ConfigSetting("SDL API", "dropdown", tooltip = "CONTROLLER_API AUDIO_API Support SDL2 or SDL 1.2 (sm64ex-based repos only)", dropdownOptions = ["SDL2","SDL1"]),
			"MAXJOBS": ConfigSetting("Maximum Jobs", "dropdown", dropdownOptions = [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "12", "15", "" ], tooltip = "Maximum cpu threads used during compile.\nUndefined (blank) will try to use all."),
			"BASEPATH": ConfigSetting("Base Folder", "line", tooltip = "Must be valid existing path.\nFolders for each repo cloned will be placed there."),
			"InstallHD": ConfigSetting("Install HD Add-ons", "check", tooltip = "Install HD Add-ons when applicable including\nHD Mario & Bowser Models, HD intro (goddard) and 3D Coins ,\nUpscaled Textures & High Quality Sounds - see FAQ"),
			"MODELPACK": ConfigSetting("Install R96 MODELPACK", "check", tooltip = "Install Render 96 SGI Model Pack\n(sm64ex-based repos only)"),
			"DYNOS": ConfigSetting("DYNOS", "check", tooltip = "Add additional options menu with Dynamic Option System by PeachyPeach\n(sm64ex-based repos only)\n(cannot be disabled in render96ex)"),
			"CHEATER": ConfigSetting("CHEATER", "check", tooltip = "Add additional cheat options with CHEATER by s4ys\n(sm64ex-based repos only)\n(cannot be disabled in render96ex)"),
			"HIGHFPS": ConfigSetting("HIGHFPS", "check", tooltip="enable HIGHFPS (render96ex) or use repository provided 60fps patch"),

			"NODRAWINGDISTANCE": ConfigSetting("NODRAWINGDISTANCE", "check", tooltip = "Don't hide faraway objects\n(sm64ex-based repos only)\n(render96ex includes in game slider control)"),
			"EXTERNAL_DATA": ConfigSetting("EXTERNAL_DATA", "check", tooltip = "Allow add-on texture and soundpacks\n(sm64ex-based repos only)\n(cannot be disabled in render96ex)"),
			"BETTERCAMERA": ConfigSetting("BETTERCAMERA", "check", tooltip = "Adds Camera Settings to options menu\n(sm64ex-based repos only)\n(cannot be disabled in render96ex)"),
			"TEXTURE_FIX": ConfigSetting("TEXTURE_FIX", "check", tooltip = "Fix minor details like smoke texture\n(sm64ex-based repos only)"),
			"DISCORDRPC": ConfigSetting("DISCORDRPC", "check", tooltip = "Enable Discord Rich Presence\n(64-bit sm64ex-based repos only)"),
			"TEXTSAVES": ConfigSetting("TEXTSAVES", "check", tooltip = "Save player data as a text file instead of binary rom format\n(sm64ex-based repos only)\n(cannot be disabled in render96ex)"),
			"DEBUG": ConfigSetting("DEBUG", "check", tooltip = "Advanced Build Option"),
			"TARGET_WEB": ConfigSetting("TARGET_WEB", "check", tooltip = "Build Web Version with emsdk"),
			"TARGET_RPI": ConfigSetting("TARGET_RPI", "check", tooltip = "Build Raspberry Pi version on Rapsberry Pi"),
			"DISCORD_SDK": ConfigSetting("DISCORD_SDK (Co-op)", "check", tooltip = "Enable Discord Integration\n(sm64ex-coop only)"),
			"IMMEDIATELOAD": ConfigSetting("IMMEDIATELOAD (Co-op)", "check", tooltip = "Advanced Build Option\n(sm64ex-coop only)"),

			"GIT": ConfigSetting("UserDef Git", "line", tooltip = "GIT and BRANCH are ignored if PRESET is known"),
			"BRANCH": ConfigSetting("UserDef Branch", "line", tooltip = "GIT and BRANCH are ignored if PRESET is known"),
			"FLAGS": ConfigSetting("UserDef Flags", "line", tooltip = "Additional flags to pass to make. Advanced usage only.\nMust be surrounded by quotation marks, for example:\n\"CUSTOMFLAG=1 ANOTHERFLAG=WHATEVER\""),
			"DOS_GL": ConfigSetting("DOS_GL: ", "dropdown", tooltip = "Supports dmesa (glide) or osmesa", dropdownOptions = ["dmesa","osmesa"]),
			"ENABLE_OPENGL_LEGACY": ConfigSetting("ENABLE_OPENGL_LEGACY (DOS)", "check", tooltip = "see dos github"),
			"TOUCH_CONTROLS": ConfigSetting("TOUCH_CONTROLS (Android)", "check", tooltip = "Enable touschsceen Overlay\n(Android only)"),
			"ARMONLY": ConfigSetting("Target ARM Only (Android)", "check", tooltip = "Prevent x86 builds for apk\n(Android only)"),
			"LEGACY_RES": ConfigSetting("LEGACY_RES (render96ex)", "check", tooltip = "Advanced Build Option\n(render96ex only)"),
			"CONFIG": ConfigSetting("Prompt to configure before each build", "check", tooltip = "CONFIG"),
			"BuildMusic": ConfigSetting("Play background music during build", "check", tooltip = "BuildMusic"),
			"AutoUpdate": ConfigSetting("Update smlinux before each build", "check", tooltip = "AutoUpdate"),
		}

		# Change this variable to adjust the layout of the options.
		itemsPerColumn = 11
		# This loops through the dictionary and adds all the settings to the menu.
		# This may be out of order depending on your version of Python 3.
		for i in self.configDict:
			actualSettingsLayout.addWidget(self.configDict[i], list(self.configDict.keys()).index(i) % itemsPerColumn, floor(list(self.configDict.keys()).index(i) / itemsPerColumn))
			if not list(self.configDict.keys()).index(i) % itemsPerColumn:
				actualSettingsLayout.setColumnStretch(floor(list(self.configDict.keys()).index(i) / itemsPerColumn), 1)

		# Read in the config file
		configFile = open(sys.argv[1], "r")
		configFileLines = configFile.readlines()
		for i in configFileLines:
			if i[0] == '#':
				continue
			self.configDict[i.split("=")[0]].setSetting(i.split("=")[1].strip("\n"))
		configFile.close()

		# Now we add the cancel and save buttons
		saveAndCancelContainer = QWidget()
		saveAndCancelLayout = QHBoxLayout()
		saveAndCancelContainer.setLayout(saveAndCancelLayout)

		#cancelButton = QPushButton()
		#cancelButton.setText("Exit Config Editor without Saving Changes")
		#cancelButton.clicked.connect(self.close)
		#saveAndCancelLayout.addWidget(cancelButton)

		saveButton = QPushButton()
		saveButton.setText("Okay")
		saveButton.clicked.connect(self.saveAndExit)
		saveAndCancelLayout.addWidget(saveButton)

		mainLayout.addWidget(saveAndCancelContainer)

	def saveAndExit(self):
		configFile = open(sys.argv[1], "r")
		configFileStrOld = configFile.read()
		configFile.close()

		configFileStrNew = ""
		for i in configFileStrOld.splitlines():
			if i[0] == '#':
				configFileStrNew += i + '\n'
				continue
			configFileStrNew += i.split("=")[0] + '='
			configFileStrNew += self.configDict[i.split("=")[0]].getSetting() + '\n'

		configFile = open(sys.argv[1], "w")
		configFile.write(configFileStrNew)
		configFile.close()

		self.close()


# This is the entrypoint for the program
def main():
	# Before we do anything, let's check to see if the config file exists
	if not os.path.exists(sys.argv[1]):
		print("ERROR: configuration \'" + sys.argv[1] + "\' does not exist.")
		sys.exit(1)

	# We declare the app
	configApp = QApplication(sys.argv)

	# We declare the window
	configWindow = ConfigWindow()

	# We show the window
	configWindow.show()

	# We trigger the event loop for the app inside of "sys.exit()" to prevents leaks
	sys.exit(configApp.exec_())

if __name__ == '__main__':
	main()