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 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
use std::{borrow::Cow, collections::HashMap};
use bstr::BStr;
use smallvec::ToSmallVec;
use crate::{
file::{mutable::multi_value::EntryData, Index, MetadataFilter, MultiValueMut, Size, ValueMut},
lookup,
parse::{section, Event},
File,
};
/// # Raw value API
///
/// These functions are the raw value API, returning normalized byte strings.
impl<'event> File<'event> {
/// Returns an uninterpreted value given a section, an optional subsection
/// and key.
///
/// Consider [`Self::raw_values()`] if you want to get all values of
/// a multivar instead.
pub fn raw_value(
&self,
section_name: impl AsRef<str>,
subsection_name: Option<&BStr>,
key: impl AsRef<str>,
) -> Result<Cow<'_, BStr>, lookup::existing::Error> {
self.raw_value_filter(section_name, subsection_name, key, &mut |_| true)
}
/// Returns an uninterpreted value given a section, an optional subsection
/// and key, if it passes the `filter`.
///
/// Consider [`Self::raw_values()`] if you want to get all values of
/// a multivar instead.
pub fn raw_value_filter(
&self,
section_name: impl AsRef<str>,
subsection_name: Option<&BStr>,
key: impl AsRef<str>,
filter: &mut MetadataFilter,
) -> Result<Cow<'_, BStr>, lookup::existing::Error> {
self.raw_value_filter_inner(section_name.as_ref(), subsection_name, key.as_ref(), filter)
}
fn raw_value_filter_inner(
&self,
section_name: &str,
subsection_name: Option<&BStr>,
key: &str,
filter: &mut MetadataFilter,
) -> Result<Cow<'_, BStr>, lookup::existing::Error> {
let section_ids = self.section_ids_by_name_and_subname(section_name, subsection_name)?;
for section_id in section_ids.rev() {
let section = self.sections.get(§ion_id).expect("known section id");
if !filter(section.meta()) {
continue;
}
if let Some(v) = section.value(key) {
return Ok(v);
}
}
Err(lookup::existing::Error::KeyMissing)
}
/// Returns a mutable reference to an uninterpreted value given a section,
/// an optional subsection and key.
///
/// Consider [`Self::raw_values_mut`] if you want to get mutable
/// references to all values of a multivar instead.
pub fn raw_value_mut<'lookup>(
&mut self,
section_name: impl AsRef<str>,
subsection_name: Option<&'lookup BStr>,
key: &'lookup str,
) -> Result<ValueMut<'_, 'lookup, 'event>, lookup::existing::Error> {
self.raw_value_mut_filter(section_name, subsection_name, key, &mut |_| true)
}
/// Returns a mutable reference to an uninterpreted value given a section,
/// an optional subsection and key, and if it passes `filter`.
///
/// Consider [`Self::raw_values_mut`] if you want to get mutable
/// references to all values of a multivar instead.
pub fn raw_value_mut_filter<'lookup>(
&mut self,
section_name: impl AsRef<str>,
subsection_name: Option<&'lookup BStr>,
key: &'lookup str,
filter: &mut MetadataFilter,
) -> Result<ValueMut<'_, 'lookup, 'event>, lookup::existing::Error> {
self.raw_value_mut_filter_inner(section_name.as_ref(), subsection_name, key, filter)
}
fn raw_value_mut_filter_inner<'lookup>(
&mut self,
section_name: &str,
subsection_name: Option<&'lookup BStr>,
key: &'lookup str,
filter: &mut MetadataFilter,
) -> Result<ValueMut<'_, 'lookup, 'event>, lookup::existing::Error> {
let mut section_ids = self
.section_ids_by_name_and_subname(section_name, subsection_name)?
.rev();
let key = section::Key(Cow::<BStr>::Borrowed(key.into()));
while let Some(section_id) = section_ids.next() {
let mut index = 0;
let mut size = 0;
let mut found_key = false;
let section = self.sections.get(§ion_id).expect("known section id");
if !filter(section.meta()) {
continue;
}
for (i, event) in section.as_ref().iter().enumerate() {
match event {
Event::SectionKey(event_key) if *event_key == key => {
found_key = true;
index = i;
size = 1;
}
Event::Newline(_) | Event::Whitespace(_) | Event::ValueNotDone(_) if found_key => {
size += 1;
}
Event::ValueDone(_) | Event::Value(_) if found_key => {
found_key = false;
size += 1;
}
Event::KeyValueSeparator if found_key => {
size += 1;
}
_ => {}
}
}
if size == 0 {
continue;
}
drop(section_ids);
let nl = self.detect_newline_style().to_smallvec();
return Ok(ValueMut {
section: self.sections.get_mut(§ion_id).expect("known section-id").to_mut(nl),
key,
index: Index(index),
size: Size(size),
});
}
Err(lookup::existing::Error::KeyMissing)
}
/// Returns all uninterpreted values given a section, an optional subsection
/// ain order of occurrence.
///
/// The ordering means that the last of the returned values is the one that would be the
/// value used in the single-value case.and key.
///
/// # Examples
///
/// If you have the following config:
///
/// ```text
/// [core]
/// a = b
/// [core]
/// a = c
/// a = d
/// ```
///
/// Attempting to get all values of `a` yields the following:
///
/// ```
/// # use gix_config::File;
/// # use std::borrow::Cow;
/// # use std::convert::TryFrom;
/// # use bstr::BStr;
/// # let git_config = gix_config::File::try_from("[core]a=b\n[core]\na=c\na=d").unwrap();
/// assert_eq!(
/// git_config.raw_values("core", None, "a").unwrap(),
/// vec![
/// Cow::<BStr>::Borrowed("b".into()),
/// Cow::<BStr>::Borrowed("c".into()),
/// Cow::<BStr>::Borrowed("d".into()),
/// ],
/// );
/// ```
///
/// Consider [`Self::raw_value`] if you want to get the resolved single
/// value for a given key, if your key does not support multi-valued values.
pub fn raw_values(
&self,
section_name: impl AsRef<str>,
subsection_name: Option<&BStr>,
key: impl AsRef<str>,
) -> Result<Vec<Cow<'_, BStr>>, lookup::existing::Error> {
self.raw_values_filter(section_name, subsection_name, key, &mut |_| true)
}
/// Returns all uninterpreted values given a section, an optional subsection
/// and key, if the value passes `filter`, in order of occurrence.
///
/// The ordering means that the last of the returned values is the one that would be the
/// value used in the single-value case.
pub fn raw_values_filter(
&self,
section_name: impl AsRef<str>,
subsection_name: Option<&BStr>,
key: impl AsRef<str>,
filter: &mut MetadataFilter,
) -> Result<Vec<Cow<'_, BStr>>, lookup::existing::Error> {
self.raw_values_filter_inner(section_name.as_ref(), subsection_name, key.as_ref(), filter)
}
fn raw_values_filter_inner(
&self,
section_name: &str,
subsection_name: Option<&BStr>,
key: &str,
filter: &mut MetadataFilter,
) -> Result<Vec<Cow<'_, BStr>>, lookup::existing::Error> {
let mut values = Vec::new();
let section_ids = self.section_ids_by_name_and_subname(section_name, subsection_name)?;
for section_id in section_ids {
let section = self.sections.get(§ion_id).expect("known section id");
if !filter(section.meta()) {
continue;
}
values.extend(section.values(key));
}
if values.is_empty() {
Err(lookup::existing::Error::KeyMissing)
} else {
Ok(values)
}
}
/// Returns mutable references to all uninterpreted values given a section,
/// an optional subsection and key.
///
/// # Examples
///
/// If you have the following config:
///
/// ```text
/// [core]
/// a = b
/// [core]
/// a = c
/// a = d
/// ```
///
/// Attempting to get all values of `a` yields the following:
///
/// ```
/// # use gix_config::File;
/// # use std::borrow::Cow;
/// # use std::convert::TryFrom;
/// # use bstr::BStr;
/// # let mut git_config = gix_config::File::try_from("[core]a=b\n[core]\na=c\na=d").unwrap();
/// assert_eq!(
/// git_config.raw_values("core", None, "a")?,
/// vec![
/// Cow::<BStr>::Borrowed("b".into()),
/// Cow::<BStr>::Borrowed("c".into()),
/// Cow::<BStr>::Borrowed("d".into())
/// ]
/// );
///
/// git_config.raw_values_mut("core", None, "a")?.set_all("g");
///
/// assert_eq!(
/// git_config.raw_values("core", None, "a")?,
/// vec![
/// Cow::<BStr>::Borrowed("g".into()),
/// Cow::<BStr>::Borrowed("g".into()),
/// Cow::<BStr>::Borrowed("g".into())
/// ],
/// );
/// # Ok::<(), gix_config::lookup::existing::Error>(())
/// ```
///
/// Consider [`Self::raw_value`] if you want to get the resolved single
/// value for a given key, if your key does not support multi-valued values.
///
/// Note that this operation is relatively expensive, requiring a full
/// traversal of the config.
pub fn raw_values_mut<'lookup>(
&mut self,
section_name: impl AsRef<str>,
subsection_name: Option<&'lookup BStr>,
key: &'lookup str,
) -> Result<MultiValueMut<'_, 'lookup, 'event>, lookup::existing::Error> {
self.raw_values_mut_filter(section_name, subsection_name, key, &mut |_| true)
}
/// Returns mutable references to all uninterpreted values given a section,
/// an optional subsection and key, if their sections pass `filter`.
pub fn raw_values_mut_filter<'lookup>(
&mut self,
section_name: impl AsRef<str>,
subsection_name: Option<&'lookup BStr>,
key: &'lookup str,
filter: &mut MetadataFilter,
) -> Result<MultiValueMut<'_, 'lookup, 'event>, lookup::existing::Error> {
self.raw_values_mut_filter_inner(section_name.as_ref(), subsection_name, key, filter)
}
fn raw_values_mut_filter_inner<'lookup>(
&mut self,
section_name: &str,
subsection_name: Option<&'lookup BStr>,
key: &'lookup str,
filter: &mut MetadataFilter,
) -> Result<MultiValueMut<'_, 'lookup, 'event>, lookup::existing::Error> {
let section_ids = self.section_ids_by_name_and_subname(section_name, subsection_name)?;
let key = section::Key(Cow::<BStr>::Borrowed(key.into()));
let mut offsets = HashMap::new();
let mut entries = Vec::new();
for section_id in section_ids.rev() {
let mut last_boundary = 0;
let mut expect_value = false;
let mut offset_list = Vec::new();
let mut offset_index = 0;
let section = self.sections.get(§ion_id).expect("known section-id");
if !filter(section.meta()) {
continue;
}
for (i, event) in section.as_ref().iter().enumerate() {
match event {
Event::SectionKey(event_key) if *event_key == key => {
expect_value = true;
offset_list.push(i - last_boundary);
offset_index += 1;
last_boundary = i;
}
Event::Value(_) | Event::ValueDone(_) if expect_value => {
expect_value = false;
entries.push(EntryData {
section_id,
offset_index,
});
offset_list.push(i - last_boundary + 1);
offset_index += 1;
last_boundary = i + 1;
}
_ => (),
}
}
offsets.insert(section_id, offset_list);
}
entries.sort();
if entries.is_empty() {
Err(lookup::existing::Error::KeyMissing)
} else {
Ok(MultiValueMut {
section: &mut self.sections,
key,
indices_and_sizes: entries,
offsets,
})
}
}
/// Sets a value in a given `section_name`, optional `subsection_name`, and `key`.
/// Note sections named `section_name` and `subsection_name` (if not `None`)
/// must exist for this method to work.
///
/// # Examples
///
/// Given the config,
///
/// ```text
/// [core]
/// a = b
/// [core]
/// a = c
/// a = d
/// ```
///
/// Setting a new value to the key `core.a` will yield the following:
///
/// ```
/// # use gix_config::File;
/// # use std::borrow::Cow;
/// # use bstr::BStr;
/// # use std::convert::TryFrom;
/// # let mut git_config = gix_config::File::try_from("[core]a=b\n[core]\na=c\na=d").unwrap();
/// git_config.set_existing_raw_value("core", None, "a", "e")?;
/// assert_eq!(git_config.raw_value("core", None, "a")?, Cow::<BStr>::Borrowed("e".into()));
/// assert_eq!(
/// git_config.raw_values("core", None, "a")?,
/// vec![
/// Cow::<BStr>::Borrowed("b".into()),
/// Cow::<BStr>::Borrowed("c".into()),
/// Cow::<BStr>::Borrowed("e".into())
/// ],
/// );
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn set_existing_raw_value<'b>(
&mut self,
section_name: impl AsRef<str>,
subsection_name: Option<&BStr>,
key: impl AsRef<str>,
new_value: impl Into<&'b BStr>,
) -> Result<(), lookup::existing::Error> {
self.raw_value_mut(section_name, subsection_name, key.as_ref())
.map(|mut entry| entry.set(new_value))
}
/// Sets a value in a given `section_name`, optional `subsection_name`, and `key`.
/// Creates the section if necessary and the key as well, or overwrites the last existing value otherwise.
///
/// # Examples
///
/// Given the config,
///
/// ```text
/// [core]
/// a = b
/// ```
///
/// Setting a new value to the key `core.a` will yield the following:
///
/// ```
/// # use gix_config::File;
/// # use std::borrow::Cow;
/// # use bstr::BStr;
/// # use std::convert::TryFrom;
/// # let mut git_config = gix_config::File::try_from("[core]a=b").unwrap();
/// let prev = git_config.set_raw_value("core", None, "a", "e")?;
/// git_config.set_raw_value("core", None, "b", "f")?;
/// assert_eq!(prev.expect("present").as_ref(), "b");
/// assert_eq!(git_config.raw_value("core", None, "a")?, Cow::<BStr>::Borrowed("e".into()));
/// assert_eq!(git_config.raw_value("core", None, "b")?, Cow::<BStr>::Borrowed("f".into()));
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn set_raw_value<'b, Key, E>(
&mut self,
section_name: impl AsRef<str>,
subsection_name: Option<&BStr>,
key: Key,
new_value: impl Into<&'b BStr>,
) -> Result<Option<Cow<'event, BStr>>, crate::file::set_raw_value::Error>
where
Key: TryInto<section::Key<'event>, Error = E>,
section::key::Error: From<E>,
{
self.set_raw_value_filter(section_name, subsection_name, key, new_value, &mut |_| true)
}
/// Similar to [`set_raw_value()`][Self::set_raw_value()], but only sets existing values in sections matching
/// `filter`, creating a new section otherwise.
pub fn set_raw_value_filter<'b, Key, E>(
&mut self,
section_name: impl AsRef<str>,
subsection_name: Option<&BStr>,
key: Key,
new_value: impl Into<&'b BStr>,
filter: &mut MetadataFilter,
) -> Result<Option<Cow<'event, BStr>>, crate::file::set_raw_value::Error>
where
Key: TryInto<section::Key<'event>, Error = E>,
section::key::Error: From<E>,
{
let mut section = self.section_mut_or_create_new_filter(section_name, subsection_name, filter)?;
Ok(section.set(key.try_into().map_err(section::key::Error::from)?, new_value.into()))
}
/// Sets a multivar in a given section, optional subsection, and key value.
///
/// This internally zips together the new values and the existing values.
/// As a result, if more new values are provided than the current amount of
/// multivars, then the latter values are not applied. If there are less
/// new values than old ones then the remaining old values are unmodified.
///
/// **Note**: Mutation order is _not_ guaranteed and is non-deterministic.
/// If you need finer control over which values of the multivar are set,
/// consider using [`raw_values_mut()`][Self::raw_values_mut()], which will let you iterate
/// and check over the values instead. This is best used as a convenience
/// function for setting multivars whose values should be treated as an
/// unordered set.
///
/// # Examples
///
/// Let us use the follow config for all examples:
///
/// ```text
/// [core]
/// a = b
/// [core]
/// a = c
/// a = d
/// ```
///
/// Setting an equal number of values:
///
/// ```
/// # use gix_config::File;
/// # use std::borrow::Cow;
/// # use std::convert::TryFrom;
/// # use bstr::BStr;
/// # let mut git_config = gix_config::File::try_from("[core]a=b\n[core]\na=c\na=d").unwrap();
/// let new_values = vec![
/// "x",
/// "y",
/// "z",
/// ];
/// git_config.set_existing_raw_multi_value("core", None, "a", new_values.into_iter())?;
/// let fetched_config = git_config.raw_values("core", None, "a")?;
/// assert!(fetched_config.contains(&Cow::<BStr>::Borrowed("x".into())));
/// assert!(fetched_config.contains(&Cow::<BStr>::Borrowed("y".into())));
/// assert!(fetched_config.contains(&Cow::<BStr>::Borrowed("z".into())));
/// # Ok::<(), gix_config::lookup::existing::Error>(())
/// ```
///
/// Setting less than the number of present values sets the first ones found:
///
/// ```
/// # use gix_config::File;
/// # use std::borrow::Cow;
/// # use std::convert::TryFrom;
/// # use bstr::BStr;
/// # let mut git_config = gix_config::File::try_from("[core]a=b\n[core]\na=c\na=d").unwrap();
/// let new_values = vec![
/// "x",
/// "y",
/// ];
/// git_config.set_existing_raw_multi_value("core", None, "a", new_values.into_iter())?;
/// let fetched_config = git_config.raw_values("core", None, "a")?;
/// assert!(fetched_config.contains(&Cow::<BStr>::Borrowed("x".into())));
/// assert!(fetched_config.contains(&Cow::<BStr>::Borrowed("y".into())));
/// # Ok::<(), gix_config::lookup::existing::Error>(())
/// ```
///
/// Setting more than the number of present values discards the rest:
///
/// ```
/// # use gix_config::File;
/// # use std::borrow::Cow;
/// # use std::convert::TryFrom;
/// # use bstr::BStr;
/// # let mut git_config = gix_config::File::try_from("[core]a=b\n[core]\na=c\na=d").unwrap();
/// let new_values = vec![
/// "x",
/// "y",
/// "z",
/// "discarded",
/// ];
/// git_config.set_existing_raw_multi_value("core", None, "a", new_values)?;
/// assert!(!git_config.raw_values("core", None, "a")?.contains(&Cow::<BStr>::Borrowed("discarded".into())));
/// # Ok::<(), gix_config::lookup::existing::Error>(())
/// ```
pub fn set_existing_raw_multi_value<'a, Iter, Item>(
&mut self,
section_name: impl AsRef<str>,
subsection_name: Option<&BStr>,
key: impl AsRef<str>,
new_values: Iter,
) -> Result<(), lookup::existing::Error>
where
Iter: IntoIterator<Item = Item>,
Item: Into<&'a BStr>,
{
self.raw_values_mut(section_name, subsection_name, key.as_ref())
.map(|mut v| v.set_values(new_values))
}
}