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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
//! Auto launch any application or executable at startup. Supports Windows, Mac (via AppleScript or Launch Agent), and Linux.
//!
//! ## Usage
//!
//! The parameters of `AutoLaunch::new` are different on each platform.
//! See the function definition or the demo below for details.
//!
//! Or you can construct the AutoLaunch by using `AutoLaunchBuilder`.
//!
//! ```rust
//! # #[cfg(target_os = "linux")]
//! # mod linux {
//! use auto_launch::AutoLaunch;
//!
//! fn main() {
//! let app_name = "the-app";
//! let app_path = "/path/to/the-app";
//! let args = &["--minimized"];
//! let auto = AutoLaunch::new(app_name, app_path, args);
//!
//! // enable the auto launch
//! auto.enable().is_ok();
//! auto.is_enabled().unwrap();
//!
//! // disable the auto launch
//! auto.disable().is_ok();
//! auto.is_enabled().unwrap();
//! }
//! # }
//! ```
//!
//! ### macOS
//!
//! macOS supports two ways to achieve auto launch (via AppleScript or Launch Agent).
//! When the `use_launch_agent` is true, it will achieve by Launch Agent, otherwise by AppleScript.
//!
//! **Note**:
//! - The `app_path` should be a absolute path and exists. Otherwise, it will cause an error when `enable`.
//! - In case using AppleScript, the `app_name` should be same as the basename of `app_path`, or it will be corrected automatically.
//!
//! ```rust
//! # #[cfg(target_os = "macos")]
//! # mod macos {
//! use auto_launch::AutoLaunch;
//!
//! fn main() {
//! let app_name = "the-app";
//! let app_path = "/path/to/the-app.app";
//! let args = &["--minimized"];
//! let auto = AutoLaunch::new(app_name, app_path, false, args);
//!
//! // enable the auto launch
//! auto.enable().is_ok();
//! auto.is_enabled().unwrap();
//!
//! // disable the auto launch
//! auto.disable().is_ok();
//! auto.is_enabled().unwrap();
//! }
//! # }
//! ```
//!
//! ### Windows
//!
//! On Windows, it will add a registry entry under `\HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Run`.
//!
//! ```rust
//! # #[cfg(target_os = "windows")]
//! # mod win {
//! use auto_launch::AutoLaunch;
//!
//! fn main() {
//! let app_name = "the-app";
//! let app_path = "C:\\path\\to\\the-app.exe";
//! let args = &["--minimized"];
//! let auto = AutoLaunch::new(app_name, app_path, args);
//!
//! // enable the auto launch
//! auto.enable().is_ok();
//! auto.is_enabled().unwrap();
//!
//! // disable the auto launch
//! auto.disable().is_ok();
//! auto.is_enabled().unwrap();
//! }
//! # }
//! ```
//!
//! ### Builder
//!
//! AutoLaunch Builder helps to eliminate the constructor difference
//! on various platforms.
//!
//! ```rust
//! use auto_launch::*;
//!
//! fn main() {
//! let auto = AutoLaunchBuilder::new()
//! .set_app_name("the-app")
//! .set_app_path("/path/to/the-app")
//! .set_use_launch_agent(true)
//! .set_args(&["--minimized"])
//! .build()
//! .unwrap();
//!
//! auto.enable().is_ok();
//! auto.is_enabled().unwrap();
//!
//! auto.disable().is_ok();
//! auto.is_enabled().unwrap();
//! }
//! ```
//!
#[cfg(target_os = "linux")]
mod linux;
#[cfg(target_os = "macos")]
mod macos;
#[cfg(target_os = "windows")]
mod windows;
/// The parameters of `AutoLaunch::new` are different on each platform.
///
/// ### Linux
///
/// ```rust
/// # #[cfg(target_os = "linux")]
/// # {
/// # use auto_launch::AutoLaunch;
/// # let app_name = "the-app";
/// # let app_path = "/path/to/the-app";
/// # let args = &["--minimized"];
/// AutoLaunch::new(app_name, app_path, args);
/// # }
/// ```
///
/// ### Macos
///
/// ```rust
/// # #[cfg(target_os = "macos")]
/// # {
/// # use auto_launch::AutoLaunch;
/// # let app_name = "the-app";
/// # let app_path = "/path/to/the-app";
/// # let use_launch_agent = false;
/// # let args = &["--minimized"];
/// AutoLaunch::new(app_name, app_path, use_launch_agent, args);
/// # }
/// ```
///
/// ### Windows
///
/// ```rust
/// # #[cfg(target_os = "windows")]
/// # {
/// # use auto_launch::AutoLaunch;
/// # let app_name = "the-app";
/// # let app_path = "/path/to/the-app";
/// # let args = &["--minimized"];
/// AutoLaunch::new(app_name, app_path, args);
/// # }
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AutoLaunch {
/// The application name
pub(crate) app_name: String,
/// The application executable path (absolute path will be better)
pub(crate) app_path: String,
#[cfg(target_os = "macos")]
/// Whether use Launch Agent for implement or use AppleScript
pub(crate) use_launch_agent: bool,
/// Args passed to the binary on startup
pub(crate) args: Vec<String>,
}
impl AutoLaunch {
/// check whether it is support the platform
///
/// ## Usage
///
/// ```rust
/// use auto_launch::AutoLaunch;
///
/// dbg!(AutoLaunch::is_support());
/// ```
pub fn is_support() -> bool {
cfg!(any(
target_os = "linux",
target_os = "macos",
target_os = "windows",
))
}
/// get the application name
pub fn get_app_name(&self) -> &str {
&self.app_name
}
/// get the application path
pub fn get_app_path(&self) -> &str {
&self.app_path
}
/// get the args
pub fn get_args(&self) -> &[String] {
&self.args
}
}
#[derive(Debug, Default, Clone)]
/// AutoLaunch Builder helps to eliminate the constructor difference
/// on various platforms.
///
/// ## Notes
///
/// The builder will not check whether the app_path matches the platform-specify file path.
///
/// ## Usage
///
/// ```rust
/// use auto_launch::*;
///
/// fn main() {
/// let auto = AutoLaunchBuilder::new()
/// .set_app_name("the-app")
/// .set_app_path("/path/to/the-app")
/// .set_use_launch_agent(true)
/// .set_args(&["--minimized"])
/// .build()
/// .unwrap();
///
/// auto.enable().is_ok();
/// auto.is_enabled().unwrap();
///
/// auto.disable().is_ok();
/// auto.is_enabled().unwrap();
/// }
/// ```
pub struct AutoLaunchBuilder {
pub app_name: Option<String>,
pub app_path: Option<String>,
pub use_launch_agent: bool,
pub args: Option<Vec<String>>,
}
impl AutoLaunchBuilder {
pub fn new() -> AutoLaunchBuilder {
AutoLaunchBuilder::default()
}
/// Set the `app_name`
pub fn set_app_name(&mut self, name: &str) -> &mut Self {
self.app_name = Some(name.into());
self
}
/// Set the `app_path`
pub fn set_app_path(&mut self, path: &str) -> &mut Self {
self.app_path = Some(path.into());
self
}
/// Set the `use_launch_agent`
/// This setting only works on macOS
pub fn set_use_launch_agent(&mut self, use_launch_agent: bool) -> &mut Self {
self.use_launch_agent = use_launch_agent;
self
}
/// Set the args
pub fn set_args(&mut self, args: &[impl AsRef<str>]) -> &mut Self {
self.args = Some(args.iter().map(|s| s.as_ref().to_string()).collect());
self
}
/// Construct a AutoLaunch instance
///
/// ## Errors
///
/// - `app_name` is none
/// - `app_path` is none
///
/// ## Panics
///
/// - Unsupported target OS
pub fn build(&self) -> anyhow::Result<AutoLaunch> {
if self.app_name.is_none() {
anyhow::bail!("The `app_name` should not be none.");
}
if self.app_path.is_none() {
anyhow::bail!("The `app_path` should not be none.");
}
let app_name = self.app_name.clone().unwrap();
let app_path = self.app_path.clone().unwrap();
let args = self.args.clone().unwrap_or_default();
#[cfg(target_os = "linux")]
return Ok(AutoLaunch::new(&app_name, &app_path, &args));
#[cfg(target_os = "macos")]
return Ok(AutoLaunch::new(
&app_name,
&app_path,
self.use_launch_agent,
&args,
));
#[cfg(target_os = "windows")]
return Ok(AutoLaunch::new(&app_name, &app_path, &args));
#[cfg(not(any(target_os = "macos", target_os = "windows", target_os = "linux")))]
panic!("unsupported target os");
}
}