ladybird/Userland/Libraries/LibKeyboard/CharacterMap.h

/*
 * Copyright (c) 2020, Hüseyin Aslıtürk <asliturk@hotmail.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/ByteString.h>
#include <AK/Error.h>
#include <LibKeyboard/CharacterMapData.h>

namespace Keyboard {

class CharacterMap {

public:
    CharacterMap(ByteString const& map_name, CharacterMapData const& map_data);
    static ErrorOr<CharacterMap> load_from_file(ByteString const& filename);

    int set_system_map();
    static ErrorOr<CharacterMap> fetch_system_map();

    CharacterMapData const& character_map_data() const { return m_character_map_data; }
    ByteString const& character_map_name() const;

private:
    CharacterMapData m_character_map_data;
    ByteString m_character_map_name;
};

}
-												LibKeyboard: Add new library for keyboard applications

Move shared code base from keymap and KeyboardMapper to this library.
											
										
										
											2020-05-31 16:23:55 +03:00
+								/*
 								 * Copyright (c) 2020, Hüseyin Aslıtürk <asliturk@hotmail.com>
 								 *
-												Everything: Move to SPDX license identifiers in all files.

SPDX License Identifiers are a more compact / standardized
way of representing file license information.

See: https://spdx.dev/resources/use/#identifiers

This was done with the `ambr` search and replace tool.

 ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *

											
										
										
											2021-04-22 01:24:48 -07:00
+								 * SPDX-License-Identifier: BSD-2-Clause
-												LibKeyboard: Add new library for keyboard applications

Move shared code base from keymap and KeyboardMapper to this library.
											
										
										
											2020-05-31 16:23:55 +03:00
+								 */
 								#pragma once
-												Everywhere: Rename {Deprecated => Byte}String

This commit un-deprecates DeprecatedString, and repurposes it as a byte
string.
As the null state has already been removed, there are no other
particularly hairy blockers in repurposing this type as a byte string
(what it _really_ is).

This commit is auto-generated:
  $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \
    Meta Ports Ladybird Tests Kernel)
  $ perl -pie 's/\bDeprecatedString\b/ByteString/g;
    s/deprecated_string/byte_string/g' $xs
  $ clang-format --style=file -i \
    $(git diff --name-only | grep \.cpp\|\.h)
  $ gn format $(git ls-files '*.gn' '*.gni')

											
										
										
											2023-12-16 17:49:34 +03:30
+								#include <AK/ByteString.h>
-												Kernel: Stop using LibKeyboard's CharacterMap in HIDManagement

This was easily done, as the Kernel and Userland don't actually share
any of the APIs exposed by it, so instead the Kernel APIs were moved to
the Kernel, and the Userland APIs stayed in LibKeyboard.

This has multiple advantages:
 * The non OOM-fallible String is not longer used for storing the
   character map name in the Kernel
 * The kernel no longer has to link to the userland LibKeyboard code
 * A lot of #ifdef KERNEL cruft can be removed from LibKeyboard

											
										
										
											2022-01-21 15:22:36 +02:00
+								#include <AK/Error.h>
-												LibKeyboard: Add new library for keyboard applications

Move shared code base from keymap and KeyboardMapper to this library.
											
										
										
											2020-05-31 16:23:55 +03:00
+								#include <LibKeyboard/CharacterMapData.h>
 								namespace Keyboard {
 								class CharacterMap {
 								public:
-												Everywhere: Rename {Deprecated => Byte}String

This commit un-deprecates DeprecatedString, and repurposes it as a byte
string.
As the null state has already been removed, there are no other
particularly hairy blockers in repurposing this type as a byte string
(what it _really_ is).

This commit is auto-generated:
  $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \
    Meta Ports Ladybird Tests Kernel)
  $ perl -pie 's/\bDeprecatedString\b/ByteString/g;
    s/deprecated_string/byte_string/g' $xs
  $ clang-format --style=file -i \
    $(git diff --name-only | grep \.cpp\|\.h)
  $ gn format $(git ls-files '*.gn' '*.gni')

											
										
										
											2023-12-16 17:49:34 +03:30
+								    CharacterMap(ByteString const& map_name, CharacterMapData const& map_data);
 								    static ErrorOr<CharacterMap> load_from_file(ByteString const& filename);
-												LibKeyboard: Add new library for keyboard applications

Move shared code base from keymap and KeyboardMapper to this library.
											
										
										
											2020-05-31 16:23:55 +03:00
 								    int set_system_map();
-												LibKeyboard: Use ErrorOr<T> for CharacterMap::fetch_system_map()

											
										
										
											2021-11-07 11:25:25 +01:00
+								    static ErrorOr<CharacterMap> fetch_system_map();
-												Kernel+LibKeyboard: Store the keymap name when setting system keymap

This way we can query the kernel to see which keymap is currently in use.

											
										
										
											2020-08-06 02:03:32 +03:00
-												Everywhere: Remove needless trailing semi-colons after functions

This is a new option in clang-format-16.

											
										
										
											2023-07-07 22:48:11 -04:00
+								    CharacterMapData const& character_map_data() const { return m_character_map_data; }
-												Everywhere: Rename {Deprecated => Byte}String

This commit un-deprecates DeprecatedString, and repurposes it as a byte
string.
As the null state has already been removed, there are no other
particularly hairy blockers in repurposing this type as a byte string
(what it _really_ is).

This commit is auto-generated:
  $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \
    Meta Ports Ladybird Tests Kernel)
  $ perl -pie 's/\bDeprecatedString\b/ByteString/g;
    s/deprecated_string/byte_string/g' $xs
  $ clang-format --style=file -i \
    $(git diff --name-only | grep \.cpp\|\.h)
  $ gn format $(git ls-files '*.gn' '*.gni')

											
										
										
											2023-12-16 17:49:34 +03:30
+								    ByteString const& character_map_name() const;
-												LibKeyboard: Add new library for keyboard applications

Move shared code base from keymap and KeyboardMapper to this library.
											
										
										
											2020-05-31 16:23:55 +03:00
 								private:
-												LibKeyboard: Move  character map from Kernel to LibKeyboard



											
										
										
											2020-06-11 22:11:43 +03:00
+								    CharacterMapData m_character_map_data;
-												Everywhere: Rename {Deprecated => Byte}String

This commit un-deprecates DeprecatedString, and repurposes it as a byte
string.
As the null state has already been removed, there are no other
particularly hairy blockers in repurposing this type as a byte string
(what it _really_ is).

This commit is auto-generated:
  $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \
    Meta Ports Ladybird Tests Kernel)
  $ perl -pie 's/\bDeprecatedString\b/ByteString/g;
    s/deprecated_string/byte_string/g' $xs
  $ clang-format --style=file -i \
    $(git diff --name-only | grep \.cpp\|\.h)
  $ gn format $(git ls-files '*.gn' '*.gni')

											
										
										
											2023-12-16 17:49:34 +03:30
+								    ByteString m_character_map_name;
-												LibKeyboard: Add new library for keyboard applications

Move shared code base from keymap and KeyboardMapper to this library.
											
										
										
											2020-05-31 16:23:55 +03:00
+								};
 								}