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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

use crate::MarkdownElement;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::{borrow::Cow, fmt};

/// The type of list.
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
pub enum ListType {
    /// An ordered list prefixes all its items using numbers.
    Ordered,
    /// An unordered list prefixes all its items using a `ListItemMarker`.
    Unordered,
}

impl Default for ListType {
    fn default() -> Self {
        Self::Unordered
    }
}

/// The marker used to indicate the start of a `ListItem`.
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
pub enum ListItemMarker {
    /// The `*` list item marker.
    Asterisk,
    /// The `-` list item marker.
    Dash,
    /// A numbered list item marker.
    ///
    /// Numbered items use a special separator char that immediately follows the
    /// item number.
    Numbered(NumberedListItemMarkerSeparator),
    /// The `+` list item marker.
    Plus,
}

impl Default for ListItemMarker {
    fn default() -> Self {
        Self::Dash
    }
}

impl fmt::Display for ListItemMarker {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let c = match self {
            Self::Asterisk => Cow::Borrowed("*"),
            Self::Dash => Cow::Borrowed("-"),
            Self::Numbered(separator) => Cow::Owned(format!("{}", separator)),
            Self::Plus => Cow::Borrowed("+"),
        };
        write!(f, "{}", c)
    }
}

/// The separator used to separate the list item number and the item content.
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
pub enum NumberedListItemMarkerSeparator {
    /// The `.` separator.
    Dot,
    /// The `)` separator.
    Parenthesis,
}

impl Default for NumberedListItemMarkerSeparator {
    fn default() -> Self {
        Self::Dot
    }
}

impl fmt::Display for NumberedListItemMarkerSeparator {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let c = match self {
            Self::Dot => '.',
            Self::Parenthesis => ')',
        };
        write!(f, "{}", c)
    }
}

/// An item inside a markdown list.
pub type ListItem = Box<dyn MarkdownElement>;

/// A markdown list.
///
/// # Note
///
/// The implementation does __NOT__ check if the marker matches the specified
/// list type. It is theoretically possible to create an ordered list that uses
/// dashes as its item markers. The here exposed inner fields should therefore
/// be used with care.
///
/// Please use the [builders](module.builder.html) to safely create Markdown
/// compliant documents!
#[derive(Clone, Debug, Default)]
pub struct List {
    pub items: Vec<ListItem>,
    pub marker: ListItemMarker,
    pub ty: ListType,
}

impl List {
    /// Creates a new default `List`.
    ///
    /// The list will be unordered and uses a dash marker.
    pub fn new() -> Self {
        Self::default()
    }

    /// Creates a new empty ordered `List`.
    pub fn ordered() -> Self {
        Self {
            marker: ListItemMarker::Numbered(NumberedListItemMarkerSeparator::default()),
            ty: ListType::Ordered,
            ..Default::default()
        }
    }

    /// Creates a new empty unordered `List`.
    pub fn unordered() -> Self {
        Self {
            ty: ListType::Unordered,
            ..Default::default()
        }
    }

    /// Creates a new ordered `List` with the given items.
    pub fn ordered_with(items: Vec<ListItem>) -> Self {
        Self {
            items,
            marker: ListItemMarker::Numbered(NumberedListItemMarkerSeparator::default()),
            ty: ListType::Ordered,
        }
    }

    /// Creates a new unordered `List` with the given items.
    pub fn unordered_with(items: Vec<ListItem>) -> Self {
        Self {
            items,
            ty: ListType::Unordered,
            ..Default::default()
        }
    }
}

impl fmt::Display for List {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        for (idx, item) in self.items.iter().enumerate() {
            let marker = match self.ty {
                ListType::Ordered => format!("{}{}", idx + 1, self.marker),
                ListType::Unordered => format!("{}", self.marker),
            };
            writeln!(f, "{} {}", marker, item.render())?;
        }

        Ok(())
    }
}