Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow linking to libxkbcommon at compile time #178

Merged
merged 2 commits into from
Feb 27, 2021
Merged

Allow linking to libxkbcommon at compile time #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2dfbb60
Allow linking to libxkbcommon at compile time
milkey-mouse Feb 14, 2021
8f6cfba
Fix CI for no-features build
milkey-mouse Feb 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ jobs:
toolchain: ${{ matrix.rust }}
override: true

- name: Install libxkbcommon
run: sudo apt-get install libxkbcommon-dev

- name: Test lib no features
uses: actions-rs/cargo@v1
with:
Expand Down
5 changes: 3 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ readme = "README.md"
[dependencies]
bitflags = "1.0"
nix = "0.19"
dlib = "0.4"
dlib = "0.5"
lazy_static = "1.0"
memmap2 = "0.2.0"
andrew = { version = "0.3.0", optional = true }
Expand All @@ -25,7 +25,8 @@ wayland-cursor = "0.28"
calloop = { version = "0.6.1", optional = true }

[features]
default = ["frames", "calloop"]
default = ["frames", "calloop", "dlopen"]
dlopen = ["wayland-client/dlopen"]
frames = ["andrew"]

[dev-dependencies]
Expand Down
5 changes: 3 additions & 2 deletions src/seat/keyboard/ffi.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ bitflags::bitflags!(
}
);

dlopen_external_library!(XkbCommon,
external_library!(XkbCommon, "xkbcommon",
milkey-mouse marked this conversation as resolved.
Show resolved Hide resolved
functions:
fn xkb_keysym_get_name(xkb_keysym_t, *mut c_char, usize) -> c_int,
fn xkb_keysym_from_name(*const c_char, xkb_keysym_flags) -> xkb_keysym_t,
Expand Down Expand Up @@ -253,8 +253,9 @@ functions:
fn xkb_compose_state_get_one_sym(*mut xkb_compose_state) -> xkb_keysym_t,
);

#[cfg(feature = "dlopen")]
lazy_static::lazy_static!(
pub static ref XKBCOMMON_OPTION: Option<XkbCommon> = {
pub static ref XKBCOMMON_OPTION: Option<XkbCommon> = unsafe {
XkbCommon::open("libxkbcommon.so.0")
.or_else(|_| XkbCommon::open("libxkbcommon.so"))
.ok()
Expand Down
160 changes: 103 additions & 57 deletions src/seat/keyboard/state.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
use memmap2::MmapOptions;
use std::{env, ffi::CString, fs::File, os::raw::c_char, os::unix::ffi::OsStringExt, ptr};

use super::ffi::{self, xkb_state_component, XKBCOMMON_HANDLE as XKBH};
#[cfg(feature = "dlopen")]
use super::ffi::XKBCOMMON_HANDLE as XKBH;
#[cfg(not(feature = "dlopen"))]
use super::ffi::*;
use super::ffi::{self, xkb_state_component};
use super::Error;

pub(crate) struct KbState {
Expand Down Expand Up @@ -65,45 +69,57 @@ impl ModifiersState {

fn update_with(&mut self, state: *mut ffi::xkb_state) {
self.ctrl = unsafe {
(XKBH.xkb_state_mod_name_is_active)(
ffi_dispatch!(
XKBH,
xkb_state_mod_name_is_active,
state,
ffi::XKB_MOD_NAME_CTRL.as_ptr() as *const c_char,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE
) > 0
};
self.alt = unsafe {
(XKBH.xkb_state_mod_name_is_active)(
ffi_dispatch!(
XKBH,
xkb_state_mod_name_is_active,
state,
ffi::XKB_MOD_NAME_ALT.as_ptr() as *const c_char,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE
) > 0
};
self.shift = unsafe {
(XKBH.xkb_state_mod_name_is_active)(
ffi_dispatch!(
XKBH,
xkb_state_mod_name_is_active,
state,
ffi::XKB_MOD_NAME_SHIFT.as_ptr() as *const c_char,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE
) > 0
};
self.caps_lock = unsafe {
(XKBH.xkb_state_mod_name_is_active)(
ffi_dispatch!(
XKBH,
xkb_state_mod_name_is_active,
state,
ffi::XKB_MOD_NAME_CAPS.as_ptr() as *const c_char,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE
) > 0
};
self.logo = unsafe {
(XKBH.xkb_state_mod_name_is_active)(
ffi_dispatch!(
XKBH,
xkb_state_mod_name_is_active,
state,
ffi::XKB_MOD_NAME_LOGO.as_ptr() as *const c_char,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE
) > 0
};
self.num_lock = unsafe {
(XKBH.xkb_state_mod_name_is_active)(
ffi_dispatch!(
XKBH,
xkb_state_mod_name_is_active,
state,
ffi::XKB_MOD_NAME_NUM.as_ptr() as *const c_char,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE,
xkb_state_component::XKB_STATE_MODS_EFFECTIVE
) > 0
};
}
Expand All @@ -121,14 +137,16 @@ impl KbState {
return;
}
let mask = unsafe {
(XKBH.xkb_state_update_mask)(
ffi_dispatch!(
XKBH,
xkb_state_update_mask,
self.xkb_state,
mods_depressed,
mods_latched,
mods_locked,
0,
0,
group,
group
)
};
if mask.contains(xkb_state_component::XKB_STATE_MODS_EFFECTIVE) {
Expand All @@ -141,27 +159,36 @@ impl KbState {
if !self.ready() {
return 0;
}
unsafe { (XKBH.xkb_state_key_get_one_sym)(self.xkb_state, keycode + 8) }
unsafe { ffi_dispatch!(XKBH, xkb_state_key_get_one_sym, self.xkb_state, keycode + 8) }
}

pub(crate) fn get_utf8_raw(&mut self, keycode: u32) -> Option<String> {
if !self.ready() {
return None;
}
let size = unsafe {
(XKBH.xkb_state_key_get_utf8)(self.xkb_state, keycode + 8, ptr::null_mut(), 0)
ffi_dispatch!(
XKBH,
xkb_state_key_get_utf8,
self.xkb_state,
keycode + 8,
ptr::null_mut(),
0
)
} + 1;
if size <= 1 {
return None;
};
let mut buffer = Vec::with_capacity(size as usize);
unsafe {
buffer.set_len(size as usize);
(XKBH.xkb_state_key_get_utf8)(
ffi_dispatch!(
XKBH,
xkb_state_key_get_utf8,
self.xkb_state,
keycode + 8,
buffer.as_mut_ptr() as *mut _,
size as usize,
size as usize
);
};
// remove the final `\0`
Expand All @@ -174,33 +201,41 @@ impl KbState {
if !self.ready() || self.xkb_compose_state.is_null() {
return None;
}
Some(unsafe { (XKBH.xkb_compose_state_feed)(self.xkb_compose_state, keysym) })
Some(unsafe { ffi_dispatch!(XKBH, xkb_compose_state_feed, self.xkb_compose_state, keysym) })
}

pub(crate) fn compose_status(&mut self) -> Option<ffi::xkb_compose_status> {
if !self.ready() || self.xkb_compose_state.is_null() {
return None;
}
Some(unsafe { (XKBH.xkb_compose_state_get_status)(self.xkb_compose_state) })
Some(unsafe { ffi_dispatch!(XKBH, xkb_compose_state_get_status, self.xkb_compose_state) })
}

pub(crate) fn compose_get_utf8(&mut self) -> Option<String> {
if !self.ready() || self.xkb_compose_state.is_null() {
return None;
}
let size = unsafe {
(XKBH.xkb_compose_state_get_utf8)(self.xkb_compose_state, ptr::null_mut(), 0)
ffi_dispatch!(
XKBH,
xkb_compose_state_get_utf8,
self.xkb_compose_state,
ptr::null_mut(),
0
)
} + 1;
if size <= 1 {
return None;
};
let mut buffer = Vec::with_capacity(size as usize);
unsafe {
buffer.set_len(size as usize);
(XKBH.xkb_compose_state_get_utf8)(
ffi_dispatch!(
XKBH,
xkb_compose_state_get_utf8,
self.xkb_compose_state,
buffer.as_mut_ptr() as *mut _,
size as usize,
size as usize
);
};
// remove the final `\0`
Expand All @@ -210,18 +245,21 @@ impl KbState {
}

pub(crate) fn new() -> Result<KbState, Error> {
let xkbh = match ffi::XKBCOMMON_OPTION.as_ref() {
Some(h) => h,
None => return Err(Error::XKBNotFound),
#[cfg(feature = "dlopen")]
{
if ffi::XKBCOMMON_OPTION.as_ref().is_none() {
return Err(Error::XKBNotFound);
}
}
let context = unsafe {
ffi_dispatch!(XKBH, xkb_context_new, ffi::xkb_context_flags::XKB_CONTEXT_NO_FLAGS)
};
elinorbgr marked this conversation as resolved.
Show resolved Hide resolved
let xkb_context =
unsafe { (xkbh.xkb_context_new)(ffi::xkb_context_flags::XKB_CONTEXT_NO_FLAGS) };
if xkb_context.is_null() {
if context.is_null() {
return Err(Error::XKBNotFound);
}

let mut me = KbState {
xkb_context,
xkb_context: context,
xkb_keymap: ptr::null_mut(),
xkb_state: ptr::null_mut(),
xkb_compose_table: ptr::null_mut(),
Expand Down Expand Up @@ -276,84 +314,92 @@ impl KbState {
.unwrap_or_else(|| "C".into());
let locale = CString::new(locale.into_vec()).unwrap();

let compose_table = (XKBH.xkb_compose_table_new_from_locale)(
let compose_table = ffi_dispatch!(
XKBH,
xkb_compose_table_new_from_locale,
self.xkb_context,
locale.as_ptr(),
ffi::xkb_compose_compile_flags::XKB_COMPOSE_COMPILE_NO_FLAGS,
ffi::xkb_compose_compile_flags::XKB_COMPOSE_COMPILE_NO_FLAGS
);

if compose_table.is_null() {
// init of compose table failed, continue without compose
return;
}

let compose_state = (XKBH.xkb_compose_state_new)(
let compose_state = ffi_dispatch!(
XKBH,
xkb_compose_state_new,
compose_table,
ffi::xkb_compose_state_flags::XKB_COMPOSE_STATE_NO_FLAGS,
ffi::xkb_compose_state_flags::XKB_COMPOSE_STATE_NO_FLAGS
);

if compose_state.is_null() {
// init of compose state failed, continue without compose
(XKBH.xkb_compose_table_unref)(compose_table);
ffi_dispatch!(XKBH, xkb_compose_table_unref, compose_table);
return;
}

self.xkb_compose_table = compose_table;
self.xkb_compose_state = compose_state;
}

pub(crate) unsafe fn post_init(&mut self, xkb_keymap: *mut ffi::xkb_keymap) {
let xkb_state = (XKBH.xkb_state_new)(xkb_keymap);
self.xkb_keymap = xkb_keymap;
self.xkb_state = xkb_state;
self.mods_state.update_with(xkb_state);
pub(crate) unsafe fn post_init(&mut self, keymap: *mut ffi::xkb_keymap) {
let state = ffi_dispatch!(XKBH, xkb_state_new, keymap);
self.xkb_keymap = keymap;
self.xkb_state = state;
self.mods_state.update_with(state);
}

pub(crate) unsafe fn de_init(&mut self) {
(XKBH.xkb_state_unref)(self.xkb_state);
ffi_dispatch!(XKBH, xkb_state_unref, self.xkb_state);
self.xkb_state = ptr::null_mut();
(XKBH.xkb_keymap_unref)(self.xkb_keymap);
ffi_dispatch!(XKBH, xkb_keymap_unref, self.xkb_keymap);
self.xkb_keymap = ptr::null_mut();
}

pub(crate) unsafe fn init_with_fd(&mut self, fd: File, size: usize) {
let map = MmapOptions::new().len(size).map(&fd).unwrap();

let xkb_keymap = (XKBH.xkb_keymap_new_from_string)(
let keymap = ffi_dispatch!(
XKBH,
xkb_keymap_new_from_string,
self.xkb_context,
map.as_ptr() as *const _,
ffi::xkb_keymap_format::XKB_KEYMAP_FORMAT_TEXT_V1,
ffi::xkb_keymap_compile_flags::XKB_KEYMAP_COMPILE_NO_FLAGS,
ffi::xkb_keymap_compile_flags::XKB_KEYMAP_COMPILE_NO_FLAGS
);

if xkb_keymap.is_null() {
if keymap.is_null() {
panic!("Received invalid keymap from compositor.");
}

self.post_init(xkb_keymap);
self.post_init(keymap);
}

pub(crate) unsafe fn init_with_rmlvo(
&mut self,
names: ffi::xkb_rule_names,
) -> Result<(), Error> {
let xkb_keymap = (XKBH.xkb_keymap_new_from_names)(
let keymap = ffi_dispatch!(
XKBH,
xkb_keymap_new_from_names,
self.xkb_context,
&names,
ffi::xkb_keymap_compile_flags::XKB_KEYMAP_COMPILE_NO_FLAGS,
ffi::xkb_keymap_compile_flags::XKB_KEYMAP_COMPILE_NO_FLAGS
);

if xkb_keymap.is_null() {
if keymap.is_null() {
return Err(Error::BadNames);
}

self.post_init(xkb_keymap);
self.post_init(keymap);

Ok(())
}

pub(crate) unsafe fn key_repeats(&mut self, xkb_keycode_t: ffi::xkb_keycode_t) -> bool {
(XKBH.xkb_keymap_key_repeats)(self.xkb_keymap, xkb_keycode_t) == 1
ffi_dispatch!(XKBH, xkb_keymap_key_repeats, self.xkb_keymap, xkb_keycode_t) == 1
}

#[inline]
Expand All @@ -375,11 +421,11 @@ impl KbState {
impl Drop for KbState {
fn drop(&mut self) {
unsafe {
(XKBH.xkb_compose_state_unref)(self.xkb_compose_state);
(XKBH.xkb_compose_table_unref)(self.xkb_compose_table);
(XKBH.xkb_state_unref)(self.xkb_state);
(XKBH.xkb_keymap_unref)(self.xkb_keymap);
(XKBH.xkb_context_unref)(self.xkb_context);
ffi_dispatch!(XKBH, xkb_compose_state_unref, self.xkb_compose_state);
ffi_dispatch!(XKBH, xkb_compose_table_unref, self.xkb_compose_table);
ffi_dispatch!(XKBH, xkb_state_unref, self.xkb_state);
ffi_dispatch!(XKBH, xkb_keymap_unref, self.xkb_keymap);
ffi_dispatch!(XKBH, xkb_context_unref, self.xkb_context);
}
}
}