From e6d31799077c9bc012e2f9f29236ee7d165cf337 Mon Sep 17 00:00:00 2001 From: Mathieu David Date: Thu, 18 Feb 2016 21:55:07 +0100 Subject: [PATCH] Define config struct and basic implementation Layout the config struct and the basic impl Define helper config structs to group options for languages, renderers, authors and plugins. --- src/config/mod.rs | 221 ++++++++++++++++++++++++++++++++++++++++++++++ src/lib.rs | 1 + 2 files changed, 222 insertions(+) create mode 100644 src/config/mod.rs diff --git a/src/config/mod.rs b/src/config/mod.rs new file mode 100644 index 00000000..2546afc0 --- /dev/null +++ b/src/config/mod.rs @@ -0,0 +1,221 @@ +extern crate toml; + +use std::path::{Path, PathBuf}; +use std::error::Error; + +pub struct Config { + title: String, + description: String, + + authors: Vec, + + source: PathBuf, + + outputs: Vec, + + language: Language, + translations: Vec, + + plugins: Vec, +} + +pub struct Author { + name: String, + email: Option, +} + +pub struct Output { + identifier: String, + destination: PathBuf, + config: Option, +} + +pub struct Language { + name: String, + code: String, +} + +pub struct Plugin { + identifier: String, + enabled: bool, + config: Option, +} + + +impl Config { + pub fn new() -> Self { + Config { + title: String::new(), + description: String::new(), + + authors: vec![], + + source: PathBuf::new(), + + outputs: vec![], + + language: Language::default(), + translations: vec![], + + plugins: vec![], + } + } + + pub fn read_config(&mut self) -> Result<(), Box> { + unimplemented!() + } + + fn fill_config(&mut self, toml: &str) -> Result<(), Box> { + unimplemented!() + } + + pub fn title(&self) -> &str { + &self.title + } + + pub fn description(&self) -> &str { + &self.description + } + + pub fn authors(&self) -> &[Author] { + &self.authors + } + + pub fn source(&self) -> &Path { + &self.source + } + + pub fn outputs(&self) -> &[Output] { + &self.outputs + } + + pub fn language(&self) -> &Language { + &self.language + } + + pub fn translations(&self) -> &[Language] { + &self.translations + } + + pub fn plugins(&self) -> &[Plugin] { + &self.plugins + } +} + + +impl Author { + /// Creates a new `Author` struct with the given name. The email field will be set to `None` + pub fn new(name: &str) -> Self { + Author { + name: String::from(name), + email: None, + } + } + + /// Builder pattern function, chained to `new()` it sets the email adress. + /// Used like this: + /// ``` + /// #extern crate mdbook; + /// # + /// #fn main() { + /// let author = mdbook::config::Author::new("John Doe").set_email("john@doe.org"); + /// #} + /// + pub fn set_email(mut self, email: &str) -> Self { + self.email = Some(String::from(email)); + self + } + + /// Returns the name of the author as `&str` + pub fn name(&self) -> &str { + &self.name + } + + /// Returns an `Option` with the email adress of the author + pub fn email(&self) -> Option<&str> { + self.email.as_ref().map(String::as_ref) + } +} + + +impl Output { + pub fn new(identifier: &str, destination: &Path) -> Self { + Output { + identifier: String::from(identifier), + destination: PathBuf::from(destination), + config: None, + } + } + + pub fn set_config(mut self, config: toml::Table) -> Self { + self.config = Some(config); + self + } + + pub fn identifier(&self) -> &str { + &self.identifier + } + + pub fn destination(&self) -> &Path { + &self.destination + } + + pub fn config(&self) -> Option<&toml::Table> { + self.config.as_ref().map(|x| &*x) + } +} + + +impl Language { + pub fn new(name: &str, code: &str) -> Self { + Language { + name: String::from(name), + code: String::from(code), + } + } + + pub fn name(&self) -> &str { + &self.name + } + + pub fn code(&self) -> &str { + &self.code + } +} + +impl Default for Language { + fn default() -> Self { + Language { + name: String::from("English"), + code: String::from("en"), + } + } +} + + +impl Plugin { + pub fn new(identifier: &str, enabled: bool) -> Self { + Plugin { + identifier: String::from(identifier), + enabled: enabled, + config: None, + } + } + + pub fn set_config(mut self, config: toml::Table) -> Self { + self.config = Some(config); + self + } + + pub fn identifier(&self) -> &str { + &self.identifier + } + + pub fn enabled(&self) -> bool { + self.enabled + } + + pub fn config(&self) -> Option<&toml::Table> { + self.config.as_ref().map(|x| &*x) + } +} diff --git a/src/lib.rs b/src/lib.rs index 33010801..90daa562 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -72,6 +72,7 @@ #[macro_use] pub mod macros; pub mod book; +pub mod config; mod parse; pub mod renderer; pub mod theme;