im-switch 0.1.0

A cross-platform input method switcher — Rust crate + CLI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! A cross-platform input method switcher.
//!
//! **im-switch** provides a unified API to query, switch, and list input methods
//! across Linux, Windows, and macOS.
//!
//! # Platform support
//!
//! | Platform | Backend |
//! |----------|---------|
//! | Linux | fcitx5 (D-Bus), ibus (CLI) — auto-detected at runtime |
//! | Windows | Win32 API (keyboard layout + IME on/off control) |
//! | macOS | Carbon TIS API |
//!
//! # Quick start
//!
//! ```rust,no_run
//! use im_switch::{get_input_method, set_input_method, list_input_methods};
//!
//! // Get the current input method
//! let im = get_input_method().unwrap();
//! println!("Current IM: {im}");
//!
//! // List available input methods
//! let methods = list_input_methods().unwrap();
//! for m in &methods {
//!     println!("  {m}");
//! }
//!
//! // Restore a saved input method
//! set_input_method(&im).unwrap();
//! ```

// --- Module declarations ---

mod error;

#[cfg(target_os = "linux")]
mod linux;

#[cfg(target_os = "windows")]
mod windows;

#[cfg(target_os = "macos")]
mod macos;

#[cfg(not(any(target_os = "linux", target_os = "windows", target_os = "macos")))]
mod unsupported;

// --- Re-exports and platform alias ---

pub use error::ImSwitchError;

#[cfg(target_os = "linux")]
use linux as platform;

#[cfg(target_os = "windows")]
use windows as platform;

#[cfg(target_os = "macos")]
use macos as platform;

#[cfg(not(any(target_os = "linux", target_os = "windows", target_os = "macos")))]
use unsupported as platform;

// --- Cross-platform API ---

/// Returns the current input method identifier.
///
/// The returned value is platform-dependent:
/// - Windows: Keyboard layout ID (KLID), e.g., `"00000409"`
/// - macOS: Input source identifier, e.g., `"com.apple.keylayout.ABC"`
/// - Linux: Input method name (IM framework-dependent)
pub fn get_input_method() -> Result<String, ImSwitchError> {
    platform::get_input_method()
}

/// Sets the input method to the specified identifier.
///
/// The identifier format is platform-dependent (see [`get_input_method`]).
pub fn set_input_method(im: &str) -> Result<(), ImSwitchError> {
    platform::set_input_method(im)
}

/// Returns a list of available input method identifiers.
pub fn list_input_methods() -> Result<Vec<String>, ImSwitchError> {
    platform::list_input_methods()
}

// --- Windows-only API ---

/// Returns the current IME on/off state (Windows only).
#[cfg(target_os = "windows")]
pub fn get_ime_state() -> Result<bool, ImSwitchError> {
    platform::get_ime_state()
}

/// Sets the IME on/off state (Windows only).
#[cfg(target_os = "windows")]
pub fn set_ime_state(enabled: bool) -> Result<(), ImSwitchError> {
    platform::set_ime_state(enabled)
}

/// Toggles the IME on/off state and returns the new state (Windows only).
#[cfg(target_os = "windows")]
pub fn toggle_ime_state() -> Result<bool, ImSwitchError> {
    let current = get_ime_state()?;
    let new_state = !current;
    set_ime_state(new_state)?;
    Ok(new_state)
}