From ad7314a01684185f5cf33cc31ef35d1027776a88 Mon Sep 17 00:00:00 2001
From: Jules Aguillon <jules@j3s.fr>
Date: Sun, 21 Jan 2024 16:34:49 +0100
Subject: [PATCH] Move layout definitions into srcs/layouts

This separates the layout definitions from the special layouts
(bottom_row, greekmath) and other unrelated files (method, settings).

This is also a more intuitive location for layouts and make the resource
directory easier to navigate.

Under the hood, layouts are copied back into
build/generated-resources/xml.
---
 CONTRIBUTING.md                               |  5 ++--
 build.gradle                                  | 27 +++++++++++--------
 gen_layouts.py                                | 13 +++------
 srcs/juloo.keyboard2/KeyValue.java            |  6 ++---
 .../prefs/LayoutsPreference.java              |  2 +-
 {res/xml => srcs/layouts}/arab_alt.xml        |  0
 {res/xml => srcs/layouts}/arab_pc.xml         |  0
 {res/xml => srcs/layouts}/arab_pc_ckb.xml     |  0
 {res/xml => srcs/layouts}/arab_pc_hindu.xml   |  0
 {res/xml => srcs/layouts}/arab_pc_ir.xml      |  0
 {res/xml => srcs/layouts}/armenian_ph_am.xml  |  0
 {res/xml => srcs/layouts}/beng_national.xml   |  0
 {res/xml => srcs/layouts}/beng_provat.xml     |  0
 {res/xml => srcs/layouts}/cyrl_jcuken_ru.xml  |  0
 {res/xml => srcs/layouts}/cyrl_jcuken_uk.xml  |  0
 {res/xml => srcs/layouts}/cyrl_ueishsht.xml   |  0
 {res/xml => srcs/layouts}/cyrl_yaverti.xml    |  0
 {res/xml => srcs/layouts}/deva_alt.xml        |  0
 {res/xml => srcs/layouts}/deva_inscript.xml   |  0
 {res/xml => srcs/layouts}/grek_qwerty.xml     |  0
 .../layouts}/hang_dubeolsik_kr.xml            |  0
 {res/xml => srcs/layouts}/hebr_1_il.xml       |  0
 {res/xml => srcs/layouts}/hebr_2_il.xml       |  0
 {res/xml => srcs/layouts}/latn_azerty_fr.xml  |  0
 {res/xml => srcs/layouts}/latn_bepo_fr.xml    |  0
 {res/xml => srcs/layouts}/latn_bone.xml       |  0
 {res/xml => srcs/layouts}/latn_colemak.xml    |  0
 {res/xml => srcs/layouts}/latn_dvorak.xml     |  0
 {res/xml => srcs/layouts}/latn_neo2.xml       |  0
 {res/xml => srcs/layouts}/latn_qwerty_br.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_cz.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_es.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_hu.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_lv.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_no.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_pl.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_ro.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_se.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_tr.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_us.xml  |  0
 {res/xml => srcs/layouts}/latn_qwerty_vi.xml  |  0
 {res/xml => srcs/layouts}/latn_qwertz.xml     |  0
 {res/xml => srcs/layouts}/latn_qwertz_cz.xml  |  0
 .../latn_qwertz_cz_multifunctional.xml        |  0
 {res/xml => srcs/layouts}/latn_qwertz_de.xml  |  0
 .../layouts}/latn_qwertz_fr_ch.xml            |  0
 {res/xml => srcs/layouts}/latn_qwertz_hu.xml  |  0
 {res/xml => srcs/layouts}/latn_qwertz_sk.xml  |  0
 .../xml => srcs/layouts}/urdu_phonetic_ur.xml |  0
 49 files changed, 26 insertions(+), 27 deletions(-)
 rename {res/xml => srcs/layouts}/arab_alt.xml (100%)
 rename {res/xml => srcs/layouts}/arab_pc.xml (100%)
 rename {res/xml => srcs/layouts}/arab_pc_ckb.xml (100%)
 rename {res/xml => srcs/layouts}/arab_pc_hindu.xml (100%)
 rename {res/xml => srcs/layouts}/arab_pc_ir.xml (100%)
 rename {res/xml => srcs/layouts}/armenian_ph_am.xml (100%)
 rename {res/xml => srcs/layouts}/beng_national.xml (100%)
 rename {res/xml => srcs/layouts}/beng_provat.xml (100%)
 rename {res/xml => srcs/layouts}/cyrl_jcuken_ru.xml (100%)
 rename {res/xml => srcs/layouts}/cyrl_jcuken_uk.xml (100%)
 rename {res/xml => srcs/layouts}/cyrl_ueishsht.xml (100%)
 rename {res/xml => srcs/layouts}/cyrl_yaverti.xml (100%)
 rename {res/xml => srcs/layouts}/deva_alt.xml (100%)
 rename {res/xml => srcs/layouts}/deva_inscript.xml (100%)
 rename {res/xml => srcs/layouts}/grek_qwerty.xml (100%)
 rename {res/xml => srcs/layouts}/hang_dubeolsik_kr.xml (100%)
 rename {res/xml => srcs/layouts}/hebr_1_il.xml (100%)
 rename {res/xml => srcs/layouts}/hebr_2_il.xml (100%)
 rename {res/xml => srcs/layouts}/latn_azerty_fr.xml (100%)
 rename {res/xml => srcs/layouts}/latn_bepo_fr.xml (100%)
 rename {res/xml => srcs/layouts}/latn_bone.xml (100%)
 rename {res/xml => srcs/layouts}/latn_colemak.xml (100%)
 rename {res/xml => srcs/layouts}/latn_dvorak.xml (100%)
 rename {res/xml => srcs/layouts}/latn_neo2.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_br.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_cz.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_es.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_hu.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_lv.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_no.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_pl.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_ro.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_se.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_tr.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_us.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwerty_vi.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwertz.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwertz_cz.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwertz_cz_multifunctional.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwertz_de.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwertz_fr_ch.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwertz_hu.xml (100%)
 rename {res/xml => srcs/layouts}/latn_qwertz_sk.xml (100%)
 rename {res/xml => srcs/layouts}/urdu_phonetic_ur.xml (100%)

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<LayoutsPreference.Lay
     public SystemLayout() {}
   }
 
-  /** The name of a layout defined in [res/xml]. */
+  /** The name of a layout defined in [srcs/layouts]. */
   public static final class NamedLayout implements Layout
   {
     public final String name;
diff --git a/res/xml/arab_alt.xml b/srcs/layouts/arab_alt.xml
similarity index 100%
rename from res/xml/arab_alt.xml
rename to srcs/layouts/arab_alt.xml
diff --git a/res/xml/arab_pc.xml b/srcs/layouts/arab_pc.xml
similarity index 100%
rename from res/xml/arab_pc.xml
rename to srcs/layouts/arab_pc.xml
diff --git a/res/xml/arab_pc_ckb.xml b/srcs/layouts/arab_pc_ckb.xml
similarity index 100%
rename from res/xml/arab_pc_ckb.xml
rename to srcs/layouts/arab_pc_ckb.xml
diff --git a/res/xml/arab_pc_hindu.xml b/srcs/layouts/arab_pc_hindu.xml
similarity index 100%
rename from res/xml/arab_pc_hindu.xml
rename to srcs/layouts/arab_pc_hindu.xml
diff --git a/res/xml/arab_pc_ir.xml b/srcs/layouts/arab_pc_ir.xml
similarity index 100%
rename from res/xml/arab_pc_ir.xml
rename to srcs/layouts/arab_pc_ir.xml
diff --git a/res/xml/armenian_ph_am.xml b/srcs/layouts/armenian_ph_am.xml
similarity index 100%
rename from res/xml/armenian_ph_am.xml
rename to srcs/layouts/armenian_ph_am.xml
diff --git a/res/xml/beng_national.xml b/srcs/layouts/beng_national.xml
similarity index 100%
rename from res/xml/beng_national.xml
rename to srcs/layouts/beng_national.xml
diff --git a/res/xml/beng_provat.xml b/srcs/layouts/beng_provat.xml
similarity index 100%
rename from res/xml/beng_provat.xml
rename to srcs/layouts/beng_provat.xml
diff --git a/res/xml/cyrl_jcuken_ru.xml b/srcs/layouts/cyrl_jcuken_ru.xml
similarity index 100%
rename from res/xml/cyrl_jcuken_ru.xml
rename to srcs/layouts/cyrl_jcuken_ru.xml
diff --git a/res/xml/cyrl_jcuken_uk.xml b/srcs/layouts/cyrl_jcuken_uk.xml
similarity index 100%
rename from res/xml/cyrl_jcuken_uk.xml
rename to srcs/layouts/cyrl_jcuken_uk.xml
diff --git a/res/xml/cyrl_ueishsht.xml b/srcs/layouts/cyrl_ueishsht.xml
similarity index 100%
rename from res/xml/cyrl_ueishsht.xml
rename to srcs/layouts/cyrl_ueishsht.xml
diff --git a/res/xml/cyrl_yaverti.xml b/srcs/layouts/cyrl_yaverti.xml
similarity index 100%
rename from res/xml/cyrl_yaverti.xml
rename to srcs/layouts/cyrl_yaverti.xml
diff --git a/res/xml/deva_alt.xml b/srcs/layouts/deva_alt.xml
similarity index 100%
rename from res/xml/deva_alt.xml
rename to srcs/layouts/deva_alt.xml
diff --git a/res/xml/deva_inscript.xml b/srcs/layouts/deva_inscript.xml
similarity index 100%
rename from res/xml/deva_inscript.xml
rename to srcs/layouts/deva_inscript.xml
diff --git a/res/xml/grek_qwerty.xml b/srcs/layouts/grek_qwerty.xml
similarity index 100%
rename from res/xml/grek_qwerty.xml
rename to srcs/layouts/grek_qwerty.xml
diff --git a/res/xml/hang_dubeolsik_kr.xml b/srcs/layouts/hang_dubeolsik_kr.xml
similarity index 100%
rename from res/xml/hang_dubeolsik_kr.xml
rename to srcs/layouts/hang_dubeolsik_kr.xml
diff --git a/res/xml/hebr_1_il.xml b/srcs/layouts/hebr_1_il.xml
similarity index 100%
rename from res/xml/hebr_1_il.xml
rename to srcs/layouts/hebr_1_il.xml
diff --git a/res/xml/hebr_2_il.xml b/srcs/layouts/hebr_2_il.xml
similarity index 100%
rename from res/xml/hebr_2_il.xml
rename to srcs/layouts/hebr_2_il.xml
diff --git a/res/xml/latn_azerty_fr.xml b/srcs/layouts/latn_azerty_fr.xml
similarity index 100%
rename from res/xml/latn_azerty_fr.xml
rename to srcs/layouts/latn_azerty_fr.xml
diff --git a/res/xml/latn_bepo_fr.xml b/srcs/layouts/latn_bepo_fr.xml
similarity index 100%
rename from res/xml/latn_bepo_fr.xml
rename to srcs/layouts/latn_bepo_fr.xml
diff --git a/res/xml/latn_bone.xml b/srcs/layouts/latn_bone.xml
similarity index 100%
rename from res/xml/latn_bone.xml
rename to srcs/layouts/latn_bone.xml
diff --git a/res/xml/latn_colemak.xml b/srcs/layouts/latn_colemak.xml
similarity index 100%
rename from res/xml/latn_colemak.xml
rename to srcs/layouts/latn_colemak.xml
diff --git a/res/xml/latn_dvorak.xml b/srcs/layouts/latn_dvorak.xml
similarity index 100%
rename from res/xml/latn_dvorak.xml
rename to srcs/layouts/latn_dvorak.xml
diff --git a/res/xml/latn_neo2.xml b/srcs/layouts/latn_neo2.xml
similarity index 100%
rename from res/xml/latn_neo2.xml
rename to srcs/layouts/latn_neo2.xml
diff --git a/res/xml/latn_qwerty_br.xml b/srcs/layouts/latn_qwerty_br.xml
similarity index 100%
rename from res/xml/latn_qwerty_br.xml
rename to srcs/layouts/latn_qwerty_br.xml
diff --git a/res/xml/latn_qwerty_cz.xml b/srcs/layouts/latn_qwerty_cz.xml
similarity index 100%
rename from res/xml/latn_qwerty_cz.xml
rename to srcs/layouts/latn_qwerty_cz.xml
diff --git a/res/xml/latn_qwerty_es.xml b/srcs/layouts/latn_qwerty_es.xml
similarity index 100%
rename from res/xml/latn_qwerty_es.xml
rename to srcs/layouts/latn_qwerty_es.xml
diff --git a/res/xml/latn_qwerty_hu.xml b/srcs/layouts/latn_qwerty_hu.xml
similarity index 100%
rename from res/xml/latn_qwerty_hu.xml
rename to srcs/layouts/latn_qwerty_hu.xml
diff --git a/res/xml/latn_qwerty_lv.xml b/srcs/layouts/latn_qwerty_lv.xml
similarity index 100%
rename from res/xml/latn_qwerty_lv.xml
rename to srcs/layouts/latn_qwerty_lv.xml
diff --git a/res/xml/latn_qwerty_no.xml b/srcs/layouts/latn_qwerty_no.xml
similarity index 100%
rename from res/xml/latn_qwerty_no.xml
rename to srcs/layouts/latn_qwerty_no.xml
diff --git a/res/xml/latn_qwerty_pl.xml b/srcs/layouts/latn_qwerty_pl.xml
similarity index 100%
rename from res/xml/latn_qwerty_pl.xml
rename to srcs/layouts/latn_qwerty_pl.xml
diff --git a/res/xml/latn_qwerty_ro.xml b/srcs/layouts/latn_qwerty_ro.xml
similarity index 100%
rename from res/xml/latn_qwerty_ro.xml
rename to srcs/layouts/latn_qwerty_ro.xml
diff --git a/res/xml/latn_qwerty_se.xml b/srcs/layouts/latn_qwerty_se.xml
similarity index 100%
rename from res/xml/latn_qwerty_se.xml
rename to srcs/layouts/latn_qwerty_se.xml
diff --git a/res/xml/latn_qwerty_tr.xml b/srcs/layouts/latn_qwerty_tr.xml
similarity index 100%
rename from res/xml/latn_qwerty_tr.xml
rename to srcs/layouts/latn_qwerty_tr.xml
diff --git a/res/xml/latn_qwerty_us.xml b/srcs/layouts/latn_qwerty_us.xml
similarity index 100%
rename from res/xml/latn_qwerty_us.xml
rename to srcs/layouts/latn_qwerty_us.xml
diff --git a/res/xml/latn_qwerty_vi.xml b/srcs/layouts/latn_qwerty_vi.xml
similarity index 100%
rename from res/xml/latn_qwerty_vi.xml
rename to srcs/layouts/latn_qwerty_vi.xml
diff --git a/res/xml/latn_qwertz.xml b/srcs/layouts/latn_qwertz.xml
similarity index 100%
rename from res/xml/latn_qwertz.xml
rename to srcs/layouts/latn_qwertz.xml
diff --git a/res/xml/latn_qwertz_cz.xml b/srcs/layouts/latn_qwertz_cz.xml
similarity index 100%
rename from res/xml/latn_qwertz_cz.xml
rename to srcs/layouts/latn_qwertz_cz.xml
diff --git a/res/xml/latn_qwertz_cz_multifunctional.xml b/srcs/layouts/latn_qwertz_cz_multifunctional.xml
similarity index 100%
rename from res/xml/latn_qwertz_cz_multifunctional.xml
rename to srcs/layouts/latn_qwertz_cz_multifunctional.xml
diff --git a/res/xml/latn_qwertz_de.xml b/srcs/layouts/latn_qwertz_de.xml
similarity index 100%
rename from res/xml/latn_qwertz_de.xml
rename to srcs/layouts/latn_qwertz_de.xml
diff --git a/res/xml/latn_qwertz_fr_ch.xml b/srcs/layouts/latn_qwertz_fr_ch.xml
similarity index 100%
rename from res/xml/latn_qwertz_fr_ch.xml
rename to srcs/layouts/latn_qwertz_fr_ch.xml
diff --git a/res/xml/latn_qwertz_hu.xml b/srcs/layouts/latn_qwertz_hu.xml
similarity index 100%
rename from res/xml/latn_qwertz_hu.xml
rename to srcs/layouts/latn_qwertz_hu.xml
diff --git a/res/xml/latn_qwertz_sk.xml b/srcs/layouts/latn_qwertz_sk.xml
similarity index 100%
rename from res/xml/latn_qwertz_sk.xml
rename to srcs/layouts/latn_qwertz_sk.xml
diff --git a/res/xml/urdu_phonetic_ur.xml b/srcs/layouts/urdu_phonetic_ur.xml
similarity index 100%
rename from res/xml/urdu_phonetic_ur.xml
rename to srcs/layouts/urdu_phonetic_ur.xml