Split alacritty into a separate crates

The crate containing the entry point is called alacritty, and the crate
containing everything else is called alacritty_terminal.

2 files changed, 469 insertions, 0 deletions

diff --git a/alacritty/src/logging.rs b/alacritty/src/logging.rs
new file mode 100644
index 00000000..9c2041f0
--- /dev/null
+++ b/alacritty/src/logging.rs
@@ -0,0 +1,198 @@
+// Copyright 2016 Joe Wilm, The Alacritty Project Contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//! Logging for alacritty.
+//!
+//! The main executable is supposed to call `initialize()` exactly once during
+//! startup. All logging messages are written to stdout, given that their
+//! log-level is sufficient for the level configured in `cli::Options`.
+use std::env;
+use std::fs::{File, OpenOptions};
+use std::io::{self, LineWriter, Stdout, Write};
+use std::path::PathBuf;
+use std::process;
+use std::sync::atomic::{AtomicBool, Ordering};
+use std::sync::{Arc, Mutex};
+
+use crossbeam_channel::Sender;
+use log::{self, Level};
+use time;
+
+use alacritty_terminal::cli;
+use alacritty_terminal::message_bar::Message;
+use alacritty_terminal::term::color;
+
+const ALACRITTY_LOG_ENV: &str = "ALACRITTY_LOG";
+
+pub fn initialize(
+    options: &cli::Options,
+    message_tx: Sender<Message>,
+) -> Result<Option<PathBuf>, log::SetLoggerError> {
+    // Use env_logger if RUST_LOG environment variable is defined. Otherwise,
+    // use the alacritty-only logger.
+    if ::std::env::var("RUST_LOG").is_ok() {
+        ::env_logger::try_init()?;
+        Ok(None)
+    } else {
+        let logger = Logger::new(options.log_level, message_tx);
+        let path = logger.file_path();
+        log::set_boxed_logger(Box::new(logger))?;
+        Ok(path)
+    }
+}
+
+pub struct Logger {
+    level: log::LevelFilter,
+    logfile: Mutex<OnDemandLogFile>,
+    stdout: Mutex<LineWriter<Stdout>>,
+    message_tx: Sender<Message>,
+}
+
+impl Logger {
+    // False positive, see: https://github.com/rust-lang-nursery/rust-clippy/issues/734
+    #[allow(clippy::new_ret_no_self)]
+    fn new(level: log::LevelFilter, message_tx: Sender<Message>) -> Self {
+        log::set_max_level(level);
+
+        let logfile = Mutex::new(OnDemandLogFile::new());
+        let stdout = Mutex::new(LineWriter::new(io::stdout()));
+
+        Logger { level, logfile, stdout, message_tx }
+    }
+
+    fn file_path(&self) -> Option<PathBuf> {
+        if let Ok(logfile) = self.logfile.lock() {
+            Some(logfile.path().clone())
+        } else {
+            None
+        }
+    }
+}
+
+impl log::Log for Logger {
+    fn enabled(&self, metadata: &log::Metadata<'_>) -> bool {
+        metadata.level() <= self.level
+    }
+
+    fn log(&self, record: &log::Record<'_>) {
+        if self.enabled(record.metadata()) && record.target().starts_with("alacritty") {
+            let now = time::strftime("%F %R", &time::now()).unwrap();
+
+            let msg = if record.level() >= Level::Trace {
+                format!(
+                    "[{}] [{}] [{}:{}] {}\n",
+                    now,
+                    record.level(),
+                    record.file().unwrap_or("?"),
+                    record.line().map(|l| l.to_string()).unwrap_or_else(|| "?".into()),
+                    record.args()
+                )
+            } else {
+                format!("[{}] [{}] {}\n", now, record.level(), record.args())
+            };
+
+            if let Ok(ref mut logfile) = self.logfile.lock() {
+                let _ = logfile.write_all(msg.as_ref());
+
+                if record.level() <= Level::Warn {
+                    #[cfg(not(windows))]
+                    let env_var = format!("${}", ALACRITTY_LOG_ENV);
+                    #[cfg(windows)]
+                    let env_var = format!("%{}%", ALACRITTY_LOG_ENV);
+
+                    let msg = format!(
+                        "[{}] See log at {} ({}):\n{}",
+                        record.level(),
+                        logfile.path.to_string_lossy(),
+                        env_var,
+                        record.args(),
+                    );
+                    let color = match record.level() {
+                        Level::Error => color::RED,
+                        Level::Warn => color::YELLOW,
+                        _ => unreachable!(),
+                    };
+
+                    let mut message = Message::new(msg, color);
+                    message.set_topic(record.file().unwrap_or("?").into());
+                    let _ = self.message_tx.send(message);
+                }
+            }
+
+            if let Ok(ref mut stdout) = self.stdout.lock() {
+                let _ = stdout.write_all(msg.as_ref());
+            }
+        }
+    }
+
+    fn flush(&self) {}
+}
+
+struct OnDemandLogFile {
+    file: Option<LineWriter<File>>,
+    created: Arc<AtomicBool>,
+    path: PathBuf,
+}
+
+impl OnDemandLogFile {
+    fn new() -> Self {
+        let mut path = env::temp_dir();
+        path.push(format!("Alacritty-{}.log", process::id()));
+
+        // Set log path as an environment variable
+        env::set_var(ALACRITTY_LOG_ENV, path.as_os_str());
+
+        OnDemandLogFile { path, file: None, created: Arc::new(AtomicBool::new(false)) }
+    }
+
+    fn file(&mut self) -> Result<&mut LineWriter<File>, io::Error> {
+        // Allow to recreate the file if it has been deleted at runtime
+        if self.file.is_some() && !self.path.as_path().exists() {
+            self.file = None;
+        }
+
+        // Create the file if it doesn't exist yet
+        if self.file.is_none() {
+            let file = OpenOptions::new().append(true).create(true).open(&self.path);
+
+            match file {
+                Ok(file) => {
+                    self.file = Some(io::LineWriter::new(file));
+                    self.created.store(true, Ordering::Relaxed);
+                    let _ = writeln!(io::stdout(), "Created log file at {:?}", self.path);
+                },
+                Err(e) => {
+                    let _ = writeln!(io::stdout(), "Unable to create log file: {}", e);
+                    return Err(e);
+                },
+            }
+        }
+
+        Ok(self.file.as_mut().unwrap())
+    }
+
+    fn path(&self) -> &PathBuf {
+        &self.path
+    }
+}
+
+impl Write for OnDemandLogFile {
+    fn write(&mut self, buf: &[u8]) -> Result<usize, io::Error> {
+        self.file()?.write(buf)
+    }
+
+    fn flush(&mut self) -> Result<(), io::Error> {
+        self.file()?.flush()
+    }
+}
diff --git a/alacritty/src/main.rs b/alacritty/src/main.rs
new file mode 100644
index 00000000..7a200a8b
--- /dev/null
+++ b/alacritty/src/main.rs
@@ -0,0 +1,271 @@
+// Copyright 2016 Joe Wilm, The Alacritty Project Contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//! Alacritty - The GPU Enhanced Terminal
+#![deny(clippy::all, clippy::if_not_else, clippy::enum_glob_use, clippy::wrong_pub_self_convention)]
+#![cfg_attr(feature = "nightly", feature(core_intrinsics))]
+#![cfg_attr(all(test, feature = "bench"), feature(test))]
+// With the default subsystem, 'console', windows creates an additional console
+// window for the program.
+// This is silently ignored on non-windows systems.
+// See https://msdn.microsoft.com/en-us/library/4cc7ya5b.aspx for more details.
+#![windows_subsystem = "windows"]
+
+#[cfg(target_os = "macos")]
+use dirs;
+
+#[cfg(windows)]
+use winapi::um::wincon::{AttachConsole, FreeConsole, ATTACH_PARENT_PROCESS};
+
+use log::{error, info};
+
+use std::error::Error;
+use std::fs;
+use std::io::{self, Write};
+use std::sync::Arc;
+
+#[cfg(target_os = "macos")]
+use std::env;
+
+#[cfg(not(windows))]
+use std::os::unix::io::AsRawFd;
+
+use alacritty_terminal::config::{self, Config, Monitor};
+use alacritty_terminal::display::Display;
+use alacritty_terminal::event_loop::{self, EventLoop, Msg};
+#[cfg(target_os = "macos")]
+use alacritty_terminal::locale;
+use alacritty_terminal::message_bar::MessageBuffer;
+use alacritty_terminal::panic;
+use alacritty_terminal::sync::FairMutex;
+use alacritty_terminal::term::Term;
+use alacritty_terminal::tty;
+use alacritty_terminal::util::fmt::Red;
+use alacritty_terminal::{cli, die, event};
+
+mod logging;
+
+fn main() {
+    panic::attach_handler();
+
+    // When linked with the windows subsystem windows won't automatically attach
+    // to the console of the parent process, so we do it explicitly. This fails
+    // silently if the parent has no console.
+    #[cfg(windows)]
+    unsafe {
+        AttachConsole(ATTACH_PARENT_PROCESS);
+    }
+
+    // Load command line options
+    let options = cli::Options::load();
+
+    // Setup storage for message UI
+    let message_buffer = MessageBuffer::new();
+
+    // Initialize the logger as soon as possible as to capture output from other subsystems
+    let log_file =
+        logging::initialize(&options, message_buffer.tx()).expect("Unable to initialize logger");
+
+    // Load configuration file
+    // If the file is a command line argument, we won't write a generated default file
+    let config_path = options
+        .config_path()
+        .or_else(Config::installed_config)
+        .or_else(|| Config::write_defaults().ok())
+        .map(|path| path.to_path_buf());
+    let config = if let Some(path) = config_path {
+        Config::load_from(path).update_dynamic_title(&options)
+    } else {
+        error!("Unable to write the default config");
+        Config::default()
+    };
+
+    // Switch to home directory
+    #[cfg(target_os = "macos")]
+    env::set_current_dir(dirs::home_dir().unwrap()).unwrap();
+    // Set locale
+    #[cfg(target_os = "macos")]
+    locale::set_locale_environment();
+
+    // Store if log file should be deleted before moving config
+    let persistent_logging = options.persistent_logging || config.persistent_logging();
+
+    // Run alacritty
+    if let Err(err) = run(config, &options, message_buffer) {
+        die!("Alacritty encountered an unrecoverable error:\n\n\t{}\n", Red(err));
+    }
+
+    // Clean up logfile
+    if let Some(log_file) = log_file {
+        if !persistent_logging && fs::remove_file(&log_file).is_ok() {
+            let _ = writeln!(io::stdout(), "Deleted log file at {:?}", log_file);
+        }
+    }
+}
+
+/// Run Alacritty
+///
+/// Creates a window, the terminal state, pty, I/O event loop, input processor,
+/// config change monitor, and runs the main display loop.
+fn run(
+    mut config: Config,
+    options: &cli::Options,
+    message_buffer: MessageBuffer,
+) -> Result<(), Box<dyn Error>> {
+    info!("Welcome to Alacritty");
+    if let Some(config_path) = config.path() {
+        info!("Configuration loaded from {:?}", config_path.display());
+    };
+
+    // Set environment variables
+    tty::setup_env(&config);
+
+    // Create a display.
+    //
+    // The display manages a window and can draw the terminal
+    let mut display = Display::new(&config, options)?;
+
+    info!("PTY Dimensions: {:?} x {:?}", display.size().lines(), display.size().cols());
+
+    // Create the terminal
+    //
+    // This object contains all of the state about what's being displayed. It's
+    // wrapped in a clonable mutex since both the I/O loop and display need to
+    // access it.
+    let terminal = Term::new(&config, display.size().to_owned(), message_buffer);
+    let terminal = Arc::new(FairMutex::new(terminal));
+
+    // Find the window ID for setting $WINDOWID
+    let window_id = display.get_window_id();
+
+    // Create the pty
+    //
+    // The pty forks a process to run the shell on the slave side of the
+    // pseudoterminal. A file descriptor for the master side is retained for
+    // reading/writing to the shell.
+    let pty = tty::new(&config, options, &display.size(), window_id);
+
+    // Get a reference to something that we can resize
+    //
+    // This exists because rust doesn't know the interface is thread-safe
+    // and we need to be able to resize the PTY from the main thread while the IO
+    // thread owns the EventedRW object.
+    #[cfg(windows)]
+    let mut resize_handle = pty.resize_handle();
+    #[cfg(not(windows))]
+    let mut resize_handle = pty.fd.as_raw_fd();
+
+    // Create the pseudoterminal I/O loop
+    //
+    // pty I/O is ran on another thread as to not occupy cycles used by the
+    // renderer and input processing. Note that access to the terminal state is
+    // synchronized since the I/O loop updates the state, and the display
+    // consumes it periodically.
+    let event_loop =
+        EventLoop::new(Arc::clone(&terminal), display.notifier(), pty, options.ref_test);
+
+    // The event loop channel allows write requests from the event processor
+    // to be sent to the loop and ultimately written to the pty.
+    let loop_tx = event_loop.channel();
+
+    // Event processor
+    //
+    // Need the Rc<RefCell<_>> here since a ref is shared in the resize callback
+    let mut processor = event::Processor::new(
+        event_loop::Notifier(event_loop.channel()),
+        display.resize_channel(),
+        options,
+        &config,
+        options.ref_test,
+        display.size().to_owned(),
+    );
+
+    // Create a config monitor when config was loaded from path
+    //
+    // The monitor watches the config file for changes and reloads it. Pending
+    // config changes are processed in the main loop.
+    let config_monitor = match (options.live_config_reload, config.live_config_reload()) {
+        // Start monitor if CLI flag says yes
+        (Some(true), _) |
+        // Or if no CLI flag was passed and the config says yes
+        (None, true) => config.path()
+                .map(|path| config::Monitor::new(path, display.notifier())),
+        // Otherwise, don't start the monitor
+        _ => None,
+    };
+
+    // Kick off the I/O thread
+    let _io_thread = event_loop.spawn(None);
+
+    info!("Initialisation complete");
+
+    // Main display loop
+    loop {
+        // Process input and window events
+        let mut terminal_lock = processor.process_events(&terminal, display.window());
+
+        // Handle config reloads
+        if let Some(ref path) = config_monitor.as_ref().and_then(Monitor::pending) {
+            // Clear old config messages from bar
+            terminal_lock.message_buffer_mut().remove_topic(config::SOURCE_FILE_PATH);
+
+            if let Ok(new_config) = Config::reload_from(path) {
+                config = new_config.update_dynamic_title(options);
+                display.update_config(&config);
+                processor.update_config(&config);
+                terminal_lock.update_config(&config);
+            }
+
+            terminal_lock.dirty = true;
+        }
+
+        // Begin shutdown if the flag was raised
+        if terminal_lock.should_exit() || tty::process_should_exit() {
+            break;
+        }
+
+        // Maybe draw the terminal
+        if terminal_lock.needs_draw() {
+            // Try to update the position of the input method editor
+            #[cfg(not(windows))]
+            display.update_ime_position(&terminal_lock);
+
+            // Handle pending resize events
+            //
+            // The second argument is a list of types that want to be notified
+            // of display size changes.
+            display.handle_resize(&mut terminal_lock, &config, &mut resize_handle, &mut processor);
+
+            drop(terminal_lock);
+
+            // Draw the current state of the terminal
+            display.draw(&terminal, &config);
+        }
+    }
+
+    loop_tx.send(Msg::Shutdown).expect("Error sending shutdown to event loop");
+
+    // FIXME patch notify library to have a shutdown method
+    // config_reloader.join().ok();
+
+    // Without explicitly detaching the console cmd won't redraw it's prompt
+    #[cfg(windows)]
+    unsafe {
+        FreeConsole();
+    }
+
+    info!("Goodbye");
+
+    Ok(())
+}