Config file

Cargo.toml

@@ -22,7 +22,7 @@ cfg-if = "1.0.0"
 clap = { version = "4.0.8", features = ["cargo", "derive", "env"] }
 csscolorparser = "0.6.2"
 derive-new = "0.5.9"
-dirs = "4.0.0"
+dirs = "5.0.0"
 euclid = "0.22.7"
 flexi_logger = { version = "0.22.3", default-features = false }
 futures = "0.3.21"
@@ -45,6 +45,7 @@ swash = "0.1.4"
 time = "0.3.9"
 tokio = { version = "1.25.0", features = ["full"] }
 tokio-util = { version = "0.7.4", features = ["compat"] }
+toml = "0.7.3"
 unicode-segmentation = "1.9.0"
 which = "4.2.5"
 winit = { git = "https://github.com/neovide/winit", branch = "new-keyboard-all" }

src/cmd_line.rs

@@ -24,7 +24,7 @@ pub struct CmdLineSettings {
     pub neovim_args: Vec<String>,
 
     /// The geometry of the window
-    #[arg(long, default_value_t = last_window_geometry())]
+    #[arg(long, default_value_t = last_window_geometry(), env = "NEOVIDE_GEOMETRY")]
     pub geometry: Dimensions,
 
     /// If to enable logging to a file in the current directory
@@ -68,11 +68,11 @@ pub struct CmdLineSettings {
 
     /// Do not request sRGB when initializing the window, may help with GPUs with weird pixel
     /// formats
-    #[arg(long = "nosrgb", env = "NEOVIDE_NO_SRGB", action = ArgAction::SetFalse, value_parser = FalseyValueParser::new())]
+    #[arg(long = "nosrgb", env = "NEOVIDE_SRGB", action = ArgAction::SetFalse, value_parser = FalseyValueParser::new())]
     pub srgb: bool,
 
     /// Do not try to request VSync on the window
-    #[arg(long = "novsync", env = "NEOVIDE_NO_VSYNC", action = ArgAction::SetFalse, value_parser = FalseyValueParser::new())]
+    #[arg(long = "novsync", env = "NEOVIDE_VSYNC", action = ArgAction::SetFalse, value_parser = FalseyValueParser::new())]
     pub vsync: bool,
 
     /// Which NeoVim binary to invoke headlessly instead of `nvim` found on $PATH

src/frame.rs

@@ -1,9 +1,11 @@
 use core::fmt;
 
+use serde::Deserialize;
+
 use clap::{builder::PossibleValue, ValueEnum};
 
 // Options for the frame decorations
-#[derive(Debug, Clone, Copy, Eq, PartialEq, Default)]
+#[derive(Debug, Clone, Copy, Eq, PartialEq, Default, Deserialize)]
 pub enum Frame {
     #[default]
     Full,

src/main.rs

@@ -35,6 +35,7 @@ use std::env::{self, args};
 
 #[cfg(not(test))]
 use flexi_logger::{Cleanup, Criterion, Duplicate, FileSpec, Logger, Naming};
+use log::error;
 use log::trace;
 
 use backtrace::Backtrace;
@@ -57,6 +58,8 @@ pub use running_tracker::*;
 #[cfg(target_os = "windows")]
 pub use windows_utils::*;
 
+use crate::settings::{config_path, Config};
+
 const BACKTRACES_FILE: &str = "neovide_backtraces.log";
 const REQUEST_MESSAGE: &str = "This is a bug and we would love for it to be reported to https://github.com/neovide/neovide/issues";
 
@@ -142,6 +145,14 @@ fn protected_main() {
     #[cfg(target_os = "windows")]
     windows_attach_to_console();
 
+    match Config::load_from_path(&config_path()) {
+        Ok(config) => config.write_to_env(),
+        Err(err) => {
+            eprintln!("{err}");
+            error!("{err}");
+        }
+    };
+
     //Will exit if -h or -v
     if let Err(err) = cmd_line::handle_command_line_arguments(args().collect()) {
         eprintln!("{err}");

src/settings/config.rs

@@ -0,0 +1,82 @@
+// Config file handling
+
+use std::env;
+
+use serde::Deserialize;
+
+use crate::{dimensions::Dimensions, frame::Frame};
+
+use std::path::{Path, PathBuf};
+
+const CONFIG_FILE: &str = "config.toml";
+
+fn neovide_config_dir() -> PathBuf {
+    let mut path = dirs::config_dir().unwrap();
+    path.push("neovide");
+    path
+}
+
+pub fn config_path() -> PathBuf {
+    let mut config_path = neovide_config_dir();
+    config_path.push(CONFIG_FILE);
+    config_path
+}
+
+#[derive(Debug, Deserialize, Default)]
+pub struct Config {
+    pub multigrid: Option<bool>,
+    pub maximized: Option<bool>,
+    pub vsync: Option<bool>,
+    pub srgb: Option<bool>,
+    pub no_idle: Option<bool>,
+    pub neovim_bin: Option<PathBuf>,
+    pub frame: Option<Frame>,
+    pub geometry: Option<Dimensions>,
+}
+
+impl Config {
+    pub fn write_to_env(&self) {
+        if let Some(multigrid) = self.multigrid {
+            env::set_var("NEOVIDE_MULTIGRID", multigrid.to_string());
+        }
+        if let Some(maximized) = self.maximized {
+            env::set_var("NEOVIDE_MAXIMIZED", maximized.to_string());
+        }
+        if let Some(vsync) = self.vsync {
+            env::set_var("NEOVIDE_VSYNC", vsync.to_string());
+        }
+        if let Some(srgb) = self.srgb {
+            env::set_var("NEOVIDE_SRGB", srgb.to_string());
+        }
+        if let Some(no_idle) = self.no_idle {
+            env::set_var("NEOVIDE_NO_IDLE", no_idle.to_string());
+        }
+        if let Some(frame) = self.frame {
+            env::set_var("NEOVIDE_FRAME", frame.to_string());
+        }
+        if let Some(neovim_bin) = &self.neovim_bin {
+            env::set_var("NEOVIM_BIN", neovim_bin.to_string_lossy().to_string());
+        }
+        if let Some(geometry) = self.geometry {
+            env::set_var("NEOVIDE_GEOMETRY", geometry.to_string());
+        }
+    }
+
+    pub fn load_from_path(path: &Path) -> Result<Self, String> {
+        let toml = std::fs::read_to_string(path).map_err(|e| {
+            format!(
+                "Error while trying to open config file {}:\n{}\nContinuing with default config.",
+                path.to_string_lossy(),
+                e
+            )
+        })?;
+        let config = toml::from_str(&toml).map_err(|e| {
+            format!(
+                "Error while parsing config file {}:\n{}\nContinuing with default config.",
+                path.to_string_lossy(),
+                e
+            )
+        })?;
+        Ok(config)
+    }
+}

src/settings/mod.rs

@@ -18,6 +18,9 @@ pub use window_geometry::{
     PersistentWindowSettings, DEFAULT_WINDOW_GEOMETRY,
 };
 
+mod config;
+pub use config::{config_path, Config};
+
 lazy_static! {
     pub static ref SETTINGS: Settings = Settings::new();
 }

website/docs/SUMMARY.md

@@ -8,6 +8,7 @@ ______________________________________________________________________
 - [Installation](installation.md)
 - [Configuration](configuration.md)
 - [Command Line Reference](command-line-reference.md)
+- [Config File](config-file.md)
 - [Editing w/ External Tools](editing-with-external-tools.md)
 - [Troubleshooting](troubleshooting.md)
 - [FAQ](faq.md)

website/docs/command-line-reference.md

@@ -42,7 +42,7 @@ Can be set to:
 ### Geometry
 
 ```sh
---geometry=<width>x<height>
+--geometry=<width>x<height> or $NEOVIDE_GEOMETRY=<width>x<height>
 ```
 
 Sets the initial neovide window size in characters.
@@ -101,7 +101,7 @@ one.
 ### No sRGB
 
 ```sh
---nosrgb or $NEOVIDE_NO_SRGB
+--nosrgb or $NEOVIDE_SRGB=false
 ```
 
 Don't request sRGB on the window. Swapping sometimes fixes startup issues.
@@ -119,10 +119,10 @@ buffers.
 Note: Even if files are opened in tabs, they're buffers anyways. It's just about them being visible
 or not.
 
-## No VSync
+### No VSync
 
 ```sh
---novsync
+--novsync or $NEOVIDE_VSYNC=false
 ```
 
 **Available since 0.10.2.**