LibKeyboard: Add new library for keyboard applications

Move shared code base from keymap and KeyboardMapper to this library.

Libraries/CMakeLists.txt

@@ -10,6 +10,7 @@ add_subdirectory(LibGUI)
 add_subdirectory(LibHTTP)
 add_subdirectory(LibIPC)
 add_subdirectory(LibJS)
+add_subdirectory(LibKeyboard)
 add_subdirectory(LibLine)
 add_subdirectory(LibM)
 add_subdirectory(LibMarkdown)

Libraries/LibKeyboard/CMakeLists.txt

@@ -0,0 +1,7 @@
+set(SOURCES
+    CharacterMap.cpp
+    CharacterMapFile.cpp
+)
+
+serenity_lib(LibKeyboard keyboard)
+target_link_libraries(LibKeyboard LibCore)

Libraries/LibKeyboard/CharacterMap.cpp

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2020, Hüseyin Aslıtürk <asliturk@hotmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "CharacterMap.h"
+#include <Kernel/Syscall.h>
+#include <LibKeyboard/CharacterMapFile.h>
+
+namespace Keyboard {
+
+CharacterMap::CharacterMap(const String& file_name)
+{
+    auto result = CharacterMapFile::load_from_file(file_name);
+    ASSERT(result.has_value());
+
+    m_character_map = result.value();
+}
+
+int CharacterMap::set_system_map()
+{
+    Syscall::SC_setkeymap_params params { m_character_map.map, m_character_map.shift_map, m_character_map.alt_map, m_character_map.altgr_map };
+    return syscall(SC_setkeymap, &params);
+}
+
+}

Libraries/LibKeyboard/CharacterMap.h

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2020, Hüseyin Aslıtürk <asliturk@hotmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <AK/String.h>
+#include <LibKeyboard/CharacterMapData.h>
+
+namespace Keyboard {
+
+class CharacterMap {
+
+public:
+    CharacterMap(const String& file_name);
+
+    int set_system_map();
+
+private:
+    CharacterMapData m_character_map;
+};
+
+}

Libraries/LibKeyboard/CharacterMapData.h

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2020, Hüseyin Aslıtürk <asliturk@hotmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#define CHAR_MAP_SIZE 0x80
+
+namespace Keyboard {
+
+struct CharacterMapData {
+    char map[CHAR_MAP_SIZE];
+    char shift_map[CHAR_MAP_SIZE];
+    char alt_map[CHAR_MAP_SIZE];
+    char altgr_map[CHAR_MAP_SIZE];
+};
+
+}

Libraries/LibKeyboard/CharacterMapFile.cpp

@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2020, Hüseyin Aslıtürk <asliturk@hotmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "CharacterMapFile.h"
+#include <LibCore/File.h>
+
+namespace Keyboard {
+
+Optional<CharacterMapData> CharacterMapFile::load_from_file(const String& file_name)
+{
+    auto path = file_name;
+    if (!path.ends_with(".json")) {
+        StringBuilder full_path;
+        full_path.append("/res/keymaps/");
+        full_path.append(file_name);
+        full_path.append(".json");
+        path = full_path.to_string();
+    }
+
+    auto file = Core::File::construct(path);
+    file->open(Core::IODevice::ReadOnly);
+    if (!file->is_open()) {
+        dbg() << "Failed to open " << file_name << ":" << file->error_string();
+        return {};
+    }
+
+    auto file_contents = file->read_all();
+    auto json = JsonValue::from_string(file_contents).as_object();
+
+    ByteBuffer map = read_map(json, "map");
+    ByteBuffer shift_map = read_map(json, "shift_map");
+    ByteBuffer alt_map = read_map(json, "alt_map");
+    ByteBuffer altgr_map = read_map(json, "altgr_map");
+
+    CharacterMapData character_map;
+    for (int i = 0; i < CHAR_MAP_SIZE; i++) {
+        character_map.map[i] = map[i];
+        character_map.shift_map[i] = shift_map[i];
+        character_map.alt_map[i] = alt_map[i];
+        if (altgr_map) {
+            character_map.altgr_map[i] = altgr_map[i];
+        } else {
+            // AltGr map was not found, using Alt map as fallback.
+            character_map.altgr_map[i] = alt_map[i];
+        }
+    }
+
+    return character_map;
+}
+
+ByteBuffer CharacterMapFile::read_map(const JsonObject& json, const String& name)
+{
+    if (!json.has(name))
+        return nullptr;
+
+    ByteBuffer buffer;
+    buffer.grow(CHAR_MAP_SIZE);
+
+    auto map_arr = json.get(name).as_array();
+    for (int i = 0; i < map_arr.size(); i++) {
+        auto key_value = map_arr.at(i).as_string();
+        if (key_value.length() == 0) {
+            buffer[i] = 0;
+        } else if (key_value.length() == 1) {
+            buffer[i] = key_value.characters()[0];
+        } else {
+            dbg() << "Unknown character in " << name.characters() << "[" << i << "] = " << key_value.characters() << ".";
+            ASSERT_NOT_REACHED();
+        }
+    }
+
+    return buffer;
+}
+
+}

Libraries/LibKeyboard/CharacterMapFile.h

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2020, Hüseyin Aslıtürk <asliturk@hotmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <AK/JsonObject.h>
+#include <LibKeyboard/CharacterMapData.h>
+
+namespace Keyboard {
+
+class CharacterMapFile {
+
+public:
+    static Optional<CharacterMapData> load_from_file(const String& file_name);
+
+private:
+    static ByteBuffer read_map(const JsonObject& json, const String& name);
+};
+
+}