mxp 1.2.0

Rust implementation of the MXP (Mud eXtension Protocol) standard
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use std::fmt;
use std::ops::Deref;

use crate::color::RgbColor;
use crate::element::Element;
use crate::node::LineTagDefinition;

/// [`LineTagProperties`] for a line mode, as well as an [`Element`] if one is associated with the
/// current user-defined line mode.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct LineTag<'a> {
    /// Properties for the current line mode.
    pub properties: &'a LineTagProperties,
    /// Element associated with the current line mode.
    pub element: Option<&'a Element>,
}

impl Deref for LineTag<'_> {
    type Target = LineTagProperties;

    fn deref(&self) -> &Self::Target {
        self.properties
    }
}

/// Properties defined for a line tag.
///
/// See [MXP specification: Line Tags](https://www.zuggsoft.com/zmud/mxp.htm#User-defined%20Line%20Tags).
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct LineTagProperties {
    /// Redirect output to another window.
    pub window: Option<String>,
    /// Override foreground color.
    pub fore: Option<RgbColor>,
    /// Override background color.
    pub back: Option<RgbColor>,
    /// Suppress output in main window.
    pub gag: bool,
    /// Use this tag.
    pub enable: bool,
}

impl LineTagProperties {
    pub(crate) fn apply(&mut self, definition: LineTagDefinition) {
        if let Some(enable) = definition.enable {
            self.enable = enable;
        }
        if let Some(fore) = definition.fore {
            self.fore = Some(fore);
        }
        if let Some(back) = definition.back {
            self.back = Some(back);
        }
        if let Some(gag) = definition.gag {
            self.gag = gag;
        }
        if let Some(window) = definition.window {
            self.window = Some(window.to_owned());
        }
    }
}

impl fmt::Display for LineTagProperties {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        use crate::display::{DelimAfterFirst, Escape};

        let Self {
            window,
            fore,
            back,
            gag,
            enable,
        } = self;
        let delim = DelimAfterFirst::new(" ");
        if let Some(window) = window {
            write!(f, "{delim}WINDOWNAME={}", Escape(window))?;
        }
        if let Some(fore) = fore {
            write!(f, "{delim}FORE={fore}")?;
        }
        if let Some(back) = back {
            write!(f, "{delim}BACK={back}")?;
        }
        if *gag {
            write!(f, "{delim}GAG")?;
        }
        if !*enable {
            write!(f, "{delim}DISABLE")?;
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn fmt() {
        let properties = LineTagProperties {
            window: Some("_top".into()),
            fore: Some(RgbColor::hex(0x123456)),
            back: Some(RgbColor::hex(0x789abc)),
            gag: true,
            enable: false,
        };
        assert_eq!(
            properties.to_string(),
            "WINDOWNAME=\"_top\" FORE=#123456 BACK=#789abc GAG DISABLE"
        );
    }
}