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 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
use crate::constants::{COLON, DOLLAR, HYPHEN, NEWLINE, UNDERSCORE};
use crate::node_pool::NodeID;
use crate::parse::parse_element;
use crate::types::{Attr, Cursor, Expr, MatchError, ParseOpts, Parseable, Parser, Result};
use crate::utils::Match;
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Keyword<'a> {
pub key: &'a str,
pub val: &'a str,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Affiliated<'a> {
Name(Option<NodeID>),
Caption(Option<NodeID>, &'a str),
Attr {
child_id: Option<NodeID>,
backend: &'a str,
val: &'a str,
},
}
impl<'a> Parseable<'a> for Keyword<'a> {
fn parse(
parser: &mut Parser<'a>,
mut cursor: Cursor<'a>,
parent: Option<NodeID>,
parse_opts: ParseOpts,
) -> Result<NodeID> {
let start = cursor.index;
cursor.word("#+")?;
// ,#+attr_html: :class one :class one two three four :attr :attr1
if cursor.word("attr_").is_ok() | cursor.word("ATTR_").is_ok() {
let backend = cursor.fn_until(|chr: u8| chr == b':' || chr.is_ascii_whitespace())?;
cursor.index = backend.end;
cursor.word(":")?;
let mut new_attrs: Vec<Attr> = Vec::new();
// val is in the form
// :key val :key val :key val
let val_start_ind = cursor.index;
loop {
match cursor.try_curr()? {
NEWLINE => break,
COLON => {
cursor.next();
let key_match = cursor.fn_until(|chr| chr.is_ascii_whitespace())?;
cursor.index = key_match.end;
cursor.skip_ws();
if NEWLINE == cursor.try_curr()? {
new_attrs.push(Attr {
key: key_match.obj.trim(),
val: "",
});
break;
}
let val_begin = cursor.index;
// allows for non-breaking colons:
// #+attr_html: :style border:2px solid black
loop {
match cursor.curr() {
NEWLINE => break,
COLON => {
if cursor.peek_rev(1)?.is_ascii_whitespace() {
break;
}
}
_ => {}
}
cursor.next();
}
let val_obj = cursor.clamp_backwards(val_begin);
new_attrs.push(Attr {
key: key_match.obj.trim(),
val: val_obj.trim(),
});
}
_ => cursor.next(),
}
}
let val = cursor.clamp_backwards(val_start_ind);
// skip past newline
cursor.next();
let end = cursor.index;
let lowercase_backend = backend.obj.to_ascii_lowercase();
let child_id = loop {
if let Ok(child_id) = parse_element(parser, cursor, parent, parse_opts) {
let node = &mut parser.pool[child_id];
if let Expr::Affiliated(aff) = &node.obj {
// skip affiliated objects
cursor.index = node.end;
} else {
node.attrs
.entry(lowercase_backend)
.and_modify(|attr_vec| attr_vec.append(&mut new_attrs))
.or_insert(new_attrs);
break Some(child_id);
}
} else {
break None;
};
};
return Ok(parser.alloc(
Affiliated::Attr {
child_id,
backend: backend.obj,
val: val.trim(),
},
start,
end,
parent,
));
}
let key_word = cursor.fn_until(|chr: u8| chr == b':' || chr.is_ascii_whitespace())?;
cursor.index = key_word.end;
cursor.word(":")?;
// keywords are pure ascii so use the cheaper option
match key_word.obj.to_ascii_lowercase().as_str() {
"macro" => {
if let Ok(mac) = MacroDef::parse(cursor) {
let nam = mac.obj.name;
let id = parser.pool.alloc(mac.obj, start, mac.end, parent);
parser.macros.insert(nam, id);
return Ok(id);
}
}
"name" => {
let val = cursor.fn_until(|chr: u8| chr == b'\n')?;
cursor.index = val.end;
cursor.next();
let child_id = loop {
if let Ok(child_id) = parse_element(parser, cursor, parent, parse_opts) {
let node = &mut parser.pool[child_id];
if let Expr::Affiliated(aff) = &node.obj {
// skip affiliated objects
cursor.index = node.end;
} else {
parser.pool[child_id].id_target =
Some(parser.generate_target(val.obj.trim()));
break Some(child_id);
}
} else {
break None;
};
};
let ret_id = parser.alloc(Affiliated::Name(child_id), start, val.end + 1, parent);
return Ok(ret_id);
}
"caption" => {
let val = cursor.fn_until(|chr: u8| chr == b'\n')?;
cursor.index = val.end;
cursor.next();
let child_id = loop {
if let Ok(child_id) = parse_element(parser, cursor, parent, parse_opts) {
let node = &mut parser.pool[child_id];
if let Expr::Affiliated(aff) = &node.obj {
// skip affiliated objects
cursor.index = node.end;
} else {
break Some(child_id);
}
} else {
break None;
};
};
return Ok(parser.alloc(
Affiliated::Caption(child_id, val.obj.trim()),
start,
val.end + 1,
parent,
));
}
_ => {}
}
let val = cursor.fn_until(|chr: u8| chr == b'\n')?;
// TODO: use an fn_until_inclusive to not have to add 1 to the end
// (we want to eat the ending nl too)
parser.keywords.insert(key_word.obj, val.obj.trim());
Ok(parser.alloc(
Keyword {
key: key_word.obj,
// not mentioned in the spec, but org-element trims
val: val.obj.trim(),
},
start,
val.end + 1,
parent,
))
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MacroDef<'a> {
// Highest ArgNum
pub num_args: u32,
pub input: Vec<ArgNumOrText<'a>>,
pub name: &'a str,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ArgNumOrText<'a> {
Text(&'a str),
ArgNum(u32),
}
impl<'a> MacroDef<'a> {
pub(crate) fn parse(mut cursor: Cursor<'a>) -> Result<Match<Self>> {
let start = cursor.index;
// we start just after the colon
// #+macro: NAME INNER
// INNER: words $1 is an argument $2 is another
cursor.skip_ws();
// A string starting with a alphabetic character followed by any number of
// alphanumeric characters, hyphens and underscores (-_).
if !cursor.curr().is_ascii_alphabetic() || cursor.curr() == NEWLINE {
return Err(MatchError::InvalidLogic);
}
let name_match = cursor.fn_while(|chr: u8| {
chr.is_ascii_alphanumeric() || chr == HYPHEN || chr == UNDERSCORE
})?;
cursor.index = name_match.end;
cursor.skip_ws();
// macro with no body?
if cursor.curr() == NEWLINE {
return Err(MatchError::InvalidLogic);
}
// let inner_match = cursor.fn_until(|chr: u8| chr.is_ascii_whitespace())?;
let mut prev_ind = cursor.index;
let mut ret_vec: Vec<ArgNumOrText> = Vec::new();
let mut num_args = 0;
loop {
match cursor.curr() {
DOLLAR => {
if cursor.peek(1)?.is_ascii_digit() {
ret_vec.push(ArgNumOrText::Text(cursor.clamp_backwards(prev_ind)));
// TODO: only supports 9 args rn
// parse numbers
let arg_ident = (cursor.peek(1)? - 48) as u32;
num_args = num_args.max(arg_ident);
ret_vec.push(ArgNumOrText::ArgNum(arg_ident));
// skip past dollar and number
cursor.index += 2;
prev_ind = cursor.index;
} else {
cursor.next();
}
}
NEWLINE => {
ret_vec.push(ArgNumOrText::Text(cursor.clamp_backwards(prev_ind)));
break;
}
_ => {
cursor.next();
}
}
}
Ok(Match {
start,
end: cursor.index + 1,
obj: Self {
input: ret_vec,
num_args,
name: name_match.obj,
},
})
}
}
#[cfg(test)]
mod tests {
use crate::{
element::Keyword,
expr_in_pool, node_in_pool, parse_org,
types::{Attr, Expr},
};
#[test]
fn basic_keyword() {
let inp = "#+key:val\n";
let parsed = parse_org(inp);
let k = parsed
.pool
.iter()
.find_map(|x| {
if let Expr::Keyword(k) = x.obj {
Some(k)
} else {
None
}
})
.unwrap();
assert_eq!(
k,
Keyword {
key: "key",
val: "val"
}
)
}
#[test]
fn keyword_ignore_space() {
let inp = "#+key: \t \t val\n";
let parsed = parse_org(inp);
let k = parsed
.pool
.iter()
.find_map(|x| {
if let Expr::Keyword(k) = x.obj {
Some(k)
} else {
None
}
})
.unwrap();
assert_eq!(
k,
Keyword {
key: "key",
val: "val"
}
)
}
#[test]
fn keyword_ignore_space_nl() {
let inp = "#+key: \nval\n";
let parsed = parse_org(inp);
let k = expr_in_pool!(parsed, Keyword).unwrap();
assert_eq!(
k,
&Keyword {
key: "key",
val: ""
}
)
}
#[test]
fn attr_backend_affiliated_keyword() {
// check for spaces, whitespace between val, black vals and multiple attrs
let input = r"
#+attr_html: :black yes :class :words multiple spaces accepted
|table
";
let parsed = parse_org(input);
let table = &node_in_pool!(parsed, Table).unwrap().attrs["html"];
assert_eq!(
table,
&vec![
Attr {
key: "black",
val: "yes"
},
Attr {
key: "class",
val: ""
},
Attr {
key: "words",
val: "multiple spaces accepted"
},
]
);
}
}