harlaw 1.1.1

use serde::{Deserialize, Serialize};

pub const TAB: &str = "\t";
pub const SPACE: &char = &' ';
pub const SKIPS: &[&str]= &["#"];

const MARGINS: &[&str] = &["[/m]", "[m0]", "[m1]", "[m2]", "[m3]", "[m4]", "[m5]", "[m6]", "[m7]", "[m8]", "[m9]", "[m10]"];
const COLORS: &[&str] = &["[c aliceblue]", "[c antiquewhite]", "[c aqua]", "[c aquamarine]", "[c azure]", "[c beige]", "[c bisque]", "[c blanchedalmond]", "[c blue]", "[c blueviolet]", "[c brown]", "[c burlywood]", "[c cadetblue]", "[c chartreuse]", "[c chocolate]", "[c coral]", "[c cornflowerblue]", "[c cornsilk]", "[c crimson]", "[c cyan]", "[c darkblue]", "[c darkcyan]", "[c darkgoldenrod]", "[c darkgray]", "[c darkgreen]", "[c darkkhaki]", "[c darkmagenta]", "[c darkolivegreen]", "[c darkorange]", "[c darkorchid]", "[c darkred]", "[c darksalmon]", "[c darkseagreen]", "[c darkslateblue]", "[c darkslategray]", "[c darkturquoise]", "[c darkviolet]", "[c deeppink]", "[c deepskyblue]", "[c dimgray]", "[c dodgerblue]", "[c firebrick]", "[c floralwhite]", "[c forestgreen]", "[c fuchsia]", "[c gainsboro]", "[c ghostwhite]", "[c gold]", "[c goldenrod]", "[c gray]", "[c green]", "[c greenyellow]", "[c honeydew]", "[c hotpink]", "[c indianred]", "[c indigo]", "[c ivory]", "[c khaki]", "[c lavender]", "[c lavenderblush]", "[c lawngreen]", "[c lemonchiffon]", "[c lightblue]", "[c lightcoral]", "[c lightcyan]", "[c lightgoldenrodyellow]", "[c lightgreen]", "[c lightgrey]", "[c lightpink]", "[c lightsalmon]", "[c lightseagreen]", "[c lightskyblue]", "[c lightslategray]", "[c lightsteelblue]", "[c lightyellow]", "[c lime]", "[c limegreen]", "[c linen]", "[c magenta]", "[c maroon]", "[c mediumaquamarine]", "[c mediumblue]", "[c mediumorchid]", "[c mediumpurple]", "[c mediumseagreen]", "[c mediumslateblue]", "[c mediumspringgreen]", "[c mediumturquoise]", "[c mediumvioletred]", "[c midnightblue]", "[c mintcream]", "[c mistyrose]", "[c moccasin]", "[c navajowhite]", "[c navy]", "[c oldlace]", "[c olive]", "[c olivedrab]", "[c orange]", "[c orangered]", "[c orchid]", "[c palegoldenrod]", "[c palegreen]", "[c paleturquoise]", "[c palevioletred]", "[c papayawhip]", "[c peachpuff]", "[c peru]", "[c pink]", "[c plum]", "[c powderblue]", "[c purple]", "[c red]", "[c rosybrown]", "[c royalblue]", "[c saddlebrown]", "[c salmon]", "[c sandybrown]", "[c seagreen]", "[c seashell]", "[c sienna]", "[c silver]", "[c skyblue]", "[c slateblue]", "[c slategray]", "[c snow]", "[c springgreen]", "[c steelblue]", "[c tan]", "[c teal]", "[c thistle]", "[c tomato]", "[c turquoise]", "[c violet]", "[c wheat]", "[c white]", "[c whitesmoke]", "[c yellow]", "[c yellowgreen]", "[/c]"];
const COMMON: &[&str] = &["[u]", "[/u]", "[trn]", "[/trn]", "[!trs]", "[/!trs]", "[com]", "[/com]", "[s]", "[/s]", "[lang]", "[/lang]", "[ex]", "[/ex]"];
const REPLACEABLES: &[&str] = &["[b]", "[/b]", "[i]", "[/i]", "[p]", "[/p]", "[ref]", "[/ref]", "[sub]", "[/sub]", "[sup]", "[/sup]"];

/// Search/replace struct for custom settings.
///
/// # Examples
/// 
/// ```
/// use harlaw::ContentReplace;
/// 
/// let replace = ContentReplace {
///     search: "[b]",
///     replace: "<strong>",
/// };
/// 
/// ```
///
#[derive(Serialize, Deserialize)]
pub struct ContentReplace<'a> {
    pub search: &'a str,
    pub replace: &'a str,
}

/// Custom settings object for running removes and
/// search/replaces on DSL file.
///
/// # Examples
/// 
/// ```
/// use harlaw::{ContentReplace, HarlawSettings};
/// 
/// let settings = HarlawSettings {
/// removes: vec!["[m1]", "[m2]", "[/m]", "\t"],
/// replaces: vec![
///     ContentReplace {
///         search: "[b]",
///         replace: "<thick>",
///     },
///     ContentReplace {
///         search: "[/b]",
///         replace: "</thick>",
///     },
///     ContentReplace {
///         search: "[i]",
///         replace: "<skew>",
///     },
///     ContentReplace {
///         search: "[/i]",
///         replace: "</skew>",
///     }
/// ],
/// };
/// 
/// ```
///
#[derive(Serialize, Deserialize)]
pub struct HarlawSettings<'a> {
    #[serde(borrow)]
    pub replaces: Vec<ContentReplace<'a>>,    
    pub removes: Vec<&'a str>,
}

fn get_replaces() -> Vec<ContentReplace<'static>> {
    vec![    
        ContentReplace { search: "[b]", replace: "<strong>" },
        ContentReplace { search: "[/b]", replace: "</strong>" },
        ContentReplace { search: "[i]", replace: "<i>" },
        ContentReplace { search: "[/i]", replace: "</i>" },
        ContentReplace { search: "[p]", replace: "<span>" },
        ContentReplace { search: "[/p]", replace: "</span>" },
        ContentReplace { search: "{-}", replace: "-" },
        ContentReplace { search: "[ref]", replace: "<span class=\"reference\">" },
        ContentReplace { search: "[/ref]", replace: "</span>" },
        ContentReplace { search: "[sub]", replace: "<sub>" },
        ContentReplace { search: "[/sub]", replace: "</sub>" },
        ContentReplace { search: "[sup]", replace: "<sup>" },
        ContentReplace { search: "[/sup]", replace: "</sup>" },
    ]
}

/// Default settings for DSL transform. 
/// You can use these as a base for your own custom settings. 
/// 
/// The default settings contain removes for common Lingvo markup,
/// and replaces for common lingvo-to-html formatting tags. 
/// 
/// ```yml
/// [b] -> <strong>
/// [i] -> <i>
/// [sub] -> <sub>
/// 
/// etc.
/// ```
///
/// # Examples
/// 
/// ```
/// use harlaw::{get_default_settings, ContentReplace};
/// 
/// let mut settings = get_default_settings();
/// 
/// // Append some custom search replace.
/// settings.replaces.push(
///     ContentReplace {
///         search: "foo",
///         replace: "bar",
///     }
/// );
/// 
/// // Append some custom remove
/// settings.removes.push("baz");
/// 
/// ```
///
pub fn get_default_settings() -> HarlawSettings<'static> {
    HarlawSettings {
        removes: [MARGINS, COLORS, &[TAB], COMMON].concat(),
        replaces: get_replaces(),
    }
}

/// "No markup" settings for DSL transform.
/// Does not perform any search/replaces, but instead removes all known Lingvo markup.
/// 
/// This means all formatting tags like bolds, italics etc. are removed along with
/// non-presentatiotal lingvo markup.
///
/// # Examples
/// 
/// ```
/// use harlaw::{get_no_markup_settings, ContentReplace};
/// 
/// // Use no markup settings as base for your own settings.
/// let mut settings = get_no_markup_settings();
/// 
/// // Append additional removes
/// settings.removes.push("foo");
/// settings.removes.push("bar");
/// settings.removes.push("baz");
/// 
/// // You can also append search replaces. By default there are none.
/// settings.replaces.push(
///     ContentReplace {
///         search: "spam",
///         replace: "bacon",
///     }
/// );
/// ```
///
pub fn get_no_markup_settings() -> HarlawSettings<'static> {
    HarlawSettings {
        removes: [MARGINS, COLORS, &[TAB], COMMON, REPLACEABLES].concat(),
        replaces: vec![],
    }
}