store entire setup in a class, and use that as interface between GUI and logic

diff --git a/dsl.py b/dsl.py
index 1c4ec1e867e2eef94d26ec7fdbf36716e0ac115b..f9c58fa641bb4969c081ded41256f93f2b0f104f 100755 (executable)
--- a/dsl.py
+++ b/dsl.py
@@ -16,7 +16,7 @@
 # along with this program (gpl.txt); if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
 # along with this program (gpl.txt); if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 

-import os, re, subprocess
+import sys, os, re, subprocess

 import gui
 
 # for auto-config: common names of internal connectors
 import gui
 
 # for auto-config: common names of internal connectors


@@ -28,6 +28,33 @@ class RelativeScreenPosition:
        RIGHT         = 1
        EXTERNAL_ONLY = 2
 
        RIGHT         = 1
        EXTERNAL_ONLY = 2
 

+# storing what's necessary for screen setup
+class ScreenSetup:
+       def __init__(self, relPosition, intResolution, extResolution, extIsPrimary = False):
+               '''relPosition must be one of the RelativeScreenPosition members, the resolutions must be (width, height) pairs'''
+               self.relPosition = relPosition
+               self.intResolution = intResolution # value doesn't matter if the internal screen is disabled
+               self.extResolution = extResolution
+               self.extIsPrimary = extIsPrimary or self.relPosition == RelativeScreenPosition.EXTERNAL_ONLY # external is always primary if it is the only one
+       
+       def getInternalArgs(self):
+               if self.relPosition == RelativeScreenPosition.EXTERNAL_ONLY:
+                       return ["--off"]
+               args = ["--mode", res2xrandr(self.intResolution)] # set internal screen to desired resolution
+               if not self.extIsPrimary:
+                       args.append('--primary')
+               return args
+       
+       def getExternalArgs(self, intName):
+               args = ["--mode", res2xrandr(self.extResolution)]
+               if self.extIsPrimary:
+                       args.append('--primary')
+               if self.relPosition == RelativeScreenPosition.LEFT:
+                       args += ['--left-of', intName]
+               elif self.relPosition == RelativeScreenPosition.RIGHT:
+                       args += ['--right-of', intName]
+               return args
+

 # Load a section-less config file: maps parameter names to space-separated lists of strings (with shell quotation)
 def loadConfigFile(file):
        import shlex
 # Load a section-less config file: maps parameter names to space-separated lists of strings (with shell quotation)
 def loadConfigFile(file):
        import shlex


@@ -47,10 +74,12 @@ def loadConfigFile(file):
                                curKey = line[:pos].strip()
                                result[curKey] = shlex.split(line[pos+1:]) # shlex.split also strips
                        except Exception:
                                curKey = line[:pos].strip()
                                result[curKey] = shlex.split(line[pos+1:]) # shlex.split also strips
                        except Exception:

-                               raise Exception("Invalid config, line %d: Error parsing line (quoting issue?)." % linenr)
+                               raise Exception("Invalid config, line %d: Error parsing line (may be a quoting issue)." % linenr)

        # add some convencience get functions
        return result
 
        # add some convencience get functions
        return result
 

+# Run xrandr and return a dict of output names mapped to lists of available resolutions, each being a (width, height) pair.
+# An empty list indicates that the connector is disabled.

 def getXrandrInformation():
        p = subprocess.Popen(["xrandr", "-q"], stdout=subprocess.PIPE)
        connectors = {} # map of connector names to a list of resolutions
 def getXrandrInformation():
        p = subprocess.Popen(["xrandr", "-q"], stdout=subprocess.PIPE)
        connectors = {} # map of connector names to a list of resolutions


@@ -84,10 +113,12 @@ def getXrandrInformation():
        if p.returncode != 0: raise Exception("Querying xrandr for data failed.")
        return connectors
 
        if p.returncode != 0: raise Exception("Querying xrandr for data failed.")
        return connectors
 

+# convert a (width, height) pair into a string accepted by xrandr as argument for --mode

 def res2xrandr(res):
        (w, h) = res
        return str(w)+'x'+str(h)
 
 def res2xrandr(res):
        (w, h) = res
        return str(w)+'x'+str(h)
 

+# convert a (width, height) pair into a string to be displayed to the user

 def res2user(res):
        (w, h) = res
        # get ratio
 def res2user(res):
        (w, h) = res
        # get ratio


@@ -100,89 +131,78 @@ def res2user(res):
                strRatio = '16:%d' % ratio
        return '%dx%d (%s)' %(w, h, strRatio)
 
                strRatio = '16:%d' % ratio
        return '%dx%d (%s)' %(w, h, strRatio)
 

+# return the first available connector from those listed in tryConnectors, skipping disabled connectors

 def findAvailableConnector(tryConnectors, allConnectors):
        for connector in tryConnectors:
                if connector in allConnectors and allConnectors[connector]: # if the connector exists and is active (i.e. there is a resolution)
                        return connector
        return None
 
 def findAvailableConnector(tryConnectors, allConnectors):
        for connector in tryConnectors:
                if connector in allConnectors and allConnectors[connector]: # if the connector exists and is active (i.e. there is a resolution)
                        return connector
        return None
 

-# the main function
-def main():
-       # load connectors and options
-       connectors = getXrandrInformation()
+# Return a (internalConnector, externalConnectors) pair: The name of the internal connector, and a list of external connectors.
+# Use the config file at ~/.dsl.conf and fall back to auto-detection
+def classifyConnectors(allConnectors):

        config = loadConfigFile(os.getenv('HOME') + '/.dsl.conf')
        # find internal connector
        if 'internalConnector' in config:
                if len(config['internalConnector']) != 1:
                        raise Exception("You must specify exactly one internal connector.")
                internalConnector = config['internalConnector'][0]
        config = loadConfigFile(os.getenv('HOME') + '/.dsl.conf')
        # find internal connector
        if 'internalConnector' in config:
                if len(config['internalConnector']) != 1:
                        raise Exception("You must specify exactly one internal connector.")
                internalConnector = config['internalConnector'][0]

-               if not internalConnector in connectors:
+               if not internalConnector in allConnectors:

                        raise Exception("Connector %s does not exist, there is an error in your config file." % internalConnector)
        else:
                # auto-config
                        raise Exception("Connector %s does not exist, there is an error in your config file." % internalConnector)
        else:
                # auto-config

-               internalConnector = findAvailableConnector(commonInternalConnectorNames, connectors)
+               internalConnector = findAvailableConnector(commonInternalConnectorNames, allConnectors)

                if internalConnector is None:
                        raise Exception("Could not automatically find internal connector, please use ~/.dsl.conf to specify it manually.")
        # all the rest is external then, obviously - unless the user wants to do that manually
        if 'externalConnectors' in config:
                externalConnectors = config['externalConnectors']
                for connector in externalConnectors:
                if internalConnector is None:
                        raise Exception("Could not automatically find internal connector, please use ~/.dsl.conf to specify it manually.")
        # all the rest is external then, obviously - unless the user wants to do that manually
        if 'externalConnectors' in config:
                externalConnectors = config['externalConnectors']
                for connector in externalConnectors:

-                       if not connector in connectors:
+                       if not connector in allConnectors:

                                raise Exception("Connector %s does not exist, there is an error in your config file." % connector)
                        if connector == internalConnector:
                                raise Exception("%s is both internal and external, that doesn't make sense." % connector)
        else:
                                raise Exception("Connector %s does not exist, there is an error in your config file." % connector)
                        if connector == internalConnector:
                                raise Exception("%s is both internal and external, that doesn't make sense." % connector)
        else:

-               externalConnectors = connectors.keys()
+               externalConnectors = allConnectors.keys()

                externalConnectors.remove(internalConnector)
        if not externalConnectors:
                raise Exception("No external connector found - either your config is wrong, or your machine has only one connector.")
                externalConnectors.remove(internalConnector)
        if not externalConnectors:
                raise Exception("No external connector found - either your config is wrong, or your machine has only one connector.")

-
-       # default: screen off
-       args = {} # maps connector names to xrand arguments
-       for c in externalConnectors+[internalConnector]:
-               args[c] = ["--off"]
-
-       # Check what to do
-       usedExternalConnector = findAvailableConnector(externalConnectors, connectors) # *the* external connector which is actually used
-       if usedExternalConnector is not None: # there's an external screen connected, we need to ask what to do
-               internalResolutions = connectors[internalConnector]
-               externalResolutions = connectors[usedExternalConnector]
-               dialogue = gui.getDialogue(usedExternalConnector, map(res2user, internalResolutions), map(res2user, externalResolutions))
-               if not dialogue.run(): sys.exit(1) # the user canceled
-               extResolution = res2xrandr(externalResolutions[dialogue.getExtResolutionIndex()])
-               intResolution = res2xrandr(internalResolutions[dialogue.getIntResolutionIndex()])
-               relPosition = dialogue.getRelativeScreenPosition()
-               # build command-line
-               args[usedExternalConnector] = ["--mode", extResolution] # set external screen to desired resolution
-               if relPosition == RelativeScreenPosition.EXTERNAL_ONLY:
-                       args[usedExternalConnector] += ["--primary"]
-               else:
-                       # there are two screens
-                       args[internalConnector] = ["--mode", intResolution] # set internal screen to desired resolution
-                       # set position
-                       if relPosition == RelativeScreenPosition.LEFT:
-                               args[usedExternalConnector] += ["--left-of", internalConnector]
-                       else:
-                               args[usedExternalConnector] += ["--right-of", internalConnector]
-                       # set primary screen
-                       if dialogue.externalIsPrimary():
-                               args[usedExternalConnector] += ["--primary"]
-                       else:
-                               args[internalConnector] += ["--primary"]
-       else:
-               # use first resolution
-               args[internalConnector] = ["--mode", res2xrandr(connectors[internalConnector][0]), "--primary"]
-       # and do it
-       call = ["xrandr"]
-       for name in args:
-               call += ["--output", name] + args[name]
-       print "Call that will be made:",call
-       subprocess.check_call(call)
+       # done!
+       return (internalConnector, externalConnectors)

 
 # if we run top-level
 if __name__ == "__main__":
        try:
 
 # if we run top-level
 if __name__ == "__main__":
        try:

-               main()
+               # load connectors and classify them
+               connectors = getXrandrInformation()
+               (internalConnector, externalConnectors) = classifyConnectors(connectors)
+               
+               # default: screen off
+               connectorArgs = {} # maps connector names to xrand arguments
+               for c in externalConnectors+[internalConnector]:
+                       connectorArgs[c] = ["--off"]
+               
+               # check whether we got an external screen or not
+               # Check what to do
+               usedExternalConnector = findAvailableConnector(externalConnectors, connectors) # *the* external connector which is actually used
+               if usedExternalConnector is not None: # there's an external screen connected, we need to ask what to do
+                       # get setup
+                       dialogue = gui.getDialogue(connectors[internalConnector], connectors[usedExternalConnector])
+                       setup = dialogue.run()
+                       if setup is None: sys.exit(1) # the user canceled
+                       # apply it
+                       connectorArgs[internalConnector] = setup.getInternalArgs()
+                       connectorArgs[usedExternalConnector] = setup.getExternalArgs(internalConnector)
+               else:
+                       # use first resolution of internal connector
+                       connectorArgs[internalConnector] = ["--mode", res2xrandr(connectors[internalConnector][0]), "--primary"]
+               
+               # and do it
+               call = ["xrandr"]
+               for name in connectorArgs:
+                       call += ["--output", name] + connectorArgs[name]
+               print "Call that will be made:",call
+               subprocess.check_call(call)

        except Exception as e:
                gui.error(str(e))
                raise
        except Exception as e:
                gui.error(str(e))
                raise

diff --git a/gui.py b/gui.py
index b6906e122af59c70f1310c9fa8538894ed15d0eb..84e0da39943cb1bd4f865b89d587208eedf9f4b3 100644 (file)
--- a/gui.py
+++ b/gui.py
@@ -25,12 +25,6 @@ def error(message):
        '''Displays a fatal error to the user'''
        QtGui.QMessageBox.critical(None, 'Fatal error', message)
 
        '''Displays a fatal error to the user'''
        QtGui.QMessageBox.critical(None, 'Fatal error', message)
 

-def getDialogue(externalName, internalResolutions, externalResolutions):
-       '''Returns a class implementing the following functions:
-        * run() opens the dialogue. returns True if it was accepted, False otherwise
-        * getRelativeScreenPosition() returns one of the RelativeScreenPosition values (see dsl.py)
-        * getIntResolutionIndex() returns the index of an element in the internalResolutions list
-        * getExtResolutionIndex() returns the index of an element in the externalResolutions list
-        * externalIsPrimary() returns whether the external screen is the primary one (True) or the internal one (False)
-       '''
-       return PositionSelection(externalName, internalResolutions, externalResolutions)
+def getDialogue(internalResolutions, externalResolutions):
+       '''Returns a class implementing a function run() which returns a ScreenSetup instance, or None if the user canceled'''
+       return PositionSelection(internalResolutions, externalResolutions)

diff --git a/qt_dialogue.py b/qt_dialogue.py
index 4ebcd62dfb309150221d427d93de9dc3b73a026c..e8e42a41942903de9a8c3e1c7fba8530d901974c 100644 (file)
--- a/qt_dialogue.py
+++ b/qt_dialogue.py
@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program (gpl.txt); if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 # You should have received a copy of the GNU General Public License
 # along with this program (gpl.txt); if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

-from dsl import RelativeScreenPosition
+from dsl import RelativeScreenPosition, ScreenSetup, res2user

 from PyQt4 import QtCore, QtGui
 
 def makeLayout(layout, members):
 from PyQt4 import QtCore, QtGui
 
 def makeLayout(layout, members):


@@ -26,10 +26,10 @@ def makeLayout(layout, members):
        return layout
 
 class PositionSelection(QtGui.QDialog):
        return layout
 
 class PositionSelection(QtGui.QDialog):

-       def __init__(self, externalName, internalResolutions, externalResolutions):
+       def __init__(self, internalResolutions, externalResolutions):

                # set up main window
                super(PositionSelection, self).__init__()
                # set up main window
                super(PositionSelection, self).__init__()

-               self.setWindowTitle('External screen setup (connector: %s)' % externalName)
+               self.setWindowTitle('DSL - easy Display Setup for Laptops')

                
                # position selection
                posBox = QtGui.QGroupBox('Position of external screen', self)
                
                # position selection
                posBox = QtGui.QGroupBox('Position of external screen', self)


@@ -51,19 +51,21 @@ class PositionSelection(QtGui.QDialog):
                # resolution selection
                resBox = QtGui.QGroupBox('Screen resolutions', self)
                extResLabel = QtGui.QLabel('Resolution of external screen:', resBox)
                # resolution selection
                resBox = QtGui.QGroupBox('Screen resolutions', self)
                extResLabel = QtGui.QLabel('Resolution of external screen:', resBox)

-               self.extResolutions = QtGui.QComboBox(resBox)
+               self.extResolutions = externalResolutions
+               self.extResolutionsBox = QtGui.QComboBox(resBox)

                for res in externalResolutions:
                for res in externalResolutions:

-                       self.extResolutions.addItem(res)
-               self.extResolutions.setCurrentIndex(0) # select first resolution
-               extRow = makeLayout(QtGui.QHBoxLayout(), [extResLabel, self.extResolutions])
+                       self.extResolutionsBox.addItem(res2user(res))
+               self.extResolutionsBox.setCurrentIndex(0) # select first resolution
+               extRow = makeLayout(QtGui.QHBoxLayout(), [extResLabel, self.extResolutionsBox])

                intResLabel = QtGui.QLabel('Resolution of internal screen:', resBox)
                self.extOnly.toggled.connect(intResLabel.setDisabled) # disable the label if there's just one screen in use
                intResLabel = QtGui.QLabel('Resolution of internal screen:', resBox)
                self.extOnly.toggled.connect(intResLabel.setDisabled) # disable the label if there's just one screen in use

-               self.intResolutions = QtGui.QComboBox(resBox)
+               self.intResolutions = internalResolutions
+               self.intResolutionsBox = QtGui.QComboBox(resBox)

                for res in internalResolutions:
                for res in internalResolutions:

-                       self.intResolutions.addItem(res)
-               self.intResolutions.setCurrentIndex(0) # select first resolution
-               self.extOnly.toggled.connect(self.intResolutions.setDisabled) # disable the box if there's just one screen in use
-               intRow = makeLayout(QtGui.QHBoxLayout(), [intResLabel, self.intResolutions])
+                       self.intResolutionsBox.addItem(res2user(res))
+               self.intResolutionsBox.setCurrentIndex(0) # select first resolution
+               self.extOnly.toggled.connect(self.intResolutionsBox.setDisabled) # disable the box if there's just one screen in use
+               intRow = makeLayout(QtGui.QHBoxLayout(), [intResLabel, self.intResolutionsBox])

                resBox.setLayout(makeLayout(QtGui.QVBoxLayout(), [extRow, intRow]))
                
                # last row: buttons
                resBox.setLayout(makeLayout(QtGui.QVBoxLayout(), [extRow, intRow]))
                
                # last row: buttons


@@ -76,7 +78,11 @@ class PositionSelection(QtGui.QDialog):
        
        def run(self):
                self.exec_()
        
        def run(self):
                self.exec_()

-               return True if self.result() else False
+               if not self.result(): return None
+               return ScreenSetup(self.getRelativeScreenPosition(),
+                       self.intResolutions[self.intResolutionsBox.currentIndex()],
+                       self.extResolutions[self.extResolutionsBox.currentIndex()],
+                       self.primExt.isChecked())

        
        def getRelativeScreenPosition(self):
                if self.posLeft.isChecked():
        
        def getRelativeScreenPosition(self):
                if self.posLeft.isChecked():


@@ -85,12 +91,3 @@ class PositionSelection(QtGui.QDialog):
                        return RelativeScreenPosition.RIGHT
                else:
                        return RelativeScreenPosition.EXTERNAL_ONLY
                        return RelativeScreenPosition.RIGHT
                else:
                        return RelativeScreenPosition.EXTERNAL_ONLY

-       
-       def getIntResolutionIndex(self):
-               return self.intResolutions.currentIndex()
-       
-       def getExtResolutionIndex(self):
-               return self.extResolutions.currentIndex()
-       
-       def externalIsPrimary(self):
-               return self.primExt.isChecked()