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
use crate::*; use std::{ fmt::{Debug, Formatter, Result as FmtResult}, hash::Hash, ops::Index, str::FromStr, }; macro_rules! as_method { {$(#[$meta:meta])* fn $id:ident = $ty:ident$(($op:tt))? $(| ($default:expr)?)? $(| $ty2:ident)* -> $r:ty} => { $(#[$meta])* pub fn $id(&self) -> Result<$r, u64> { match self.yaml() { YamlBase::$ty(v) $(| YamlBase::$ty2(v))* => Ok($($op)?v), $(YamlBase::Null => Ok($default),)? _ => Err(self.pos()), } } }; } macro_rules! as_num_method { {$(#[$meta:meta])* fn $id:ident = $ty1:ident $(| $ty2:ident)*} => { $(#[$meta])* pub fn $id<N>(&self) -> Result<N, u64> where N: FromStr, { match self.yaml() { YamlBase::$ty1(n) $(| YamlBase::$ty2(n))* => match n.parse() { Ok(v) => Ok(v), Err(_) => Err(self.pos()), }, _ => Err(self.pos()), } } }; } /// A node with [`std::rc::Rc`] holder. pub type Node = NodeBase<repr::RcRepr>; /// A node with [`std::sync::Arc`] holder. pub type ArcNode = NodeBase<repr::ArcRepr>; /// Readonly node, including line number, column number, type assertion and anchor. /// You can access [`YamlBase`] type through [`NodeBase::yaml`] method. /// /// This type will ignore additional information when comparison and hashing. /// /// ``` /// use std::collections::HashSet; /// use yaml_peg::Node; /// let mut s = HashSet::new(); /// s.insert(Node::new("a".into(), 0, "", "")); /// s.insert(Node::new("a".into(), 1, "my-type", "")); /// s.insert(Node::new("a".into(), 2, "", "my-anchor")); /// assert_eq!(s.len(), 1); /// ``` /// /// There is a convenient macro [`node!`] to create nodes literally. /// /// Nodes can be indexing by `usize` or `&str`, /// but it will always return self if the index is not contained. /// /// ``` /// use yaml_peg::node; /// let n = node!(null); /// assert_eq!(n["a"][0]["bc"], n); /// ``` /// /// There are `as_*` methods provide `Result<T, u64>` returns with node position, /// default options can be created by [`Result::unwrap_or`], /// additional error message can be attach by [`Result::map_err`], /// and the optional [`Option`] can be return by [`Result::ok`], /// which shown as following example: /// /// ``` /// use yaml_peg::node; /// /// fn main() -> Result<(), (&'static str, u64)> { /// let n = node!({ /// node!("title") => node!(12.) /// }); /// let n = n.get(&["title"]).map_err(|p| ("missing \"title\"", p))?; /// assert_eq!( /// Err(("title", 0)), /// n.as_str().map_err(|p| ("title", p)) /// ); /// assert_eq!( /// Option::<&str>::None, /// n.as_str().ok() /// ); /// Ok(()) /// } /// ``` /// /// For default value on map type, [`NodeBase::get`] method has a shorten method [`NodeBase::get_default`] to combining /// transform function and default function as well. /// /// # Clone /// /// Since the YAML data is wrapped by reference counter [`std::rc::Rc`] and [`std::sync::Arc`], /// cloning node just increase the reference counter, /// the entire data structure are still shared together. /// /// If you want to copy data, please get the data first. #[derive(Hash, Eq, PartialEq, Clone)] pub struct NodeBase<R: repr::Repr>(R); impl<Repr: repr::Repr> NodeBase<Repr> { /// Create node from YAML data. pub fn new(yaml: YamlBase<Repr>, pos: u64, ty: &str, anchor: &str) -> Self { Self(Repr::repr(yaml, pos, ty.to_owned(), anchor.to_owned())) } /// Document position. #[inline(always)] pub fn pos(&self) -> u64 { self.0.pos() } /// Type assertion. #[inline(always)] pub fn ty(&self) -> &str { self.0.ty() } /// Anchor reference. #[inline(always)] pub fn anchor(&self) -> &str { self.0.anchor() } /// YAML data. #[inline(always)] pub fn yaml(&self) -> &YamlBase<Repr> { self.0.yaml() } /// Drop the node and get the YAML data. pub fn into_yaml(self) -> YamlBase<Repr> { self.0.into_yaml() } /// Check the value is null. pub fn is_null(&self) -> bool { *self.yaml() == YamlBase::Null } as_method! { /// Convert to boolean. /// /// ``` /// use yaml_peg::{node}; /// assert!(node!(true).as_bool().unwrap()); /// ``` fn as_bool = Bool(*) -> bool } as_num_method! { /// Convert to integer. /// /// ``` /// use yaml_peg::node; /// assert_eq!(60, node!(60).as_int().unwrap()); /// ``` fn as_int = Int } as_num_method! { /// Convert to float. /// /// ``` /// use yaml_peg::node; /// assert_eq!(20.06, node!(20.06).as_float().unwrap()); /// ``` fn as_float = Float } as_num_method! { /// Convert to number. /// /// ``` /// use yaml_peg::node; /// assert_eq!(60, node!(60).as_number().unwrap()); /// assert_eq!(20.06, node!(20.06).as_number().unwrap()); /// ``` fn as_number = Int | Float } as_method! { /// Convert to string pointer. /// /// This method allows null, it represented as empty string. /// You can check them by [`str::is_empty`]. /// /// ``` /// use yaml_peg::node; /// assert_eq!("abc", node!("abc").as_str().unwrap()); /// assert!(node!(null).as_str().unwrap().is_empty()); /// ``` fn as_str = Str | ("")? -> &str } /// Convert to string pointer for string, null, bool, int, and float type. /// /// This method is useful when the option mixed with digit values. /// /// ``` /// use yaml_peg::node; /// assert_eq!("abc", node!("abc").as_value().unwrap()); /// assert_eq!("123", node!(123).as_value().unwrap()); /// assert_eq!("12.04", node!(12.04).as_value().unwrap()); /// assert_eq!("true", node!(true).as_value().unwrap()); /// assert_eq!("false", node!(false).as_value().unwrap()); /// assert!(node!(null).as_value().unwrap().is_empty()); /// ``` pub fn as_value(&self) -> Result<&str, u64> { match self.yaml() { YamlBase::Str(s) | YamlBase::Int(s) | YamlBase::Float(s) => Ok(s), YamlBase::Bool(true) => Ok("true"), YamlBase::Bool(false) => Ok("false"), YamlBase::Null => Ok(""), _ => Err(self.pos()), } } as_method! { /// Convert to the string pointer of an anchor. /// /// ``` /// use yaml_peg::node; /// assert_eq!("abc", node!(*("abc")).as_anchor().unwrap()); /// ``` fn as_anchor = Anchor -> &str } as_method! { /// Convert to array. /// /// WARNING: The object ownership will be took. /// /// ``` /// use yaml_peg::node; /// assert_eq!( /// &vec![node!(1), node!(2)], /// node!([node!(1), node!(2)]).as_array().unwrap() /// ); /// ``` fn as_array = Array -> &Array<Repr> } as_method! { /// Convert to map. /// /// WARNING: The object ownership will be took. /// /// ``` /// use yaml_peg::node; /// assert_eq!( /// &node!(2), /// node!({node!(1) => node!(2)}).as_map().unwrap().get(&node!(1)).unwrap() /// ); /// ``` fn as_map = Map -> &Map<Repr> } /// Convert to map and try to get the value by keys recursivly. /// /// If any key is missing, return `Err` with node position. /// /// ``` /// use yaml_peg::node; /// assert_eq!( /// &node!(30.), /// node!({node!("a") => node!({node!("b") => node!(30.)})}).get(&["a", "b"]).unwrap() /// ); /// ``` pub fn get<Y>(&self, keys: &[Y]) -> Result<&Self, u64> where Y: Into<YamlBase<Repr>> + Copy, { if keys.is_empty() { panic!("invalid search!"); } match self.yaml() { YamlBase::Map(m) => { if let Some(n) = m.get(&Self::from(keys[0].into())) { if keys[1..].is_empty() { Ok(n) } else { n.get(&keys[1..]) } } else { Err(self.pos()) } } _ => Err(self.pos()), } } /// Same as [`NodeBase::get`] but provide default value if the key is missing. /// For this method, a transform method `as_*` is required. /// /// + If the value exist, return the value. /// + If value is a wrong type, return `Err` with node position. /// + If the value is not exist, return the default value. /// /// ``` /// use yaml_peg::{node, NodeBase}; /// let a = node!({node!("a") => node!({node!("b") => node!("c")})}); /// assert_eq!( /// "c", /// a.get_default(&["a", "b"], "d", NodeBase::as_str).unwrap() /// ); /// let b = node!({node!("a") => node!({})}); /// assert_eq!( /// "d", /// b.get_default(&["a", "b"], "d", NodeBase::as_str).unwrap() /// ); /// let c = node!({node!("a") => node!({node!("b") => node!(20.)})}); /// assert_eq!( /// Err(0), /// c.get_default(&["a", "b"], "d", NodeBase::as_str) /// ); /// ``` pub fn get_default<'a, Y, R, F>(&'a self, keys: &[Y], default: R, factory: F) -> Result<R, u64> where Y: Into<YamlBase<Repr>> + Copy, F: Fn(&'a Self) -> Result<R, u64>, { if keys.is_empty() { panic!("invalid search!"); } match self.yaml() { YamlBase::Map(m) => { if let Some(n) = m.get(&Self::from(keys[0].into())) { if keys[1..].is_empty() { factory(n) } else { n.get_default(&keys[1..], default, factory) } } else { Ok(default) } } _ => Err(self.pos()), } } } impl<R: repr::Repr> Debug for NodeBase<R> { fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult { f.write_fmt(format_args!("Node{:?}", &self.0)) } } impl<R: repr::Repr> Index<usize> for NodeBase<R> { type Output = Self; fn index(&self, index: usize) -> &Self::Output { match self.yaml() { YamlBase::Array(a) => a.get(index).unwrap_or(self), YamlBase::Map(m) => m .get(&Self::from(YamlBase::Int(index.to_string()))) .unwrap_or(self), _ => self, } } } impl<R: repr::Repr> Index<&str> for NodeBase<R> { type Output = Self; fn index(&self, index: &str) -> &Self::Output { if let YamlBase::Map(m) = self.yaml() { m.get(&Self::from(YamlBase::from(index))).unwrap_or(self) } else { self } } } impl<R: repr::Repr> From<YamlBase<R>> for NodeBase<R> { fn from(yaml: YamlBase<R>) -> Self { Self::new(yaml, 0, "", "") } }