/usr/share/pyshared/Onboard/Appearance.py is in onboard 0.97.0-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 | # -*- coding: utf-8 -*-
"""
Module for theme related classes.
"""
from __future__ import division, print_function, unicode_literals
### Logging ###
import logging
_logger = logging.getLogger("Appearance")
###############
from xml.dom import minidom
import os
import re
import colorsys
from math import log
from Onboard import Exceptions
from Onboard.utils import hexstring_to_float, brighten, toprettyxml, \
TreeItem, Version
import Onboard.utils as utils
### Config Singleton ###
from Onboard.Config import Config
config = Config()
########################
class Theme:
"""
Theme controls the visual appearance of Onboards keyboard window.
"""
# onboard 0.95
THEME_FORMAT_INITIAL = Version(1, 0)
# onboard 0.97, added key_size, switch most int values to float,
# changed range of key_gradient_direction
THEME_FORMAT_1_1 = Version(1, 1)
THEME_FORMAT = THEME_FORMAT_1_1
# core theme members
# name, type, default
attributes = [
["color_scheme_basename", "s", ""],
["key_style", "s", "flat"],
["roundrect_radius", "f", 0],
["key_size", "f", 100],
["key_fill_gradient", "f", 0],
["key_stroke_gradient", "f", 0],
["key_gradient_direction", "f", 0],
["key_label_font", "s", ""],
["key_label_overrides", "d", {}] # dict {name:(key:group)}
]
def __init__(self):
self.modified = False
self.filename = ""
self.is_system = False # True if this a system theme
self.system_exists = False # True if there exists a system
# theme with the same basename
self.name = ""
# create attributes
for name, _type, default in self.attributes:
setattr(self, name, default)
@property
def basename(self):
""" Returns the file base name of the theme. """
return os.path.splitext(os.path.basename(self.filename))[0]
def __eq__(self, other):
if not other:
return False
for name, _type, _default in self.attributes:
if getattr(self, name) != getattr(other, name):
return False
return True
def __str__(self):
return "name=%s, colors=%s, font=%s, radius=%d" % (self.name,
self.color_scheme_basename,
self.key_label_font,
self.roundrect_radius)
def apply(self, save=True):
""" Applies the theme to config properties/gsettings. """
filename = self.get_color_scheme_filename()
if not filename:
_logger.error(_("Color scheme for theme '{filename}' not found") \
.format(filename=self.filename))
return False
config.theme_settings.set_color_scheme_filename(filename, save)
for name, _type, _default in self.attributes:
if name != "color_scheme_basename":
getattr(config.theme_settings, "set_" + name) \
(getattr(self, name), save)
return True
def get_color_scheme_filename(self):
""" Returns the filename of the themes color scheme."""
filename = os.path.join(Theme.user_path(),
self.color_scheme_basename) + \
"." + ColorScheme.extension()
if not os.path.isfile(filename):
filename = os.path.join(Theme.system_path(),
self.color_scheme_basename) + \
"." + ColorScheme.extension()
if not os.path.isfile(filename):
return None
return filename
def set_color_scheme_filename(self, filename):
""" Set the filename of the color_scheme. """
self.color_scheme_basename = \
os.path.splitext(os.path.basename(filename ))[0]
def get_superkey_label(self):
""" Returns the (potentially overridden) label of the super keys. """
override = self.key_label_overrides.get("LWIN")
if override:
return override[0] # assumes RWIN=LWIN
return None
def get_superkey_size_group(self):
"""
Returns the (potentially overridden) size group of the super keys.
"""
override = self.key_label_overrides.get("LWIN")
if override:
return override[1] # assumes RWIN=LWIN
return None
def set_superkey_label(self, label, size_group):
""" Sets or clears the override for left and right super key labels. """
tuples = self.key_label_overrides
if label is None:
if "LWIN" in tuples:
del tuples["LWIN"]
if "RWIN" in tuples:
del tuples["RWIN"]
else:
tuples["LWIN"] = (label, size_group)
tuples["RWIN"] = (label, size_group)
self.key_label_overrides = tuples
@staticmethod
def system_to_user_filename(filename):
""" Returns the user filename for the given system filename. """
basename = os.path.splitext(os.path.basename(filename ))[0]
return os.path.join(Theme.user_path(),
basename) + "." + Theme.extension()
@staticmethod
def build_user_filename(basename):
"""
Returns a fully qualified filename pointing into the user directory
"""
return os.path.join(Theme.user_path(),
basename) + "." + Theme.extension()
@staticmethod
def build_system_filename(basename):
"""
Returns a fully qualified filename pointing into the system directory
"""
return os.path.join(Theme.system_path(),
basename) + "." + Theme.extension()
@staticmethod
def user_path():
""" Returns the path of the user directory for themes. """
return os.path.join(config.user_dir, "themes")
@staticmethod
def system_path():
""" Returns the path of the system directory for themes. """
return os.path.join(config.install_dir, "themes")
@staticmethod
def extension():
""" Returns the file extension of theme files """
return "theme"
@staticmethod
def load_merged_themes():
"""
Merge system and user themes.
User themes take precedence and hide system themes.
"""
system_themes = Theme.load_themes(True)
user_themes = Theme.load_themes(False)
themes = dict((t.basename, (t, None)) for t in system_themes)
for theme in user_themes:
# system theme hidden behind user theme?
if theme.basename in themes:
# keep the system theme behind the user theme
themes[theme.basename] = (theme, themes[theme.basename][0])
else:
themes[theme.basename] = (theme, None)
return themes
@staticmethod
def load_themes(is_system=False):
""" Load all themes from either the user or the system directory. """
themes = []
if is_system:
path = Theme.system_path()
else:
path = Theme.user_path()
filenames = Theme.find_themes(path)
for filename in filenames:
theme = Theme.load(filename, is_system)
themes.append(theme)
return themes
@staticmethod
def find_themes(path):
"""
Returns the full path names of all themes found in the given path.
"""
files = os.listdir(path)
themes = []
for filename in files:
if filename.endswith(Theme.extension()):
themes.append(os.path.join(path, filename))
return themes
@staticmethod
def load(filename, is_system=False):
""" Load a theme and return a new theme object. """
result = None
_file = open(filename)
try:
domdoc = minidom.parse(_file).documentElement
try:
theme = Theme()
node = domdoc.attributes.get("format")
format = Version.from_string(node.value) \
if node else Theme.THEME_FORMAT_INITIAL
theme.name = domdoc.attributes["name"].value
# "color_scheme" is the base file name of the color scheme
text = utils.xml_get_text(domdoc, "color_scheme")
if not text is None:
theme.color_scheme_basename = text
# get key label overrides
nodes = domdoc.getElementsByTagName("key_label_overrides")
if nodes:
overrides = nodes[0]
tuples = {}
for override in overrides.getElementsByTagName("key"):
key_id = override.attributes["id"].value
node = override.attributes.get("label")
label = node.value if node else ""
node = override.attributes.get("group")
group = node.value if node else ""
tuples[key_id] = (label, group)
theme.key_label_overrides = tuples
# read all other members
for name, _type, _default in Theme.attributes:
if not name in ["color_scheme_basename",
"key_label_overrides"]:
value = utils.xml_get_text(domdoc, name)
if not value is None:
if _type == "i":
value = int(value)
if _type == "f":
value = float(value)
# upgrade to current file format
if format < Theme.THEME_FORMAT_1_1:
# direction was 0..360, ccw
# is now -180..180, cw
if name == "key_gradient_direction":
value = -(value % 360)
if value <= -180:
value += 360
setattr(theme, name, value)
theme.filename = filename
theme.is_system = is_system
theme.system_exists = is_system
result = theme
except Exceptions.ThemeFileError as xxx_todo_changeme:
(ex) = xxx_todo_changeme
raise Exceptions.ThemeFileError(_("Error loading ")
+ filename, chained_exception = ex)
finally:
domdoc.unlink()
finally:
_file.close()
return result
def save_as(self, basename, name):
""" Save this theme under a new name. """
self.filename = self.build_user_filename(basename)
self.name = name
self.save()
def save(self):
""" Save this theme. """
domdoc = minidom.Document()
try:
theme_element = domdoc.createElement("theme")
theme_element.setAttribute("name", self.name)
theme_element.setAttribute("format", str(self.THEME_FORMAT))
domdoc.appendChild(theme_element)
for name, _type, _default in self.attributes:
if name == "color_scheme_basename":
element = domdoc.createElement("color_scheme")
text = domdoc.createTextNode(self.color_scheme_basename)
element.appendChild(text)
theme_element.appendChild(element)
elif name == "key_label_overrides":
overrides_element = \
domdoc.createElement("key_label_overrides")
theme_element.appendChild(overrides_element)
tuples = self.key_label_overrides
for key_id, values in list(tuples.items()):
element = domdoc.createElement("key")
element.setAttribute("id", key_id)
element.setAttribute("label", values[0])
element.setAttribute("group", values[1])
overrides_element.appendChild(element)
else:
value = getattr(self, name)
if _type == "s":
pass
elif _type == "i":
value = str(value)
elif _type == "f":
value = str(round(value, 2))
else:
assert(False) # attribute of unknown type
element = domdoc.createElement(name)
text = domdoc.createTextNode(value)
element.appendChild(text)
theme_element.appendChild(element)
pretty_xml = toprettyxml(domdoc)
with open(self.filename, "w") as _file:
_file.write(pretty_xml.encode("UTF-8"))
except Exception as xxx_todo_changeme2:
(ex) = xxx_todo_changeme2
raise Exceptions.ThemeFileError(_("Error saving ")
+ self.filename, chained_exception = ex)
finally:
domdoc.unlink()
class ColorScheme(object):
"""
ColorScheme defines the colors of onboards keyboard.
Each key or groups of keys may have their own individual colors.
Any color definition may be omitted. Undefined colors fall back
to color scheme defaults first, then to hard coded default colors.
"""
# onboard 0.95
COLOR_SCHEME_FORMAT_LEGACY = Version(1, 0)
# onboard 0.97, tree format, rule-based color matching
COLOR_SCHEME_FORMAT_TREE = Version(2, 0)
COLOR_SCHEME_FORMAT = COLOR_SCHEME_FORMAT_TREE
name = ""
filename = ""
is_system = False
root = None # tree root
def __init__(self):
pass
@property
def basename(self):
""" Returns the file base name of the color scheme. """
return os.path.splitext(os.path.basename(self.filename))[0]
def is_key_in_schema(self, key):
for id in [key.theme_id, key.id]:
if self.root.find_key_id(id):
return True
return False
def get_key_rgba(self, key, element, state = None):
# build a dict of supported key states
if state is None:
state = {}
state["prelight"] = key.prelight
state["pressed"] = key.pressed
state["active"] = key.active
state["locked"] = key.locked
state["scanned"] = key.scanned
state["insensitive"] = not key.sensitive
rgb = None
opacity = None
root_rgb = None
root_opacity = None
key_group = None
# first try to find the theme_id then fall back to the regular id
for id in [key.theme_id, key.id]:
key_group = self.root.find_key_id(id)
if key_group:
rgb, opacity = key_group.find_element_color(element, state)
break
# Get root colors in case key id wasn't mentioned
# anywhere in the color scheme.
root_key_group = self.root.get_default_key_group()
if root_key_group:
root_rgb, root_opacity = \
root_key_group.find_element_color(element, state)
# Special case for layer buttons:
# don't get fill color from root group,
# we want the layer fill color instead.
if element == "fill" and key.is_layer_button():
# Don't pick layer fill opacity when there is
# an rgb color defined in the color scheme.
if not rgb is None and \
opacity is None:
opacity = root_opacity
if opacity is None:
opacity = 1.0
elif key_group is None:
rgb = root_rgb
opacity = root_opacity
if rgb is None:
rgb = self.get_key_default_rgba(key, element, state)[:3]
if opacity is None:
opacity = self.get_key_default_rgba(key, element, state)[3]
rgba = rgb + [opacity]
return rgba
def get_key_default_rgba(self, key, element, state):
colors = {
"fill": [0.9, 0.85, 0.7, 1.0],
"prelight": [0.0, 0.0, 0.0, 1.0],
"pressed": [0.6, 0.6, 0.6, 1.0],
"active": [0.5, 0.5, 0.5, 1.0],
"locked": [1.0, 0.0, 0.0, 1.0],
"scanned": [0.45, 0.45, 0.7, 1.0],
"stroke": [0.0, 0.0, 0.0, 1.0],
"label": [0.0, 0.0, 0.0, 1.0],
"dwell-progress": [0.82, 0.19, 0.25, 1.0],
}
rgba = [0.0, 0.0, 0.0, 1.0]
if element == "fill":
if key.is_layer_button() and \
not any(state.values()):
# Special case for base fill color of layer buttons:
# default color is layer fill color (as in onboard <=0.95).
layer_index = key.get_layer_index()
rgba = self.get_layer_fill_rgba(layer_index)
elif state.get("pressed"):
new_state = dict(list(state.items()))
new_state["pressed"] = False
rgba = self.get_key_rgba(key, element, new_state)
# Make the default pressed color a slightly darker
# or brighter variation of the unpressed color.
h, l, s = colorsys.rgb_to_hls(*rgba[:3])
# boost lightness changes for very dark and very bright colors
# Ad-hoc formula, purly for aesthetics
amount = -(log((l+.001)*(1-(l-.001))))*0.05 + 0.08
if l < .5: # dark color?
rgba = brighten(+amount, *rgba) # brigther
else:
rgba = brighten(-amount, *rgba) # darker
elif state.get("scanned"):
rgba = colors["scanned"]
elif state.get("prelight"):
rgba = colors["prelight"]
elif state.get("locked"):
rgba = colors["locked"]
elif state.get("active"):
rgba = colors["active"]
else:
rgba = colors["fill"]
elif element == "stroke":
rgba == colors["stroke"]
elif element == "label":
rgba = colors["label"]
# dim label color for insensitive keys
if state.get("insensitive"):
new_state = dict(list(state.items()))
new_state["insensitive"] = False
fill = self.get_key_rgba(key, "fill", new_state)
rgba = self.get_key_rgba(key, "label", new_state)
h, lf, s = colorsys.rgb_to_hls(*fill[:3])
h, ll, s = colorsys.rgb_to_hls(*rgba[:3])
# Leave only one third of the lightness difference
# between label and fill color.
amount = (ll - lf) * 2.0 / 3.0
rgba = brighten(-amount, *rgba)
elif element == "dwell-progress":
rgba = colors["dwell-progress"]
else:
assert(False) # unknown element
return rgba
def get_layer_fill_rgba(self, layer_index):
"""
Returns the background fill color of the layer with the given index.
"""
rgb = None
opacity = None
layers = self.root.get_layers()
if layer_index >= 0 and layer_index < len(layers):
for item in layers[layer_index].items:
if item.is_color() and \
item.element == "background":
rgb = item.rgb
opacity = item.opacity
break
if rgb is None:
rgb = [0.5, 0.5, 0.5]
if opacity is None:
opacity = 1.0
rgba = rgb + [opacity]
return rgba
def get_icon_rgba(self, element):
"""
Returns the color for the given element of the icon.
"""
rgb = None
opacity = None
icons = self.root.get_icons()
for icon in icons:
for item in icon.items:
if item.is_color() and \
item.element == element:
rgb = item.rgb
opacity = item.opacity
break
# default icon background is layer0 background
if element == "background":
# hard-coded default is the most common color
rgba_default = [0.88, 0.88, 0.88, 1.0]
else:
assert(False)
if rgb is None:
rgb = rgba_default[:3]
if opacity is None:
opacity = rgba_default[3]
if rgb is None:
rgb = [0.5, 0.5, 0.5]
if opacity is None:
opacity = 1.0
rgba = rgb + [opacity]
return rgba
@staticmethod
def user_path():
""" Returns the path of the user directory for color schemes. """
return os.path.join(config.user_dir, "themes/")
@staticmethod
def system_path():
""" Returns the path of the system directory for color schemes. """
return os.path.join(config.install_dir, "themes")
@staticmethod
def extension():
""" Returns the file extension of color scheme files """
return "colors"
@staticmethod
def get_merged_color_schemes():
"""
Merge system and user color schemes.
User color schemes take precedence and hide system color schemes.
"""
system_color_schemes = ColorScheme.load_color_schemes(True)
user_color_schemes = ColorScheme.load_color_schemes(False)
color_schemes = dict((t.basename, t) for t in system_color_schemes)
for scheme in user_color_schemes:
color_schemes[scheme.basename] = scheme
return color_schemes
@staticmethod
def load_color_schemes(is_system=False):
"""
Load all color schemes from either the user or the system directory.
"""
color_schemes = []
if is_system:
path = ColorScheme.system_path()
else:
path = ColorScheme.user_path()
filenames = ColorScheme.find_color_schemes(path)
for filename in filenames:
color_scheme = ColorScheme.load(filename, is_system)
if color_scheme:
color_schemes.append(color_scheme)
return color_schemes
@staticmethod
def find_color_schemes(path):
"""
Returns the full path names of all color schemes found in the given path.
"""
files = os.listdir(path)
color_schemes = []
for filename in files:
if filename.endswith(ColorScheme.extension()):
color_schemes.append(os.path.join(path, filename))
return color_schemes
@staticmethod
def load(filename, is_system=False):
""" Load a color scheme and return it as a new object. """
color_scheme = None
f = open(filename)
try:
dom = minidom.parse(f).documentElement
name = dom.attributes["name"].value
# check layout format
format = ColorScheme.COLOR_SCHEME_FORMAT_LEGACY
if dom.hasAttribute("format"):
format = Version.from_string(dom.attributes["format"].value)
if format >= ColorScheme.COLOR_SCHEME_FORMAT_TREE: # tree format?
items = ColorScheme._parse_dom_node(dom, None, {})
else:
_logger.warning( \
_("Loading legacy color scheme format '{old_format}', "
"please consider upgrading to current format " \
"'{new_format}': '{filename}'") \
.format(old_format = format,
new_format = ColorScheme.COLOR_SCHEME_FORMAT,
filename = filename))
items = ColorScheme._parse_legacy_color_scheme(dom)
if not items is None:
root = Root()
root.set_items(items)
color_scheme = ColorScheme()
color_scheme.name = name
color_scheme.filename = filename
color_scheme.is_system = is_system
color_scheme.root = root
#print(root.dumps())
finally:
f.close()
return color_scheme
@staticmethod
def _parse_dom_node(dom_node, parent_item, used_keys):
""" Recursive function to parse all dom nodes of the layout tree """
items = []
for child in dom_node.childNodes:
if child.nodeType == minidom.Node.ELEMENT_NODE:
if child.tagName == "icon":
item = ColorScheme._parse_icon(child)
elif child.tagName == "layer":
item = ColorScheme._parse_layer(child)
elif child.tagName == "key_group":
item = ColorScheme._parse_key_group(child, used_keys)
elif child.tagName == "color":
item = ColorScheme._parse_color(child)
else:
item = None
if item:
item.parent = parent_item
item.items = ColorScheme._parse_dom_node(child, item, used_keys)
items.append(item)
return items
@staticmethod
def _parse_dom_node_item(node, item):
""" Parses common properties of all items """
if node.hasAttribute("id"):
item.id = node.attributes["id"].value
@staticmethod
def _parse_icon(node):
item = Icon()
ColorScheme._parse_dom_node_item(node, item)
return item
@staticmethod
def _parse_layer(node):
item = Layer()
ColorScheme._parse_dom_node_item(node, item)
return item
@staticmethod
def _parse_key_group(node, used_keys):
item = KeyGroup()
ColorScheme._parse_dom_node_item(node, item)
# read key ids
text = "".join([n.data for n in node.childNodes \
if n.nodeType == n.TEXT_NODE])
ids = [x for x in re.findall('\w+(?:[.][\w-]+)?', text) if x]
# check for duplicate key definitions
for key_id in ids:
if key_id in used_keys:
raise ValueError(_("Duplicate key_id '{}' found "
"in color scheme file. "
"Key_ids must occur only once."
.format(key_id)))
used_keys.update(list(zip(ids, ids)))
item.key_ids = ids
return item
@staticmethod
def _parse_color(node):
item = KeyColor()
ColorScheme._parse_dom_node_item(node, item)
if node.hasAttribute("element"):
item.element = node.attributes["element"].value
if node.hasAttribute("rgb"):
value = node.attributes["rgb"].value
item.rgb = [hexstring_to_float(value[1:3])/255,
hexstring_to_float(value[3:5])/255,
hexstring_to_float(value[5:7])/255]
if node.hasAttribute("opacity"):
item.opacity = float(node.attributes["opacity"].value)
state = {}
ColorScheme._parse_state_attibute(node, "prelight", state)
ColorScheme._parse_state_attibute(node, "pressed", state)
ColorScheme._parse_state_attibute(node, "active", state)
ColorScheme._parse_state_attibute(node, "locked", state)
ColorScheme._parse_state_attibute(node, "insensitive", state)
ColorScheme._parse_state_attibute(node, "scanned", state)
item.state = state
return item
@staticmethod
def _parse_state_attibute(node, name, state):
if node.hasAttribute(name):
value = node.attributes[name].value == "true"
state[name] = value
if name == "locked" and value:
state["active"] = True # locked implies active
###########################################################################
@staticmethod
def _parse_legacy_color_scheme(dom_node):
""" Load a color scheme and return it as a new object. """
color_defaults = {
"fill": [0.0, 0.0, 0.0, 1.0],
"hovered": [0.0, 0.0, 0.0, 1.0],
"pressed": [0.6, 0.6, 0.6, 1.0],
"pressed-latched": [0.6, 0.6, 0.6, 1.0],
"pressed-locked": [0.6, 0.6, 0.6, 1.0],
"latched": [0.5, 0.5, 0.5, 1.0],
"locked": [1.0, 0.0, 0.0, 1.0],
"scanned": [0.45, 0.45, 0.7, 1.0],
"stroke": [0.0, 0.0, 0.0, 1.0],
"stroke-hovered": [0.0, 0.0, 0.0, 1.0],
"stroke-pressed": [0.0, 0.0, 0.0, 1.0],
"stroke-pressed-latched": [0.0, 0.0, 0.0, 1.0],
"stroke-pressed-locked": [0.0, 0.0, 0.0, 1.0],
"stroke-latched": [0.0, 0.0, 0.0, 1.0],
"stroke-locked": [0.0, 0.0, 0.0, 1.0],
"stroke-scanned": [0.0, 0.0, 0.0, 1.0],
"label": [0.0, 0.0, 0.0, 1.0],
"label-hovered": [0.0, 0.0, 0.0, 1.0],
"label-pressed": [0.0, 0.0, 0.0, 1.0],
"label-pressed-latched": [0.0, 0.0, 0.0, 1.0],
"label-pressed-locked": [0.0, 0.0, 0.0, 1.0],
"label-latched": [0.0, 0.0, 0.0, 1.0],
"label-locked": [0.0, 0.0, 0.0, 1.0],
"label-scanned": [0.0, 0.0, 0.0, 1.0],
"dwell-progress": [0.82, 0.19, 0.25, 1.0],
}
items = []
# layer colors
layers = dom_node.getElementsByTagName("layer")
if not layers:
# Still accept "pane" for backwards compatibility
layers = dom_node.getElementsByTagName("pane")
for i, layer in enumerate(layers):
attrib = "fill"
rgb = None
opacity = None
color = KeyColor()
if layer.hasAttribute(attrib):
value = layer.attributes[attrib].value
color.rgb = [hexstring_to_float(value[1:3])/255,
hexstring_to_float(value[3:5])/255,
hexstring_to_float(value[5:7])/255]
oattrib = attrib + "-opacity"
if layer.hasAttribute(oattrib):
color.opacity = float(layer.attributes[oattrib].value)
color.element = "background"
layer = Layer()
layer.set_items([color])
items.append(layer)
# key groups
used_keys = {}
root_key_group = None
key_groups = []
for group in dom_node.getElementsByTagName("key_group"):
# Check for default flag.
# Default colors are applied to all keys
# not found in the color scheme.
default_group = False
if group.hasAttribute("default"):
default_group = bool(group.attributes["default"].value)
# read key ids
text = "".join([n.data for n in group.childNodes])
key_ids = [x for x in re.findall('\w+(?:[.][\w-]+)?', text) if x]
# check for duplicate key definitions
for key_id in key_ids:
if key_id in used_keys:
raise ValueError(_("Duplicate key_id '{}' found "
"in color scheme file. "
"Key_ids must occur only once."
.format(key_id)))
used_keys.update(list(zip(key_ids, key_ids)))
colors = []
for attrib in list(color_defaults.keys()):
rgb = None
opacity = None
# read color attribute
if group.hasAttribute(attrib):
value = group.attributes[attrib].value
rgb = [hexstring_to_float(value[1:3])/255,
hexstring_to_float(value[3:5])/255,
hexstring_to_float(value[5:7])/255]
# read opacity attribute
oattrib = attrib + "-opacity"
if group.hasAttribute(oattrib):
opacity = float(group.attributes[oattrib].value)
if not rgb is None or not opacity is None:
elements = ["fill", "stroke", "label", "dwell-progress"]
for element in elements:
if attrib.startswith(element):
break
else:
element = "fill"
if attrib.startswith(element):
state_attrib = attrib[len(element):]
if state_attrib.startswith("-"):
state_attrib = state_attrib[1:]
else:
state_attrib = attrib
color = KeyColor()
color.rgb = rgb
color.opacity = opacity
color.element = element
if state_attrib:
color.state = {state_attrib : True}
else:
color.state = {}
colors.append(color)
key_group = KeyGroup()
key_group.set_items(colors)
key_group.key_ids = key_ids
if default_group:
root_key_group = key_group
else:
key_groups.append(key_group)
if root_key_group:
root_key_group.append_items(key_groups)
items.append(root_key_group)
return items
class ColorSchemeItem(TreeItem):
""" Base class of color scheme items """
def dumps(self):
"""
Recursively dumps the (sub-) tree starting from self.
Returns a multi-line string.
"""
global _level
if not "_level" in globals():
_level = -1
_level += 1
s = " "*_level + repr(self) + "\n" + \
"".join(item.dumps() for item in self.items)
_level -= 1
return s
def is_icon(self):
return False
def is_layer(self):
return False
def is_key_group(self):
return False
def is_color(self):
return False
def find_key_id(self, key_id):
""" Find the key group that has key_id """
if self.is_key_group():
if key_id in self.key_ids:
return self
for child in self.items:
item = child.find_key_id(key_id)
if item:
return item
return None
class Root(ColorSchemeItem):
""" Container for a layers colors """
def get_layers(self):
"""
Get list of layer items in order of appearance
in the color scheme file.
"""
layers = []
for item in self.items:
if item.is_layer():
layers.append(item)
return layers
def get_icons(self):
"""
Get list of the icon items in order of appearance
in the color scheme file.
"""
icons = []
for item in self.items:
if item.is_icon():
icons.append(item)
return icons
def get_default_key_group(self):
""" Default key group for keys that aren't part of any key group """
for child in self.items:
if child.is_key_group():
return child
return None
class Icon(ColorSchemeItem):
""" Container for a Icon's' colors """
def is_icon(self):
return True
class Layer(ColorSchemeItem):
""" Container for a layers colors """
def is_layer(self):
return True
class Color(ColorSchemeItem):
""" A single color, rgb + opacity """
element = None
rgb = None
opacity = None
def __repr__(self):
return "{} element={} rgb={} opacity={}".format( \
ColorSchemeItem.__repr__(self),
repr(self.element),
repr(self.rgb),
repr(self.opacity))
def is_color(self):
return True
def matches(self, element, *args):
"""
Returns true if self matches the given parameters.
"""
return self.element == element
class KeyColor(Color):
"""
A single key (or layer) color.
"""
state = None # dict whith "pressed"=True, "active"=False, etc.
def __repr__(self):
return "{} element={} rgb={} opacity={} state={}".format( \
ColorSchemeItem.__repr__(self),
repr(self.element),
repr(self.rgb),
repr(self.opacity),
repr(self.state))
def matches(self, element, state):
"""
Returns true if self matches the given parameters.
state attributes match if they are equal or None, i.e. an
empty state dict always matches.
"""
result = True
if not self.element == element:
return False
for attr, value in list(state.items()):
# Special case for fill color
# By default the fill color is only applied to the single
# state where nothing is pressed, active, locked, etc.
# All other elements apply to all state permutations if
# not asked to do otherwise.
# Allows for hard coded default fill colors to take over without
# doing anything special in the color scheme files.
default = value # "don't care", always match unspecified states
if element == "fill" and \
attr in ["active", "locked", "pressed", "scanned"] and \
not attr in self.state:
default = False # consider unspecified states to be False
if element == "label" and \
attr in ["insensitive"] and \
not attr in self.state:
default = False # consider unspecified states to be False
if self.state.get(attr, default) != value:
result = False
return result
class KeyGroup(ColorSchemeItem):
""" A group of key ids and their colors """
key_ids = ()
def __repr__(self):
return "{} key_ids={}".format(ColorSchemeItem.__repr__(self),
repr(self.key_ids))
def is_key_group(self):
return True
def find_element_color(self, element, state):
rgb = None
opacity = None
# walk key groups from self down to the root
for key_group in self.iter_to_root():
if key_group.is_key_group():
# run through all colors of the key group, top to bottom
for child in key_group.items:
if child.is_color():
for color in child.iter_depth_first():
# matching color found?
if color.matches(element, state):
if rgb is None:
rgb = color.rgb
if opacity is None:
opacity = color.opacity
if not rgb is None and not opacity is None:
return rgb, opacity # break early
return rgb, opacity
|