Refactor Shell, Command, and Launcher to share impl

This commit is contained in:
Kirill Chibisov 2020-06-05 01:10:31 +03:00 committed by GitHub
parent 1e32e5a515
commit f99220f015
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 79 additions and 113 deletions

View File

@ -18,7 +18,7 @@ use std::path::PathBuf;
use clap::{crate_authors, crate_description, crate_name, crate_version, App, Arg}; use clap::{crate_authors, crate_description, crate_name, crate_version, App, Arg};
use log::{self, error, LevelFilter}; use log::{self, error, LevelFilter};
use alacritty_terminal::config::{Delta, Dimensions, Shell, DEFAULT_NAME}; use alacritty_terminal::config::{Delta, Dimensions, Program, DEFAULT_NAME};
use alacritty_terminal::index::{Column, Line}; use alacritty_terminal::index::{Column, Line};
use crate::config::Config; use crate::config::Config;
@ -41,7 +41,7 @@ pub struct Options {
pub class: Option<String>, pub class: Option<String>,
pub embed: Option<String>, pub embed: Option<String>,
pub log_level: LevelFilter, pub log_level: LevelFilter,
pub command: Option<Shell<'static>>, pub command: Option<Program>,
pub hold: bool, pub hold: bool,
pub working_dir: Option<PathBuf>, pub working_dir: Option<PathBuf>,
pub config: Option<PathBuf>, pub config: Option<PathBuf>,
@ -243,9 +243,9 @@ impl Options {
// The following unwrap is guaranteed to succeed. // The following unwrap is guaranteed to succeed.
// If `command` exists it must also have a first item since // If `command` exists it must also have a first item since
// `Arg::min_values(1)` is set. // `Arg::min_values(1)` is set.
let command = String::from(args.next().unwrap()); let program = String::from(args.next().unwrap());
let args = args.map(String::from).collect(); let args = args.map(String::from).collect();
options.command = Some(Shell::new_with_args(command, args)); options.command = Some(Program::WithArgs { program, args });
} }
if matches.is_present("hold") { if matches.is_present("hold") {

View File

@ -22,6 +22,7 @@ use serde::de::{self, MapAccess, Unexpected, Visitor};
use serde::{Deserialize, Deserializer}; use serde::{Deserialize, Deserializer};
use serde_yaml::Value as SerdeValue; use serde_yaml::Value as SerdeValue;
use alacritty_terminal::config::Program;
use alacritty_terminal::term::TermMode; use alacritty_terminal::term::TermMode;
use alacritty_terminal::vi_mode::ViMotion; use alacritty_terminal::vi_mode::ViMotion;
@ -94,7 +95,7 @@ pub enum Action {
/// Run given command. /// Run given command.
#[serde(skip)] #[serde(skip)]
Command(String, Vec<String>), Command(Program),
/// Move vi mode cursor. /// Move vi mode cursor.
#[serde(skip)] #[serde(skip)]
@ -763,7 +764,7 @@ impl<'a> Deserialize<'a> for RawBinding {
let mut mode: Option<TermMode> = None; let mut mode: Option<TermMode> = None;
let mut not_mode: Option<TermMode> = None; let mut not_mode: Option<TermMode> = None;
let mut mouse: Option<MouseButton> = None; let mut mouse: Option<MouseButton> = None;
let mut command: Option<CommandWrapper> = None; let mut command: Option<Program> = None;
use de::Error; use de::Error;
@ -860,7 +861,7 @@ impl<'a> Deserialize<'a> for RawBinding {
return Err(<V::Error as Error>::duplicate_field("command")); return Err(<V::Error as Error>::duplicate_field("command"));
} }
command = Some(map.next_value::<CommandWrapper>()?); command = Some(map.next_value::<Program>()?);
}, },
} }
} }
@ -882,12 +883,7 @@ impl<'a> Deserialize<'a> for RawBinding {
}, },
(Some(action), None, None) => action, (Some(action), None, None) => action,
(None, Some(chars), None) => Action::Esc(chars), (None, Some(chars), None) => Action::Esc(chars),
(None, None, Some(cmd)) => match cmd { (None, None, Some(cmd)) => Action::Command(cmd),
CommandWrapper::Just(program) => Action::Command(program, vec![]),
CommandWrapper::WithArgs { program, args } => {
Action::Command(program, args)
},
},
_ => { _ => {
return Err(V::Error::custom( return Err(V::Error::custom(
"must specify exactly one of chars, action or command", "must specify exactly one of chars, action or command",
@ -929,33 +925,6 @@ impl<'a> Deserialize<'a> for KeyBinding {
} }
} }
#[serde(untagged)]
#[derive(Debug, Deserialize, Clone, PartialEq, Eq)]
pub enum CommandWrapper {
Just(String),
WithArgs {
program: String,
#[serde(default)]
args: Vec<String>,
},
}
impl CommandWrapper {
pub fn program(&self) -> &str {
match self {
CommandWrapper::Just(program) => program,
CommandWrapper::WithArgs { program, .. } => program,
}
}
pub fn args(&self) -> &[String] {
match self {
CommandWrapper::Just(_) => &[],
CommandWrapper::WithArgs { args, .. } => args,
}
}
}
/// Newtype for implementing deserialize on glutin Mods. /// Newtype for implementing deserialize on glutin Mods.
/// ///
/// Our deserialize impl wouldn't be covered by a derive(Deserialize); see the /// Our deserialize impl wouldn't be covered by a derive(Deserialize); see the

View File

@ -4,9 +4,9 @@ use glutin::event::ModifiersState;
use log::error; use log::error;
use serde::{Deserialize, Deserializer}; use serde::{Deserialize, Deserializer};
use alacritty_terminal::config::{failure_default, LOG_TARGET_CONFIG}; use alacritty_terminal::config::{failure_default, Program, LOG_TARGET_CONFIG};
use crate::config::bindings::{CommandWrapper, ModsWrapper}; use crate::config::bindings::ModsWrapper;
#[serde(default)] #[serde(default)]
#[derive(Default, Clone, Debug, Deserialize, PartialEq, Eq)] #[derive(Default, Clone, Debug, Deserialize, PartialEq, Eq)]
@ -26,7 +26,7 @@ pub struct Mouse {
pub struct Url { pub struct Url {
/// Program for opening links. /// Program for opening links.
#[serde(deserialize_with = "deserialize_launcher")] #[serde(deserialize_with = "deserialize_launcher")]
pub launcher: Option<CommandWrapper>, pub launcher: Option<Program>,
/// Modifier used to open links. /// Modifier used to open links.
#[serde(deserialize_with = "failure_default")] #[serde(deserialize_with = "failure_default")]
@ -39,9 +39,7 @@ impl Url {
} }
} }
fn deserialize_launcher<'a, D>( fn deserialize_launcher<'a, D>(deserializer: D) -> std::result::Result<Option<Program>, D::Error>
deserializer: D,
) -> ::std::result::Result<Option<CommandWrapper>, D::Error>
where where
D: Deserializer<'a>, D: Deserializer<'a>,
{ {
@ -55,7 +53,7 @@ where
return Ok(None); return Ok(None);
} }
match <Option<CommandWrapper>>::deserialize(val) { match <Option<Program>>::deserialize(val) {
Ok(launcher) => Ok(launcher), Ok(launcher) => Ok(launcher),
Err(err) => { Err(err) => {
error!( error!(
@ -73,11 +71,11 @@ impl Default for Url {
fn default() -> Url { fn default() -> Url {
Url { Url {
#[cfg(not(any(target_os = "macos", windows)))] #[cfg(not(any(target_os = "macos", windows)))]
launcher: Some(CommandWrapper::Just(String::from("xdg-open"))), launcher: Some(Program::Just(String::from("xdg-open"))),
#[cfg(target_os = "macos")] #[cfg(target_os = "macos")]
launcher: Some(CommandWrapper::Just(String::from("open"))), launcher: Some(Program::Just(String::from("open"))),
#[cfg(windows)] #[cfg(windows)]
launcher: Some(CommandWrapper::Just(String::from("explorer"))), launcher: Some(Program::Just(String::from("explorer"))),
modifiers: Default::default(), modifiers: Default::default(),
} }
} }

View File

@ -147,7 +147,9 @@ impl<T: EventListener> Execute<T> for Action {
let text = ctx.terminal_mut().clipboard().load(ClipboardType::Selection); let text = ctx.terminal_mut().clipboard().load(ClipboardType::Selection);
paste(ctx, &text); paste(ctx, &text);
}, },
Action::Command(ref program, ref args) => { Action::Command(ref program) => {
let args = program.args();
let program = program.program();
trace!("Running command {} with args {:?}", program, args); trace!("Running command {} with args {:?}", program, args);
match start_daemon(program, args) { match start_daemon(program, args) {

View File

@ -12,7 +12,6 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
use std::borrow::Cow;
use std::collections::HashMap; use std::collections::HashMap;
use std::fmt::Display; use std::fmt::Display;
use std::path::PathBuf; use std::path::PathBuf;
@ -78,8 +77,8 @@ pub struct Config<T> {
pub selection: Selection, pub selection: Selection,
/// Path to a shell program to run on startup. /// Path to a shell program to run on startup.
#[serde(default, deserialize_with = "from_string_or_deserialize")] #[serde(default, deserialize_with = "failure_default")]
pub shell: Option<Shell<'static>>, pub shell: Option<Program>,
/// Path where config was loaded from. /// Path where config was loaded from.
#[serde(default, deserialize_with = "failure_default")] #[serde(default, deserialize_with = "failure_default")]
@ -286,33 +285,30 @@ where
.unwrap_or_else(|_| Percentage::new(DEFAULT_CURSOR_THICKNESS))) .unwrap_or_else(|_| Percentage::new(DEFAULT_CURSOR_THICKNESS)))
} }
#[derive(Clone, Debug, Deserialize, PartialEq, Eq)] #[serde(untagged)]
pub struct Shell<'a> { #[derive(Deserialize, Debug, Clone, PartialEq, Eq)]
pub program: Cow<'a, str>, pub enum Program {
Just(String),
#[serde(default, deserialize_with = "failure_default")] WithArgs {
pub args: Vec<String>, program: String,
#[serde(default, deserialize_with = "failure_default")]
args: Vec<String>,
},
} }
impl<'a> Shell<'a> { impl Program {
pub fn new<S>(program: S) -> Shell<'a> pub fn program(&self) -> &str {
where match self {
S: Into<Cow<'a, str>>, Program::Just(program) => program,
{ Program::WithArgs { program, .. } => program,
Shell { program: program.into(), args: Vec::new() } }
} }
pub fn new_with_args<S>(program: S, args: Vec<String>) -> Shell<'a> pub fn args(&self) -> &[String] {
where match self {
S: Into<Cow<'a, str>>, Program::Just(_) => &[],
{ Program::WithArgs { args, .. } => args,
Shell { program: program.into(), args } }
}
}
impl FromString for Option<Shell<'_>> {
fn from(input: String) -> Self {
Some(Shell::new(input))
} }
} }
@ -395,19 +391,3 @@ where
value => Some(T::deserialize(value).unwrap_or_else(fallback_default)), value => Some(T::deserialize(value).unwrap_or_else(fallback_default)),
}) })
} }
pub fn from_string_or_deserialize<'de, T, D>(deserializer: D) -> Result<T, D::Error>
where
D: Deserializer<'de>,
T: Deserialize<'de> + FromString + Default,
{
Ok(match Value::deserialize(deserializer)? {
Value::String(value) => T::from(value),
value => T::deserialize(value).unwrap_or_else(fallback_default),
})
}
// Used over From<String>, to allow implementation for foreign types.
pub trait FromString {
fn from(input: String) -> Self;
}

View File

@ -1,10 +1,10 @@
use std::os::raw::c_ulong; use std::os::raw::c_ulong;
use serde::Deserialize; use log::error;
use serde::{Deserialize, Deserializer};
use serde_yaml::Value;
use crate::config::{ use crate::config::{failure_default, option_explicit_none, Delta, LOG_TARGET_CONFIG};
failure_default, from_string_or_deserialize, option_explicit_none, Delta, FromString,
};
use crate::index::{Column, Line}; use crate::index::{Column, Line};
/// Default Alacritty name, used for window title and class. /// Default Alacritty name, used for window title and class.
@ -42,7 +42,7 @@ pub struct WindowConfig {
pub title: String, pub title: String,
/// Window class. /// Window class.
#[serde(deserialize_with = "from_string_or_deserialize")] #[serde(deserialize_with = "failure_default")]
pub class: Class, pub class: Class,
/// XEmbed parent. /// XEmbed parent.
@ -158,8 +158,7 @@ impl Dimensions {
} }
/// Window class hint. /// Window class hint.
#[serde(default)] #[derive(Debug, Clone, PartialEq, Eq)]
#[derive(Deserialize, Debug, Clone, PartialEq, Eq)]
pub struct Class { pub struct Class {
pub instance: String, pub instance: String,
pub general: String, pub general: String,
@ -171,8 +170,26 @@ impl Default for Class {
} }
} }
impl FromString for Class { impl<'a> Deserialize<'a> for Class {
fn from(value: String) -> Self { fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
Class { instance: value, general: DEFAULT_NAME.into() } where
D: Deserializer<'a>,
{
let value = Value::deserialize(deserializer)?;
if let Value::String(instance) = value {
return Ok(Class { instance, general: DEFAULT_NAME.into() });
}
match Self::deserialize(value) {
Ok(value) => Ok(value),
Err(err) => {
error!(
target: LOG_TARGET_CONFIG,
"Problem with config: {}; using class Alacritty", err
);
Ok(Self::default())
},
}
} }
} }

View File

@ -14,7 +14,7 @@
// //
//! TTY related functionality. //! TTY related functionality.
use crate::config::{Config, Shell}; use crate::config::{Config, Program};
use crate::event::OnResize; use crate::event::OnResize;
use crate::term::SizeInfo; use crate::term::SizeInfo;
use crate::tty::{ChildEvent, EventedPty, EventedReadWrite}; use crate::tty::{ChildEvent, EventedPty, EventedReadWrite};
@ -163,14 +163,14 @@ pub fn new<C>(config: &Config<C>, size: &SizeInfo, window_id: Option<usize>) ->
let shell_name = pw.shell.rsplit('/').next().unwrap(); let shell_name = pw.shell.rsplit('/').next().unwrap();
let argv = vec![String::from("-c"), format!("exec -a -{} {}", shell_name, pw.shell)]; let argv = vec![String::from("-c"), format!("exec -a -{} {}", shell_name, pw.shell)];
Shell::new_with_args("/bin/bash", argv) Program::WithArgs { program: "/bin/bash".to_owned(), args: argv }
} else { } else {
Shell::new(pw.shell) Program::Just(pw.shell.to_owned())
}; };
let shell = config.shell.as_ref().unwrap_or(&default_shell); let shell = config.shell.as_ref().unwrap_or(&default_shell);
let mut builder = Command::new(&*shell.program); let mut builder = Command::new(&*shell.program());
for arg in &shell.args { for arg in shell.args() {
builder.arg(arg); builder.arg(arg);
} }
@ -246,7 +246,7 @@ pub fn new<C>(config: &Config<C>, size: &SizeInfo, window_id: Option<usize>) ->
pty.on_resize(size); pty.on_resize(size);
pty pty
}, },
Err(err) => die!("Failed to spawn command '{}': {}", shell.program, err), Err(err) => die!("Failed to spawn command '{}': {}", shell.program(), err),
} }
} }

View File

@ -18,7 +18,7 @@ use std::iter::once;
use std::os::windows::ffi::OsStrExt; use std::os::windows::ffi::OsStrExt;
use std::sync::mpsc::TryRecvError; use std::sync::mpsc::TryRecvError;
use crate::config::{Config, Shell}; use crate::config::{Config, Program};
use crate::event::OnResize; use crate::event::OnResize;
use crate::term::SizeInfo; use crate::term::SizeInfo;
use crate::tty::windows::child::ChildExitWatcher; use crate::tty::windows::child::ChildExitWatcher;
@ -197,11 +197,11 @@ impl OnResize for Pty {
} }
fn cmdline<C>(config: &Config<C>) -> String { fn cmdline<C>(config: &Config<C>) -> String {
let default_shell = Shell::new("powershell"); let default_shell = Program::Just("powershell".to_owned());
let shell = config.shell.as_ref().unwrap_or(&default_shell); let shell = config.shell.as_ref().unwrap_or(&default_shell);
once(shell.program.as_ref()) once(shell.program().as_ref())
.chain(shell.args.iter().map(|a| a.as_ref())) .chain(shell.args().iter().map(|a| a.as_ref()))
.collect::<Vec<_>>() .collect::<Vec<_>>()
.join(" ") .join(" ")
} }