diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62b2342..596ea64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,14 +88,15 @@ Github secret named `DEBUG_KEYSTORE`. ### Adding a layout -Layouts are defined in XML, see `res/xml/latn_qwerty_us.xml`. +Layouts are defined in XML, see `srcs/layouts/latn_qwerty_us.xml`. An online tool for editing layout files written by @Lixquid is available [here](https://unexpected-keyboard-layout-editor.lixquid.com/). Makes sure to specify the `name` attribute like in `latn_qwerty_us.xml`, otherwise the layout won't be added to the app. -The layout file must be placed in the `res/xml/` directory and named according to: +The layout file must be placed in the `srcs/layouts` directory and named +according to: - script (`latn` for latin, etc..) - layout name (eg. the name of a standard) - country code (or language code if more adequate) diff --git a/build.gradle b/build.gradle index b2ea12d..1f12e56 100644 --- a/build.gradle +++ b/build.gradle @@ -115,17 +115,13 @@ tasks.register('genLayoutsList') { tasks.register('checkKeyboardLayouts') { println "\nChecking layouts" - new ByteArrayOutputStream().withStream { bos -> - exec { - def layouts = new File(projectDir, "res/xml").listFiles().findAll { - it.isFile() && it.name.endsWith(".xml") - } - workingDir = projectDir - commandLine("python", "check_layout.py", *layouts) - standardOutput = bos + exec { + def layouts = new File(projectDir, "srcs/layouts").listFiles().findAll { + it.name.endsWith(".xml") } - - new File(projectDir, "check_layout.output").write(bos.toString()) + workingDir = projectDir + commandLine("python", "check_layout.py", *layouts) + standardOutput = new FileOutputStream("${projectDir}/check_layout.output") } } @@ -140,6 +136,7 @@ tasks.register('syncTranslations') { tasks.named("preBuild") { dependsOn += "initDebugKeystore" dependsOn += "copyRawQwertyUS" + dependsOn += "copyLayoutDefinitions" } tasks.register('initDebugKeystore') { @@ -156,7 +153,15 @@ tasks.register('initDebugKeystore') { tasks.register('copyRawQwertyUS') { copy { - from "res/xml/latn_qwerty_us.xml" + from "srcs/layouts/latn_qwerty_us.xml" into "build/generated-resources/raw" } } + +tasks.register('copyLayoutDefinitions') +{ + copy { + from "srcs/layouts" + into "build/generated-resources/xml" + } +} diff --git a/gen_layouts.py b/gen_layouts.py index c2e6e8d..4b8ac59 100644 --- a/gen_layouts.py +++ b/gen_layouts.py @@ -1,7 +1,7 @@ #!/usr/bin/env python # Generates the list of layouts in res/values/layouts.xml from the layout files -# in res/xml. Every layouts must have a 'name' attribute to be listed. +# in srcs/layouts. Every layouts must have a 'name' attribute to be listed. import itertools as it import sys, os, glob @@ -11,11 +11,6 @@ import xml.etree.ElementTree as XML # are sorted alphabetically. FIRST_LAYOUTS = [ "latn_qwerty_us", "latn_colemak", "latn_dvorak" ] -# File names that are known not to be layouts. Avoid warning about them. -KNOWN_NOT_LAYOUT = set([ - "number_row", "numpad", "pin", "bottom_row", "settings", "method", - "greekmath", "numeric" ]) - # Read a layout from a file. Returns [None] if [fname] is not a layout. def read_layout(fname): root = XML.parse(fname).getroot() @@ -28,9 +23,7 @@ def read_layouts(files): for layout_file in files: layout_id, _ = os.path.splitext(os.path.basename(layout_file)) layout = read_layout(layout_file) - if layout_id in KNOWN_NOT_LAYOUT: - continue - elif layout == None: + if layout == None: print("Not a layout file: %s" % layout_file) elif layout["name"] == None: print("Layout doesn't have a name: %s" % layout_id) @@ -66,6 +59,6 @@ def generate_arrays(out, layouts): XML.indent(root) XML.ElementTree(element=root).write(out, encoding="unicode", xml_declaration=True) -layouts = sort_layouts(read_layouts(glob.glob("res/xml/*.xml"))) +layouts = sort_layouts(read_layouts(glob.glob("srcs/layouts/*.xml"))) with open("res/values/layouts.xml", "w") as out: generate_arrays(out, layouts) diff --git a/srcs/juloo.keyboard2/KeyValue.java b/srcs/juloo.keyboard2/KeyValue.java index 27ceaf4..dbd9e3e 100644 --- a/srcs/juloo.keyboard2/KeyValue.java +++ b/srcs/juloo.keyboard2/KeyValue.java @@ -317,9 +317,9 @@ public final class KeyValue { switch (name) { - /* These symbols have special meaning when in `res/xml` and are escaped in - standard layouts. The backslash is not stripped when parsed from the - custom layout option. */ + /* These symbols have special meaning when in `srcs/layouts` and are + escaped in standard layouts. The backslash is not stripped when parsed + from the custom layout option. */ case "\\?": return makeStringKey("?"); case "\\#": return makeStringKey("#"); case "\\@": return makeStringKey("@"); diff --git a/srcs/juloo.keyboard2/prefs/LayoutsPreference.java b/srcs/juloo.keyboard2/prefs/LayoutsPreference.java index 787800c..842a2f2 100644 --- a/srcs/juloo.keyboard2/prefs/LayoutsPreference.java +++ b/srcs/juloo.keyboard2/prefs/LayoutsPreference.java @@ -245,7 +245,7 @@ public class LayoutsPreference extends ListGroupPreference