document_tree 0.4.0

reStructuredText’s DocumentTree representation
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
113
114
115
116
117
118
119
120

use serde_derive::Serialize;

use crate::url::Url;
use crate::attribute_types::{
	CanBeEmpty,
	FixedSpace,
	ID,NameToken,
	AlignHV,AlignH,AlignV,
	TableAlignH,TableBorder,TableGroupCols,
	Measure,
	EnumeratedListType,
};

pub trait ExtraAttributes<A> {
	fn with_extra(extra: A) -> Self;
	fn extra    (&    self) -> &    A;
	fn extra_mut(&mut self) -> &mut A;
}

macro_rules! impl_extra {
	( $name:ident { $( $(#[$pattr:meta])* $param:ident : $type:ty ),* $(,)* } ) => (
		impl_extra!(
			#[derive(Default,Debug,PartialEq,Serialize,Clone)]
			$name { $( $(#[$pattr])* $param : $type, )* }
		);
	);
	( $(#[$attr:meta])+ $name:ident { $( $(#[$pattr:meta])* $param:ident : $type:ty ),* $(,)* } ) => (
		$(#[$attr])+
		pub struct $name { $(
			$(#[$pattr])*
			#[serde(skip_serializing_if = "CanBeEmpty::is_empty")]
			pub $param : $type,
		)* }
	);
}

impl_extra!(Address { space: FixedSpace });
impl_extra!(LiteralBlock { space: FixedSpace });
impl_extra!(DoctestBlock { space: FixedSpace });
impl_extra!(SubstitutionDefinition { ltrim: bool, rtrim: bool });
impl_extra!(Comment { space: FixedSpace });
impl_extra!(Target {
	/// External reference to a URI/URL
	refuri: Option<Url>,
	/// References to ids attributes in other elements
	refid: Option<ID>,
	/// Internal reference to the names attribute of another element. May resolve to either an internal or external reference.
	refname: Vec<NameToken>,
	anonymous: bool,
});
impl_extra!(Raw { space: FixedSpace, format: Vec<NameToken> });
impl_extra!(#[derive(Debug,PartialEq,Serialize,Clone)] Image {
	uri: Url,
	align: Option<AlignHV>,
	alt: Option<String>,
	height: Option<Measure>,
	width: Option<Measure>,
	scale: Option<u8>,
	target: Option<Url>,  // Not part of the DTD but a valid argument
});

//bools usually are XML yesorno. “auto” however either exists and is set to something random like “1” or doesn’t exist
//does auto actually mean the numbering prefix?

impl_extra!(BulletList { bullet: Option<String> });
impl_extra!(EnumeratedList { enumtype: Option<EnumeratedListType>, prefix: Option<String>, suffix: Option<String> });

impl_extra!(Footnote { backrefs: Vec<ID>, auto: bool });
impl_extra!(Citation { backrefs: Vec<ID> });
impl_extra!(SystemMessage { backrefs: Vec<ID>, level: Option<usize>, line: Option<usize>, type_: Option<NameToken> });
impl_extra!(Figure { align: Option<AlignH>, width: Option<usize> });
impl_extra!(Table { frame: Option<TableBorder>, colsep: Option<bool>, rowsep: Option<bool>, pgwide: Option<bool> });

impl_extra!(TableGroup { cols: TableGroupCols, colsep: Option<bool>, rowsep: Option<bool>, align: Option<TableAlignH> });
impl_extra!(TableHead { valign: Option<AlignV> });
impl_extra!(TableBody { valign: Option<AlignV> });
impl_extra!(TableRow { rowsep: Option<bool>, valign: Option<AlignV> });
impl_extra!(TableEntry { colname: Option<NameToken>, namest: Option<NameToken>, nameend: Option<NameToken>, morerows: Option<usize>, colsep: Option<bool>, rowsep: Option<bool>, align: Option<TableAlignH>, r#char: Option<char>, charoff: Option<usize>, valign: Option<AlignV>, morecols: Option<usize> });
impl_extra!(TableColspec { colnum: Option<usize>, colname: Option<NameToken>, colwidth: Option<String>, colsep: Option<bool>, rowsep: Option<bool>, align: Option<TableAlignH>, r#char: Option<char>, charoff: Option<usize>, stub: Option<bool> });

impl_extra!(OptionArgument { delimiter: Option<String> });

impl_extra!(Reference {
	name: Option<NameToken>,  //TODO: is CDATA in the DTD, so maybe no nametoken?
	/// External reference to a URI/URL
	refuri: Option<Url>,
	/// References to ids attributes in other elements
	refid: Option<ID>,
	/// Internal reference to the names attribute of another element
	refname: Vec<NameToken>,
});
impl_extra!(FootnoteReference { refid: Option<ID>, refname: Vec<NameToken>, auto: bool });
impl_extra!(CitationReference { refid: Option<ID>, refname: Vec<NameToken> });
impl_extra!(SubstitutionReference { refname: Vec<NameToken> });
impl_extra!(Problematic { refid: Option<ID> });

//also have non-inline versions. Inline image is no figure child, inline target has content
impl_extra!(TargetInline {
	/// External reference to a URI/URL
	refuri: Option<Url>,
	/// References to ids attributes in other elements
	refid: Option<ID>,
	/// Internal reference to the names attribute of another element. May resolve to either an internal or external reference.
	refname: Vec<NameToken>,
	anonymous: bool,
});
impl_extra!(RawInline { space: FixedSpace, format: Vec<NameToken> });
pub type ImageInline = Image;

impl Image {
	pub fn new(uri: Url) -> Image { Image {
		uri,
		align: None,
		alt: None,
		height: None,
		width: None,
		scale: None,
		target: None,
	} }
}