summaryrefslogtreecommitdiff
path: root/src/informal_table.rs
blob: a940de4c204986e745b38bccf68dc2aef3ced548 (plain)
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
//! Informal table.
use crate::description::{Paragraph, ParagraphError};
use crate::xml::element::{Elements, FromElements, Tagged};

/// Informal table.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct InformalTable
{
    groups: Vec<TableGroup>,
}

impl InformalTable
{
    /// Returns the table groups.
    #[must_use]
    pub fn groups(&self) -> &[TableGroup]
    {
        &self.groups
    }
}

impl FromElements for InformalTable
{
    type Error = Error;

    fn from_elements(elements: &Elements) -> Result<Self, Self::Error>
    {
        let groups = elements
            .get_all_tagged_elements_with_name("tgroup")
            .into_iter()
            .map(TableGroup::from_tagged_element)
            .collect::<Result<Vec<_>, _>>()?;

        Ok(Self { groups })
    }
}

/// [`InformalTable`] error.
#[derive(Debug, thiserror::Error)]
pub enum Error
{
    /// Invalid group.
    #[error("Invalid group")]
    InvalidGroup(#[from] TableGroupError),
}

/// Table group
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TableGroup
{
    cols: u32,
    align: Option<String>,
    column_specs: Vec<ColumnSpec>,
    head: Vec<TableRow>,
    body: Vec<TableRow>,
}

impl TableGroup
{
    /// Returns the column count.
    #[must_use]
    pub fn cols(&self) -> u32
    {
        self.cols
    }

    /// Returns the column alignment.
    #[must_use]
    pub fn align(&self) -> Option<&str>
    {
        self.align.as_deref()
    }

    /// Returns the column specifications.
    #[must_use]
    pub fn column_specs(&self) -> &[ColumnSpec]
    {
        &self.column_specs
    }

    /// Returns the head.
    #[must_use]
    pub fn head(&self) -> &[TableRow]
    {
        &self.head
    }

    /// Returns the body.
    #[must_use]
    pub fn body(&self) -> &[TableRow]
    {
        &self.body
    }
}

impl TableGroup
{
    fn from_tagged_element(element: &Tagged) -> Result<Self, TableGroupError>
    {
        let cols = String::from_utf8(
            element
                .attributes()
                .iter()
                .find(|attr| attr.key == "cols")
                .ok_or(TableGroupError::MissingCols)?
                .value
                .clone(),
        )
        .map_err(|_| TableGroupError::ColsNotUTF8)?
        .parse::<u32>()
        .map_err(|_| TableGroupError::ColsNotNumber)?;

        let align = match element.attributes().iter().find(|attr| attr.key == "align") {
            Some(attr) => Some(
                String::from_utf8(attr.value.clone())
                    .map_err(|_| TableGroupError::AlignNotUTF8)?,
            ),
            None => None,
        };

        let column_specs = element
            .child_elements()
            .get_all_tagged_elements_with_name("colspec")
            .into_iter()
            .map(|column_spec_element| {
                ColumnSpec::from_tagged_element(column_spec_element)
            })
            .collect::<Result<Vec<_>, _>>()?;

        let mut body = element
            .child_elements()
            .get_first_tagged_with_name("tbody")
            .ok_or(TableGroupError::MissingBody)?
            .child_elements()
            .get_all_tagged_elements_with_name("row")
            .into_iter()
            .map(|row_element| TableRow::from_elements(row_element.child_elements()))
            .collect::<Result<Vec<_>, _>>()?;

        let head = element
            .child_elements()
            .get_first_tagged_with_name("thead")
            .map_or_else(
                || Ok(vec![body.remove(0)]),
                |head_element| {
                    head_element
                        .child_elements()
                        .get_all_tagged_elements_with_name("row")
                        .into_iter()
                        .map(|row_element| {
                            TableRow::from_elements(row_element.child_elements())
                        })
                        .collect::<Result<Vec<_>, _>>()
                },
            )?;

        Ok(Self {
            cols,
            align,
            column_specs,
            head,
            body,
        })
    }
}

/// [`TableGroup`] error.
#[derive(Debug, thiserror::Error)]
pub enum TableGroupError
{
    /// Missing cols element attribute.
    #[error("Missing cols")]
    MissingCols,

    /// Invalid column specification.
    #[error("Invalid column specification")]
    InvalidColumnSpec(#[from] ColumnSpecError),

    /// Missing body element.
    #[error("Missing body")]
    MissingBody,

    /// Invalid row.
    #[error("Invalid row")]
    InvalidRow(#[from] TableRowError),

    /// Cols is not valid UTF-8.
    #[error("Cols is not valid UTF-8")]
    ColsNotUTF8,

    /// Cols is not a number
    #[error("Cols is not a number")]
    ColsNotNumber,

    /// Align is not valid UTF-8.
    #[error("Align is not valid UTF-8")]
    AlignNotUTF8,
}

/// Column specification.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ColumnSpec
{
    width: String,
    num: Option<u32>,
    name: Option<String>,
}

impl ColumnSpec
{
    /// Returns the width.
    #[must_use]
    pub fn width(&self) -> &str
    {
        &self.width
    }

    /// Returns the number.
    #[must_use]
    pub fn num(&self) -> &Option<u32>
    {
        &self.num
    }

    /// Returns the name.
    #[must_use]
    pub fn name(&self) -> Option<&str>
    {
        self.name.as_deref()
    }
}

impl ColumnSpec
{
    fn from_tagged_element(element: &Tagged) -> Result<Self, ColumnSpecError>
    {
        let width = String::from_utf8(
            element
                .attributes()
                .iter()
                .find(|attr| attr.key == "colwidth")
                .ok_or(ColumnSpecError::MissingWidth)?
                .value
                .clone(),
        )
        .map_err(|_| ColumnSpecError::WidthNotUTF8)?;

        let num_result = element
            .attributes()
            .iter()
            .find(|attr| attr.key == "colnum")
            .map(|attr| String::from_utf8(attr.value.clone()));

        let num = match num_result {
            Some(num) => Some(
                num.map_err(|_| ColumnSpecError::NumNotUTF8)?
                    .parse::<u32>()
                    .map_err(|_| ColumnSpecError::NumNotNumber)?,
            ),
            None => None,
        };

        let name_result = element
            .attributes()
            .iter()
            .find(|attr| attr.key == "colname")
            .map(|attr| String::from_utf8(attr.value.clone()));

        let name = match name_result {
            Some(name) => Some(name.map_err(|_| ColumnSpecError::NameNotUTF8)?),
            None => None,
        };

        Ok(Self { width, num, name })
    }
}

/// [`ColumnSpec`] error.
#[derive(Debug, thiserror::Error)]
pub enum ColumnSpecError
{
    /// Missing width element.
    #[error("Missing width")]
    MissingWidth,

    /// Width is not valid UTF-8.
    #[error("Width is not valid UTF-8")]
    WidthNotUTF8,

    /// Num is not valid UTF-8.
    #[error("Num is not valid UTF-8")]
    NumNotUTF8,

    /// Name is not valid UTF-8.
    #[error("Name is not valid UTF-8")]
    NameNotUTF8,

    /// Num is not a number.
    #[error("Num is not a number")]
    NumNotNumber,
}

/// Table row.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TableRow
{
    entries: Vec<Paragraph>,
}

impl TableRow
{
    /// Returns the entries.
    #[must_use]
    pub fn entries(&self) -> &[Paragraph]
    {
        &self.entries
    }
}

impl FromElements for TableRow
{
    type Error = TableRowError;

    fn from_elements(elements: &Elements) -> Result<Self, Self::Error>
    {
        let entries = elements
            .get_all_tagged_elements_with_name("entry")
            .into_iter()
            .map(|entry_element| Paragraph::from_elements(entry_element.child_elements()))
            .collect::<Result<Vec<_>, _>>()?;

        Ok(Self { entries })
    }
}

/// [`TableRow`] error.
#[derive(Debug, thiserror::Error)]
pub enum TableRowError
{
    /// Invalid paragraph.
    #[error("Invalid paragraph")]
    InvalidParagraph(#[from] ParagraphError),
}