-#!/usr/bin/python
+#!/usr/bin/python3
# DSL - easy Display Setup for Laptops
-# Copyright (C) 2012 Ralf Jung <post@ralfj.de>
+# Copyright (C) 2012-2015 Ralf Jung <post@ralfj.de>
#
# 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
# GNU General Public License for more details.
#
# 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
+# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-import os, re, subprocess
-from selector_window import PositionSelection
-import gui
+import argparse, sys, os, re, subprocess
+from enum import Enum
+import gui, screen
+frontend = gui.getFrontend("cli") # the fallback, until we got a proper frontend. This is guaranteed to be available.
-# for auto-config: common names of internal connectors
-commonInternalConnectorNames = ['LVDS', 'LVDS0', 'LVDS1', 'LVDS-0', 'LVDS-1']
-# Load a section-less config file: maps parameter names to space-separated lists of strings (with shell quotation)
-def loadConfigFile(file):
- import shlex
- result = {}
- if not os.path.exists(file):
- return result # no config file
- # read config file
- linenr = 0
- with open(file) as file:
- for line in file:
- linenr += 1
- line = line.strip()
- if not len(line) or line.startswith("#"): continue # skip empty and comment lines
- try:
- # parse line
- pos = line.index("=") # will raise exception when substring is not found
- 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)
- # add some convencience get functions
- return result
+# for auto-config: common names of internal connectors
+commonInternalConnectorPrefixes = ['LVDS', 'eDP']
+commonInternalConnectorSuffices = ['', '0', '1', '-0', '-1']
+def commonInternalConnectorNames():
+ for prefix in commonInternalConnectorPrefixes:
+ for suffix in commonInternalConnectorSuffices:
+ yield prefix+suffix
-def getXrandrInformation():
- p = subprocess.Popen(["xrandr", "-q"], stdout=subprocess.PIPE)
- connectors = {} # map of connector names to a list of resolutions
- connector = None # current connector
- for line in p.stdout:
- # screen?
- m = re.search(r'^Screen [0-9]+: ', line)
- if m is not None: # ignore this line
- connector = None
- continue
- # new connector?
- m = re.search(r'^([\w\-]+) (dis)?connected ', line)
- if m is not None:
- connector = m.groups()[0]
- assert connector not in connectors
- connectors[connector] = []
- continue
- # new resolution?
- m = re.search(r'^ ([\d]+)x([\d]+) +', line)
- if m is not None:
- assert connector is not None
- connectors[connector].append((int(m.groups()[0]), int(m.groups()[1])))
- continue
- # unknown line
- raise Exception("Unknown line in xrandr output:\n"+line)
- # be sure to always proprly finish up with the xrandr
- p.communicate()
- # if everything succeededso far, check return code
- if p.returncode != 0: raise Exception("Querying xrandr for data failed.")
- return connectors
-def res2xrandr(res):
- (w, h) = res
- return str(w)+'x'+str(h)
+# Load a section-less config file: maps parameter names to space-separated lists of strings (with shell quotation)
+def loadConfigFile(filename):
+ import shlex
+ result = {}
+ if not os.path.exists(filename):
+ return result # no config file
+ # read config file
+ linenr = 0
+ with open(filename) as f:
+ for line in f:
+ linenr += 1
+ line = line.strip()
+ if not len(line) or line.startswith("#"): continue # skip empty and comment lines
+ try:
+ # parse line
+ pos = line.index("=") # will raise exception when substring is not found
+ 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 (may be a quoting issue)." % linenr)
+ # add some convencience get functions
+ return result
-def res2user(res):
- (w, h) = res
- # get ratio
- ratio = int(round(16.0*h/w))
- if ratio == 12: # 16:12 = 4:3
- strRatio = '4:3'
- elif ratio == 13: # 16:12.8 = 5:4
- strRatio = '5:4'
- else: # let's just hope this will never be 14 or more...
- strRatio = '16:%d' % ratio
- return '%dx%d (%s)' %(w, h, strRatio)
-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
+# Make sure the backlight is turned on
+def turnOnBacklight():
+ try:
+ backlight = float(subprocess.check_output(["xbacklight", "-get"]).strip())
+ if backlight == 0: # it's completely turned off, we better enable it
+ subprocess.check_call(["xbacklight", "-set", "100"])
+ except FileNotFoundError:
+ print("xbacklight has not been found, unable to turn your laptop backlight on.")
+ except subprocess.CalledProcessError:
+ print("xbacklight returned an error while attempting to turn your laptop backlight on.")
-# the main function
-def main():
- # load connectors and options
- connectors = getXrandrInformation()
- 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:
- raise Exception("Connector %s does not exist, there is an error in your config file." % internalConnector)
- else:
- # auto-config
- internalConnector = findAvailableConnector(commonInternalConnectorNames, connectors)
- 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:
- raise Exception("Connector %s does not exist, there is an error in your config file." % internalConnector)
- else:
- externalConnectors = connectors.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.")
- # default: screen off
- args = {} # maps connector names to xrand arguments
- for c in externalConnectors+[internalConnector]:
- args[c] = ["--off"]
+# return the current sceen situation, using the configuration to control connecor detection
+def situationByConfig(config):
+ # internal connectors
+ if 'internalConnector' in config:
+ if len(config['internalConnector']) != 1:
+ raise Exception("You must specify exactly one internal connector.")
+ internalConnectors = config['internalConnector']
+ else:
+ internalConnectors = commonInternalConnectorNames()
+ # run!
+ return screen.ScreenSituation(internalConnectors, config.get('externalConnectors'))
- # 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]
- extPosition = PositionSelection(usedExternalConnector, map(res2user, internalResolutions), map(res2user, externalResolutions))
- extPosition.exec_()
- if not extPosition.result(): sys.exit(1) # the user canceled
- extResolution = res2xrandr(externalResolutions[extPosition.extResolutions.currentIndex()])
- intResolution = res2xrandr(internalResolutions[extPosition.intResolutions.currentIndex()])
- # build command-line
- args[usedExternalConnector] = ["--mode", extResolution] # set external screen to desired resolution
- if extPosition.extOnly.isChecked():
- args[usedExternalConnector] += ["--primary"]
- else:
- # there are two screens
- args[internalConnector] = ["--mode", intResolution] # set internal screen to desired resolution
- # set position
- if extPosition.posLeft.isChecked():
- args[usedExternalConnector] += ["--left-of", internalConnector]
- else:
- args[usedExternalConnector] += ["--right-of", internalConnector]
- # set primary screen
- if extPosition.primExt.isChecked():
- 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)
# if we run top-level
if __name__ == "__main__":
- try:
- main()
- except Exception as e:
- gui.error(str(e))
- raise
+ try:
+ # how do we filter the RelativeScreenPosition for the CLI?
+ relPosFilter = str.lower
+
+ # parse command-line arguments
+ parser = argparse.ArgumentParser(description='easy Display Setup for Laptops')
+ parser.add_argument("-f", "--frontend",
+ dest="frontend",
+ help="The frontend to be used for user interaction")
+ parser.add_argument("-r", "--relative-position",
+ dest="rel_position", choices=list(map(relPosFilter, screen.RelativeScreenPosition.__members__.keys())),
+ help="Set the position of external screen relative to internal one.")
+ parser.add_argument("-e", "--external-only",
+ dest="external_only", action='store_true',
+ help="If an external screen is connected, disable all the others.")
+ parser.add_argument("-i", "--internal-only",
+ dest="internal_only", action='store_true',
+ help="Enable internal screen, disable all the others.")
+ cmdArgs = parser.parse_args()
+
+ # load frontend early (for error mssages)
+ frontend = gui.getFrontend(cmdArgs.frontend)
+
+ # load configuration
+ config = loadConfigFile(os.getenv('HOME') + '/.dsl.conf')
+
+ # see what situation we are in
+ situation = situationByConfig(config)
+
+ # construct the ScreenSetup
+ setup = None
+ if not cmdArgs.internal_only and situation.externalResolutions() is not None:
+ # there's an external screen connected that we may want to use
+ if cmdArgs.external_only:
+ setup = screen.ScreenSetup(intResolution = None, extResolution = situation.externalResolutions()[0])
+ elif cmdArgs.rel_position is not None:
+ # construct automatically, based on CLI arguments
+ # first, figure out the desired RelativeScreenPosition... waht a bad hack...
+ relPos = list(filter(lambda relPosItem: relPosFilter(relPosItem[0]) == cmdArgs.rel_position, screen.RelativeScreenPosition.__members__.items()))
+ assert len(relPos) == 1, "CLI argument is ambigue"
+ relPos = relPos[0][1]
+ # now we construct the ScreenSetup
+ if relPos == screen.RelativeScreenPosition.MIRROR:
+ res = situation.commonResolutions()[0]
+ setup = screen.ScreenSetup(res, res, relPos)
+ else:
+ setup = screen.ScreenSetup(intResolution = situation.internalResolutions()[0], extResolution = situation.externalResolutions()[0], relPosition = relPos)
+ else:
+ # ask the user
+ setup = frontend.setup(situation)
+ if setup is None: sys.exit(1) # the user canceled
+ else:
+ # use first resolution of internal connector
+ setup = screen.ScreenSetup(intResolution = situation.internalResolutions()[0], extResolution = None)
+
+ # call xrandr
+ xrandrCall = situation.forXrandr(setup)
+ print("Call that will be made:",xrandrCall)
+ subprocess.check_call(xrandrCall)
+
+ # make sure the internal screen is really, *really* turned on if there is no external screen
+ if setup.extResolution is None:
+ turnOnBacklight()
+ except Exception as e:
+ frontend.error(str(e))
+ raise