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
use std::{borrow::Cow, fmt::Display};
use bstr::{BStr, BString, ByteSlice, ByteVec};
use crate::parse::{
section::{into_cow_bstr, Header, Name},
Event,
};
#[derive(Debug, PartialOrd, PartialEq, Eq, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error("section names can only be ascii, '-'")]
InvalidName,
#[error("sub-section names must not contain newlines or null bytes")]
InvalidSubSection,
}
impl<'a> Header<'a> {
pub fn new(
name: impl Into<Cow<'a, str>>,
subsection: impl Into<Option<Cow<'a, BStr>>>,
) -> Result<Header<'a>, Error> {
let name = Name(validated_name(into_cow_bstr(name.into()))?);
if let Some(subsection_name) = subsection.into() {
Ok(Header {
name,
separator: Some(Cow::Borrowed(" ".into())),
subsection_name: Some(validated_subsection(subsection_name)?),
})
} else {
Ok(Header {
name,
separator: None,
subsection_name: None,
})
}
}
}
pub fn is_valid_subsection(name: &BStr) -> bool {
name.find_byteset(b"\n\0").is_none()
}
fn validated_subsection(name: Cow<'_, BStr>) -> Result<Cow<'_, BStr>, Error> {
is_valid_subsection(name.as_ref())
.then_some(name)
.ok_or(Error::InvalidSubSection)
}
fn validated_name(name: Cow<'_, BStr>) -> Result<Cow<'_, BStr>, Error> {
name.iter()
.all(|b| b.is_ascii_alphanumeric() || *b == b'-')
.then_some(name)
.ok_or(Error::InvalidName)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn empty_header_names_are_legal() {
assert!(Header::new("", None).is_ok(), "yes, git allows this, so do we");
}
#[test]
fn empty_header_sub_names_are_legal() {
assert!(
Header::new("remote", Some(Cow::Borrowed("".into()))).is_ok(),
"yes, git allows this, so do we"
);
}
}
impl Header<'_> {
pub fn is_legacy(&self) -> bool {
self.separator.as_deref().map_or(false, |n| n == ".")
}
pub fn subsection_name(&self) -> Option<&BStr> {
self.subsection_name.as_deref()
}
pub fn name(&self) -> &BStr {
&self.name
}
#[must_use]
pub fn to_bstring(&self) -> BString {
let mut buf = Vec::new();
self.write_to(&mut buf).expect("io error impossible");
buf.into()
}
pub fn write_to(&self, mut out: impl std::io::Write) -> std::io::Result<()> {
out.write_all(b"[")?;
out.write_all(&self.name)?;
if let (Some(sep), Some(subsection)) = (&self.separator, &self.subsection_name) {
let sep = sep.as_ref();
out.write_all(sep)?;
if sep == "." {
out.write_all(subsection.as_ref())?;
} else {
out.write_all(b"\"")?;
out.write_all(escape_subsection(subsection.as_ref()).as_ref())?;
out.write_all(b"\"")?;
}
}
out.write_all(b"]")
}
#[must_use]
pub fn to_owned(&self) -> Header<'static> {
Header {
name: self.name.to_owned(),
separator: self.separator.clone().map(|v| Cow::Owned(v.into_owned())),
subsection_name: self.subsection_name.clone().map(|v| Cow::Owned(v.into_owned())),
}
}
}
fn escape_subsection(name: &BStr) -> Cow<'_, BStr> {
if name.find_byteset(b"\\\"").is_none() {
return name.into();
}
let mut buf = Vec::with_capacity(name.len());
for b in name.iter().copied() {
match b {
b'\\' => buf.push_str(br#"\\"#),
b'"' => buf.push_str(br#"\""#),
_ => buf.push(b),
}
}
BString::from(buf).into()
}
impl Display for Header<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
Display::fmt(&self.to_bstring(), f)
}
}
impl From<Header<'_>> for BString {
fn from(header: Header<'_>) -> Self {
header.into()
}
}
impl From<&Header<'_>> for BString {
fn from(header: &Header<'_>) -> Self {
header.to_bstring()
}
}
impl<'a> From<Header<'a>> for Event<'a> {
fn from(header: Header<'_>) -> Event<'_> {
Event::SectionHeader(header)
}
}