]> git.donarmstrong.com Git - deb_pkgs/autorandr.git/blobdiff - autorandr.py
fix infinite loop in debug_regexp
[deb_pkgs/autorandr.git] / autorandr.py
index e9d1c2570b4cda5a922b562f3030549a8653cac1..18381df0fff950a2713030c4afe99bf3354c07ba 100755 (executable)
@@ -21,8 +21,6 @@
 # You should have received a copy of the GNU General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-# TODO Add virtual profiles common, horizontal, vertical
-#      This also requires to load all resolutions into the XrandrOutputs
 
 from __future__ import print_function
 import copy
@@ -34,6 +32,7 @@ import os
 import re
 import subprocess
 import sys
+from distutils.version import LooseVersion as Version
 
 from itertools import chain
 from collections import OrderedDict
@@ -48,14 +47,14 @@ virtual_profiles = [
 help_text = """
 Usage: autorandr [options]
 
--h, --help             get this small help
--c, --change           reload current setup
--s, --save <profile>   save your current setup to profile <profile>
--l, --load <profile>   load profile <profile>
+-h, --help              get this small help
+-c, --change            reload current setup
+-s, --save <profile>    save your current setup to profile <profile>
+-l, --load <profile>    load profile <profile>
 -d, --default <profile> make profile <profile> the default profile
---force                        force (re)loading of a profile
---fingerprint          fingerprint your current hardware setup
---config               dump your current xrandr setup
+--force                 force (re)loading of a profile
+--fingerprint           fingerprint your current hardware setup
+--config                dump your current xrandr setup
 --dry-run               don't change anything, only print the xrandr commands
 
  To prevent a profile from being loaded, place a script call "block" in its
@@ -85,7 +84,7 @@ class XrandrOutput(object):
             unknown\ connection |
             (?P<connected>connected)\s+                                                 # If connected:
             (?P<primary>primary\ )?                                                     # Might be primary screen
-            (?P<width>[0-9]+)x(?P<height>[0-9]+)                                        # Resolution
+            (?P<width>[0-9]+)x(?P<height>[0-9]+)                                        # Resolution (might be overridden below!)
             \+(?P<x>[0-9]+)\+(?P<y>[0-9]+)\s+                                           # Position
             (?:\(0x[0-9a-fA-F]+\)\s+)?                                                  # XID
             (?P<rotate>(?:normal|left|right|inverted))\s+                               # Rotation
@@ -99,10 +98,10 @@ class XrandrOutput(object):
         ))+
         \s*
         (?P<modes>(?:
-            [0-9]+x[0-9]+.+?\*current.+\s+h:.+\s+v:.+clock\s+(?P<rate>[0-9\.]+)Hz\s* |  # Interesting (current) resolution: Extract rate
+            (?P<mode_width>[0-9]+)x(?P<mode_height>[0-9]+).+?\*current.+\s+
+                h:.+\s+v:.+clock\s+(?P<rate>[0-9\.]+)Hz\s* |                            # Interesting (current) resolution: Extract rate
             [0-9]+x[0-9]+.+\s+h:.+\s+v:.+\s*                                            # Other resolutions
         )*)
-        $
     """
 
     XRANDR_OUTPUT_MODES_REGEXP = """(?x)
@@ -115,10 +114,29 @@ class XrandrOutput(object):
     def __repr__(self):
         return "<%s%s %s>" % (self.output, (" %s..%s" % (self.edid[:5], self.edid[-5:])) if self.edid else "", " ".join(self.option_vector))
 
+    @property
+    def options_with_defaults(self):
+        "Return the options dictionary, augmented with the default values that weren't set"
+        if "off" in self.options:
+            return self.options
+        options = {}
+        if xrandr_version() >= Version("1.3"):
+            options.update({
+                "transform": "1,0,0,0,1,0,0,0,1",
+            })
+        if xrandr_version() >= Version("1.2"):
+            options.update({
+                "reflect": "normal",
+                "rotate": "normal",
+                "gamma": "1:1:1",
+            })
+        options.update(self.options)
+        return options
+
     @property
     def option_vector(self):
         "Return the command line parameters for XRandR for this instance"
-        return sum([["--%s" % option[0], option[1]] if option[1] else ["--%s" % option[0]] for option in chain((("output", self.output),), self.options.items())], [])
+        return sum([["--%s" % option[0], option[1]] if option[1] else ["--%s" % option[0]] for option in chain((("output", self.output),), self.options_with_defaults.items())], [])
 
     @property
     def option_string(self):
@@ -153,10 +171,12 @@ class XrandrOutput(object):
         except:
             raise RuntimeError("Parsing XRandR output failed, there is an error in the regular expression.")
         if not match_object:
-            raise RuntimeError("Parsing XRandR output failed, the regular expression did not match.")
+            debug = debug_regexp(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
+            raise RuntimeError("Parsing XRandR output failed, the regular expression did not match: %s" % debug)
         remainder = xrandr_output[len(match_object.group(0)):]
         if remainder:
-            raise RuntimeError("Parsing XRandR output failed, %d bytes left unmatched after regular expression." % len(remainder))
+            raise RuntimeError(("Parsing XRandR output failed, %d bytes left unmatched after regular expression,"
+                                "starting with ..'%s'.") % (len(remainder), remainder[:10]))
 
 
         match = match_object.groupdict()
@@ -164,18 +184,23 @@ class XrandrOutput(object):
         modes = []
         if match["modes"]:
             modes = [ x.groupdict() for x in re.finditer(XrandrOutput.XRANDR_OUTPUT_MODES_REGEXP, match["modes"]) ]
+            if not modes:
+                raise RuntimeError("Parsing XRandR output failed, couldn't find any display modes")
 
         options = {}
         if not match["connected"]:
             options["off"] = None
             edid = None
         else:
-            if match["rotate"] not in ("left", "right"):
-                options["mode"] = "%sx%s" % (match["width"], match["height"])
+            if "mode_width" in match:
+                options["mode"] = "%sx%s" % (match["mode_width"], match["mode_height"])
             else:
-                options["mode"] = "%sx%s" % (match["height"], match["width"])
-            options["rotate"] = match["rotate"]
-            options["reflect"] = "normal"
+                if match["rotate"] not in ("left", "right"):
+                    options["mode"] = "%sx%s" % (match["width"], match["height"])
+                else:
+                    options["mode"] = "%sx%s" % (match["height"], match["width"])
+            if match["rotate"] != "normal":
+                options["rotate"] = match["rotate"]
             if "reflect" in match:
                 if match["reflect"] == "X":
                     options["reflect"] = "x"
@@ -188,8 +213,10 @@ class XrandrOutput(object):
                 transformation = ",".join(match["transform"].strip().split())
                 if transformation != "1.000000,0.000000,0.000000,0.000000,1.000000,0.000000,0.000000,0.000000,1.000000":
                     options["transform"] = transformation
-                else:
-                    options["transform"] = "none"
+                    if "mode_width" not in match:
+                        # TODO We'd need to apply the reverse transformation here. Let's see if someone complains, I doubt that this
+                        # special case is actually required.
+                        print("Warning: Output %s has a transformation applied. Could not determine correct mode!", file=sys.stderr)
             if match["gamma"]:
                 gamma = match["gamma"].strip()
                 if gamma != "1.0:1.0:1.0":
@@ -218,7 +245,7 @@ class XrandrOutput(object):
                 fuzzy_output = re.sub("(card[0-9]+|-)", "", options["output"])
                 if fuzzy_output not in fuzzy_edid_map:
                     raise RuntimeError("Failed to find a corresponding output in config/setup for output `%s'" % options["output"])
-                edid = edid_map[edid_map.keys()[fuzzy_edid_map.index(fuzzy_output)]]
+                edid = edid_map[list(edid_map.keys())[fuzzy_edid_map.index(fuzzy_output)]]
         output = options["output"]
         del options["output"]
 
@@ -236,6 +263,32 @@ class XrandrOutput(object):
     def __eq__(self, other):
         return self.edid == other.edid and self.output == other.output and self.options == other.options
 
+def xrandr_version():
+    "Return the version of XRandR that this system uses"
+    if getattr(xrandr_version, "version", False) is False:
+        version_string = os.popen("xrandr -v").read()
+        version = re.search("xrandr program version\s+([0-9\.]+)", version_string).group(1)
+        xrandr_version.version = Version(version)
+    return xrandr_version.version
+
+def debug_regexp(pattern, string):
+    "Use the partial matching functionality of the regex module to display debug info on a non-matching regular expression"
+    try:
+        import regex
+        bounds = ( 0, len(string) )
+        while bounds[0] != bounds[1]:
+            half = int((bounds[0] + bounds[1]) / 2)
+            if half == bounds[0]:
+                break
+            bounds = (half, bounds[1]) if regex.search(pattern, string[:half], partial=True) else (bounds[0], half - 1)
+        partial_length = bounds[0]
+        return ("Regular expression matched until position "
+              "%d, ..'%s', and did not match from '%s'.." % (partial_length, string[max(0, partial_length-20):partial_length],
+                                                             string[partial_length:partial_length+10]))
+    except ImportError:
+        pass
+    return "Debug information available if `regex' module is installed."
+
 def parse_xrandr_output():
     "Parse the output of `xrandr --verbose' into a list of outputs"
     xrandr_output = os.popen("xrandr -q --verbose").read()
@@ -279,6 +332,10 @@ def load_profiles(profile_path):
             else:
                 buffer.append(line)
 
+        for output_name in list(config.keys()):
+            if "off" in config[output_name].options:
+                del config[output_name]
+
         profiles[profile] = config
 
     return profiles
@@ -340,8 +397,9 @@ def apply_configuration(configuration, dry_run=False):
     for output in outputs:
         if not configuration[output].edid:
             argv += configuration[output].option_vector
-    if subprocess.call(argv) != 0:
-        return False
+    if argv != base_argv:
+        if subprocess.call(argv) != 0:
+            return False
 
     # Enable remaining outputs in pairs of two
     remaining_outputs = [ x for x in outputs if configuration[x].edid ]
@@ -349,6 +407,12 @@ def apply_configuration(configuration, dry_run=False):
         if subprocess.call((base_argv[:] + configuration[remaining_outputs[index]].option_vector + (configuration[remaining_outputs[index + 1]].option_vector if index < len(remaining_outputs) - 1 else []))) != 0:
             return False
 
+def add_unused_outputs(source_configuration, target_configuration):
+    "Add outputs that are missing in target to target, in 'off' state"
+    for output_name, output in source_configuration.items():
+        if output_name not in target_configuration:
+            target_configuration[output_name] = XrandrOutput(output_name, output.edid, { "off": None })
+
 def generate_virtual_profile(configuration, modes, profile_name):
     "Generate one of the virtual profiles"
     configuration = copy.deepcopy(configuration)
@@ -399,11 +463,25 @@ def exec_scripts(profile_path, script_name):
             subprocess.call(script)
 
 def main(argv):
-    options = dict(getopt.getopt(argv[1:], "s:l:d:cfh", [ "dry-run", "change", "default=", "save=", "load=", "force", "fingerprint", "config", "help" ])[0])
+    try:
+       options = dict(getopt.getopt(argv[1:], "s:l:d:cfh", [ "dry-run", "change", "default=", "save=", "load=", "force", "fingerprint", "config", "help" ])[0])
+    except getopt.GetoptError as e:
+        print(str(e))
+        options = { "--help": True }
 
     profile_path = os.path.expanduser("~/.autorandr")
-    profiles = load_profiles(profile_path)
-    config, modes = parse_xrandr_output()
+
+    try:
+        profiles = load_profiles(profile_path)
+    except Exception as e:
+        print("Failed to load profiles:\n%s" % str(e), file=sys.stderr)
+        sys.exit(1)
+
+    try:
+        config, modes = parse_xrandr_output()
+    except Exception as e:
+        print("Failed to parse current configuration from XRandR:\n%s" % str(e), file=sys.stderr)
+        sys.exit(1)
 
     if "--fingerprint" in options:
         output_setup(config, sys.stdout)
@@ -417,9 +495,13 @@ def main(argv):
         options["--save"] = options["-s"]
     if "--save" in options:
         if options["--save"] in ( x[0] for x in virtual_profiles ):
-            print("Cannot save current configuration as profile '%s': This configuration name is a reserved virtual configuration." % options["--save"])
+            print("Cannot save current configuration as profile '%s':\nThis configuration name is a reserved virtual configuration." % options["--save"])
+            sys.exit(1)
+        try:
+            save_configuration(os.path.join(profile_path, options["--save"]), config)
+        except Exception as e:
+            print("Failed to save current configuration as profile '%s':\n%s" % (options["--save"], str(e)), file=sys.stderr)
             sys.exit(1)
-        save_configuration(os.path.join(profile_path, options["--save"]), config)
         print("Saved current configuration as profile '%s'" % options["--save"])
         sys.exit(0)
 
@@ -454,16 +536,32 @@ def main(argv):
         if load_profile in ( x[0] for x in virtual_profiles ):
             profile = generate_virtual_profile(config, modes, load_profile)
         else:
-            profile = profiles[load_profile]
+            try:
+                profile = profiles[load_profile]
+            except KeyError:
+                print("Failed to load profile '%s':\nProfile not found" % load_profile, file=sys.stderr)
+                sys.exit(1)
+        add_unused_outputs(config, profile)
         if profile == config and not "-f" in options and not "--force" in options:
             print("Config already loaded")
             sys.exit(0)
 
-        exec_scripts(os.path.join(profile_path, load_profile), "preswitch")
-        apply_configuration(profile, "--dry-run" in options)
-        exec_scripts(os.path.join(profile_path, load_profile), "postswitch")
+        try:
+            if "--dry-run" in options:
+                apply_configuration(profile, True)
+            else:
+                exec_scripts(os.path.join(profile_path, load_profile), "preswitch")
+                apply_configuration(profile, False)
+                exec_scripts(os.path.join(profile_path, load_profile), "postswitch")
+        except Exception as e:
+            print("Failed to apply profile '%s':\n%s" % (load_profile, str(e)), file=sys.stderr)
+            sys.exit(1)
 
     sys.exit(0)
 
 if __name__ == '__main__':
-    main(sys.argv)
+    try:
+        main(sys.argv)
+    except Exception as e:
+        print("General failure. Please report this as a bug:\n%s" % (str(e),), file=sys.stderr)
+        sys.exit(1)