generate.py

from lxml import etree
import sys, json

manifest = dict[str, object]() # https://developer.chrome.com/docs/extensions/mv3/manifest/
manifest['manifest_version'] = 3
manifest['name'] = 'XKB keyboard layouts for Chrome OS'
manifest['version'] = '0.0.9'
manifest['description'] = "500+ keyboard layouts for Chrome OS. This extension makes all XKB layouts visible in Chrome OS."
manifest['icons'] = {'128' : 'icon128.png'}
manifest['input_components'] = list()

from typing import Iterator, NamedTuple, Optional
class ConfigItemDetails(NamedTuple):
    """Details from a single configItem xml element"""
    name: str
    shortDescription: Optional[str]
    description: Optional[str]
    """Countries"""
    iso3166: Optional[list[str]]
    """Languages"""
    iso639: Optional[list[str]]

class LayoutDetails(NamedTuple):
    """Details combining layout and optional variant"""
    layout: str
    variant: Optional[str]
    brief: Optional[str]
    description: Optional[str]
    """Countries"""
    iso3166: Optional[list[str]]
    """Languages"""
    iso639: Optional[list[str]]

    def xkb_name(self) -> str:
        return f"{self.layout}({self.variant})" if self.variant else self.layout


def merge(parent : ConfigItemDetails, variant : Optional[ConfigItemDetails]) -> LayoutDetails:
    if not variant:
        return LayoutDetails(layout = parent.name, variant=None, brief = parent.shortDescription, description = parent.description, iso3166 = parent.iso3166, iso639 = parent.iso639)
    return LayoutDetails(layout=parent.name, variant=variant.name, brief = variant.shortDescription if variant.shortDescription != None else parent.shortDescription, description=variant.description, iso3166=variant.iso3166 if variant.iso3166 != None else parent.iso3166, iso639 = variant.iso639 if variant.iso639 != None else parent.iso639)

import langcodes

def append_input_component(details: LayoutDetails):
    obj = dict[str, object]()
    obj['name']= f"XKB's {details.xkb_name()} -- {details.description}"
    obj['id']="all-xkb-layouts-" + details.xkb_name()
    if details.iso639:
        # languages = [f"{language}-{country}" for country in details.countries for language in details.languages] if details.countries else details.languages
        obj['language']=[langcodes.standardize_tag(language) for language in details.iso639] # multiple allowed
    else:
        # necessary otherwise switching to layoyut will crash Chrome OS
        obj['language']=['??']
    obj['layouts']=[details.xkb_name()] # list of one
    manifest['input_components'].append(obj)


def get_config_details(configItem) -> ConfigItemDetails:
    name = configItem.find('name').text
    shortDescription = configItem.find('shortDescription').text if configItem.find('shortDescription') is not None else None
    description = configItem.find('description').text if configItem.find('description') is not None else None
    iso3166 = [x.text for x in configItem.findall('countryList/iso3166Id')] if configItem.find('countryList') is not None else None
    iso639 = [x.text for x in configItem.findall('languageList/iso639Id')] if configItem.find('languageList') is not None else None
    return ConfigItemDetails(name=name, shortDescription=shortDescription, description=description, iso3166=iso3166, iso639=iso639)

def layouts_from_xml_path(path: str) -> Iterator[LayoutDetails]:
    evdev = etree.parse(path)
    for layout in evdev.findall('layoutList/layout'):
        parent = get_config_details(layout.find('configItem'))
        yield merge(parent, None)
        for variant in layout.findall('variantList/variant/configItem'):
            yield merge(parent, get_config_details(variant))

def layouts_from_yaml_path(path: str) -> list[LayoutDetails]:
    import ruamel.yaml
    return [LayoutDetails(**layout) for layout in ruamel.yaml.safe_load(open(path))['layouts']]

paths = sys.argv[1:] or ["/usr/share/X11/xkb/rules/evdev.xml"]
for path in paths:
    layouts = layouts_from_yaml_path(path) if path.endswith(".yaml") else layouts_from_xml_path(path)
    for layout in layouts:
        append_input_component(layout)

with open('manifest.json', 'w') as f:
    json.dump(manifest, f, indent=4)